Documentation

CoAP GET /iam/users/:username

DESCRIPTION

This endpoint is used to get details about a particular user of the device.

DECLARATION

GET /iam/users/:username

REQUEST

Request body is empty.

RESPONSE

CoAP status codes:

  • 205: On success.
  • 403: Blocked by IAM configuration.
  • 404: The username does not exist.

The response body contains a CBOR object with relevant information about the user configured in the device. If a value as described below is not configured for the particular user, it will not be present in the CBOR object. A user must always have a username meaning its field will always exist in the response. The server connect token (SCT) is generated by the device upon user creation and will exist unless the SCT has explicitly been removed from the user.

{
  "Username": "john",
  "DisplayName": "John Doe",
  "Fingerprint": "...",
  "Fingerprints": [
    {
      "Fingerprint": "...",
      "Name": "..."
    },...
  ],
  "OauthSubject": "...",
  "NotificationCategories": ["...", ...],
  "Sct": "...",
  "Role": "r1",
}
Username:
Username identical to the provided username.
DisplayName:
UTF-8 name of user for presenting in the client.
Fingerprint:
DEPRECATED Fingerprint of one of the clients paired with this user.
Fingerprints:
Array of named fingerprints of the clients paired with this user.
OauthSubject:
Oauth subject for this user when authenticating using Oauth.
NotificationCategories:
List of notification categories this user is subscribed to.
Sct:
Server Connect Token (SCT) assigned to the user for remote access.
Role:
The role assigned to the user defining which resources it can access.

IAM PARAMETERS

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

  • IAM:GetUser

This endpoint provides the additional attribute:

  • IAM:Username