APIs MySafe

9 minutos de leitura

Imprimir
Compartilhar
Tema escuro
Tema claro
Pdf

APIs MySafe

9 minutos de leitura

Imprimir
Compartilhar
Tema escuro
Tema claro
Pdf

Article Summary

Share feedback

Thanks for sharing your feedback!

A autorização das APIs do MySafe é realizada diretamente no módulo. Para saber mais, consulte o artigo Integrações de API do MySafe.

Consultar uma senha

Método: Get

GET /iso/mysafe/password/{id}

Parâmetros do método

Campo	Descrição	Obrigatório?
id	Código de identificação do segredo	Sim

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "Success",
        "erro": false,
        "cod_erro": 0,
        "message": "Success",
        "error": false,
        "error_code": 0
    },
    "password_entity": {
            "identifier": "1",
            "name": "url",
             "url": "www.url.com",
            "username": "matheus",
            "password": "%#BRasil123",
            "notes": "",
            "tags": ""
    }
}

Retorno esperado em caso de falha - usuário não tem acesso ou segredo não existe

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

Retorno esperado em caso de falha - informação inativa

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

Consultar uma nota

Método: Get

GET /iso/mysafe/note/{id}

Parâmetros do método

Campo	Descrição	Obrigatório?
id	Código de identificação do segredo	Sim

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "Success",
        "erro": false,
        "cod_erro": 0,
        "message": "Success",
        "error": false,
        "error_code": 0
    },
    "note_entity": {
            "identifier": "1",
            "name": "url",
             "url", "www.url.com",
            "note": "matheus",
            "tags": ""
    }
}

Retorno esperado em caso de falha - usuário não tem acesso ou segredo não existe

HTTP/1.1 400 Bad Request

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

Retorno esperado em caso de falha - informação inativa

HTTP/1.1 400 Bad Request

{
    "response": {
        "status": 400,
        "mensagem": "1009: Inactive note",
        "erro": true,
        "cod_erro": 0,
        "message": "1009: Inactive note",
        "error": true,
        "error_code": 0
    },
    "exception": {
        "code": 1009,
        "message": "1009: Inactive note",
        "detail": ""
    }
}

Consultar todas as senhas

Método: Get

GET /iso/mysafe/password?tag={tag}

Parâmetros do método

Campo	Descrição	Obrigatório?
tag	Busca todas as senhas que possuem uma tag específica	Não

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "",
        "erro": false,
        "cod_erro": 0,
        "message": "",
        "error": false,
        "error_code": 0
    },
    "password_on_list": [
        {
            "identifier": "1",
            "name": "url",
            "url": "www.url.com",
            "username": "matheus",
            "tags": "",
            "need_justify": "0",
            "need_approval": "0"
        },
        {
            "identifier": "12",
            "name": "repositorio",
            "url": "www.repositorio.com",
            "username": "shinobu",
            "tags": "",
            "need_justify": "0",
            "need_approval": "0"
        }
    ],
    "notes_on_list": [
        {
            "identifier": "1",
            "name": "marketing plan",
            "note": "update it before Jan/2023",
            "tags": "",
            "need_justify": "0",
            "need_approval": "0"
        }
    ]
}

Consultar todas as notas

Método: Get

GET /iso/mysafe/note?tag={tag}

Parâmetros do método

Campo	Descrição	Obrigatório?
tag	Busca todas as notas que possuem uma tag específica	Não

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "",
        "erro": false,
        "cod_erro": 0,
        "message": "",
        "error": false,
        "error_code": 0
    },
    "notes_on_list": [
        {
            "identifier": "1",
            "name": "marketing plan",
            "tags": "",
            "need_justify": "0",
            "need_approval": "0"
        }
    ]
}

Criar uma senha

No momento da criação, a informação fica automaticamente associada a quem a criou, sendo esta a pessoa proprietária da senha.

POST /iso/mysafe/password

Parâmetros do método

Campo	Descrição	Obrigatório?
name		Sim
url		Não
username		Sim
password		Não
tags		Não
users_allowed	Nome dos usuários que terão acesso à informação e suas permissões. O campo de permissão não é obrigatório. Caso esteja em branco, a permissão será apenas de visualização.	Não
groups_allowed	Nome dos grupos que terão acesso à informação e suas permissões. O campo de permissão não é obrigatório. Caso esteja em branco, a permissão será apenas de visualização.	Não

Exemplo

{
    "name": "novainfo",
    "username": "teste",
    "password": "123456",
    "tags": "tag1, tag2",
    "users_allowed": [
        {
            "username" : "Admin"
            "can_edit" : true
        },
        {
            "username" : "malu",
            "can_edit" : true
        }

    ],
    "groups_allowed": [
        {
            "name" : "grupo1",
            "can_edit" : true
        },
        {
            "name" : "grupo2",
            "can_edit" : true
        },
        {
            "name" : "grupo3",
            "can_edit" : true
        }
    ]
}

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 201,
        "mensagem": "Password successfully registered!",
        "erro": false,
        "cod_erro": 0,
        "message": "Password successfully registered!",
        "error": false,
        "error_code": 0
    },
    "password_entity": {
        "identifier": "176",
        "name": "novainfo",
        "url": "",
        "username": "teste",
        "note": "",
        "tags": "tag1, tag2"
    }
}

Retorno esperado em caso de falha - informar quais campos foram preenchidos incorretamente

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

Criar uma nota

No momento da criação, a informação fica automaticamente associada ao criador da autorização como seu proprietário.

Método: Post

POST /iso/mysafe/note

Parâmetros do método

