This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Device Code
You can obtain a device code from Microsoft Azure to sign in to the Microsoft authentication portal.
Request
POST https://<hostname>:4443/v6/DeviceCode |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
The request body must contain the following properties:
Property | Type | Description |
|---|---|---|
targetRegion | string | Specifies the region of the Microsoft 365 organization that you plan to add. The following values are available:
|
Request Example
Request: POST https://abc.tech.local:4443/v6/DeviceCode
Request Header: Authorization: Bearer <Access-Token> Request Body: { "targetRegion": "Worldwide" } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
The response body contains the following properties:
Property | Type | Description |
|---|---|---|
userCode | string | Specifies the code that you must copy and then specify on the Microsoft authentication portal. |
verificationUrl | string | Specifies the verification URL that you must open to sign in to Microsoft Azure. |
expiresIn | integer | Specifies the lifespan of the code in seconds. |
message | string | Specifies the help message. |
Response Example
Response: 200 OK
Response Body: { "userCode": "CWE5QHLNM", "verificationUrl": "https://microsoft.com/devicelogin", "expiresIn": 899, "message": "To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CWE5QHLNM to authenticate." } |