检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
发送短信验证码 功能介绍 发送短信验证码。 URI POST /api/v2/sdk/sms/send 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
支付宝登录 功能介绍 支付宝登录。 URI POST /api/v3/sdk/login/alipay 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
社交账号登录绑定手机号 功能介绍 在管理门户配置的认证源选择未关联用户为绑定时,用于社交账号绑定手机号操作。 URI POST /api/v2/sdk/social/bind 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
社交账号注册并绑定手机号 功能介绍 在管理门户配置的认证源选择未关联用户为绑定时或注册时,用于社交账号注册并绑定手机号操作。 URI POST /api/v2/sdk/social/register-bind 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type
手机短信验证码登录 功能介绍 手机短信验证码登录。 URI POST /api/v2/sdk/login/mobile-verify-code 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“app
用户名密码登录 功能介绍 用户名密码登录,正常调用成功会返回用户的session_token,开启密码过期检查或二次认证会返回state_token,失败返回失败信息。 URI POST /api/v2/sdk/login 请求参数 表1 请求Header参数 参数 是否必选 参数类型
微信登录 功能介绍 微信登录。 URI POST /api/v2/sdk/login/wechat 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
手机号短信验证码二次认证 功能介绍 登录过程中如果需要二次认证,则调用本接口根据手机号、短信验证码认证。 URI POST /api/v2/sdk/mfa/sms 请求参数 表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参数
获取OIDC metadata 功能介绍 获取基于OpenID Connect的身份提供商IdP的Metadata文件。 接口约束 无 URI GET /api/v1/oauth2/.well-known/openid-configuration 请求参数 无 响应参数 无 请求示例
获取IdP元数据metadata 功能介绍 获取基于SAML2.0的身份提供商IdP的Metadata文件。(不支持postman接口请求下载) 接口约束 无 URI GET /api/v1/saml2/idp/metadata 请求参数 无 响应参数 无 请求示例 获取基于SAML2
IdP-initiated单点登录 功能介绍 发起基于IdP-initiated的单点登录。 接口约束 无 URI GET /api/v1/saml2/idp/sso 表1 Query参数 参数 是否必选 参数类型 描述 sp 是 String 应用Entity ID。 请求参数
注销登录 功能介绍 注销登录会话。 接口约束 无 URI GET /api/v1/cas/logout 表1 Query参数 参数 是否必选 参数类型 描述 service 否 String 注销退出后的重定向地址,不设置则跳转登录页,若设置必须与应用CAS配置中的应用回调URL一致。
公共返回码 事件回调接口采用HTTP状态码表示操作结果成功或者失败。企业应用的回调服务参考以下错误码及错误提示进行返回,OneAccess将返回的错误码和错误信息保存到应用同步记录中。 表1 公共返回码 返回码code 说明 200 success。 400 参数XX已存在,如参数userName已存在。
删除组织 功能介绍 删除指定组织。 接口约束 无 URI DELETE /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 要删除的组织id(如果存在子组织无法删除)。 请求参数
隐式授权 功能介绍 用户访问集成应用时,应用通过隐式授权方式获取Access Token和ID Token,向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用,并携带Access Token和ID Token参数。 URI
删除用户 功能介绍 删除用户。 接口约束 无 URI DELETE /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
全局退出 功能介绍 注销会话退出登录,当用户退出第三方应用系统时,除退出应用系统本身的会话外,同时将销毁OneAccess生成的SSO票据,OneAccess销毁SSO票据后,浏览器将重定向到应用端指定的回调地址URL。 接口约束 无 URI GET /api/v1/logout
删除应用机构 功能介绍 删除应用机构。 接口约束 无 URI DELETE /api/v2/tenant/applications/{application_id}/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id
删除应用账号 功能介绍 删除应用账号。 接口约束 无 URI DELETE /api/v2/tenant/applications/{application_id}/accounts/{account_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id