UiPath Documentation
automation-cloud
latest
false
Automation Cloud API 指南
重要 :
请注意,此内容已使用机器翻译进行了部分本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

获取组织级别的有效访问权限

组织级有效访问权限 API,用于检索主体的角色以及在 Automation Cloud 中的活动租户之间的分配情况。

检索组织中用户、组或外部应用程序的有效访问权限。响应将组织范围内的分配与每个活动租户中的租户级别的分配相结合。不包含文件夹级别的分配详细信息。

API 端点

POST {accessURL}/{organizationName}/pdp_/api/geteffectiveaccess

{accessURL}替换为您的云平台的基本 URL:

Cloud Platform访问 URL
Automation Cloudhttps://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"
  }
}'
  • API 端点
  • 权限
  • 请求标头
  • 查询参数
  • 请求正文
  • 响应
  • 200 OK
  • 400 Bad Request
  • 401 未经授权
  • 403 Forbidden
  • 请求示例

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新