Obtenha acesso eficaz no nível da organização

Organization-level effective access API for retrieving a principal's roles and assignments across active tenants in Automation Cloud.

Recupera o acesso efetivo para um usuário, grupo ou aplicativo externo em uma organização. A resposta combina atribuições no escopo da organização com atribuições no nível do tenant de cada tenant ativo. Os detalhes de atribuição no nível da pasta não são incluídos.

Ponto de Extremidade da API

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

Substitua {accessURL} pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Automation Cloud	https://cloud.uipath.com
Automation Cloud Setor público	https://govcloud.uipath.us
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com

Permissões

Para solicitações feitas com um token de acesso de usuário, o chamador deve ser um Administrador da Organização. Os Tenant Administrators recebem uma resposta 403 Forbidden.

Cabeçalhos de solicitação.

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

Para obter informações sobre como obter um token de acesso, consulte Métodos de autenticação.

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description
top	Número inteiro	Número máximo de grupos de atribuição de funções a serem retornados. O padrão é 10, e o máximo é 50. O valor não pode ser negativo.
skip	Número inteiro	Número de grupos de atribuição de funções a serem ignorados. O padrão é 0, e o valor não pode ser negativo.

Corpo da Solicitação

O exemplo a seguir recupera o acesso efetivo no nível da organização para uma entidade de segurança:

{
  "securityPrincipalId": "00000000-0000-0000-0000-000000000001",
  "scopeIdentifier": {
    "scopeType": "Organization"
  }
}

Propriedade	Tipo de dados	Description
securityPrincipalId	String (GUID)	Identificador do usuário, grupo ou aplicativo externo cujo acesso efetivo é retornado.
scopeIdentifier.scopeType	String	Deve ser Organization para resultados no nível da organização. O valor não diferencia maiúsculas de minúsculas.
scopeIdentifier.value.id	String (GUID)	Identificador opcional da organização. Se estiver incluída, deve corresponder à organização do chamador.
serviceName	String	Filtro opcional do nome do serviço. Apenas as atribuições para o serviço especificado são retornadas.
roleNameStartsWith	String	Filtro opcional de prefixo de função-nome. Apenas as atribuições cujo nome de função começa com o valor especificado são retornadas.

Resposta

200 OK

Retorna as informações de acesso efetivas para o principal de segurança solicitado.

Propriedade Resposta	Description
roleAssignments	Grupos de atribuição paginados, codificados por tenant e função. Grupos sem um tenantId contêm atribuições com escopo da organização. Os grupos com escopo da organização aparecem antes de grupos com escopo de tenant.
grantedServicesMetadata	Lista de serviços não paginados em toda a organização para os quais o principal tem uma atribuição de função.
grantedRolesMetadata	Lista não paginada de funções de toda a organização concedidas ao principal.

400 Bad Request

Retornado quando os valores de paginação são inválidos ou quando scopeIdentifier.value.id não corresponde à organização do chamador.

401 não autorizado

Retornado quando o token de portador está ausente ou é inválido.

403 Forbidden

Retornado quando o chamador do token de usuário não é um Administrador da Organização.

Exemplo de solicitação

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"
  }
}'