检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
找回密码 若用户忘记密码,可通过用户门户登录页面的“忘记密码”功能找回密码。 前提条件 管理员已在界面配置中配置了“开启找回密码”功能,操作请参见设置全局参数。 操作步骤 用户进入用户门户登录页面。 请联系企业管理员获取用户访问域名,如https://example.huaweioneaccess
通过LDAP协议同步数据 LDAP(Lightweight Directory Access Protocol)即轻量目录访问协议。它是一种树状结构的组织数据,可以简单理解成一个存储用户和组织信息的树形结构数据库。单点登录是LDAP的主要使用场景之一,即用户只在公司计算机上登录一次后,便可以自动在公司内部网上登录。
界面配置 OneAccess提供了界面定制功能,管理员可以根据需要自定义用户门户的登录界面、注册界面和找回密码界面。管理员可以选择OneAccess提供的内置模板,也可以自定义模板。在自定义模板中,您可以修改顶部区域、表单区域和底部区域的透明度、主题色、内容颜色等,也可以修改底图,以及认证窗体的左中右布局位置等参数。
获取公钥 功能介绍 获取公钥,用于调用服务端接口时,对敏感信息进行加密操作(每个应用拥有不同的公钥,有且只有一个)。 URI GET /api/v2/sdk/public-key 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version
退出登录 功能介绍 退出登录。 URI GET /api/v2/sdk/logout 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint
创建组织 功能介绍 创建组织。 接口约束 无 URI POST /api/v2/tenant/organizations 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
构造请求 本节介绍API请求的组成,并以调用OneAccess登录登出接口中的“用户名密码登录”为例说明如何调用API,用户名密码登录,正常调用成功会返回用户的session_token,可用来获取用户信息等。 前提条件 调用API前,需要获取管理员在OneAccess管理门户中
管理用户 在OneAccess管理门户,您可以进行添加、编辑、修改、删除用户等操作。 如果需要添加大量用户,建议采用身份源同步、数据导入的方式批量添加。 身份源同步:从身份源同步用户数据到OneAccess,在高级配置中可以对同步的处理逻辑进行灵活配置,实现将上游身份源数据同步至
删除用户 功能介绍 删除用户。 接口约束 无 URI DELETE /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
微信登录 功能介绍 微信登录。 URI POST /api/v2/sdk/login/wechat 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
刷新session_token 功能介绍 刷新session_token。 URI POST /api/v2/tenant/sso/session-token/refresh 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态。 对于获取访问凭据接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 该部分可选。 对应请求消息头,响应同
禁用用户 功能介绍 禁用用户。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选
获取国际区号 功能介绍 获取支持的国际区号。 URI GET /api/v2/sdk/country-codes 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android
获取访问凭据 功能介绍 获取应用的API访问凭据。Token的有效期默认为30分钟,可在管理门户-设置-服务配置-API认证配置中设置过期时间修改。建议进行缓存,避免频繁调用。使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态。 对于获取访问凭据接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 该部分可选。 对应请求消息头,响应同
管理区域 您可以添加区域规则,方便您在访问控制中进行配置。 添加区域 登录OneAccess管理门户。 在导航栏中,选择“认证 > 区域范围”。 在区域范围页面,单击“添加区域”。 在添加区域页面,填写区域信息。 表1 区域信息 参数 说明 * 区域名称 企业部门的分布区域命名,如开发区域。支持自定义。
创建用户 功能介绍 创建用户。 接口约束 无 URI POST /api/v2/tenant/users 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
删除组织 功能介绍 删除指定组织。 接口约束 无 URI DELETE /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 要删除的组织id(如果存在子组织无法删除)。 请求参数
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态。 对于用户名密码登录接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 对应请求消息头,响应同样也有消息头,如“Content-type”。