Enum kanidm_cli::Oauth2Opt

pub enum Oauth2Opt {
    List(CommonOpt),
    Get(Named),
    CreateBasic {
        name: String,
        displayname: String,
        origin: String,
        copt: CommonOpt,
    },
    CreatePublic {
        name: String,
        displayname: String,
        origin: String,
        copt: CommonOpt,
    },
    UpdateScopeMap(Oauth2CreateScopeMapOpt),
    DeleteScopeMap(Oauth2DeleteScopeMapOpt),
    UpdateSupScopeMap(Oauth2CreateScopeMapOpt),
    DeleteSupScopeMap(Oauth2DeleteScopeMapOpt),
    UpdateClaimMap {
        copt: CommonOpt,
        name: String,
        claim_name: String,
        group: String,
        values: Vec<String>,
    },
    UpdateClaimMapJoin {
        copt: CommonOpt,
        name: String,
        claim_name: String,
        join: Oauth2ClaimMapJoin,
    },
    DeleteClaimMap {
        copt: CommonOpt,
        name: String,
        claim_name: String,
        group: String,
    },
    ResetSecrets(Named),
    ShowBasicSecret(Named),
    Delete(Named),
    SetDisplayname(Oauth2SetDisplayname),
    SetName {
        nopt: Named,
        name: String,
    },
    SetLandingUrl {
        nopt: Named,
        url: String,
    },
    EnablePkce(Named),
    DisablePkce(Named),
    EnableLegacyCrypto(Named),
    DisableLegacyCrypto(Named),
    EnablePublicLocalhost {
        copt: CommonOpt,
        name: String,
    },
    DisablePublicLocalhost {
        copt: CommonOpt,
        name: String,
    },
    PreferShortUsername(Named),
    PreferSPNUsername(Named),
    SetOrigin {
        nopt: Named,
        origin: String,
    },
}

Variants

List(CommonOpt)

List all configured oauth2 resource servers

Get(Named)

Display a selected oauth2 resource server

CreateBasic

Fields

name: String

displayname: String

origin: String

copt: CommonOpt

Create a new oauth2 confidential resource server that is protected by basic auth.

CreatePublic

Fields

name: String

displayname: String

origin: String

copt: CommonOpt

Create a new OAuth2 public resource server that requires PKCE. You should prefer using confidential resource server types if possible over public ones.

Public clients have many limitations and can not access all API’s of OAuth2. For example rfc7662 token introspection requires client authentication.

UpdateScopeMap(Oauth2CreateScopeMapOpt)

Update or add a new mapping from a group to scopes that it provides to members

DeleteScopeMap(Oauth2DeleteScopeMapOpt)

Remove a mapping from groups to scopes

UpdateSupScopeMap(Oauth2CreateScopeMapOpt)

Update or add a new mapping from a group to scopes that it provides to members

DeleteSupScopeMap(Oauth2DeleteScopeMapOpt)

Remove a mapping from groups to scopes

UpdateClaimMap

Fields

copt: CommonOpt

name: String

claim_name: String

group: String

values: Vec<String>

Update or add a new mapping from a group to custom claims that it provides to members

UpdateClaimMapJoin

Fields

copt: CommonOpt

name: String

claim_name: String

join: Oauth2ClaimMapJoin

The join strategy. Valid values are csv (comma separated value), ssv (space separated value) and array.

DeleteClaimMap

Fields

copt: CommonOpt

name: String

claim_name: String

group: String

Remove a mapping from groups to a custom claim

ResetSecrets(Named)

Reset the secrets associated to this resource server

ShowBasicSecret(Named)

Show the associated basic secret for this resource server

Delete(Named)

Delete a oauth2 resource server

SetDisplayname(Oauth2SetDisplayname)

Set a new displayname for a resource server

SetName

Fields

nopt: Named

name: String

Set a new name for this resource server. You may need to update your integrated applications after this so that they continue to function correctly.

SetLandingUrl

Fields

nopt: Named

url: String

When redirecting from the Kanidm Apps Listing page, some linked applications may need to land on a specific page to trigger oauth2/oidc interactions.

EnablePkce(Named)

Enable PKCE on this oauth2 resource server. This defaults to being enabled.

DisablePkce(Named)

Disable PKCE on this oauth2 resource server to work around insecure clients that may not support it. You should request the client to enable PKCE!

EnableLegacyCrypto(Named)

Enable legacy signing crypto on this oauth2 resource server. This defaults to being disabled. You only need to enable this for openid clients that do not support modern crytopgraphic operations.

DisableLegacyCrypto(Named)

Disable legacy signing crypto on this oauth2 resource server. This is the default.

EnablePublicLocalhost

Fields

copt: CommonOpt

name: String

Allow public clients to redirect to localhost.

DisablePublicLocalhost

Fields

copt: CommonOpt

name: String

Disable public clients redirecting to localhost.

PreferShortUsername(Named)

Use the ‘name’ attribute instead of ‘spn’ for the preferred_username

PreferSPNUsername(Named)

Use the ‘spn’ attribute instead of ‘name’ for the preferred_username

SetOrigin

Fields

nopt: Named

origin: String

Set the origin of an oauth2 client

Implementations

impl Oauth2Opt

pub fn debug(&self) -> bool

pub async fn exec(&self)

Trait Implementations

impl Debug for Oauth2Opt

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

Formats the value using the given formatter.

impl FromArgMatches for Oauth2Opt

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 Oauth2Opt

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

Append to [Command] so it can instantiate Self.

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

Append to [Command] so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand