POST | Update API secret

Update an API secret in MySafe.

Requirements

• Permission to edit the API secret.

Request

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

Request parameters

Send the parameter below in the path of the URL.

Send the parameters you want to update in the request body.

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

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

• client_id - string - ID of the client application.

• client_secret - string - The secret used to the 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.

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

Example request

PUT {{url}}api/mysafe/secretapi/update/43

{
    "name": "GCP1",
    "url": "https://gcp1.com",
    "client_id": "hb455f7g8fg9dfg8yt845bxxku",
    "client_secret": "hy746**********t4tr",
    "identifier_code": "gcp7852",
    "tags": "Cloud1",
    "notes": "Access details for this API secret",
     "users_allowed": [
        {
            "username" : "alices",
            "can_edit" : true
        }
    ],
    "groups_allowed": []
}

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

Errors