Skip to content

RegisterClientRequest

Source code in docs_src/capo_sso_oidc/types/register_client_request.py
class RegisterClientRequest(TypedDict, closed=True):
    client_name: "capo_sso_oidc.types.client_name.ClientName"
    """<p>The friendly name of the client.</p>"""
    client_type: "capo_sso_oidc.types.client_type.ClientType"
    """<p>The type of client. The service supports only <code>public</code> as a client type. Anything other than public will be rejected by the service.</p>"""
    scopes: NotRequired["capo_sso_oidc.types.scopes.Scopes"]
    """<p>The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.</p>"""
    redirect_uris: NotRequired["capo_sso_oidc.types.redirect_uris.RedirectUris"]
    """<p>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.</p>"""
    grant_types: NotRequired["capo_sso_oidc.types.grant_types.GrantTypes"]
    """<p>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. </p> <p>* Authorization Code - <code>authorization_code</code> </p> <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code> </p> <p>* Refresh Token - <code>refresh_token</code> </p>"""
    issuer_url: NotRequired["capo_sso_oidc.types.uri.URI"]
    """<p>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.</p>"""
    entitled_application_arn: NotRequired["capo_sso_oidc.types.arn_type.ArnType"]
    """<p>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.</p>"""

client_name instance-attribute

client_name: ClientName

The friendly name of the client.

client_type instance-attribute

client_type: ClientType

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

entitled_application_arn instance-attribute

entitled_application_arn: NotRequired[ArnType]

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.

grant_types instance-attribute

grant_types: NotRequired[GrantTypes]

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 instance-attribute

issuer_url: NotRequired[URI]

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.

redirect_uris instance-attribute

redirect_uris: NotRequired[RedirectUris]

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.

scopes instance-attribute

scopes: NotRequired[Scopes]

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