导出用户角色分配

导出包含与任何 UiPath™ 产品关联的所有角色和角色分配的报告。

Postman 集合

要使用检查访问权限导出 API，请在 Postman 应用程序中下载并导入Postman 集合。

备注：

使用 Postman 集合时，当响应大于 50 MB 时，您可能会遇到错误。可以（在桌面版和网页版中）更改 Postman 上的此设置，方法是导航到“设置” ，然后选择“常规” ，然后将“最大响应大小”设置为零 MB。

API 端点

GET {accessURL}/<yourorgname>/pap_/api/userroleassignments/export

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	https://cloud.uipath.com/
Test Cloud 公共部门版	https://govcloud.uipath.us/
Test Cloud 专用版	https://{customURL}.dedicated.uipath.com/

作用域

• 需要平台级别用户作用域。
• 此端点需要用户访问令牌或受支持的 S2S 令牌。
• 不支持使用应用程序作用域的仅限应用程序令牌（客户端凭据流程），这些令牌将导致403 Forbidden响应。
• 配置外部应用程序时，请确保：
  • 请求的作用域是用户作用域，而不是应用程序作用域。
  • 令牌是通过用户身份验证流程（例如，授权代码流程）或已批准的 S2S 配置生成的。

请求标头

--header 'Authorization: Bearer {access_token}'\

备注：

访问令牌必须是：

• 用户访问令牌，或
• 支持的 S2S 令牌。此端点不支持使用具有应用程序作用域的客户端凭据流程生成的令牌。

查询参数

查询参数	数据类型	描述
exportoutputtype (必填)	字符串	指定两种可用的文件格式之一： .json或.csv
expandgroupmemberships (必填)	字符串	true - 允许在响应中扩展 AAD 组成员身份。 false或缺失 - 属于本地组的 AAD 成员在报告中不可见。

响应

200 OK

用户角色和角色分配报告将以.json或.csv格式下载到您的计算机。

请求示例

curl --location -- request GET 'https://cloud.uipath.com/acmeorg/pap_/api/userroleassignments/export?exportoutputtype=json' \
--header 'Authorization: Bearer {your token}

以下响应正文表示用户角色和角色分配检索已成功：

[
    {
        "Id": "34ecc3f3-a582-4cad-9889-120d7a3ffd62",
        "RoleUniqueName": "DOCUMENTUNDERSTANDING.DU VIEWER",
        "RoleDescription": "Can view all the entities but has not rights to edit or delete them.",
        "SecurityPrincipalId": "cdc34b5b-77d2-4ae1-9744-209d21ce557d",
        "RoleAssignmentType": "BuiltIn",
        "RoleType": "BUILTIN",
        "Scope": "/",
        "OrganizationId": "feb0dd79-85b6-483b-b297-0e49a1aa5b7d",
        "TenantId": null,
        "CreatedBy": "7f36fcc2-b822-430b-ae30-5ecfbacac186",
        "CreatedOn": "2023-03-30T08:30:04.9346766+00:00"
    },
...
]

下表描述了已导出文件中的标头字段：

字段	描述
ID	角色分配的唯一标识符。
角色名称	界面中显示的角色名称。 例如， Folder Administrator
角色 ID	角色的唯一标识符。
角色说明	界面中显示的角色说明。 例如， Folder Administrator 例如， Folder Administrator
角色类型	角色类型，由用户或系统定义： 自定义：由用户定义的角色。 内置: 由管理门户默认显示的角色。
角色分配类型	创建时的角色分配类型，可以是以下两个选项之一： 自定义：由用户进行的分配。 内置：默认情况下在管理门户中进行分配。
范围	作用域是组织层次结构中的特定级别，用作某些操作、权限和对象的边界。作用域可以是以下层次结构选项之一，以 ID 表示： 组织 租户 服务 文件夹
包含显示名称的作用域	作用域是组织层次结构中的特定级别，用作某些操作、权限和对象的边界。作用域可以是以下层次结构选项之一： 组织 租户 服务 文件夹
ServiceName	角色所属的 UiPath 服务的名称。
安全主体 ID	用于标识用户、组等身份的唯一标识符。
安全主体类型	用户、组或机器人的身份类型。
安全主体电子邮件	用户的电子邮件地址。如果身份不是用户，则此字段为空。
安全主体显示名称	身份的名称。如果是目录用户，则此字段为空。
继承自组名称	继承角色分配的组名称。
继承自组 ID	继承角色分配的组标识符。
租户名称	进行分配的租户的名称。如果是组织级别的分配，则此字段为空。
组织名称	进行分配的组织的名称。
组织 ID	进行分配的组织的标识符。
租户 ID	进行分配的租户的标识符。如果是组织级别的分配，则此字段为空。
CreatedBy	创建分配的用户的唯一标识符。
创建用户: 显示名称	创建分配的用户的名称。
创建日期	分配角色时的时间戳。
文件夹名称	与分配关联的文件夹的名称。
FolderKey	与分配关联的文件夹的唯一标识符。
ProjectId	与任务关联的项目（例如 Document Understanding 或 IXP）的 ID。