Exportar asignaciones de roles de usuario

Referencia de API para exportar asignaciones de roles de usuario en Test Cloud privado, incluidos los puntos finales, los campos de solicitud y las respuestas.

Exporta un informe que contiene todos los roles y asignaciones de roles asociados a cualquier producto de UiPath®.

Colección Postman

Para utilizar la API de exportación de Check access, descarga e importa la colección Postman en tu aplicación Postman.

Nota:

Al utilizar la colección Postman, puedes encontrar errores cuando la respuesta es superior a 50 MB. Esta configuración en Postman se puede cambiar (tanto en la versión de escritorio como en la web) navegando a Configuración, luego seleccionando General y luego estableciendo el Tamaño máximo de respuesta en cero MB.

Punto final de API

GET https://{yourDomain}/<yourorgname>/pap_/api/userroleassignments/export

Ámbitos

Requiere todos los ámbitos a nivel de plataforma.

Solicitar encabezados.

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

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos en Métodos de autenticación.

Parámetros de consulta

Parámetro de consulta	Tipo de datos	Descripción
exportoutputtype (obligatorio)	String	Especifique uno de los dos formatos de archivo disponibles: .json o .csv
expandgroupmemberships (obligatorio)	String	true : habilita la expansión de la pertenencia a grupos de AAD en la respuesta. false o falta: los miembros de AAD que forman parte de grupos locales no son visibles en el informe.

Respuesta

200 OK

El informe de roles de usuario y asignaciones de roles se descarga en tu máquina, en el formato .json o .csv .

Solicitud de ejemplo

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

El siguiente cuerpo de respuesta representa una recuperación correcta del rol de usuario y la asignación de roles:

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

La siguiente tabla describe los campos de encabezado del archivo exportado:

Campo	Descripción
ID	El identificador único de la asignación de roles.
NombreDelRol	El nombre del rol como se muestra en la interfaz. Por ejemplo, Administrador de carpeta
IdDelRol	El identificador único del rol.
DescripciónDeRol	La descripción del rol, como se muestra en la interfaz. Por ejemplo, Administrador de carpeta
Tipo de rol	El tipo de rol, según lo definido por el usuario o el sistema: Personalizado : rol definido por un usuario. Integrado : rol presente en el portal de administración predeterminado.
TipoDeAsignaciónDeRoles	El tipo de asignación de roles cuando se creó, que puede ser una de las dos opciones siguientes: Personalizado : asignación realizada por el usuario. Integrado : asignación realizada de forma predeterminada en el portal de administración.
Ámbito	El ámbito es un nivel específico en la jerarquía organizativa que sirve como límite para determinadas acciones, permisos y objetos. Un ámbito puede ser una de las siguientes opciones jerárquicas, representadas como ID: Organización Tenant Servicio Carpeta
ÁmbitoConNombresParaMostrar	El ámbito es un nivel específico en la jerarquía organizativa que sirve como límite para determinadas acciones, permisos y objetos. Un ámbito puede ser una de las siguientes opciones jerárquicas: Organización Tenant Servicio Carpeta
ServiceName	El nombre del servicio UiPath al que pertenece el rol.
IDPrincipalDeSeguridad	El identificador único para la identidad de un usuario, grupo, etc.
TipoDePrincipalDeSeguridad	El tipo de identidad de un usuario, grupo o robot.
Correo electrónico principal de seguridad	El correo electrónico del usuario. Este campo está en blanco en caso de que la identidad no sea un usuario.
SecurityPrincipalDisplayName	El nombre de la identidad. Este campo está en blanco en el caso de los usuarios del directorio.
NombreDeGrupoHeredado	El nombre del grupo del que se hereda la asignación de roles.
HeredadoDeIdDeGrupo	Identificador de grupo del que se hereda la asignación de roles.
NombreDeTenant	El nombre del tenant donde se realiza la asignación. Este campo está en blanco en caso de asignaciones a nivel de organización.
NombreDeLaOrganización	El nombre de la organización donde se realiza la asignación.
IDDeOrganización	El identificador de la organización donde se realiza la asignación.
IDdeTenant	El identificador del tenant donde se realiza la asignación. Este campo está en blanco en caso de asignaciones a nivel de organización.
CreatedBy	El identificador único del usuario que crea la asignación.
CreadoPorNombreParaMostrar	El nombre del usuario que crea la asignación.
Creado en	La marca de tiempo cuando se asigna el rol.
NombreDeCarpeta	El nombre de la carpeta asociada a la asignación.
FolderKey	El identificador único de la carpeta asociada a la asignación.
ProjectId	El ID del proyecto (por ejemplo, Document Understanding o Extracción y Procesamiento Inteligentes (IXP)) asociado a la asignación.