华为云用户手册

  • 请求示例 支付宝登录。支付宝提供的授权码为ad12sasdsfe3dfdg3sc。 POST https://{domain_name}/api/v2/sdk/login/alipay X-operating-sys-version: Android 10 X-device-fingerprint: 156aysdna213sac X-device-ip: 10.10.10.1 X-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 X-L: zh X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "code": "ad12sasdsfe3dfdg3sc" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint 是 String 调用方设备指纹,例如:156aysdna213sc50。 X-device-ip 否 String 调用方IP,例如:10.10.10.1。 X-agent 是 String 用户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。 X-L 否 String 用于国际化语言设置,例如:zh。 X-client-id 是 String 应用标识,注册应用后分配的ClientId。 X-tenant-id 否 String 租户id,ISV应用调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id,并将X-client-id换成ISV应用模板的client_id。 表2 请求Body参数 参数 是否必选 参数类型 描述 code 是 String 授权码(app拉起支付宝应用的时候支付宝应用提供的授权码)。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 session_token String 用户新的session_token,可使用该token调用单点登录接口获取sso_ticket,通过sso_ticket可以获取用户信息。 id_token String 本质上是一个JWT Token,包含了用户身份信息,默认2小时有效,支持可配置。 expire Integer 过期时间,单位为秒。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误详情。
  • 请求示例 根据用户登录成功后获取值为r5y******LU1的session_token再刷新session_token。 POST https://{domain_name}/api/v2/tenant/sso/session-token/refresh Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140... X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "session_token": "r5y******LU1", "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" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 Authorization 是 String 认证凭据,值:Bearer {access_token},access_token通过“获取访问凭据”接口获取。 X-tenant-id 否 String 租户外部ID,如果为ISV方调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id。 表2 请求Body参数 参数 是否必选 参数类型 描述 session_token 是 String 用户登录后的session_token。 operating_sys_version 是 String 调用方操作系统版本,例如: Android 10。 device_ip 是 String 调用方设备ip,例如:10.10.10.1。 device_fingerprint 是 String 调用方设备指纹,同一个用户调用接口时该参数的值需保持统一,例如:156aysdna213sc50。 agent 否 String 调用方User-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。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Long 应用帐号总数。 accounts Array of AccountDetail objects 响应的用户列表。 表5 AccountDetail 参数 参数类型 描述 id String 应用帐号id。 account_name String 应用帐号名。 account_type String 应用帐号类型。 name String 姓名。 disabled Boolean 是否禁用。 org_id String 应用机构id。 roles Array of RolesInfo objects 角色信息。 extension Object 自定义扩展属性。 表6 RolesInfo 参数 参数类型 描述 role_id String 角色id。 role_code String 角色代码。 role_name String 角色名称。 privileges Array of PrivilegeInfo objects 权限集合。 表7 PrivilegeInfo 参数 参数类型 描述 privilege_id String 权限ID。 privilege_code String 权限代码。 privilege_name String 权限名称。 resource_items Array of ResourceItem objects 资源条目集合。 表8 ResourceItem 参数 参数类型 描述 item_id String 条目ID。 item_code String 条目代码。 item_name String 条目名称。 item_parentid String 父条目ID。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误编号。 error_msg String 错误详情。
  • 请求示例 根据应用id分页查询应用下的普通应用账号列表,返回查询结果的前100条数据,如不满100条,则返回实际数量的结果。 GET https://{domain_name}/api/v2/tenant/applications/{application_id}/accounts?account_type=BASIC_ACCOUNT&offset=0&limit=100 Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...
  • 响应示例 状态码: 200 请求成功。 { "total" : 1, "accounts" : [ { "id" : "20210621095850460-5A8A-03D94B540", "account_name" : "Test01", "account_type" : "BASIC_ACCOUNT", "name" : "Example01", "disabled" : false, "org_id" : "20210621095942194-560B-57E3CC...", "extension" : { } } ] }
  • URI GET /api/v2/tenant/applications/{application_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String 应用id。 表2 Query参数 参数 是否必选 参数类型 描述 account_type 否 String 帐号类型,固定值,普通应用帐号(BASIC_ACCOUNT),孤儿帐号(ORPHAN_ACCOUNT),公共帐号(PUBLIC_ACCOUNT),不填查询所有。 offset 是 Integer 第几页。 最小值:0 limit 是 Integer 每页多少条。 最小值:10 最大值:100
  • 请求示例 通过手机号找回密码。手机号为12345678901,验证码为123456,新密码为P******d。 POST https://{domain_name}/api/v2/sdk/pwd/update-by-mobile X-operating-sys-version: Android 10 X-device-fingerprint: 156aysdna213sac X-device-ip: 10.10.10.1 X-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 X-L: zh X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "mobile": "12345678901", "verify_code": "123456", "password": "P******d" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint 是 String 调用方设备指纹,例如:156aysdna213sc50。 X-device-ip 否 String 调用方IP,例如:10.10.10.1。 X-agent 是 String 用户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。 X-L 否 String 用于国际化语言设置,例如:zh。 X-client-id 是 String 应用标识,注册应用后分配的ClientId。 X-tenant-id 否 String 租户id,ISV应用调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id,并将X-client-id换成ISV应用模板的client_id。 表2 请求Body参数 参数 是否必选 参数类型 描述 mobile 是 String 接收验证码的手机号。 verify_code 是 String 接收到的验证码。 password 是 String 新密码。
  • 请求示例 社交账号注册并绑定手机号。手机号为12345678901,收到的验证码为123456。 POST https://{domain_name}/api/v2/sdk/social/register-bind X-operating-sys-version: Android 10 X-device-fingerprint: 156aysdna213sac X-device-ip: 10.10.10.1 X-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 X-L: zh X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm X-state-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "mobile": "12345678901", "verify_code": "123456" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 登录流程状态标识,返回SUC CES S表示登录成功。 session_token String 用户session_token,可使用该token调用单点登录接口获取sso_ticket,通过sso_ticket可以获取用户信息。 id_token String 本质上是一个JWT Token,包含了用户身份信息,默认2小时有效,支持可配置。 expire Integer session_token有效期,单位为秒,有效期内可以使用session_token获取ticket。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误详情。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint 是 String 调用方设备指纹,例如:156aysdna213sc50。 X-device-ip 否 String 调用方IP,例如:10.10.10.1。 X-agent 是 String 用户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。 X-L 否 String 用于国际化语言设置,例如:zh。 X-client-id 是 String 应用标识,注册应用后分配的ClientId。 X-state-token 是 String 临时令牌。当认证源配置为绑定时,用于社交帐号绑定手机号操作,需要传入对应的state_token,绑定成功返回用户session_token,绑定失败返回失败信息。 X-tenant-id 否 String 租户id,ISV应用调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id,并将X-client-id换成ISV应用模板的client_id。 表2 请求Body参数 参数 是否必选 参数类型 描述 mobile 是 String 接收验证码的手机号。 verify_code 是 String 接收到的验证码。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Long 用户总数。 users Array of UsersDetailsResult objects 用户列表。 表4 UsersDetailsResult 参数 参数类型 描述 user_id String 用户id。 org_id String 用户所属组织。 user_name String 用户名。 name String 姓名。 mobile String 手机号。 email String 邮箱。 pwd_must_modify Boolean 首次登录是否强制修改密码。 pwd_change_at String 密码修改时间 created_at String 创建时间。 updated_at String 最后一次修改时间。 disabled Boolean 是否禁用。 grade Integer 可信等级。 locked String 是否锁定。 extension Object 自定义扩展属性。 user_org_relation_list Array of UserOrgRelationListResult objects 用户组织关系集合。 表5 UserOrgRelationListResult 参数 参数类型 描述 org_id String 组织id。 relation_type String 关系类型。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编号。 error_msg String 错误详情。
  • 响应示例 状态码: 200 请求成功。 { "total" : 1, "users" : [ { "extension" : { }, "user_name" : "zhangsan", "mobile" : "12345678901", "created_at" : "2022-03-31 16:46:02.964", "pwd_must_modify" : false, "updated_at" : "2022-03-31 16:48:44.073", "user_id" : "20220331164602949-904C-D475B60AE", "org_id" : "20220331135144180-0FA5-EE3B69068", "grade" : 1, "name" : "zhangsan", "disabled" : false, "pwd_change_at" : "2022-03-31 16:47:51.481", "locked" : false, "user_org_relation_list" : [ { "org_id" : "20220331135144180-0FA5-EE3B69068", "relation_type" : 1 }, { "org_id" : "20220415103506608-AF59-5CC9081B9", "relation_type" : 0 } ] } ] }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 status String 登录流程状态标识。 枚举值: SUCCESS:登录成功 ACCESS_DENIED:拒绝访问 session_token String 用户session_token,可使用该token调用单点登录接口获取sso_ticket,通过sso_ticket可以获取用户信息。 id_token String 本质上是一个JWT Token,包含了用户身份信息,默认2小时有效,支持可配置。 expire Integer session_token有效期,单位为秒,有效期内可以使用session_token获取ticket。 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误详情。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint 是 String 调用方设备指纹,例如:156aysdna213sc50。 X-device-ip 否 String 调用方IP,例如:10.10.10.1。 X-agent 是 String 用户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。 X-L 否 String 用于国际化语言设置,例如:zh。 X-client-id 是 String 应用标识,注册应用后分配的ClientId。 X-state-token 是 String 临时令牌,调用密码登录相关接口,密码快过期时返回的state_token。 X-tenant-id 否 String 租户id,ISV应用调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id,并将X-client-id换成ISV应用模板的client_id。
  • 请求示例 跳过强制修改密码。 GET https://{domain_name}/api/v2/sdk/pwd/skip-update X-operating-sys-version: Android 10 X-device-fingerprint: 156aysdna213sac X-device-ip: 10.10.10.1 X-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 X-L: zh X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm X-state-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 登录流程状态标识。 枚举值: SUCCESS:登录成功 PASSWORD_WARN:密码快过期,需要调用密码过期强制修改密码接口设置密码 PASSWORD_EXPIRED:密码已过期,需要调用密码过期强制修改密码接口设置密码 ACCESS_DENIED:拒绝访问 MFA_AUTH:登录成功但需要进行二次认证,需要调用根据state_Token获取手机号接口、手机和短信验证码二次认证接口进行二次认证 session_token String 用户session_token,可使用该token调用单点登录接口获取sso_ticket,通过sso_ticket可以获取用户信息。 id_token String 本质上是一个JWT Token,包含了用户身份信息,默认2小时有效,支持可配置。 expire Integer session_token有效期,单位为秒,有效期内可以使用session_token获取sso_ticket。 state_token String 用户带有状态的令牌。 data String 返回说明。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误详情。
  • 请求示例 用户名密码登录。用户名为test01,用户密码为1******6。 POST https://{domain_name}/api/v2/sdk/login X-operating-sys-version: Android 10 X-device-fingerprint: 156aysdna213sac X-device-ip: 10.10.10.1 X-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 X-L: zh X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "user_name": "test01", "password": "1******6" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint 是 String 调用方设备指纹,例如:156aysdna213sc50。 X-device-ip 否 String 调用方IP,例如:10.10.10.1。 X-agent 是 String 用户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。 X-L 否 String 用于国际化语言设置,例如:zh。 X-client-id 是 String 应用标识,注册应用后分配的ClientId。 X-tenant-id 否 String 租户id,ISV应用调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id,并将X-client-id换成ISV应用模板的client_id。 表2 请求Body参数 参数 是否必选 参数类型 描述 user_name 是 String 用户名。 password 是 String 密码。
  • 响应示例 状态码: 200 请求成功。 { "id" : "5C00-C91355BC0", "account_name" : "example01", "name" : "示例1", "account_type" : "BASIC_ACCOUNT", "org_id" : "20201027162527852-B712-D040F4C71", "disabled" : false, "extension" : { "age" : "18" }, "roles" : [ { "role_id" : "20220210090626329-AFAE-EB2862B3A", "role_code" : "admin", "role_name" : "管理员", "privileges" : [ { "privilege_id" : "20220210135202250-92C8-D89EC88C6", "privilege_code" : "demo_privilege", "privilege_name" : "示例权限", "resource_items" : [ { "item_id" : "20201027161283642-R582-7230F4E84", "item_code" : "demo_item", "item_name" : "示例条目", "item_parentid" : null } ] } ] } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 应用帐号id。 account_name String 应用帐号名。 account_type String 应用帐号类型。 name String 姓名。 disabled Boolean 是否禁用。 org_id String 应用机构id。 roles Array of RolesInfo objects 角色信息。 extension Object 自定义扩展属性。 表4 RolesInfo 参数 参数类型 描述 role_id String 角色id。 role_code String 角色代码。 role_name String 角色名称。 privileges Array of PrivilegeInfo objects 权限集合。 表5 PrivilegeInfo 参数 参数类型 描述 privilege_id String 权限ID。 privilege_code String 权限代码。 privilege_name String 权限名称。 resource_items Array of ResourceItem objects 资源条目集合。 表6 ResourceItem 参数 参数类型 描述 item_id String 条目ID。 item_code String 条目代码。 item_name String 条目名称。 item_parentid String 父条目ID。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编号。 error_msg String 错误详情。
  • 请求示例 通登录成功后响应得到值为iJK******ITu的session_token获取sso_ticket。 POST https://{domain_name}/api/v2/tenant/sso/session-token/sso-ticket Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140... X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "session_token": "iJK******ITu", "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", "client_id": "9fIHl3Dc9ivToWLVtblrF6Sjv9Fx47JJ" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 expire Integer 过期时间,单位秒。 sso_ticket String 一次性票据,通过用户登录后的session_token获取一次性访问票据sso_ticket,通过sso_ticket可以获取用户信息。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误详情。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 Authorization 是 String 认证凭据,值:Bearer {access_token},access_token通过“获取访问凭据”接口获取。 X-tenant-id 否 String 租户外部ID,如果为ISV方调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id。 表2 请求Body参数 参数 是否必选 参数类型 描述 session_token 是 String 登录成功返回的会话token。 operating_sys_version 是 String 调用方操作系统版本,例如: Android 10。 device_ip 是 String 调用方设备ip,例如:10.10.10.1。 device_fingerprint 是 String 调用方设备指纹,同一个用户调用接口时该参数的值需和登录接口中的值保持统一,例如:156aysdna213sc50。 agent 否 String 调用方User-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。 client_id 否 String 应用授权ID,获取用户信息时如果想获取的是单点应用的用户信息,则需要传入单点应用的client_id。
  • 请求示例 手机短信验证码登录。接收验证码的手机号为12345678901,验证码为232326。 POST https://{domain_name}/api/v2/sdk/login/mobile-verify-code X-operating-sys-version: Android 10 X-device-fingerprint: 156aysdna213sac X-device-ip: 10.10.10.1 X-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 X-L: zh X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "mobile": "12345678901", "verify_code": "232326" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint 是 String 调用方设备指纹,例如:156aysdna213sc50。 X-device-ip 否 String 调用方IP,例如:10.10.10.1。 X-agent 是 String 用户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。 X-L 否 String 用于国际化语言设置,例如:zh。 X-client-id 是 String 应用标识,注册应用后分配的ClientId。 X-tenant-id 否 String 租户id,ISV应用调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id,并将X-client-id换成ISV应用模板的client_id。 表2 请求Body参数 参数 是否必选 参数类型 描述 mobile 是 String 接收验证码的手机号。 verify_code 是 String 接收到的验证码。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 登录流程状态标识。 枚举值: SUCCESS:登录成功 PASSWORD_WARN:密码快过期,需要调用密码过期强制修改密码接口设置密码 PASSWORD_EXPIRED:密码已过期,需要调用密码过期强制修改密码接口设置密码 ACCESS_DENIED:拒绝访问 MFA_AUTH:登录成功但需要进行二次认证,需要调用根据state_Token获取手机号接口、手机和短信验证码二次认证接口进行二次认证 session_token String 用户session_token,可使用该token调用单点登录接口获取sso_ticket,通过sso_ticket可以获取用户信息。 id_token String 本质上是一个JWT Token,包含了用户身份信息,默认2小时有效,支持可配置。 expire Integer session_token有效期,单位为秒,有效期内可以使用session_token获取sso_ticket。 state_token String 用户带有状态的令牌。 data String 返回说明。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误详情。
共100000条