automation-cloud
latest
false
Automation Cloud API 指南
- 入门指南
- 身份验证
- 作用域和权限
- 平台管理 API
组织级有效访问权限 API,用于检索主体的角色以及在 Automation Cloud 中的活动租户之间的分配情况。
检索组织中用户、组或外部应用程序的有效访问权限。响应将组织范围内的分配与每个活动租户中的租户级别的分配相结合。不包含文件夹级别的分配详细信息。
API 端点
POST {accessURL}/{organizationName}/pdp_/api/geteffectiveaccess
将{accessURL}替换为您的云平台的基本 URL:
| Cloud Platform | 访问 URL |
|---|---|
| Automation Cloud | https://cloud.uipath.com |
| Automation Cloud 公共部门 | https://govcloud.uipath.us |
| Automation Cloud 专用 | https://{customURL}.dedicated.uipath.com |
权限
对于使用用户访问令牌发出的请求,调用者必须是组织管理员。Tenant Administrator 会收到 403 Forbidden 响应。
请求标头
Authorization: Bearer {access_token}
Content-Type: application/json
Authorization: Bearer {access_token}
Content-Type: application/json
有关获取访问令牌的信息,请参阅身份验证方法。
查询参数
| 查询参数 | 数据类型 | 描述 |
|---|---|---|
top | 整数 | 要返回的角色分配组的最大数。默认值为 10,最大值为 50。该值不能为负数。 |
skip | 整数 | 要跳过的角色分配组数。默认值为 0,且值不能为负数。 |
请求正文
以下示例检索一个安全主体的组织级别有效访问权限:
{
"securityPrincipalId": "00000000-0000-0000-0000-000000000001",
"scopeIdentifier": {
"scopeType": "Organization"
}
}
{
"securityPrincipalId": "00000000-0000-0000-0000-000000000001",
"scopeIdentifier": {
"scopeType": "Organization"
}
}
| 属性 | 数据类型 | 描述 |
|---|---|---|
securityPrincipalId | 字符串 (GUID) | 返回其有效访问权限的用户、组或外部应用程序的标识符。 |
scopeIdentifier.scopeType | 字符串 | 对于组织级别的结果,必须为 Organization。该值不区分大小写。 |
scopeIdentifier.value.id | 字符串 (GUID) | 可选的组织标识符。如果包含,则它必须与调用者的组织匹配。 |
serviceName | 字符串 | 可选服务名称筛选器。仅返回指定服务的分配情况。 |
roleNameStartsWith | 字符串 | 可选的角色名称前缀筛选器。仅返回角色名称以指定值开头的分配。 |
响应
200 OK
返回请求的安全主体的有效访问权限信息。
| 响应属性 | 描述 |
|---|---|
roleAssignments | 已分页的分配组,按租户和角色设置键值。不带 tenantId 的组包含组织范围内的分配。组织范围内的组显示在租户范围内的组之前。 |
grantedServicesMetadata | 主体具有角色分配的未分页组织范围内服务列表。 |
grantedRolesMetadata | 向主体授予的未分页的组织范围内角色列表。 |
400 Bad Request
当分页值无效或 scopeIdentifier.value.id 与调用者的组织不匹配时返回。
401 未经授权
持有者令牌缺失或无效时返回。
403 Forbidden
当用户令牌调用者不是组织管理员时返回。
请求示例
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/pdp_/api/geteffectiveaccess?top=10&skip=0' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"securityPrincipalId": "00000000-0000-0000-0000-000000000001",
"scopeIdentifier": {
"scopeType": "Organization"
}
}'
curl --location --request POST 'https://cloud.uipath.com/{organizationName}/pdp_/api/geteffectiveaccess?top=10&skip=0' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"securityPrincipalId": "00000000-0000-0000-0000-000000000001",
"scopeIdentifier": {
"scopeType": "Organization"
}
}'