Criar ou atualizar uma senha

Este artigo apresenta como criar ou atualizar uma senha 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 do 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

Criar uma senha

Requisição

Para adicionar uma senha ao MySafe, envie uma requisição para o seguinte endpoint:

POST /api/mysafe/password

Parâmetros de requisição

Body

Exemplo de requisição

{
    "name": "senseg account",
    "url": "www.senhasegura.com",
    "username": "npass",
    "password": "8jhfy@3789",
    "secret_key": "JBSWY3DPEHPK3PXP",
    "notes": "Access details",
    "tags": "tag1, tag2",
    "users_allowed": [
        {
            "username" : "pduarte"
        }
    ],
    "groups_allowed": [
        {
            "name" : "Test group",
            "can_edit" : false
        }
    ]
}

Retorno

Adiciona uma senha ao MySafe, e retorna uma mensagem com informações sobre o processo de adição da senha.

Resposta esperada

HTTP/1.1 201 Created

{
    "code": 201,
    "response": {
        "status": 201,
        "message": "Password successfully registered",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Password successfully registered",
        "erro": false,
        "cod_erro": 0
    },
    "password_entity": {
        "identifier": "312",
        "name": "senseg account",
        "url": "www.senhasegura.com",
        "username": "npass",
        "note": "Access details",
        "tags": "tag1, tag2",
        "users_allowed": [
            {
                "username": "pduarte",
                "can_edit": false
            }
        ],
        "groups_allowed": [
            {
                "name": "Test group",
                "can_edit": false
            }
        ],
        "shared_error": []
    }
}

Em caso de erro - parâmetro obrigatório ausente

HTTP/1.1 400 Bad Request

{
    "response": {
        "status": 400,
        "mensagem": "1001: Parameter 'username' was not informed!",
        "erro": true,
        "cod_erro": 0,
        "message": "1001: Parameter 'username' was not informed!",
        "error": true,
        "error_code": 0
    },
    "exception": {
        "code": 1001,
        "message": "1001: Parameter 'username' was not informed!",
        "detail": ""
    }
}

Atualizar uma senha

Requisição

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

PUT /api/mysafe/password/update/[identifier]

Parâmetros de requisição

Path

Body

Exemplo de requisição

{
    "name": "senhasegura account",
    "username": "senhapass",
    "url": "www.url.com",
    "password": "x%8jhfy@3789a",
    "notes": "Access details for this key.",
    "tags": "access",
    "secret_key": "3DPEHPK3PXPGHODADA",
    "users_allowed": [
        {
            "username": "pduarte", 
            "can_edit": true
         }
    ],
    "groups_allowed": [
        {
            "name": "Test group",
            "can_edit": false
        }
    ]
}

Retorno

Atualiza uma senha armazenada no MySafe, com base no seu identifier, e retorna uma mensagem com informações sobre o processo de atualização.

Resposta esperada

HTTP/1.1 200 OK

{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Password successfully updated",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Password successfully updated",
        "erro": false,
        "cod_erro": 0
    },
    "password_entity": {
        "identifier": "312",
        "name": "senhasegura account",
        "url": "www.url.com",
        "username": "senhapass",
        "note": "Access details for this key.",
        "tags": "access",
        "users_allowed": [
            {
                "username": "pduarte",
                "can_edit": true
            }
        ],
        "groups_allowed": [
            {
                "name": "Test group",
                "can_edit": true
            }
        ],
        "shared_error": []
    }
}

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

HTTP/1.1 400 Bad Request

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

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": ""
    }
}