Enum kanidm_cli::SynchOpt

pub enum SynchOpt {
    List(CommonOpt),
    Get(Named),
    Create {
        account_id: String,
        copt: CommonOpt,
        description: Option<String>,
    },
    GenerateToken {
        account_id: String,
        label: String,
        copt: CommonOpt,
    },
    DestroyToken {
        account_id: String,
        copt: CommonOpt,
    },
    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

Create

Fields

account_id: String

copt: CommonOpt

description: Option<String>

Create a new IDM sync account

GenerateToken

Fields

account_id: String

label: String

copt: CommonOpt

Generate a bearer token for an IDM sync account

DestroyToken

Fields

account_id: String

copt: CommonOpt

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

ForceRefresh

Fields

account_id: String

copt: CommonOpt

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.

Finalise

Fields

account_id: String

copt: CommonOpt

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.

Terminate

Fields

account_id: String

copt: CommonOpt

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.

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<'b>) -> Command<'b>

Append to [Command] so it can instantiate Self.

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

Append to [Command] so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand