检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业API使用 场景简介 OneAccess提供第三方API的授权管理功能,API提供者将API配置到OneAccess之后,API消费者在使用API之前需要先到OneAccess获取鉴权Token,在使用API时携带该鉴权Token,API提供者根据鉴权Token判断是否可以提供服务
授权内置API产品 管理员在OneAccess管理门户中,授权需要调用API产品的应用。 登录OneAccess管理门户。 在导航栏中,选择“资源 > 企业API”。 在企业API页面,选择“系统API产品 > 内置API”,进入“修改API产品”页面,切换“应用授权”页签,单击目标应用操作列的
获取国际区号 功能介绍 获取支持的国际区号。 URI GET /api/v2/sdk/country-codes 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android
错误码 状态码 错误码 错误信息 描述 处理措施 400 APP.0001 Application does not exist. 应用不存在 请检查对应应用是否存在 400 APP.0002 Application ID required. 应用ID不能为空 请检查入参中的应用ID
跳过强制修改密码 功能介绍 调用密码登录相关接口时,如果密码快过期,并且用户选择跳过修改密码时调用本接口,需要传入对应的state_token。 URI GET /api/v2/sdk/pwd/skip-update 请求参数 表1 请求Header参数 参数 是否必选 参数类型
签名验签说明 当OneAccess同步数据至企业应用时,需要企业应用对该同步事件进行识别并确认,确保事件来源的安全性和可靠性,从而保证数据在一个安全的环境中进行交互。 签名校验/加解密术语 表1 术语 术语 说明 signature 消息签名,用于验证请求是否来自OneAccess
社交账号登录绑定手机号 功能介绍 在管理门户配置的认证源选择未关联用户为绑定时,用于社交账号绑定手机号操作。 URI POST /api/v2/sdk/social/bind 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
社交账号解绑 功能介绍 社交账号解绑。 URI POST /api/v2/sdk/social/unbind-account 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json
获取用户已绑定的社交账号列表 功能介绍 获取用户已绑定的社交账号列表。 URI GET /api/v2/sdk/social 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,
session token签名 签名流程 构造待签名数据:"session_token="+sessionToken+"×tamp="+timestamp+"&nonce="+nonce。 其中,timestamp为当前服务器时间戳,可调用获取服务器时间戳接口获取,nonce
注销登录 功能介绍 注销登录会话。 接口约束 无 URI GET /api/v1/cas/logout 表1 Query参数 参数 是否必选 参数类型 描述 service 否 String 注销退出后的重定向地址,不设置则跳转登录页,若设置必须与应用CAS配置中的应用回调URL一致
查询应用机构列表 功能介绍 查询一个应用被授权访问的机构列表 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/organizations 表1 路径参数 参数 是否必选 参数类型 描述 application_id
通过session_token获取sso_ticket 功能介绍 获取用户信息时,先调用本接口获取sso_ticket。 URI POST /api/v2/tenant/sso/session-token/sso-ticket 请求参数 表1 请求Header参数 参数 是否必选
刷新session_token 功能介绍 刷新session_token。 URI POST /api/v2/tenant/sso/session-token/refresh 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
通过session_token生成id_token 功能介绍 通过session_token生成id_token,一般刷新id_token时使用。 URI POST /api/v2/sdk/session-token/refresh-id-token 请求参数 表1 请求Header
通过手机号找回密码 功能介绍 用户在登录页面单击忘记密码,并选择通过手机号找回密码时,需要输入手机号、验证码、新的密码并通过图形验证码校验后调用本接口。 URI POST /api/v2/sdk/pwd/update-by-mobile 请求参数 表1 请求Header参数 参数
退出登录 功能介绍 退出登录。 URI GET /api/v2/sdk/logout 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint
通过CAS协议单点登录至应用 概述 CAS是一个基于HTTP2、HTTP3的协议,要求每个组件都可以通过特定的URL访问。通过CAS协议将OneAccess作为身份服务提供商,使第三方应用可以读取OneAccess的用户账号数据。支持CAS1.0、CAS2.0、CAS3.0三种协议
删除应用账号 功能介绍 删除应用账号。 接口约束 无 URI DELETE /api/v2/tenant/applications/{application_id}/accounts/{account_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id
获取图形验证码 功能介绍 获取图形验证码。 URI GET /api/v2/sdk/captcha 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10