Device Authorization Grant
Device authorization request
Initiates a device authorization workflow, generating and returning a unique device verification code.
See https://www.rfc-editor.org/rfc/rfc8628#section-3.1 for details.
Body
application/x-www-form-urlencoded
Body
The request schema for the device authorization request.
The client identifier.
The scope of the access request.
Response
application/json
Response
Device authorization response
Device Authorization Response
The device verification code.
The end-user verification code.
The end-user verification URI on the authorization server.
A verification URI that includes the “user_code”.
The lifetime in seconds of the “device_code” and “user_code”.
The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint.
Body
Device access token request
This endpoint provides the machine client a means of being notified when a request for authorization is granted or rejected.
It is expected for the client to try the access token request repeatedly in a polling fashion based on the error code in the response.
See https://www.rfc-editor.org/rfc/rfc8628#section-3.4 for details.
Body
application/x-www-form-urlencoded
Body
The request schema for the device access token request.
Value MUST be set to “urn:ietf:params:oauth:grant-type:device_code”.
The device verification code, “device_code” from the device authorization response.
The client identifier.
Response
application/json
Response
Device access token response
Device Access Token Response
The access token issued by the authorization server.
The type of the token issued.
The lifetime in seconds of the access token.
The refresh token, which can be used to obtain new access tokens using the same authorization grant.
The scope of the access token.
Body
User device authorization request
Marks the device code as authorized and is a means to provide the interactive UI flow with the necessary request metadata for the user to confirm the request.
Body
application/json
Body
The request schema for the user device authorization request.
The end-user device verification code.
Response
application/json
Response
User device authorization response
User Device Authorization Response
The name of the organization.
The user object contains information about an individual user who can use the Konnect application and API.
Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"Test User","preferred_name":"test","active":true,"inferred_region":"us","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"}
Show Child Parameters
The device metadata to be displayed to the user for confirmation.
Example:{"client_name":"Konnect CLI","user_agent":"kconnectctl/0.12","source_ip":"192.158.1.38","requested_at":"2022-02-07T17:46:57.52Z"}
Show Child Parameters
Authentication
Body
Device confirmation request
Confirms the authorization request by marking the device code as confirmed.
Body
application/json
Body
The request schema for the device confirmation request.
The end-user device verification code.
Response
Response
No Content