SSOOIDC / Client / register_client

register_client#

SSOOIDC.Client.register_client(**kwargs)#

Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

See also: AWS API Documentation

Request Syntax

response = client.register_client(
    clientName='string',
    clientType='string',
    scopes=[
        'string',
    ],
    redirectUris=[
        'string',
    ],
    grantTypes=[
        'string',
    ],
    issuerUrl='string',
    entitledApplicationArn='string'
)
Parameters:

  • clientName (string) –

    [REQUIRED]

    The friendly name of the client.

  • clientType (string) –

    [REQUIRED]

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

  • scopes (list) –

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

    • (string) –

  • redirectUris (list) –

    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.

    • (string) –

  • grantTypes (list) –

    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.

    • (string) –

  • issuerUrl (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.

  • entitledApplicationArn (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.

Return type:

dict

Returns:

Response Syntax

{
    'clientId': 'string',
    'clientSecret': 'string',
    'clientIdIssuedAt': 123,
    'clientSecretExpiresAt': 123,
    'authorizationEndpoint': 'string',
    'tokenEndpoint': 'string'
}

Response Structure

  • (dict) –

    • clientId (string) –

      The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.

    • clientSecret (string) –

      A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.

    • clientIdIssuedAt (integer) –

      Indicates the time at which the clientId and clientSecret were issued.

    • clientSecretExpiresAt (integer) –

      Indicates the time at which the clientId and clientSecret will become invalid.

    • authorizationEndpoint (string) –

      An endpoint that the client can use to request authorization.

    • tokenEndpoint (string) –

      An endpoint that the client can use to create tokens.

Exceptions

  • SSOOIDC.Client.exceptions.InvalidRequestException

  • SSOOIDC.Client.exceptions.InvalidScopeException

  • SSOOIDC.Client.exceptions.InvalidClientMetadataException

  • SSOOIDC.Client.exceptions.InternalServerException

  • SSOOIDC.Client.exceptions.InvalidRedirectUriException

  • SSOOIDC.Client.exceptions.UnsupportedGrantTypeException