POST

/device_authorization

http://oidc.{region}.amazonaws.com/device_authorization

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Access Token Required: API Key

Body Params

clientIdstringrequired

The unique identifier string for the client that is registered with IAM Identity Center. This value should come from the persisted result of the <a>RegisterClient</a> API operation.

startUrlstringrequired

The URL for the AWS access portal. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html">Using the AWS access portal</a> in the <i>IAM Identity Center User Guide</i>.

clientSecretstringrequired

A secret string that is generated for the client. This value should come from the persisted result of the <a>RegisterClient</a> API operation.

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/device_authorization' \
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}