Obter configurações

Referência de ponto de extremidade de API para recuperar configurações de e-mail e autenticação como pares de chave-valor para uma organização do Test Cloud.

Use esse ponto de extremidade para recuperar a lista de pares de chave-valor para as configurações de e-mail e de autenticação.

Ponto de Extremidade da API

GET {accessURL}/{organizationName}/identity_/api/Setting

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/

Escopos

Requer os seguintes escopos:

• PM.Setting
• PM.Setting.Read

Cabeçalhos de solicitação.

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

Observação:

Para obter o <your-access-token>, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description
key (opcional)	String	Insira o nome da configuração que você deseja recuperar. Por exemplo, para recuperar a configuração do Domínio SMTP, insira key=Email.Smtp.Domain.
partitionGlobalId (opcional)	String	O ID do grupo a ser excluído.
userId (opcional)	String	O ID do grupo a ser excluído.

Resposta

200 OK

Retorna as contas de Robots consultadas.

Exemplo de solicitação

Digamos que você reuniu todas as informações necessárias para criar a chamada de API.

• Seu {baseURL} é: https://cloud.uipath.com/{organizationName}/identity_
• Seu <your-access-token> é: 1234 (para considerações de comprimento).
• O {partitionGlobalId} é: 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Você deseja recuperar as configurações de e-mail globais, para que você faça login como administrador host. Nesse caso, você não fornece um userID.

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/identity_/api/Setting?partitionGlobalId=3fa85f64-5717-4562-b3fc-2c963f66afa6&key=Email.Smtp.Domain&key=Email.Smtp.EnableSsl&key=Email.Smtp.FromDisplayName&key=Email.Smtp.FromEmail&key=Email.Smtp.Host&key=Email.Smtp.Password&key=Email.Smtp.Port&key=Email.Smtp.UseDefaultCredentials&key=Email.Smtp.UserName' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Aqui está o body da resposta de uma chamada bem-sucedida:

[
    {
        "id": 6,
        "key": "Email.Smtp.FromEmail",
        "value": "[e-mail]",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 7,
        "key": "Email.Smtp.FromDisplayName",
        "value": "Hogwarts server - 21.10 - Clean",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 15,
        "key": "Email.Smtp.Domain",
        "value": "",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 16,
        "key": "Email.Smtp.EnableSsl",
        "value": "true",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 17,
        "key": "Email.Smtp.Port",
        "value": "587",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 18,
        "key": "Email.Smtp.UseDefaultCredentials",
        "value": "false",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 19,
        "key": "Email.Smtp.UserName",
        "value": "[e-mail]",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 20,
        "key": "Email.Smtp.Host",
        "value": "smtp.gmail.com",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    },
    {
        "id": 21,
        "key": "Email.Smtp.Password",
        "value": "protego-spell",
        "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userId": null
    }
]