检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改内置API产品 在OneAccess管理门户可以修改内置API,其通用信息不支持修改。 登录OneAccess管理门户。 在导航栏中,选择“资源 > 企业API”。 在企业API页面,选择“系统API产品 > 内置API”,进入企业API详情页面。 切换到“应用授权”页签,修
单击应用图标,进入通用信息页面。 选择“API权限 > 内置API”,在API权限页面,单击某一权限代码右侧操作列的“授权”则授权成功。其中权限与接口对应关系如下表。 表1 权限与接口对应表 权限代码 权限描述 对应接口描述 对应接口URL 备注 user_all 用户管理接口的读写权限 创建用户 POST
用户门户网站支持认证源方式登录,具体操作可参见认证源登录。 当管理员开启了用户协议配置,具体操作请参考开启及配置用户协议,使用认证源首次登录用户门户时必须勾选配置的协议。 当管理员修改了用户协议,具体参照请参考编辑协议,再次使用认证源登录时必须勾选配置的协议。 父主题: 登录OneAccess用户门户并进入应用
配置自定义API产品 添加API产品后,需要添加企业的开放接口并进行授权。(自定义API可选择性添加内置API的权限代码,从而达到目标应用授权API权限的便利,同时自定义API也可添加外部API权限。)授权后,相应的应用才可以正常使用。 管理员登录OneAccess管理门户。 在导航栏中,选择“资源
添加自定义API产品 OneAccess管理员在OneAccess管理门户中添加企业需要的自定义API产品。 登录OneAccess管理门户。 在导航栏中,选择“资源 > 企业API”。 在企业API页面,单击自定义API产品下的“添加自定义API产品”。 在“添加企业API”页面,
删除自定义API产品 管理员登录OneAccess管理门户。 在导航栏中,选择“资源 > 企业API”。 在企业API页面,选择“自定义API产品”,单击目标API产品右上角的,单击“删除”,在提示框中单击“确定”删除自定义API产品成功。 请谨慎删除API产品。删除企业API后拥有
URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。 domain_name:使用OneAccess服务API需要使用用户访问域名,获取方法请参见获取用户访问域名。 resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取
构造请求 本节介绍API请求的组成,并以调用OneAccess管理类接口必须的“获取访问凭据”为例接口说明如何调用API,获取访问凭证后,可用于调用其他管理类API。 前提条件 调用API前,管理员在OneAccess管理门户中需参考授权API授权API,并且获取管理员在OneA
URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。 domain_name:使用OneAccess服务API需要使用用户访问域名,获取方法请参见获取用户访问域名。 resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“用户
单击“保存”。认证集成的方式不同,需配置的参数也不同,具体可参考: SAML协议的认证配置可参考认证集成。 OAuth2协议的认证配置可参考认证集成。 OIDC协议的认证配置可参考认证集成。 CAS协议的认证配置可参考认证集成。 插件代填方式的认证配置可参考认证集成。 映射配置
对于用户名密码登录接口,返回如下消息体。 { "session_token" : "bts*********************************2VO", "expire" : 604800, "status" : "SUCCESS" } 当接口调用出错时,会
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态。 对于获取访问凭据接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 该部分可选。 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取访问凭据接口,不返回响应消息头。 响应消息体(可选) 该部分可
${access_token}。 图8 统一退出接口配置 表5 统一退出接口配置参数 参数 说明 接口地址 OneAccess的域名拼接泛微e-cology的登录地址,例如:https://*****.huaweioneaccess.com/api/ams/logout?redirectToUrl=https://oa
s内置的API产品和权限,自定义API产品是由用户自定义的API产品和权限。对于系统API产品,只支持查看和授权。 在授权内置API产品、调用内置API产品、修改内置API产品、添加自定义API产品、配置自定义API产品、删除自定义API产品章节将为您详细介绍系统API的授权与调用操作。
应用集成接口 如何调用API 基于CAS的应用认证集成 基于SAML2.0的应用认证集成 基于OAuth2.0的应用认证集成 基于OIDC的应用认证集成 统一退出 父主题: API
用户类接口 如何调用API 系统接口 注册 验证码 登录登出 社交账号 密码管理 二次认证 个人信息管理 SSO id_token管理 父主题: API
码表示了请求响应的状态。 对于获取访问凭据接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 该部分可选。 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于Access Token接口,不返回响应消息头。 响应消息体(可选) 该
用。 添加应用后,需要配置相关参数,才可正常使用,详情请参考应用管理。 添加预集成应用 预集成应用指OneAccess根据应用的开发接口、相应协议已提前集成的应用。 登录OneAccess管理门户。 在导航栏中,单击“资源 > 应用”。 在企业应用页面,单击预集成应用下的“新增预集成应用”。
附录 session token签名 对OIDC协议中的id_token进行验证 错误码
录绑定手机号相关接口完成绑定流程 USER_REGISTER:自动注册绑定流程,需要调用验证码和社交账号注册并绑定手机号相关接口完成注册绑定流程 ACCESS_DENIED:拒绝访问 MFA_AUTH:登录成功但需要进行二次认证,需要调用验证码和二次认证相关接口进行二次认证 session_token