automation-suite
2.2510
true
- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
- Recuperação do partiçãoGlobalId para uso da API
- Alertas
- ClienteExterno
- Obter configurações
- Atualizar configurações
Guia da API do Automation Suite
Última atualização 24 de abr de 2026
Como Host ou Organization Administrator, use esse ponto de extremidade para atualizar as configurações existentes ou criar novas configurações para uma ID de organização e/ou de usuário.
Ponto de Extremidade da API
PUT /identity_/api/Setting
Escopos
Requer os seguintes escopos:
- PM.Setting
- PM.Setting.Write
Cabeçalhos de solicitaçã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 em Métodos de autenticação.
Corpo da Solicitação
O corpo da solicitação contém a ID da organização e as chaves de configuração que você deseja atualizar.
{
"settings": [
{
"key": "string",
"value": "string"
}
],
"partitionGlobalId": "string",
"userId": "string"
}
{
"settings": [
{
"key": "string",
"value": "string"
}
],
"partitionGlobalId": "string",
"userId": "string"
}
Resposta
200 OK
As configurações são atualizadas com as informações que você forneceu.
Exemplo de solicitação
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}é:3fa85f64-5717-4562-b3fc-2c963f66afa6 - Você deseja atualizar as configurações de autenticação e, para isso, faz login como admin host.
A chamada deve ser semelhante ao seguinte exemplo (cURL):
curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting' \)\)
--header 'Authorization: Bearer 1234' \)\)
--header 'Content-Type: application/json'
--data-raw '
{
"settings": [
{
"key": "Auth.Password.DefaultExpirationDays",
"value": "0"
},
{
"key": "Auth.Password.PasswordComplexity",
"value": "{\"hasSpecialCharacter\":false,\"hasLowercase\":true,\"hasUppercase\":false,\"hasDigit\":true,\"Length\":\"10\"}"
},
{
"key": "Auth.Password.PreviousUseLimit",
"value": "1"
},
{
"key": "Auth.Password.ShouldChangePasswordAfterFirstLogin",
"value": "true"
},
{
"key": "Auth.UserLockOut.DefaultAccountLockoutSeconds",
"value": "0"
},
{
"key": "Auth.UserLockOut.IsEnabled",
"value": "false"
},
{
"key": "Auth.UserLockOut.MaxFailedAccessAttemptsBeforeLockout",
"value": "2"
}
],
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Setting' \)\)
--header 'Authorization: Bearer 1234' \)\)
--header 'Content-Type: application/json'
--data-raw '
{
"settings": [
{
"key": "Auth.Password.DefaultExpirationDays",
"value": "0"
},
{
"key": "Auth.Password.PasswordComplexity",
"value": "{\"hasSpecialCharacter\":false,\"hasLowercase\":true,\"hasUppercase\":false,\"hasDigit\":true,\"Length\":\"10\"}"
},
{
"key": "Auth.Password.PreviousUseLimit",
"value": "1"
},
{
"key": "Auth.Password.ShouldChangePasswordAfterFirstLogin",
"value": "true"
},
{
"key": "Auth.UserLockOut.DefaultAccountLockoutSeconds",
"value": "0"
},
{
"key": "Auth.UserLockOut.IsEnabled",
"value": "false"
},
{
"key": "Auth.UserLockOut.MaxFailedAccessAttemptsBeforeLockout",
"value": "2"
}
],
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
Aqui está a resposta de uma chamada bem-sucedida:
[
{
"id": 4,
"key": "Auth.Password.DefaultExpirationDays",
"value": "0",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 1,
"key": "Auth.Password.PasswordComplexity",
"value": "{\"HasDigit\":true,\"HasLowercase\":true,\"HasSpecialCharacter\":false,\"HasUppercase\":false,\"Length\":10,\"RegexComplexity\":{\"HasDigitRegex\":\"(?=.*\\\\d)\",\"HasLowercaseRegex\":\"(?=.*[a-z])\",\"HasSpecialCharacterRegex\":\"(?=.*[^a-zA-Z\\\\d])\",\"HasUppercaseRegex\":\"(?=.*[A-Z])\",\"LengthRegex\":\"{10,}\",\"Regex\":\"(?=.*\\\\d)(?=.*[a-z]).{10,}\"}}",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 3,
"key": "Auth.Password.PreviousUseLimit",
"value": "1",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 2,
"key": "Auth.Password.ShouldChangePasswordAfterFirstLogin",
"value": "true",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 26,
"key": "Auth.UserLockOut.DefaultAccountLockoutSeconds",
"value": "0",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 27,
"key": "Auth.UserLockOut.IsEnabled",
"value": "false",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 28,
"key": "Auth.UserLockOut.MaxFailedAccessAttemptsBeforeLockout",
"value": "2",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
}
]
[
{
"id": 4,
"key": "Auth.Password.DefaultExpirationDays",
"value": "0",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 1,
"key": "Auth.Password.PasswordComplexity",
"value": "{\"HasDigit\":true,\"HasLowercase\":true,\"HasSpecialCharacter\":false,\"HasUppercase\":false,\"Length\":10,\"RegexComplexity\":{\"HasDigitRegex\":\"(?=.*\\\\d)\",\"HasLowercaseRegex\":\"(?=.*[a-z])\",\"HasSpecialCharacterRegex\":\"(?=.*[^a-zA-Z\\\\d])\",\"HasUppercaseRegex\":\"(?=.*[A-Z])\",\"LengthRegex\":\"{10,}\",\"Regex\":\"(?=.*\\\\d)(?=.*[a-z]).{10,}\"}}",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 3,
"key": "Auth.Password.PreviousUseLimit",
"value": "1",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 2,
"key": "Auth.Password.ShouldChangePasswordAfterFirstLogin",
"value": "true",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 26,
"key": "Auth.UserLockOut.DefaultAccountLockoutSeconds",
"value": "0",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 27,
"key": "Auth.UserLockOut.IsEnabled",
"value": "false",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
},
{
"id": 28,
"key": "Auth.UserLockOut.MaxFailedAccessAttemptsBeforeLockout",
"value": "2",
"partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": null
}
]