automation-suite
2022.4
false
- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
- [Visualizar] Obter configurações
- [Visualizar] Atualizar configurações
[Visualizar] Obter configurações
Importante :
A tradução automática foi aplicada parcialmente neste conteúdo.
Guia da API do Automation Suite
Last updated 17 de jun de 2024
[Visualizar] Obter configurações
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.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Observação: para obter o
{access_token}
, certifique-se de se autenticar por meio de um dos métodos descritos aqui.
Parâmetro de consulta |
Tipo de dados |
Description |
---|---|---|
(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 .
|
(opcional) |
String |
O ID do grupo a ser excluído. |
(opcional) |
String |
O ID do grupo a ser excluído. |
Digamos que você reuniu todas as informações necessárias para criar a chamada de API.
- Seu
{baseURL}
é:https://{yourDomain}/{organizationName}/{tenantName}/
-
Seu
{access_token}
é:1234
(para considerações de comprimento). - O
{partitionGlobalId}
é:magic-7
- 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 ter a seguinte aparência (cURL):
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting?partitionGlobalId=magic-7&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'
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting?partitionGlobalId=magic-7&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": "newalerts.uipath@gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 7,
"key": "Email.Smtp.FromDisplayName",
"value": "Hogwarts server - 21.10 - Clean",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 15,
"key": "Email.Smtp.Domain",
"value": "",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 16,
"key": "Email.Smtp.EnableSsl",
"value": "true",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 17,
"key": "Email.Smtp.Port",
"value": "587",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 18,
"key": "Email.Smtp.UseDefaultCredentials",
"value": "false",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 19,
"key": "Email.Smtp.UserName",
"value": "newalerts.uipath@gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 20,
"key": "Email.Smtp.Host",
"value": "smtp.gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 21,
"key": "Email.Smtp.Password",
"value": "protego-spell",
"partitionGlobalId": "magic-7",
"userId": null
}
]
[
{
"id": 6,
"key": "Email.Smtp.FromEmail",
"value": "newalerts.uipath@gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 7,
"key": "Email.Smtp.FromDisplayName",
"value": "Hogwarts server - 21.10 - Clean",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 15,
"key": "Email.Smtp.Domain",
"value": "",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 16,
"key": "Email.Smtp.EnableSsl",
"value": "true",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 17,
"key": "Email.Smtp.Port",
"value": "587",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 18,
"key": "Email.Smtp.UseDefaultCredentials",
"value": "false",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 19,
"key": "Email.Smtp.UserName",
"value": "newalerts.uipath@gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 20,
"key": "Email.Smtp.Host",
"value": "smtp.gmail.com",
"partitionGlobalId": "magic-7",
"userId": null
},
{
"id": 21,
"key": "Email.Smtp.Password",
"value": "protego-spell",
"partitionGlobalId": "magic-7",
"userId": null
}
]