Campo	Descrição	Obrigatório?
name		Sim
note		Sim
tags		Não
users_allowed	Nome dos usuários que terão acesso à informação e suas permissões. O campo de permissão não é obrigatório. Caso esteja em branco, a permissão será apenas de visualização.	Não
groups_allowed	Nome dos grupos que terão acesso à informação e suas permissões. O campo de permissão não é obrigatório. Caso esteja em branco, a permissão será apenas de visualização.	Não

Exemplo

{
    "name": "nota",
    "note": "umanota",
    "users_allowed": [
        {
            "username" : "Admin",
            "can_edit" : true
        },
        {
            "username" : "malu",
            "can_edit" : true
        }
    ],
    "groups_allowed": [
        {
            "name" : "grupo1",
            "can_edit" : true
        },
        {
            "name" : "grupo2",
            "can_edit" : true
        }
    ]
}

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 201,
        "mensagem": "Note successfully registered!",
        "erro": false,
        "cod_erro": 0,
        "message": "Note successfully registered!",
        "error": false,
        "error_code": 0
    },
    "note_entity": {
        "identifier": "32",
        "name": "nota",
        "tags": ""
    }
}

Retorno esperado em caso de falha - informar quais campos foram preenchidos incorretamente

HTTP/1.1 400 Bad Request

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

Inativar uma senha

Método: Post

POST /iso/mysafe/password/inactive/{id}

Parâmetros do método

Campo	Descrição	Obrigatório?
id	Código de identificação do segredo	Sim

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "Password successfully deactivated",
        "erro": false,
        "cod_erro": 0,
        "message": "Password successfully deactivated",
        "error": false,
        "error_code": 0
    }
}

Retorno esperado em caso de falha - permissão negada

HTTP/1.1 403 Forbidden

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

Retorno esperado em caso de falha - informação 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": ""
    }
}

Inativar uma nota

Método: Post

POST /iso/mysafe/note/inactive/{id}

Parâmetros do método

Campo	Descrição	Obrigatório?
id	Código de identificação do segredo	Sim

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "Note successfully deactivated",
        "erro": false,
        "cod_erro": 0,
        "message": "Note successfully deactivated",
        "error": false,
        "error_code": 0
    }
}

Retorno esperado em caso de falha - permissão negada

HTTP/1.1 403 Forbidden

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

Retorno esperado em caso de falha - informação não encontrada

HTTP/1.1 400 Bad Request

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

Reativar uma senha

Método: Post

POST /iso/mysafe/password/active/{id}

Parâmetros do método

Campo	Descrição	Obrigatório?
id	Código de identificação do segredo	Sim

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "Password successfully activated",
        "erro": false,
        "cod_erro": 0,
        "message": "Password successfully activated",
        "error": false,
        "error_code": 0
    }
}

Retorno esperado em caso de falha - permissão negada

HTTP/1.1 403 Forbidden

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

Retorno esperado em caso de falha - segredo não encontrado

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

Reativar uma nota

Método: Post

POST /iso/mysafe/nota/active/{id}

Parâmetros do método

Campo	Descrição	Obrigatório?
id	Código de identificação do segredo	Sim

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "Note successfully activated",
        "erro": false,
        "cod_erro": 0,
        "message": "Note successfully activated",
        "error": false,
        "error_code": 0
    }
}

Retorno esperado em caso de falha - permissão negada

HTTP/1.1 403 Forbidden

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

Retorno esperado em caso de falha - segredo não encontrado

HTTP/1.1 400 Bad Request

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

Atualizar uma senha

Método: Put

PUT /iso/mysafe/password/update/{id}

Parâmetros do método

Campo	Descrição	Obrigatório?
id	Código de identificação do segredo	Sim
name		Não
url		Não
username		Não
password		Não
tags		Não
users_allowed	Nome dos usuários que terão acesso à informação e suas permissões. O campo de permissão não é obrigatório. Caso esteja em branco, a permissão será apenas de visualização.	Não
groups_allowed	Nome dos grupos que terão acesso à informação e suas permissões.O campo de permissão não é obrigatório. Caso esteja em branco, a permissão será apenas de visualização.	Não

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "Password successfully updated",
        "erro": false,
        "cod_erro": 0,
        "message": "Password successfully updated",
        "error": false,
        "error_code": 0
    }
}

Retorno esperado em caso de falha - permissão negada

HTTP/1.1 403 Forbidden

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

Retorno esperado em caso de falha - segredo não encontrado

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

Atualizar uma nota

Método: Put

PUT /iso/mysafe/note/update/{id}

Parâmetros do método

Campo	Descrição	Obrigatório?
id	Código de identificação do segredo.	Sim
name		Não
note		Não
password		Não
tags		Não
users_allowed	Nome dos usuários que terão acesso à informação e suas permissões. O campo de permissão não é obrigatório. Caso esteja em branco, a permissão será apenas de visualização.	Não
groups_allowed	Nome dos grupos que terão acesso à informação e suas permissões. O campo de permissão não é obrigatório. Caso esteja em branco, a permissão será apenas de visualização.	Não

Retorno esperado em caso de sucesso

HTTP/1.1 200 OK

{
    "response": {
        "status": 200,
        "mensagem": "Note successfully updated",
        "erro": false,
        "cod_erro": 0,
        "message": "Note successfully updated",
        "error": false,
        "error_code": 0
    }
}

Retorno esperado em caso de falha - permissão negada

HTTP/1.1 403 Forbidden

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

Retorno esperado em caso de falha - segredo não encontrado

HTTP/1.1 400 Bad Request

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

Este artigo foi útil?

What's Next

Certificate Manager

Nesta página

Consultar uma senha
Consultar uma nota
Consultar todas as senhas
Consultar todas as notas
Criar uma senha
Criar uma nota
Inativar uma senha
Inativar uma nota
Reativar uma senha
Reativar uma nota
Atualizar uma senha
Atualizar uma nota