Listar senhas

Este artigo apresenta como acessar as informações das senhas armazenadas no MySafe via API, os endpoints disponíveis, os parâmetros necessários, exemplos de requisições e respostas em caso de sucesso ou em caso de erros.

Autorização

A autorização para as APIs MySafe é feita diretamente no módulo.
Para mais informações, acesse o documento sobre Como adicionar uma autorização de chave de acesso.

Autenticação

A autenticação nas APIs MySafe é feita utilizando o método de autenticação OAuth 2.0. Para iniciar este processo, é necessário fornecer o Client ID e o Client Secret, além de obter o token de autenticação deles a partir do endpoint:

GET /api/oauth2/token

Para mais informações sobre como obter o Client ID e o Client Secret, acesse o documento sobre Como visualizar uma autorização de chave de acesso.

Métodos

Listar todas as senhas

Requisição

Para acessar uma lista com todas as senhas armazenadas no MySafe, envie uma requisição para o seguinte endpoint:

GET /iso/mysafe/password

Parâmetros de requisição

Query

Retorno

Retorna todas as senhas associadas ao acesso do seu usuário no MySafe e apresenta uma mensagem com informações sobre o processo de consulta.

Resposta esperada

HTTP/1.1 200 OK

{
    "code": 200,
    "response": {
        "status": 200,
        "message": "",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "",
        "erro": false,
        "cod_erro": 0
    },
    "password_on_list": 
        {
            "identifier": "197",
            "name": "Testing",
            "url": "www.url.com",
            "username": "maria",
            "tags": "test",
            "need_justify": "0",
            "need_approval": "0",
            "can_view": true,
            "can_write": true
        },
        {
            "identifier": "198",
            "name": "API",
            "url": "",
            "username": "dleite",
            "tags": "api",
            "need_justify": "0",
            "need_approval": "0",
            "can_view": true,
            "can_write": true
        },
        {
            "identifier": "226",
            "name": "Gmail",
            "url": "www.gmail.com",
            "username": "dleite",
            "tags": "gmail",
            "need_justify": "0",
            "need_approval": "0",
            "can_view": true,
            "can_write": true
        }
    ]
}

Listar uma senha

Requisição

Para acessar uma senha armazenada no MySafe, envie uma requisição para o seguinte endpoint:

GET /api/mysafe/password/[identifier]

Parâmetros de requisição

Path

Retorno

Retorna uma senha associada ao acesso do seu usuário no MySafe, com base em seu identifier, e uma mensagem com informações sobre o processo de consulta.

Parâmetros de resposta

Resposta esperada

HTTP/1.1 200 OK

{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Success",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Success",
        "erro": false,
        "cod_erro": 0
    },
    "password_entity": {
        "identifier": "197",
        "name": "Testing",
        "url": "www.url.com",
        "username": "maria",
        "password": "Cs^Q4PdbIOo4",
        "secret_key": JBSWY3DPEHPK3PXP,
        "token": 452180,
        "notes": "This is a test password",
        "tags": "test",
        "users_allowed": [],
        "groups_allowed": []
    }
}

Em caso de erro - senha não encontrada

HTTP/1.1 400 Bad Request

{
    "response": {
        "status": 400,
        "mensagem": "1005: Password not found",
        "erro": true,
        "cod_erro": 0,
        "message": "1005: Password not found",
        "error": true,
        "error_code": 0
    },
    "exception": {
        "code": 1005,
        "message": "1005: Password not found",
        "detail": ""
    }
}

Em caso de erro - usuário não possui acesso a essa senha

HTTP/1.1 400 Bad request

{
    "response": {
        "status": 400,
        "mensagem": "1006: User does not have access",
        "erro": true,
        "cod_erro": 1,
        "message": "1006: User does not have access",
        "error": true,
        "error_code": 1
    },
    "exception": {
        "code": 1006,
        "message": "1006: User does not have access",
        "detail": ""
    }
}