UiPath Documentation
test-cloud
latest
false
Guia da API do Test Cloud
Importante :
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

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

Use a API de acesso efetivo no nível da organização para recuperar as funções e atribuições de um principal em tenants ativos no Test Cloud.

Recupera acesso efetivo para um usuário, grupo ou aplicativo externo em toda uma organização. A resposta combina atribuições com escopo da organização com atribuições no nível do tenant a partir de cada tenant ativo. Os detalhes da atribuição no nível da pasta não estã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 PlatformURL de acesso
Test Cloudhttps://cloud.uipath.com
Test Cloud para o Setor Públicohttps://govcloud.uipath.us
Test Cloud Dedicadohttps://{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 Administradores de tenant recebem uma resposta 403 Forbidden.

Cabeçalhos de solicitação.​

Authorization: Bearer <your-access-token>
Content-Type: application/json
Authorization: Bearer <your-access-token>
Content-Type: application/json

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

Parâmetros de Consulta​

Parâmetro de consultaTipo de dadosDescription
topNúmero inteiroNúmero máximo de grupos de atribuição de função para retornar. O padrão é 10, e o máximo é 50. O valor não pode ser negativo.
skipNúmero inteiroNúmero de grupos de atribuição de função para pular. O padrão é 0, e o valor não pode ser negativo.

Corpo da Solicitação​

O exemplo a seguir mostra como você pode recuperar o acesso efetivo no nível da organização para uma entidade de segurança:

{
  "securityPrincipalId": "00000000-0000-0000-0000-000000000001",
  "scopeIdentifier": {
    "scopeType": "Organization"
  }
}
{
  "securityPrincipalId": "00000000-0000-0000-0000-000000000001",
  "scopeIdentifier": {
    "scopeType": "Organization"
  }
}
PropriedadeTipo de dadosDescription
securityPrincipalIdString (GUID)Identificador do usuário, grupo ou aplicativo externo cujo acesso efetivo é retornado.
scopeIdentifier.scopeTypeStringDeve ser Organization para resultados no nível da organização. O valor não diferencia maiúsculas de minúsculas.
scopeIdentifier.value.idString (GUID)Identificador opcional da organização. Se incluído, ele deve corresponder à organização do chamador.
serviceNameStringFiltro opcional por nome de serviço. O sistema retorna apenas atribuições para o serviço especificado.
roleNameStartsWithStringFiltro de prefixo de nome da função opcional. O sistema retorna apenas atribuições cujo nome da função começa com o valor especificado.

Resposta​

200 OK​

Retorna as informações de acesso efetivas para a entidade de segurança solicitada.

Propriedade da respostaDescription
roleAssignmentsGrupos de atribuição paginados, indexados por tenant e função. Grupos sem um tenantId contêm atribuições com escopo da organização. Grupos com escopo da organização aparecem antes dos grupos com escopo do tenant.
grantedServicesMetadataLista não paginada de serviços para toda a organização para os quais a entidade tem uma atribuição de função.
grantedRolesMetadataLista não paginada de funções para toda a organização concedidas à entidade.

400 Bad Request​

Retorna 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​

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

403 Forbidden​

Retorna quando um chamador com 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 <your-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 <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "securityPrincipalId": "00000000-0000-0000-0000-000000000001",
  "scopeIdentifier": {
    "scopeType": "Organization"
  }
}'

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades