- What's New
- Service Overview
- Getting Started
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
- Instance Management
- Access Control Attribute Management
-
Permission Set Management
- Adding a System-defined Identity Policy
- Deleting a Permission Set
- Querying Permission Set Details
- Updating a Permission Set
- Deleting a System-defined Identity Policy
- Querying Details About a Custom Identity Policy
- Adding a Custom Identity Policy
- Deleting a Custom Identity Policy
- Listing Accounts Associated with a Permission Set
- Listing System-defined Identity Policies
- Listing Pre-provisioning Statuses of Permission Sets
- Listing Permission Sets
- Creating a Permission Set
- Listing Permission Sets Provisioned to an Account
- Pre-provisioning a Permission Set
- Querying Pre-attachment Status Details of a Permission Set
- Adding a System-defined Policy
- Deleting a System-defined Policy
- Listing System-defined Policies
-
Account Assignment Management
- Removing Account Assignments
- Querying Details about the Account Assignment Creation Status
- Listing Account Assignment Creation Statuses
- Listing Account Assignment Deletion Statuses
- Listing Users or Groups Associated with an Account and a Permission Set
- Creating Account Assignments
- Querying Details about the Account Assignment Deletion Status
- Tag Management
- User Management
- Group Management
- Group Membership Management
- SCIM User Management
- SCIM Group Management
- Service Provider (SP) Management
- Client Management
- Token Management
- Device Authorization Management
- Authorization Management
- Account Management
- Agency Management
- Credentials Management
- Appendixes
- Change History
- General Reference
Copied.
Requesting Device Authorization
Function
This API is used to request device authorization.
URI
POST /v1/device/authorize
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
client_id |
Yes |
String |
Unique ID of the client registered in the IAM Identity Center |
client_secret |
Yes |
String |
Secret string generated for the client to obtain authorization from services in subsequent calls |
start_url |
Yes |
String |
User Portal URL |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
device_code |
String |
Device code used by the device to poll session tokens |
expires_in |
Integer |
Expiration time of a device code (in seconds) |
interval |
Integer |
Number of seconds the client must wait for between two attempts when polling a session |
user_code |
String |
One-time user verification code. This operation is required when authorizing a device in use. |
verification_uri |
String |
URI of the validation page for authorizing a device using the one-time user verification code |
verification_uri_complete |
String |
Alternate URL that the client can use to automatically start the browser. This procedure skips the manual steps of the user accessing the validation page and entering the code. |
Example Request
Requesting device authorization
POST https://{hostname}/v1/device/authorize { "client_id" : "example_client_id", "client_secret" : "example_client_secret", "start_url" : "https://example-start.example.com/start/url" }
Example Response
Status code: 200
Successful
{ "device_code" : "1234567890123456789012345678901234567890123456789012345678901234", "expires_in" : 1684955360, "interval" : 10, "user_code" : "1234567890123456", "verification_uri" : "https://example-erification.example.com/erification/url", "verification_uri_complete" : "https://example-erification-complete.example.com/erification/url" }
Status Codes
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot