GET | List a device by [id]
  • 2 minutes to read
  • Dark
    Light
  • PDF

GET | List a device by [id]

  • Dark
    Light
  • PDF

Article summary

Access information of a device registered in PAM Core.

Requirements

Request

GET /api/pam/device/[id]

Request parameters

Send the parameter below in the path of the URL.

id - int - required - Unique identification code of the device.Note: this value is automatically assigned by senhasegura in POST | Create device and is obtained in the response to the GET | List all devices.

Example request

GET {{url}}/api/pam/device/14

Response

HTTP/1.1 200 OK 
{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Device 14",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Device 14",
        "erro": false,
        "cod_erro": 0
    },
    "tenant": "senhasegura",
    "device": {
        "id": "14",
        "hostname": "API device",
        "ip": "10.66.33.17",
        "model": "Gmail",
        "type": "Desktop",
        "vendor": "Linux",
        "site": "AWS",
        "device_domain": "my_device_domain",
        "connectivities": "HTTP:80, SSH:22"",
        "session_remote_config": "HTTP::",
        "device_tags": "test"
    }
}

Response body fields

devices - object - Device data.


    → id - int - Unique identification code of the device.


    →hostname - string - Hostname of the device.


    →ip - string - IP address of the device.


    →model - string - Device model.


    →type - string - Device type.


    →vendor - string - Device vendor.


    →site - string - Device location.


    →device_domain - string - Name or short name of the device.


    →connectivities - string - Device connectivity.


    →session_remote_config - string - Login expression.


    →device_tags - string - Keywords associated with the device.


Errors

400 - Bad Request

Message: "1011: Device not found"


Possible cause: the device wasn't found.

Solution: check the id used to search for the device and resend the request.


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?