Enum SynchOpt

pub enum SynchOpt {
    List(CommonOpt),
    Get(Named),
    SetCredentialPortal {
        account_id: String,
        copt: CommonOpt,
        url: Option<Url>,
    },
    Create {
        account_id: String,
        copt: CommonOpt,
        description: Option<String>,
    },
    GenerateToken {
        account_id: String,
        label: String,
        copt: CommonOpt,
    },
    DestroyToken {
        account_id: String,
        copt: CommonOpt,
    },
    SetYieldAttributes {
        account_id: String,
        copt: CommonOpt,
        attrs: Vec<String>,
    },
    ForceRefresh {
        account_id: String,
        copt: CommonOpt,
    },
    Finalise {
        account_id: String,
        copt: CommonOpt,
    },
    Terminate {
        account_id: String,
        copt: CommonOpt,
    },
}

Variants

List(CommonOpt)

List all configured IDM sync accounts

Get(Named)

Display a selected IDM sync account

SetCredentialPortal

Set the url to the external credential portal. This will be displayed to synced users so that they can be redirected to update their credentials on this portal.

Fields

account_id: String

copt: CommonOpt

url: Option<Url>

Create

Create a new IDM sync account

Fields

account_id: String

copt: CommonOpt

description: Option<String>

GenerateToken

Generate a bearer token for an IDM sync account

Fields

account_id: String

label: String

copt: CommonOpt

DestroyToken

Destroy (revoke) the bearer token for an IDM sync account

Fields

account_id: String

copt: CommonOpt

SetYieldAttributes

Set the list of attributes that have their authority yielded from the sync account and are allowed to be modified by kanidm and users. Any attributes not listed in in this command will have their authority returned to the sync account.

Fields

account_id: String

copt: CommonOpt

attrs: Vec<String>

ForceRefresh

Reset the sync cookie of this connector, so that on the next operation of the sync tool a full refresh of the provider is requested. Kanidm attributes that have been granted authority will not be lost or deleted.

Fields

account_id: String

copt: CommonOpt

Finalise

Finalise and remove this sync account. This will transfer all synchronised entries into the authority of Kanidm. This signals the end of a migration from an external IDM into Kanidm. ⚠️ This action can NOT be undone. Once complete, it is most likely that attempting to recreate a sync account from the same IDM will fail due to conflicting entries that Kanidm now owns.

Fields

account_id: String

copt: CommonOpt

Terminate

Terminate and remove this sync account. This will DELETE all entries that were imported from the external IDM source. ⚠️ This action can NOT be undone, and will require you to recreate the sync account if you wish to re-import data. Recreating the sync account may fail until the recycle bin and and tombstones are purged.

Fields

account_id: String

copt: CommonOpt

Implementations

impl SynchOpt

pub fn debug(&self) -> bool

pub async fn exec(&self)

Trait Implementations

impl Debug for SynchOpt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for SynchOpt

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for SynchOpt

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand