检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
系统接口 获取服务器时间 获取公钥 父主题: 用户类接口
对于用户名密码登录接口,返回如下消息体。 { "session_token" : "bts*********************************2VO", "expire" : 604800, "status" : "SUCCESS" } 当接口调用出错时,会
mestamp表示当前时间戳,nonce表示当前时间戳的16进制,加密方式为RSA公钥加密。当前时间戳可调用获取服务器时间接口获取,加密公钥可调用获取公钥接口获取。 X-tenant-id 否 String 租户id,ISV应用调用则为必填,需要将{domain_name}换成I
删除组织 功能介绍 删除指定组织。 接口约束 无 URI DELETE /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 要删除的组织id(如果存在子组织无法删除)。 请求参数
录绑定手机号相关接口完成绑定流程 USER_REGISTER:自动注册绑定流程,需要调用验证码和社交账号注册并绑定手机号相关接口完成注册绑定流程 ACCESS_DENIED:拒绝访问 MFA_AUTH:登录成功但需要进行二次认证,需要调用验证码和二次认证相关接口进行二次认证 session_token
码表示了请求响应的状态。 对于获取访问凭据接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 该部分可选。 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于Access Token接口,不返回响应消息头。 响应消息体(可选) 该
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态。 对于获取访问凭据接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 该部分可选。 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取访问凭据接口,不返回响应消息头。 响应消息体(可选) 该部分可
创建组织 功能介绍 创建组织。 接口约束 无 URI POST /api/v2/tenant/organizations 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
删除用户 功能介绍 删除用户。 接口约束 无 URI DELETE /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
用户类接口 如何调用API 系统接口 注册 验证码 登录登出 社交账号 密码管理 二次认证 个人信息管理 SSO id_token管理 父主题: API
功能介绍 获取应用的API访问凭据。Token的有效期默认为30分钟,可在管理门户-设置-服务配置-API认证配置中设置过期时间修改。建议进行缓存,避免频繁调用。使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。重新获取Token,不影响已有Token有效性。
查询组织详情 功能介绍 通过组织id查询组织详情。 接口约束 无 URI GET /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id。 请求参数 表2 请求Header参数
启用用户 功能介绍 启用用户。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/enable 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选
error_msg String 错误详情。 请求示例 根据用户登录成功后获取值为r5y******LU1的session_token再刷新session_token。 POST https://{domain_name}/api/v2/tenant/sso/session-token/refresh
修改组织 功能介绍 修改指定组织。 接口约束 无 URI PUT /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id。 请求参数 表2 请求Header参数 参数 是否必选
禁用用户 功能介绍 禁用用户。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选
应用集成接口 如何调用API 基于CAS的应用认证集成 基于SAML2.0的应用认证集成 基于OAuth2.0的应用认证集成 基于OIDC的应用认证集成 统一退出 父主题: API
管理类接口 如何调用API 访问凭据 用户管理 组织管理 应用机构管理 应用账号管理 应用侧角色管理 父主题: API
创建用户 功能介绍 创建用户。 接口约束 无 URI POST /api/v2/tenant/users 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
响应参数 无 请求示例 OneAccess全局退出登录并重定向到应用回调地址https://example.com。 GET https://{domain_name}/api/v1/logout?redirect_url= https://example.com 响应示例 无 状态码