KAkamu-data
kamu

Authorization of a device

post/platform/token/device/authorization

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body application/x-www-form-urlencoded

client_idstring required

REQUIRED if the client is not authenticating with the authorization server as described in Section 3.2.1. of RFC6749. The client identifier as described in Section 2.2 of RFC6749.

scopestring nullable

OPTIONAL. The scope of the access request as defined by Section 3.3 of RFC6749.

Response

device authorization started

device_codestring required

REQUIRED. The device verification code.

expires_ininteger required

REQUIRED. The lifetime in seconds of the "device_code" and "user_code".

intervalinteger nullable

OPTIONAL. The minimum amount of time in seconds that the client SHOULD wait between polling requests to the token endpoint. If no value is provided, clients MUST use 5 as the default.

user_codestring required

REQUIRED. The end-user verification code.

verification_uristring required

REQUIRED. The end-user verification URI on the authorization server. The URI should be short and easy to remember as end users will be asked to manually type it into their user agent.

verification_uri_completestring nullable

OPTIONAL. A verification URI that includes the "user_code" (or other information with the same function as the "user_code"), which is designed for non-textual transmission.

Example response

{
  "expires_in": 300,
  "interval": 5
}

Changes

No recorded changes to this operation across all 62 revisions of this API.