检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
码表示了请求响应的状态。 对于获取访问凭据接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 该部分可选。 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于Access Token接口,不返回响应消息头。 响应消息体(可选) 该
通过session_token获取sso_ticket 功能介绍 获取用户信息时,先调用本接口获取sso_ticket。 URI POST /api/v2/tenant/sso/session-token/sso-ticket 请求参数 表1 请求Header参数 参数 是否必选
跳过强制修改密码 功能介绍 调用密码登录相关接口时,如果密码快过期,并且用户选择跳过修改密码时调用本接口,需要传入对应的state_token。 URI GET /api/v2/sdk/pwd/skip-update 请求参数 表1 请求Header参数 参数 是否必选 参数类型
修改密码接口设置密码 PASSWORD_EXPIRED:密码已过期,需要调用密码过期强制修改密码接口设置密码 ACCESS_DENIED:拒绝访问 MFA_AUTH:登录成功但需要进行二次认证,需要调用根据state_Token获取手机号接口、手机和短信验证码二次认证接口进行二次认证
功能介绍 获取应用的API访问凭据。Token的有效期默认为30分钟,可在管理门户-设置-服务配置-API认证配置中设置过期时间修改。建议进行缓存,避免频繁调用。使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。重新获取Token,不影响已有Token有效性。
通过sso_ticket获取用户信息 功能介绍 通过sso_ticket获取用户信息。 URI POST /api/v2/tenant/sso/sso-ticket/verify 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
修改组织 功能介绍 修改指定组织。 接口约束 无 URI PUT /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id。 请求参数 表2 请求Header参数 参数 是否必选
获取图形验证码 功能介绍 获取图形验证码。 URI GET /api/v2/sdk/captcha 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。
获取ID Token 功能介绍 获取ID Token。 URI POST /api/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 grant_type 是 String 授权类型,固定值:authorization_code。
授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用,并携带授权码code参数。 URI GET /api/v1/oauth2/authorize 表1 Query参数 参数 是否必选 参数类型 描述 client_id 是 String 应用
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态。 对于获取访问凭据接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 该部分可选。 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取访问凭据接口,不返回响应消息头。 响应消息体(可选) 该部分可
修改个人信息 功能介绍 用户登录成功后修改个人信息时调用本接口,本接口不支持修改个人密码、手机号、邮箱。 URI POST /api/v2/sdk/profile/update 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
创建组织 功能介绍 创建组织。 接口约束 无 URI POST /api/v2/tenant/organizations 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
查询用户所有授权的应用账号 功能介绍 查询用户所有授权的应用账号。 接口约束 无 URI GET /api/v2/tenant/users/{user_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数
应用集成接口 如何调用API 基于CAS的应用认证集成 基于SAML2.0的应用认证集成 基于OAuth2.0的应用认证集成 基于OIDC的应用认证集成 统一退出 父主题: API
用户使用应用认证登录接口POST/api/v1/login/form 传递参数:username、password;用户输入用户密码认证成功后,在调用下面的接口,OneAccess将重定向回应用,携带ticket参数传递Service Ticket票据。 接口约束 无 URI GET
查询应用侧角色列表 功能介绍 查询应用侧角色列表。 URI GET /api/v2/tenant/applications/{application_id}/role-list 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String 应用id。
查询用户列表 功能介绍 查询用户列表。 接口约束 无 URI GET /api/v2/tenant/users 表1 Query参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id,为空时查询所有用户。 offset 是 Integer 第几页。 最小值:0
新增应用机构 功能介绍 新增应用机构。 接口约束 无 URI POST /api/v2/tenant/applications/{application_id}/organizations 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String
查询应用账号列表 功能介绍 查询一个应用被授权访问的账号列表。 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是