Notas de Implementação:
Método para recuperar senha de acesso do usuário via portal.
Informações de Envio:
Modelo:
Dados de senha do usuário em formato de DTO.
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| Usuario |
Nome de usuário. |
string |
Obrigatório |
| Senha |
Senha. |
string |
Opcional |
| UrlPortal |
Url do portal que requisitou alteração de senha. |
string |
Obrigatório |
| Token |
Token resposável por validar se a requisição é valida. |
string |
Opcional |
| CodigoSenhaCriptografada |
Valor da senha criptografada. |
string |
Opcional |
| RemoverPortalUrl |
Define se será removido o nome do portal ao gerar a url para alteração de senha. |
boolean |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"Usuario": "string 1",
"Senha": "string 2",
"UrlPortal": "string 3",
"Token": "string 4",
"CodigoSenhaCriptografada": "string 5",
"RemoverPortalUrl": true
}
Informações de Retorno:
Cabeçalhos Adicionais:
| Nome | Descrição | Valor |
|---|---|---|
| cigam-api-version | Versão do build/compilação dessa versão da API | 2.1.8565.21067 |
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| success | boolean |
Opcional |
|
| hash | string |
Opcional |
|
| messages | string |
Opcional |
|
| data | Object |
Opcional |
|
| tipoLogin | string |
Opcional |
Formato de Resposta:
Objeto JSON com retorno do processo de solicitação para a alteração de senha.
| Código de status HTTP | Descrição | Modelo de resposta |
|---|---|---|
| 200 | OK |
application/json, text/json
Exemplo:
{
"success": true,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 400 | Requisição inválida |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 401 | Não autorizado |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 500 | Requisição falhou |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 502 | Falha de comunicação |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|