检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业API使用 场景简介 OneAccess提供第三方API的授权管理功能,API提供者将API配置到OneAccess之后,API消费者在使用API之前需要先到OneAccess获取鉴权Token,在使用API时携带该鉴权Token,API提供者根据鉴权Token判断是否可以提供服务,用以实现API的授权管理功能。
删除应用侧角色 功能介绍 删除应用侧角色。 URI DELETE /api/v2/tenant/applications/{application_id}/role/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 role_id 是 String 角色id。 application_id
启用应用账号 功能介绍 启用应用账号。 接口约束 无 URI PUT /api/v2/tenant/applications/{application_id}/accounts/{account_id}/enable 表1 路径参数 参数 是否必选 参数类型 描述 application_id
删除组织 功能介绍 删除指定组织。 接口约束 无 URI DELETE /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 要删除的组织id(如果存在子组织无法删除)。 请求参数
删除应用机构 功能介绍 删除应用机构。 接口约束 无 URI DELETE /api/v2/tenant/applications/{application_id}/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id
新增应用侧角色 功能介绍 新增应用侧角色。 接口约束 无 URI POST /api/v2/tenant/applications/{application_id}/role 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String 应用id。
修改应用机构 功能介绍 修改应用机构。 接口约束 无 URI PUT /api/v2/tenant/applications/{application_id}/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id
查询应用账号列表 功能介绍 查询一个应用被授权访问的账号列表。 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是
查询组织详情 功能介绍 通过组织id查询组织详情。 接口约束 无 URI GET /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id。 请求参数 表2 请求Header参数
获取ID Token 功能介绍 获取ID Token。 URI POST /api/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 grant_type 是 String 授权类型,固定值:authorization_code。
查询应用侧角色详情 功能介绍 查询应用侧角色详情。 URI GET /api/v2/tenant/applications/{application_id}/role/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String
获取AccessToken 功能介绍 获取Access Token,Access Token可用于调用获取用户信息API。 接口约束 无 URI POST /api/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 code 是
刷新Access Token 功能介绍 刷新AccessToken。 URI POST /api/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 client_id 是 String 应用标识,注册应用后,分配的ClientId。
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态。 对于用户名密码登录接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头(可选) 对应请求消息头,响应同样也有消息头,如“Content-type”。
更新应用账号 功能介绍 更新应用账号。 接口约束 无 URI PUT /api/v2/tenant/applications/{application_id}/accounts/{account_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id
修改组织 功能介绍 修改指定组织。 接口约束 无 URI PUT /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id。 请求参数 表2 请求Header参数 参数 是否必选
注销登录 功能介绍 注销登录会话。 接口约束 无 URI GET /api/v1/cas/logout 表1 Query参数 参数 是否必选 参数类型 描述 service 否 String 注销退出后的重定向地址,不设置则跳转登录页,若设置必须与应用CAS配置中的应用回调URL一致。
查询应用机构列表 功能介绍 查询一个应用被授权访问的机构列表 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/organizations 表1 路径参数 参数 是否必选 参数类型 描述 application_id
标准协议认证源 SAML认证登录 OIDC认证登录 CAS认证登录 OAuth认证登录 Kerberos认证登录 AD认证登录 LDAP认证登录 父主题: 集成认证源
认证登录获取授权码 功能介绍 用户访问集成应用时,应用向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用回调地址,并携带授权码code参数。 接口约束 无 URI GET /api/v1/oauth2/authorize