Cliente externo — Credenciais federadas

As credenciais federadas permitem que um aplicativo externo do OAuth se autentique na UiPath usando um JSON Web Token (JWT) emitido por um provedor de identidade externo, sem exigir um segredo do cliente. Cada aplicativo oferece suporte a um máximo de 20 credenciais federadas.

Use os pontos de extremidade nesta página para listar, criar, recuperar, atualizar e excluir credenciais federadas para um aplicativo externo do OAuth registrado. Para gerenciar os próprios aplicativos externos, consulte Gerenciamento de aplicativos externos do OAuth.

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Test Cloud	https://cloud.uipath.com/
Test Cloud para o Setor Público	https://govcloud.uipath.us/
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com/

---

Listar credenciais federadas

Recupera todas as credenciais federadas registradas para um aplicativo externo do OAuth específico.

Ponto de Extremidade da API

GET {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials

Parâmetros do caminho

Parâmetro	Description
partitionGlobalId	O ID global da organização.
clientId	O ID do aplicativo externo do OAuth.

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Read

Cabeçalhos de solicitação.

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

Observação:

Para obter o {access_token}, use um token de administrador da organização ou autentique-se por meio de um dos métodos descritos em Métodos de autenticação.

Resposta

200 OK

Retorna uma matriz de objetos FederatedCredentialDto . Retorna uma matriz vazia se nenhuma credencial estiver registrada.

Exemplo de solicitação

curl --request GET \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials' \
  --header 'Authorization: Bearer {access_token}'

Resposta de exemplo

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
    "name": "GitHub Actions",
    "description": "Used for GitHub Actions CI/CD pipeline",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main",
    "createdAt": "2026-03-01T10:00:00Z",
    "updatedAt": "2026-03-01T10:00:00Z"
  }
]

---

Criar uma credencial federada

Criar uma credencial de identidade federada para um aplicativo externo do OAuth específico.

Observação:

Cada aplicativo oferece suporte a um máximo de 20 credenciais federadas.

Ponto de Extremidade da API

POST {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials

Parâmetros do caminho

Parâmetro	Description
partitionGlobalId	O ID global da organização.
clientId	O ID do aplicativo externo do OAuth.

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write

Cabeçalhos de solicitação.

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

Corpo da Solicitação

{
  "name": "azure-production-workload",
  "description": "Federated credential for production Azure workload",
  "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0",
  "audience": "api://uipath-production",
  "subject": "00000000-0000-0000-0000-000000000000"
}

Campo	Required	Description
name	Sim	Um nome descritivo para a credencial. Deve ser único dentro do aplicativo. Máximo de 128 caracteres.
description	Não	Contexto opcional para a credencial. Máximo de 512 caracteres.
issuer	Sim	O URI HTTPS do provedor de identidade externo. Deve ser acessível no momento da criação.
audience	Sim	Uma única string que deve aparecer na declaração JWT aud .
subject	Sim	Um valor que deve corresponder exatamente à declaração JWT sub .

Resposta

201 criado

Retorna o objeto FederatedCredentialDto criado.

400 Bad Request

A solicitação é inválida. Possíveis causas: name não é exclusivo dentro do cliente, issuer não é um URI HTTPS válido, o ponto de extremidade JWKS do emissor está inacessível ou o máximo de 20 credenciais por aplicativo foi atingido.

404 Não encontrado

O clientId especificado não existe ou não pertence à organização do chamador.

Exemplo de solicitação

curl --request POST \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GitHub Actions",
    "description": "Used for GitHub Actions CI/CD pipeline",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main"
  }'

Resposta de exemplo

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions",
  "description": "Used for GitHub Actions CI/CD pipeline",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-01T10:00:00Z"
}

---

Obter uma credencial federada

Recupere uma credencial federada específica por seu ID.

Ponto de Extremidade da API

GET {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

Parâmetros do caminho

Parâmetro	Description
partitionGlobalId	O ID global da organização.
clientId	O ID do aplicativo externo do OAuth.
credentialId	O ID da credencial federada.

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Read

Cabeçalhos de solicitação.

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

Resposta

200 OK

Retorna o objeto FederatedCredentialDto para a credencial solicitada.

404 Não encontrado

O aplicativo ou credencial especificada não existe na organização do chamador.

Exemplo de solicitação

curl --request GET \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}'

Resposta de exemplo

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions",
  "description": "Used for GitHub Actions CI/CD pipeline",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-15T08:30:00Z"
}

---

Atualizar uma credencial federada

Atualize uma credencial federada existente. Todos os campos obrigatórios devem ser incluídos no corpo da solicitação.

Ponto de Extremidade da API

