- 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 User Information Using sso_ticket
Function
This API is used to obtain user information using sso_ticket.
URI
POST /api/v2/tenant/sso/sso-ticket/verify
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Set this field to "application/json;charset=utf8". |
Authorization |
Yes |
String |
Authentication credential. The value is Bearer {access_token}. access_token is obtained by calling the API for obtaining an access credential. |
X-tenant-id |
No |
String |
External ID of a tenant. This parameter is mandatory if the API is called by an ISV. Replace "{domain_name}" with the ISV common domain name "{common_domain}". The tenant ID of the corresponding tenant must be specified in the request header. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
sso_ticket |
Yes |
String |
One-time access ticket (sso_ticket), which is obtained using session_token upon user login, and used to obtain user information. |
operating_sys_version |
Yes |
String |
Caller OS version, for example, Android 10. |
device_ip |
Yes |
String |
Caller device IP address, for example, 10.10.10.1 |
device_fingerprint |
Yes |
String |
Caller device fingerprint. When the same user calls the API, values of this parameter must be the same, for example, 156aysdna213sc50. |
agent |
No |
String |
User agent information of the caller, for example, Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
message |
String |
Error description. |
data |
data object |
User information. |
Parameter |
Type |
Description |
---|---|---|
userName |
String |
Username. |
id |
String |
User ID. |
name |
String |
Name. |
mobile |
String |
Mobile number. |
|
String |
Email address. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error details. |
Example Requests
Query user information based on sso_ticket obtained from session_token. The value of sso_ticket is ssoTicket-r5TCBLU14oSGxCMVdxeB5HA1uJiV.
POST https://{domain_name}/api/v2/tenant/sso/sso-ticket/verify Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140... X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "sso_ticket": "ssoTicket-r5TCBLU14oSGxCMVdxeB5HA1uJiV", "operating_sys_version": "Android 10", "device_ip": "10.10.10.1", "device_fingerprint": "156aysdna213sac", "agent": "Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36" }
Example Responses
Status code: 200
Request successful.
{ "code" : "0", "message" : "success", "data" : { "user" : { "name" : "20220330162435", "mobile" : "12345678901", "id" : "20220330162436475-7570-D943B4FF3", "userName" : "20220330162435", "email" : "20220330162435@example.com" } } }
Status Codes
Status Code |
Description |
---|---|
200 |
Request successful. |
400 |
Invalid parameter. |
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