Export user role assignments

Exports a report of all roles and role assignments associated with any UiPath® product.

API Endpoint

GET https://cloud.uipath.com/<yourorgname>/pap_/api/userroleassignments/export

Scopes

Requires the following scopes:

• PM.User

• PM.User.Read

Request headers

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Note: To obtain the {access_token}, ensure you authenticate through one of the methods described in Authentication methods.

Query parameters

Query parameter	Data type	Description
exportoutputtype (required)	string	Specify one of the two available file formats: .json or .csv

Responses

200 OK

The report of user roles and role assignments downloads to your machine, in the .json or .csv format.

Example request

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

The following response body represents a successful user role and role assignment retrieval:

[
    {
        "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"
    },
...
]

The following table describes the header fields from the exported file:

Field	Description
Id	The unique identifier of the assigned role.
OriginalRoleName	The role name, as displayed in the interface.
RoleDescription	The role description, as displayed in the interface.
RoleAssignmentType	The role assignment type when it was created, which can be one of the following two options: - Custom, assignment made by the user. - Built in, assignment made by the system.
RoleType	The role type, as defined by the user or the system: - Custom (user defined role) - Built in (system defined role)
Scope	The scope is a specific level in the organizational hierarchy that serves as a boundary for certain actions, permissions, and objects. A scope can be one of the following hierarchical options: - Organization - Tenant - Service - Folder
SecurityPrincipalId	The unique identifier for the identity of a user, group, etc.
SecurityPrincipalType	The identity type of a user, group, or robot.
SecurityPrincipalEmail	The email of the user. This field is blank in case the identity is not a user.
SecurityPrincipalDisplayName	The name of the identity. This field is blank in case of directory users.
InheritedFromGroupName	The group name from which the role assignment is inherited.
InheritedFromGroupId	Group identifier from which the role assignment is inherited.
TenantName	The name of the tenant where the assignment is made. This field is blank in case of organization-level assignments.
OrganizationName	The name of the organization where the assignment is made.
OrganizationId	The identifier of the organization where the assignment is made.
TenantId	The identifier of the tenant where the assignment is made. This field is blank in case of organization-level assignments.
CreatedBy	The unique identifier of the user who creates the assignment.
CreatedOn	The timestamp when the role is assigned.