PUT {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

Parâmetros do caminho

Parâmetro	Description
partitionGlobalId	O ID global da organização.
clientId	O ID do aplicativo externo do OAuth.
credentialId	O ID da credencial federada a ser atualizada.

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write

Cabeçalhos de solicitação.

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

Corpo da Solicitação

{
  "name": "azure-production-workload-updated",
  "description": "Updated description",
  "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0",
  "audience": "api://uipath-production",
  "subject": "00000000-0000-0000-0000-000000000000"
}

Campo	Required	Description
name	Sim	Um nome descritivo para a credencial. Deve ser único dentro do aplicativo. Máximo de 128 caracteres.
description	Não	Contexto opcional para a credencial. Máximo de 512 caracteres.
issuer	Sim	O URI HTTPS do provedor de identidade externo. Deve ser acessível no momento da criação.
audience	Sim	Uma única string que deve aparecer na declaração JWT aud .
subject	Sim	Um valor que deve corresponder exatamente à declaração JWT sub .

Resposta

200 OK

Retorna o objeto FederatedCredentialDto atualizado.

400 Bad Request

Falha na validação. Possíveis causas: name duplicado, URI do emissor inválido ou endpoint JWKS inacessível.

Exemplo de solicitação

curl --request PUT \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GitHub Actions — Production",
    "description": "Production branch deployments only",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main"
  }'

Resposta de exemplo

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions — Production",
  "description": "Production branch deployments only",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-20T14:00:00Z"
}

---

Excluir uma credencial federada

Exclua uma credencial federada. Esta ação é permanente e invalida imediatamente qualquer aquisição de token usando esta credencial.

AVISO:

A exclusão é permanente. Após a exclusão, a credencial não pode mais ser usada para adquirir novos tokens de acesso. Os tokens de acesso já emitidos antes da exclusão permanecem válidos até expirarem.

Ponto de Extremidade da API

DELETE {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

Parâmetros do caminho

Parâmetro	Description
partitionGlobalId	O ID global da organização.
clientId	O ID do aplicativo externo do OAuth.
credentialId	O ID da credencial federada a ser excluída.

Escopos

Requer um dos seguintes escopos:

• PM.OAuthApp
• PM.OAuthApp.Write

Cabeçalhos de solicitação.

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

Resposta

204 Sem conteúdo

A credencial federada foi excluída com sucesso. O corpo da resposta está vazio.

404 Não encontrado

O aplicativo ou credencial especificada não existe na organização do chamador.

Exemplo de solicitação

curl --request DELETE \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}'

---

Adquirir um token usando uma credencial federada

Troca um JWT do seu provedor de identidade externo por um token de acesso da UiPath.

Ponto de Extremidade da API

POST {accessURL}/identity_/connect/token

Cabeçalhos de solicitação.

--header 'Content-Type: application/x-www-form-urlencoded'

Corpo da Solicitação

grant_type=client_credentials
&client_id={client_id}
&client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
&client_assertion={jwt_token}
&scope={requested_scopes}

Parâmetro	Description
grant_type	Deve ser client_credentials.
client_id	O ID do cliente do aplicativo externo do OAuth registrado.
client_assertion_type	Deve ser urn:ietf:params:oauth:client-assertion-type:jwt-bearer.
client_assertion	O JWT emitido por seu provedor de identidade externo.
scope	Os escopos do OAuth solicitados para o token de acesso.

Resposta

200 OK

Retorna um objeto de token de acesso. Use o valor access_token no cabeçalho Authorization: Bearer das chamadas de API subsequentes.

400 Bad Request

Falha na aquisição do token. Possíveis causas: assinatura JWT inválida, incompatibilidade de emissor ou público, incompatibilidade de assunto, JWT expirado ou JWT excede 8 KB.

---

Esquemas

FederatedCredentialDto

O objeto retornado por operações GET, POST e PUT.

Propriedade	Tipo	Nulo	Description
id	string (uuid)	Não	O identificador exclusivo da credencial federada.
clientId	String	Sim	O ID do aplicativo externo do OAuth ao qual esta credencial pertence.
name	String	Sim	O nome de exibição da credencial federada.
description	String	Sim	A descrição da credencial federada.
issuer	String	Sim	A URL do provedor de identidade externo.
audience	String	Sim	O valor da declaração aud esperada no JWT.
subject	String	Sim	O valor da declaração sub esperada no JWT.
createdAt	string (data-hora)	Não	O carimbo de data/hora UTC de quando a credencial foi criada.
updatedAt	string (data-hora)	Não	O carimbo de data/hora UTC de quando a credencial foi atualizada pela última vez.