ORory
oAuth2

The OAuth 2.0 Device Authorize Endpoint

Changed on

This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exist.

To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc8628

post/oauth2/device/auth

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /oauth2/device/auth
  • Auth
    none declared

Response

deviceAuthorization

device_codestring

The device verification code.

expires_ininteger

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

intervalinteger

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

The end-user verification code.

verification_uristring

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

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

{
  "device_code": "ory_dc_smldfksmdfkl.mslkmlkmlk",
  "expires_in": 16830,
  "interval": 5,
  "user_code": "AAAAAA",
  "verification_uri": "https://auth.ory.sh/tv",
  "verification_uri_complete": "https://auth.ory.sh/tv?user_code=AAAAAA"
}

Changes