- Service Overview
- Billing
- Getting Started
-
User Guide
- Before You Start
- Buying an Instance
- Instance Management
-
Enterprise Administrator Guide
- Logging In to the OneAccess Administrator Portal
- User Management
-
Resources
- Overview
-
Applications
- Adding an Application
- Enabling, Disabling, or Deleting an Application
- General Information
- Authentication Integration
- Synchronization Integration
- Login Configuration
- Access Control
- Object Models
- Authorization Management
- API Permission Management
- Application Permission Management
- Security Settings
- Audit Logs
- APIs
- Authentication
- Security
- Audit
- Settings
- Common User Guide
- Key Operations Recorded by CTS
-
Best Practices
- OneAccess Best Practices
- Identity Source Integration
-
Application Integration
-
Logging In to the Huawei Cloud Through User Portal
- Introduction
- Logging In to Single Huawei Cloud Account via OneAccess Without Password (SAML - Virtual User SSO)
- Logging In to Multiple Huawei Cloud Accounts via OneAccess Without Password (SAML - Virtual User SSO)
- Logging In to Single Huawei Cloud Account via OneAccess Without Password (SAML - IAM User SSO)
- Logging In to Multiple Huawei Cloud Accounts via OneAccess Without Password (SAML - IAM User SSO)
- Logging In to Huawei Cloud via OneAccess Without Password (OIDC)
- SSO Access to Applications Through SAML
- SSO Access to Applications Through OAuth 2.0
- SSO Access to Applications Through OIDC
- SSO Access to Applications Through CAS
- SSO Access to Applications Through Plug-in Autocompletion
-
Logging In to the Huawei Cloud Through User Portal
- Data Synchronization
- Authentication Provider Integration
- Authorizing IAM Users to Access a OneAccess Instance Administrator Portal
- API Usage
- Configuring MFA for User Login
- Developer Guide
-
API Reference
- Before You Start
- API Overview
-
OneAccess APIs
-
Management APIs
- Calling APIs
- Access Credentials
-
User Management
- Creating a User
- Modifying a User
- Deleting a User
- Enabling a User
- Disabling a User
- Changing a User Password
- Verifying and Modifying the Original User Password
- Querying User Details by User ID
- Querying User Details by Username
- Querying the User List
- Authorizing an Application Account
- Querying All Authorized Application Accounts of a User
- Organization Management
- Application Organization Management
- Application Account Management
- Application Role Management
- User APIs
- Application Integration APIs
-
Management APIs
- Appendix
- FAQs
- General Reference
Copied.
Obtaining an ID Token
Function
This API is used to obtain an ID token.
URI
POST /api/v1/oauth2/token
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
grant_type |
Yes |
String |
Grant type. The value is fixed at authorization_code. |
code |
Yes |
String |
Authorization code, which is obtained through callback after login authentication. |
client_id |
Yes |
String |
Application ID, which is a client ID allocated to an application after registration. |
client_secret |
Yes |
String |
Application secret, which is a client secret allocated to an application after registration. |
redirect_uri |
Yes |
String |
Callback address. The address can be the callback address or the domain name entered during application registration. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
access_token |
String |
Access token that the authorization server returns to the third-party application. |
token_type |
String |
Type of the access token. Fixed value: Bearer. |
expires_in |
String |
Validity period of the access token. Unit: second. |
scope |
String |
Authorization scope. |
refresh_token |
String |
Refresh token. By default, no refresh token is generated. If you need one, set the refresh token validity period in the authentication configuration of the application. |
id_token |
String |
ID token. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
String |
Error type. |
error_description |
String |
Error description. |
Example Requests
Obtain an ID token based on an authorization code. The value of grant type is fixed at authorization_code. ClientId and ClientSecret allocated in the application registration are used. Redirection address is configured to the callback address (https://example.com) in the application registration.
POST https://{domain_name}/api/v1/oauth2/token Content-Type: application/x-www-form-urlencoded grant_type=authorization_code& code=0yV...& client_id=cU0L3GsEq1vuOJ5iQrRSu5AyPnKL8...& client_secret=EFj******TcE& redirect_uri=https://example.com
Example Responses
Status code: 200
Request successful.
-
Example 1
{ "access_token" : "ObU******NpD", "token_type" : "Bearer", "expires_in" : 7200, "scope" : "openid", "id_token" : "eyJ******Njg" }
-
Example 2
{ "access_token" : "NqMh******d3k", "token_type" : "Bearer", "expires_in" : 7200, "scope" : "openid", "refresh_token" : "5wI******anH", "id_token" : "eyJ******Njg" }
Status code: 400
Request error.
{ "error" : "invalid_grant", "error_description" : "Invalid authorization code" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request successful. |
400 |
Request error. |
Error Codes
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