Jump to

• Request
• Response

Generate Device Code and User Code (OAuth Device Flow)

post

/oauth2/v1/device

Request

Supported Media Types

• application/x-www-form-urlencoded

Body ()

Root Schema : schema

Type: object

Show Source

• client_id: string
  Unique ID of the client.

  Example: a5bf5db7f6c43b47b1eae399c68319c4
• response_type: string
  Type of response from the server (device_code)

  Example: device_code
• scope: string
  Scope for which the Device Code and User Code is requested.

  Example: http://abccorp.com/quote

{
    "type":"object",
    "properties":{
        "response_type":{
            "description":"Type of response from the server (device_code)",
            "type":"string",
            "example":"device_code"
        },
        "scope":{
            "description":"Scope for which the Device Code and User Code is requested.",
            "type":"string",
            "example":"http://abccorp.com/quote"
        },
        "client_id":{
            "description":"Unique ID of the client.",
            "type":"string",
            "example":"a5bf5db7f6c43b47b1eae399c68319c4"
        }
    },
    "required":[
        "response_type",
        "scope",
        "client_id"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Device Code and User Code generated

Body ()

Root Schema : device

Type: object

Generated Device Code and User Code (OAuth Device Flow)

Show Source

• device_code: string
  Device Code used to obtain the Access Token
• expires_in: number
  Expiry time of the Device Code and User Code in seconds
• user_code: string
  User Code used by user to approve OAuth Device Flow.
• verification_uri: string
  Verification URI where User authenticates and approves User Code.

{
    "description":"Generated Device Code and User Code (OAuth Device Flow)",
    "type":"object",
    "properties":{
        "device_code":{
            "type":"string",
            "description":"Device Code used to obtain the Access Token"
        },
        "expires_in":{
            "type":"number",
            "description":"Expiry time of the Device Code and User Code in seconds"
        },
        "user_code":{
            "type":"string",
            "description":"User Code used by user to approve OAuth Device Flow."
        },
        "verification_uri":{
            "type":"string",
            "description":"Verification URI where User authenticates and approves User Code."
        }
    },
    "required":[
        "device_code",
        "expires_in",
        "user_code",
        "verification_uri"
    ]
}

400 Response

Invalid request

Body ()

Root Schema : error

Type: object

Error message that appears during Access Token generation

Show Source

• error: string
  Error values that are based on the OAuth specification
• error_description: string
  Detailed error messages

{
    "description":"Error message that appears during Access Token generation",
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error values that are based on the OAuth specification"
        },
        "error_description":{
            "type":"string",
            "description":"Detailed error messages"
        }
    },
    "required":[
        "error",
        "error_description"
    ]
}

401 Response

Unauthorized client

Body ()

Root Schema : error

Type: object

Error message that appears during Access Token generation

Show Source

• error: string
  Error values that are based on the OAuth specification
• error_description: string
  Detailed error messages

{
    "description":"Error message that appears during Access Token generation",
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error values that are based on the OAuth specification"
        },
        "error_description":{
            "type":"string",
            "description":"Detailed error messages"
        }
    },
    "required":[
        "error",
        "error_description"
    ]
}

Back to Top