Protect User information

Get all users

Get all Protect users. Users are filtered based on access permissions.

get/v1/users

Request

Response

Success response

idstring required

The primary key of user

namestring required

The user name (first-name + last-name).

firstNamestring nullable required

The user first-name.

lastNamestring nullable required

The user last-name.

emailstring nullable required

The user email.

ucoreUserIdstring nullable required

The unique id of the UniFi Identity user. Matches the id field of the corresponding UlpUser.

modelKey'user' required

The model key of the user

Example response

[
  {
    "id": "66d025b301ebc903e80003ea",
    "name": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "ucoreUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.