SSO 免登录到企业后台首页
概述
- 此 API 用于获取 SSO 免登录到猎户星空企业后台(接待后台)首页的 URL;
授权方式
数据维度授权 | 企业级授权 | 此 API 为企业级授权,企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。 |
---|
接口维度授权 | 默认授权 | 此 API 为默认授权,您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。 |
---|
请求
请求域名
请求协议
HTTP URL 路径 | /v1/sso/corp_admin_sso |
---|---|
HTTP Method | GET |
请求 URL 参数
参数 | 类型 | 必填 | 参数说明 |
---|---|---|---|
sso_acct_mobile | string | 是 | 免登录的目标企业账号的手机号,SSO 免登录相当于不用输入账号密码,直接使用此手机号对应的账号登录猎户星空企业后台(接待后台)。 |
sso_acct_id | string | 否 | 第三方系统(您的系统)的账号 id,如果传递了此参数猎户星空会原样记录。不能超过 64 字节。 |
sso_acct_name | string | 否 | 第三方系统(您的系统)的账号昵称或者姓名。如果传递了此参数,免登录到猎户星空企业后台(接待后台)之后,当前账号的姓名会显示成此参数的值。不能超过 16 个字。 |
sso_acct_avatar_url | string | 否 | 第三方系统(您的系统)的账号头像 URL。如果传递了此参数,免登录到猎户星空企业后台(接待后台)之后,当前账号的头像会显示成此参数的值。不能超过 256 字节。 |
请求 cURL 示例
# 请根据您的区域替换域名 curl --location 'https://openapi.orionstar.com/v1/sso/corp_admin_sso?sso_acct_mobile=13512345678' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
响应
公共响应体
参数 | 类型 | 参数说明 |
---|---|---|
code | int | 错误代码。0 是成功,非 0 是失败,请参考 错误代码。 |
msg | string | 错误描述,当失败的时候会给出具体的错误描述。 |
req_id | string | 日志跟踪 id,当遇到问题需要猎户星空协助查问题时候,请提供此跟踪 id 值。 |
data | object | 业务数据 data 对象,详见下述 响应体 data 对象。 |
响应体 data 对象
参数 | 类型 | 参数说明 |
---|---|---|
redirect_url | string | SSO 免登录跳转 URL |
expires_in | string | 跳转 url 有效期,单位是秒。例如 60 表示跳转 URL 的有效期是 1 分钟,请注意是字符串类型的整数。 |
响应体示例
{ "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" : "60" } }