GenerateDeviceCode - Identity as a Service - Alibaba Cloud Documentation Center

Generates a device code.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /v2/{instanceId}/{applicationId}/oauth2/device/code HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
applicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
scope	string	No	The authorization scope.	xxx

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
device_code	string	The device code.	xxxxx
user_code	string	The user authorization code.	xxxxx
verification_uri	string	The verification URI.	https://example.com/authorize/device
verification_uri_complete	string	The complete verification URI.	https://example.com/authorize/device?user_code= xxxx
expires_in	long	The remaining validity period of the device code. Unit: seconds.	1200
expires_at	long	The time when the token expires. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1653288641
interval	long	The timeout period of the request token. Unit: seconds.	5

Examples

Sample success responses

JSONformat

{
  "device_code": "xxxxx",
  "user_code": "xxxxx",
  "verification_uri": "https://example.com/authorize/device",
  "verification_uri_complete": "https://example.com/authorize/device?user_code=\nxxxx",
  "expires_in": 1200,
  "expires_at": 1653288641,
  "interval": 5
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-24	The internal configuration of the API is changed, but the call is not affected	View Change Details