Device Authorization

POST 
/auth/v1/device/code

Scan QR code to log in https://tools.ietf.org/html/rfc8628

Request

application/json

Body

required

client_id OPTIONAL: Default can be obtained from base auth (string)
scope OPTIONAL: Permissions. If empty, the default permissions for this client id will be obtained from the backend (string)

Responses

200

A successful response.

application/json

Schema

Schema

device_code string
user_code string
expires_in int32
interval int32
verification_uri string
verification_uri_complete string

Example (from schema)

{
  "device_code": "string",
  "user_code": "string",
  "expires_in": 0,
  "interval": 0,
  "verification_uri": "string",
  "verification_uri_complete": "string"
}

401

the oauth2.0 access token is not correct or expired

application/json

Schema

Schema

any

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...