Enterprise Robot MP Subpage SSO
Overview
- This API is used to obtain the URL of SSO login to the OrionStar enterprise robot MP subpage;
Authorization
| Data Dimension Authorization | Enterprise-level Authorization | This API requires enterprise-level authorization. Both enterprise-level and agent-level authorization accounts can call this API. Please refer to Authorization Methods. |
|---|
| Interface Dimension Authorization | Default Authorization | This API is granted by default, so you don't need to apply for interface dimension authorization separately for your authorization account. Please refer to Authorization Methods. |
|---|
Notes
- Please try to reuse the redirection URL within the same login session of the third-party system (your system) to the greatest extent possible, instead of reacquiring the redirection URL every time you jump to the subpage;
- OrionStar may restrict the number of times the same authorized account can obtain the subpage redirection URL each day to prevent excessive consumption of session resources caused by creating a new login session every time you enter the subpage;
Request
Request Entry Point
| Region | Entry Point |
|---|---|
| China Region | https://openapi.orionstar.com |
| Europe Region | https://global-openapi.orionstar.com |
| USA Region | https://us-openapi.orionstar.com |
| Japan Region | https://jp-openapi.orionstar.com |
Request Protocol
| HTTP URL Path | /v1/sso/corp_admin_page_sso |
|---|---|
| HTTP Method | GET |
Request URL Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| sso_acct_mobile | string | Yes | The mobile number of the target enterprise account for login-free login. SSO login is equivalent to logging into the OrionStar enterprise Robot MP directly using the account corresponding to this mobile number without entering the account password. |
| sso_acct_id | string | No | The account ID of the third-party system (your system). If this parameter is passed, OrionStar will record it as is. Cannot exceed 64 bytes. |
| sso_acct_name | string | No | The nickname or name of the account in the third-party system (your system). If this parameter is passed, after logging in to our enterprise backstage without login, the name of the current account will be displayed as the value of this parameter. Cannot exceed 16 characters. |
| sso_acct_avatar_url | string | No | The avatar URL of the account in the third-party system (your system). If this parameter is passed, after logging in to our enterprise backstage without login, the avatar of the current account will be displayed as the value of this parameter. Cannot exceed 256 bytes. |
| target_route | string | Yes | The route address of the enterprise backstage subpage. The route address of different subpages is different. Please contact OrionStar's pre-sales technical support to obtain the route address after confirming the subpage. |
| target_args | string | No | Additional parameters attached to the redirection URL, in the format of a JSON object string. Different subpages may require passing some business parameters. Please contact OrionStar's pre-sales technical support to obtain the parameters to be attached after confirming the subpage. For example, {“robot_sn”: “SN”} |
Request cURL Example
# Please replace the entry point with yours according to your region curl --location 'https://global-openapi.orionstar.com/v1/sso/corp_admin_page_sso?sso_acct_mobile=13512345678&target_route=test_route' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
Response
Common Response Body
| Parameter | Type | Description |
|---|---|---|
| code | int | Error code. 0 means success, non-zero means failure, Please refer to Error Codes. |
| msg | string | Error description. When there is a failure, a specific error description will be provided. |
| req_id | string | Log tracking ID. When encountering problems that require assistance from OrionStar, please provide this tracking ID value. |
| data | object | Business data object, see below for details Response Body Data Object. |
Response Body Data Object
| Parameter | Type | Description |
|---|---|---|
| redirect_url | string | SSO login redirection URL, valid for 60 seconds. |
| expires_in | string | Expiration time of the redirection URL, in seconds. For example, 14400 indicates that the expiration time of the redirection URL is 4 hours. Please note that it is an integer of type string. |
Response Body Example
{ "code": 0, "msg": "", "data": { "redirect_url" : "https://jiedai.orionstar.com/capi/v1/corp/admin_sso_auth?sso_token=test_token&target_type=main", "expires_in" : "14400" } }