Struct RegisterClientInput

#[non_exhaustive]
pub struct RegisterClientInput {
    pub client_name: Option<String>,
    pub client_type: Option<String>,
    pub scopes: Option<Vec<String>>,
    pub redirect_uris: Option<Vec<String>>,
    pub grant_types: Option<Vec<String>>,
    pub issuer_url: Option<String>,
    pub entitled_application_arn: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_name: Option<String>

The friendly name of the client.

client_type: Option<String>

The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

scopes: Option<Vec<String>>

The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

redirect_uris: Option<Vec<String>>

The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.

grant_types: Option<Vec<String>>

The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token.

* Authorization Code - authorization_code

* Device Code - urn:ietf:params:oauth:grant-type:device_code

* Refresh Token - refresh_token

issuer_url: Option<String>

The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.

entitled_application_arn: Option<String>

This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.

Implementations

impl RegisterClientInput

pub fn client_name(&self) -> Option<&str>

The friendly name of the client.

pub fn client_type(&self) -> Option<&str>

The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

pub fn scopes(&self) -> &[String]

The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .scopes.is_none().

pub fn redirect_uris(&self) -> &[String]

The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .redirect_uris.is_none().

pub fn grant_types(&self) -> &[String]

The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token.

* Authorization Code - authorization_code

* Device Code - urn:ietf:params:oauth:grant-type:device_code

* Refresh Token - refresh_token

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .grant_types.is_none().

pub fn issuer_url(&self) -> Option<&str>

The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.

pub fn entitled_application_arn(&self) -> Option<&str>

This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.

impl RegisterClientInput

pub fn builder() -> RegisterClientInputBuilder

Creates a new builder-style object to manufacture RegisterClientInput.

Trait Implementations

impl Clone for RegisterClientInput

fn clone(&self) -> RegisterClientInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RegisterClientInput

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

Formats the value using the given formatter.

impl PartialEq for RegisterClientInput

fn eq(&self, other: &RegisterClientInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RegisterClientInput