POST

/client/register

http://oidc.{region}.amazonaws.com/client/register

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.

Access Token Required: API Key

Body Params

scopesarray

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

clientNamestringrequired

The friendly name of the client.

clientTypestringrequired

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://oidc.{region}.amazonaws.com/client/register' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}