Step 1: Create a custom application
POST {{apiPath}}/environments/{{envID}}/applications
You can use the POST /environments/{{envID}}/applications
endpoint to create the new application.
The app config must specify the DEVICE_CODE
value on the grantTypes
property (and optionally the REFRESH_TOKEN
value). Applications configured with the device code grant type use the /{{envID}}/as/device_authorization
endpoint to initiate authorization.
Note: The deviceTimeout
and devicePollingInterval
OIDC properties are required when DEVICE_CODE
is specified on the grantTypes
property.
The response data returns information about the new application, including its id
property, which identifies the UUID for this application resource. You will need the application's UUID property value in Step 5 to send the authorization request and in Step 11 for the token request.
Request Body
{"enabled"=>true, "name"=>"Device-App{{$timestamp}}", "description"=>"App for Device Auth Grant", "type"=>"CUSTOM_APP", "protocol"=>"OPENID_CONNECT", "grantTypes"=>["DEVICE_CODE", "REFRESH_TOKEN"], "deviceTimeout"=>600, "devicePollingInterval"=>5, "tokenEndpointAuthMethod"=>"NONE"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string |