PUT | Enable SSH key
  • 2 minutes to read
  • Dark
    Light
  • PDF

PUT | Enable SSH key

  • Dark
    Light
  • PDF

Article summary

Enable an SSH key in PAM Core.

Requirements

Request

PUT /api/pam/key/[id]

Request parameters

Send the parameter below in the path of the URL.

  • id - int - required - Unique identification code of the SSH key.

    Note: this value is automatically assigned by senhasegura in POST | Create SSH key and is obtained in the response to the GET /api/pam/credential which lists all credentials.

Example request

PUT {{url}}/api/pam/key/83

Response

HTTP/1.1 200 OK
{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Key successfully activated",
        "error": false,
        "error_code": 0,
        "detail": "",
        "Message": "Key successfully activated",
        "erro": false,
        "cod_erro": 0
    }
}

Errors

400 - Bad Request

Message: "1009: No access to credential"


Possible cause: you don't have the authorization to access this credential.

Solution: ask the administrator to check your permission to access this credential.


Message: "1015: SSH key not found"


Possible cause: the SSH key wasn't found.

Solution: check the value for the id and resend the request.


Message: "1016: The item is not a ssh key"


Possible cause: the value for the id doesn't belong to an SSH key.

Solution: check the value for the id and resend the request.


Message: "1039: Without PAM Configuration Access permission"

Possible cause: your authorization doesn’t have permission to create a credential.

Solution: ask the administrator to check your read and write permission to PAM Core resources in A2A.


Message: "1045: Ssh key is already activated"

Possible cause: the SSH key is already active.


404 - Not Found

Message: "Resource sub not found"

Possible cause: the URL or the requested resource isn’t correct.

Solution: check the URL and make sure the parameter is correct.


500 - Internal Server Error

Message: "Unexpected error."

Possible cause: the error is in the senhasegura server.

Solution: contact the support team for more information.


Message: "You are not authorized to access this resource."

Possible cause: you don’t have the authorization to access this resource.

Solution: ask the administrator to check your permission to access the PAM Core resources in A2A.


Client authentication failed

Message: "Client authentication failed."

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

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


Invalid signature

Message: "Invalid signature"

Possible cause: failure in recognizing the URL of the client application.

Solution: check the URL of the client application and resent the request.


No route matched with those values

Message: "No route matched with those values."

Possible cause: the authorization header is missing in the API request.

Solution: request a new access token.


Request timed out

Message: "Request timed out."

Possible cause: the request time has expired.

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


Was this article helpful?