Documentation

CoAP GET /iam/settings

DESCRIPTION

This endpoint shows the current IAM settings configured for the device.

DECLARATION

GET /iam/settings

REQUEST

Request body is empty.

RESPONSE

CoAP status codes:

  • 205: On success.
  • 403: Blocked by IAM configuration.

Response body:

{
    PasswordOpenPairing: bool,
    LocalOpenPairing: bool,
    PasswordOpenSct: String,
    PasswordOpenPassword: String
}
PasswordOpenPairing:
Is Password open pairing enabled.
LocalOpenPairing:
Is Local open pairing enabled.
PasswordOpenSct:
Server Connect Token (SCT) to use for Password open pairing if connecting remotely and using an [SCT Console App](/developer/guides/security/token_based_access_control.html#sct-intro).
PasswordOpenPassword:
The password to use for Password open pairing.

IAM PARAMETERS

A user must have access to the following IAM Action to use this endpoint:

  • IAM:GetSettings

No special attributes are provided.