检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取公钥 功能介绍 获取公钥,用于调用服务端接口时,对敏感信息进行加密操作(每个应用拥有不同的公钥,有且只有一个)。 URI GET /api/v2/sdk/public-key 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version
找回密码 若用户忘记密码,可通过用户门户登录页面的“忘记密码”功能找回密码。 前提条件 管理员已在界面配置中配置了“开启找回密码”功能,操作请参见设置全局参数。 操作步骤 用户进入用户门户登录页面。 请联系企业管理员获取用户访问域名,如https://example.huaweioneaccess
获取ID Token 功能介绍 获取ID Token。 URI POST /api/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 grant_type 是 String 授权类型,固定值:authorization_code。
获取国际区号 功能介绍 获取支持的国际区号。 URI GET /api/v2/sdk/country-codes 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android
状态码 状态码 描述 302 用户未登录,跳转用户登录页面。用户已登录,携带授权码重定向到redirect_uri地址。例:https://example.com?code=z2D...&state=test。 错误码 请参见错误码。 父主题: 基于OIDC的应用认证集成
状态码 状态码 描述 302 用户未登录,跳转用户登录页面;用户已登录,携带授权码重定向到redirect_uri地址。例:https://example.com?code=z2D...&state=test。 错误码 请参见错误码。 父主题: 基于OAuth2.0的应用认证集成
获取访问凭据 功能介绍 获取应用的API访问凭据。Token的有效期默认为30分钟,可在管理门户-设置-服务配置-API认证配置中设置过期时间修改。建议进行缓存,避免频繁调用。使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失
获取AccessToken 功能介绍 获取Access Token,Access Token可用于调用获取用户信息API。 接口约束 无 URI POST /api/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 code 是
获取服务器时间 功能介绍 获取服务器时间。 URI GET /api/v2/sdk/server-date 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android
获取OIDC metadata 功能介绍 获取基于OpenID Connect的身份提供商IdP的Metadata文件。 接口约束 无 URI GET /api/v1/oauth2/.well-known/openid-configuration 请求参数 无 响应参数 无 请求示例
管理员已在界面配置中配置了“开启注册”功能,操作请参见设置全局参数。 操作步骤 进入用户门户登录页面。 请联系企业管理员获取用户访问域名,如https://example.huaweioneaccess.com。 用户在登录页面单击“立即注册”。 在注册页面,输入手机号。 单击“发送验证码”,将收到的验证码输入在验证码输入框。
获取用户信息 功能介绍 获取用户信息。 接口约束 无 URI GET /api/v1/oauth2/userinfo 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 认证凭据,值:Bearer {access_token}。
管理员已完成短信网关配置,具体操作请参见短信网关配置。 操作步骤 用户进入用户门户登录页面。 请联系企业管理员获取用户访问域名,如https://example.huaweioneaccess.com。 用户在登录页面选择“短信”页签,输入手机号。 单击“发送验证码”,输入框中输入收到的验证
管理员已在用户门户应用登录配置中开启密码认证,具体操作请参见登录配置。 操作步骤 用户进入用户门户登录页面。 请联系企业管理员获取用户访问域名,如https://example.huaweioneaccess.com。 用户在登录页面选择“密码”登录。 默认为“用户名/邮箱”登录,输入用户名/邮箱和密码。 选择“手机号登录”,输入手机号和密码。
获取IdP元数据metadata 功能介绍 获取基于SAML2.0的身份提供商IdP的Metadata文件。(不支持postman接口请求下载) 接口约束 无 URI GET /api/v1/saml2/idp/metadata 请求参数 无 响应参数 无 请求示例 获取基于SAML2
获取图形验证码 功能介绍 获取图形验证码。 URI GET /api/v2/sdk/captcha 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。
通过session_token获取sso_ticket 功能介绍 获取用户信息时,先调用本接口获取sso_ticket。 URI POST /api/v2/tenant/sso/session-token/sso-ticket 请求参数 表1 请求Header参数 参数 是否必选
{access_token},access_token通过“获取访问凭据”接口获取。 X-tenant-id 否 String 租户外部ID,如果为ISV方调用则为必填,需要将{domain_name}换成ISV通用域名{common_domain},请求Header参数中需要指定对应租户的tenant_id。
通过state_Token获取手机号 功能介绍 用于手机号短信二次认证时,通过state_token获取手机号。 URI GET /api/v2/sdk/mobile-by-token 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version
用户已在用户门户网站激活了动态口令,具体操作请参见账号安全设置。 操作步骤 用户进入用户门户登录页面。 请联系企业管理员获取用户访问域名,如https://example.huaweioneaccess.com。 用户在登录页面选择“动态口令”登录。 默认为“用户名/邮箱”登录,输入用户名/邮箱和收到的动态口令。