Descrição
Este recurso permite a configuração de informações importantes para o funcionamento adequado da API de Monitoramento, de acordo com as necessidades e preferências do usuário. Para atualizar quaisquer das configurações de autenticação, basta adicionar o parâmetro correspondente na requisição e inserir seu novo valor. Para não sobrescrever um campo já configurado, o campo não deve ser informado na requisição.
Parâmetros de Entrada
A tabela a seguir descreve os parâmetros de entrada deste método, indicando se são obrigatórios ou não.
| Campo | Obrigatório? | Valores Possíveis | Descrição |
|---|---|---|---|
| AccessToken | Sim | Token de autenticação nas APIs da Plataforma de Dados. Também pode ser informado no cabeçalho da requisição. | Token JWT |
| AuthorizationKey | Não | Chave de autorização | Chave de acesso |
| AuthorizationToken | Não | Token de autorização | Token |
| OAuthBasicToken | Não | Token básico de OAuth | Token OAuth |
| OAuthPublicKey | Não | Este campo deve ser usado junto ao OAuthPrivateKey, caso o OAuthBasicToken não sejainformado | Chave de acesso |
| OAuthPrivateKey | Não | Chave privada de OAuth | Chave de acesso |
| OAuthURLTarget | Não | URL de acesso ao servidor de autenticação | URL |
| OAuthContentType | Não | Tipo de conteúdo que deve ser retornado | Tipo de conteúdo |
| OAuthGrantType | Não | Determina o tipo de autorização | Tipo de permissão |
| OAuthExpectedTokenFieldName | Não | Este campo serve para o cliente apontar o campo onde recuperaremos o access token vindo da OAuth (valor padrão é "access_token") | Nome do campo |
Os campos AuthorizationToken e OAuthBasicToken não ficam armazenados em nossas bases de dados. Utilizamos o serviço de persistência de chaves da AWS, oferecendo mais segurança às credenciais do usuário.
Retorno
A tabela a seguir descreve os campos do objeto de retorno desse método.
| Campo | Descrição |
|---|---|
| User | Nome do usuário |
| ResultStatus | Mensagem de status da consulta |
Exemplos
A seguir estão alguns exemplos de uso deste endpoint.
POST: https://plataforma.bigdatacorp.com.br/monitoramento/definirUsuario
Request:
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"AuthorizationKey": "<YOUR_AUTH_KEY>",
"AuthorizationToken": "<YOUR_AUTH_TOKEN>"
}
Response:
{
"SubscriptionConfiguration": {
"User": "[email protected]",
"ResultStatus": "OK"
},
"QueryId": "1cfecda3-7cdf-4c9e-10e7-e66c5b2b74a5",
"ElapsedMilliseconds": 0,
"QueryDate": "2024-09-19T13:51:39.898Z",
"Status": {
"subscription": [
{
"Code": 0,
"Message": "OK"
}
]
}
}