GET | Listar uma credencial
  • 4 minutos de leitura
  • Tema escuro
    Tema claro
  • Pdf

GET | Listar uma credencial

  • Tema escuro
    Tema claro
  • Pdf

Resumo do artigo

Acesse informações de uma credencial no PAM Core.

Requisitos

Listar credencial por id - Requisição

GET /api/pam/credential/[id]

Parâmetros de requisição

Envie o parâmetro abaixo no path da URL.

Exemplo de requisição

GET {{url}}/api/pam/credential/5

Resposta

HTTP/1.1 200 OK
{
    "response": {
        "status": 200,
        "mensagem": "Credential 5",
        "erro": false,
	 "detail": "",
        "message": "Credential 5",
        "error": false,
	 "error_code": 0
    },
    "credential": {
        "id": "5",
        "identifier": "robot-test-5",
        "username": "credential_5",
        "password": "secret@2504",
        "content": "secret@2504",
        "hostname": "destktop-91.com",
        "parent_credential_cod": null,
        "parent_credential": null,
        "additional": "CREDADD01",
        "domain": "",
        "ip": "172.10.10.90",
        "port": "22",
        "model": "Ubuntu",
        "expiration_time": "2021-01-16T17:31:39"
    }

Listar credencial por username@hostname - Requisição

GET /api/pam/credential/[username@hostname]

Parâmetros de requisição

Envie o parâmetro abaixo no path da URL.


Atenção

Caso o username fornecido possua um @, como em johndoe@senhasegura, o endpoint não funcionará como esperado devido ao conflito gerado pela presença de dois símbolos @ no endpoint.

Exemplo de requisição

GET {{url}}api/pam/[email protected]

Resposta

HTTP/1.1 200 OK
json
{
    "response": {
        "status": 200,
        "mensagem": "Credential 5",
        "erro": false,
	 "detail": "",
        "message": "Credential 5",
        "error": false,
	 "error_code": 0
    },
    "credential": {
        "id": "5",
        "identifier": "robot-test-5",
        "username": "credential_5",
        "password": "secret@2504",
        "content": "secret@2504",
        "hostname": "destktop-91.com",
        "parent_credential_cod": null,
        "parent_credential": null,
        "additional": "CREDADD01",
        "domain": "",
        "ip": "172.10.10.90",
        "port": "22",
        "model": "Ubuntu",
        "expiration_time": "2021-01-16T17:31:39"
    }

Campos do corpo da resposta

  • credential - objeto - Dados da credencial.
    →id - int - Código único de identificação da credencial.


    →identifier - string - String única criada pelo usuário ou pelo senhasegura para identificar a credencial.    Nota: esse valor pode ser atualizado através da requisição POST | Atualizar credencial.


    →username - string - Nome do usuário designado à credencial.


    →password - string - Senha designada à credencial.


    →content - string - Senha designada à credencial.


    →hostname - string - Nome do host do dispositivo associado à credencial.


    →parent_credential_cod - string - Identificador da credencial pai.


    →parent_credential - string - Credencial pai.    Nota: ao escolher uma credencial pai, a credencial filha irá assumir a mesma senha da credencial pai. Sempre que ocorrer uma troca de senha, manual ou automatizada, na credencial pai, a credencial filha também será modificada e assumirá a mesma senha da credencial pai.


    →additional - string - Informações adicionais sobre a credencial.


    →domain - string - Nome de domínio ou abreviação.


    →ip - string - Endereço IP do dispositivo associado à credencial.


    →port - string - Porta associada à credencial.


    →model - string - Modelo do dispositivo.    Nota: um novo modelo é criado caso o valor passado seja único.


    →expiration_time - string - Data e hora de expiração da credencial em formato ISO 8601.    Exemplo: 2024-05-16T17:31:31-03:00

Erros

400 - Bad Request

Mensagem: "1007: Credential not found"

Possível causa: a credencial não foi encontrada.

Solução: verifique se os valores dos parâmetros usados para buscar pela credencial estão corretos e envie a requisição novamente.


Mensagem: "1009: No access to credential"


Possível causa: sua autorização não possui acesso à credencial.

Solução: solicite ao administrador que revise sua permissão de acesso à credencial desejada.


Mensagem: "1010: The item is not a credential"


Possível causa: o valor do parâmetro id não corresponde a uma credencial.

Solução: verifique o id e envie a requisição novamente.


404 - Not Found

Mensagem: "Resource sub not found"

Possível causa: a URL ou o recurso solicitado não está correto.

Solução: verifique a URL e envie a requisição novamente.


500 - Internal Server Error

Mensagem: "Unexpected error."

Possível causa: o erro está no servidor senhasegura.

Solução: contate o time de suporte para mais informações.


Mensagem: "You are not authorized to access this resource"

Possível causa: você não possui autorização para acessar esse recurso.

Solução: solicite ao administrador que revise sua permissão de acesso aos recursos do PAM Core no A2A.


Client authentication failed

Mensagem: "Client authentication failed"

Possível causa: falha na autenticação da sua aplicação com o servidor senhasegura.

Solução: verifique os parâmetros de autenticação como Access Token, Client ID e Client secret e solicite um novo token de acesso.


No route matched with those values

Mensagem: "No route matched with those values"

Possível causa: ausência do header de autorização na requisição de API.

Solução: solicite um novo token de acesso.


Request timed out

Mensagem: "Request timed out"

Possível causa: o tempo da requisição se esgotou.

Solução: verifique a conectividade entre a origem da requisição e o servidor senhasegura.


Este artigo foi útil?