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',
    ]
)

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) --

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) --

    The endpoint where the client can request authorization.

  • tokenEndpoint (string) --

    The endpoint where the client can get an access token.

Exceptions

• SSOOIDC.Client.exceptions.InvalidRequestException
• SSOOIDC.Client.exceptions.InvalidScopeException
• SSOOIDC.Client.exceptions.InvalidClientMetadataException
• SSOOIDC.Client.exceptions.InternalServerException