POST | Create API secret

Create an API secret in MySafe.

Request

POST api/mysafe/secretapi

Info

When an API secret is added to MySafe, it's automatically associated with its creator, identifying them as the owner.

Request parameters

Send the parameters below in the request body.

name - string - required - Name assigned to the API secret.

url - string - required - URL of the website where the API secret will be used.

client_id - string - required - ID of the client application.

client_secret - string - The secret used to authenticate the application.

identifier_code - string - Unique string defined by the user to identify the API secret.

tags - string - Keywords associated with the API secret.

notes - string - Observations about the API secret.

method - string - The HTTP method to be used in the API call.

users_allowed - array of objects - Data of the users with access to the API secret.

→username - string - Name of the user with API secret access permission.

→can_edit - boolean - Editing permission.

Nota: if left empty, users will have only viewing permission.

Attention

Users with can_edit = true permission can disable the API secret.

groups_allowed - array of objects - Data of the groups with API secret access.

→name - string - Name of the group with API secret access permission.

→can_edit - boolean - Editing permission.

Note: if left empty, group members will have only viewing permission.

Attention

Group members with can_edit = true permission can disable the API secret.

Example request

POST {{url}}api/mysafe/secretapi

{
    "name": "GCP",
    "url": "https://gcp.com",
    "client_id": "gf455f7g8fb5dfg8fd545bffbv",
    "client_secret": "gf5464******g8fds",
    "identifier_code": "hyga125",
    "tags": "Cloud",
    "notes": "Access details",
    "method": "get",
     "users_allowed": [
        {
            "username" : "pduarte",
            "can_edit" : true
        }
    ],
    "groups_allowed": [
        {
            "name" : "Test group"
        }
    ]
}

Response

HTTP/1.1 201 CREATED

  {
    "code": 201,
    "response": {
        "status": 201,
        "message": "Api secret successfully registered",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Api secret successfully registered",
        "erro": false,
        "cod_erro": 0
    },
    "api_entity": {
        "identifier": "43",
        "name": "GCP",
        "url": "https://gcp.com",
        "client_secret": "gf5464******g8fds",
        "client_id": "gf455f7g8fb5dfg8fd545bffbv",
        "identifier_code": "hyga125",
        "method": "get",
        "tags": "Cloud",
        "notes": "Access details",
        "users_allowed": [
            {
                "username": "pduarte",
                "can_edit": true
            }
        ],
        "groups_allowed": [
            {
                "name": "Test group",
                "can_edit": false
            }
        ],
        "shared_error": []
    }
}

Erros

400 - Bad Request.

Message: "1001: Parameter 'name' was not informed!"

Possible cause: the required parameter name of the API secret wasn't informed.

Solution: provide a value for name and resend the request.

Message: "1001: Parameter 'url' was not informed!"

Possible cause: the required parameter url of the API secret wasn't informed.

Solution: provide a value for the url and resend the request.

Message: "1001: Parameter 'client_id' was not informed!"

Possible cause: the required parameter client_id of the API secret wasn't informed.

Solution: provide a value for the client_id and resend the request.

Mensagem: "1001: Identifier already found in another API key of this user"

Possible cause: the identifier provided is already registered for another API secret.

Solution: provide a new value for the identifier and resend the request.

500 - Internal Server Error.

Message: "Unexpected error."

Possible cause: the error is on the senhasegura server.

Solution: contact the support team for more information.

No route matched with those values.

Message: "No route matched with those values."

Possible cause: failure in your application authentication with the senhasegura server.

Solution: check the authentication parameters such as Access Token URL, Client ID and Client Secret and request a new access token or check and correct the URL.

An invalid response was received from the upstream server .

Message: "An invalid response was received from the upstream server

Possible cause: the upstream server may be taking too long to respond, leading to a timeout error that is interpreted as an invalid response by the proxy/gateway server.

Solution: check the connectivity between the source of the request and the senhasegura server.

The upstream server is timing out.

Message: "The upstream server is timing out"

Possible cause: the request time has expired.

Solution: check the connectivity between the source of the request and the senhasegura server.