List users

Content Platform for Cloud Scale Management API Reference

Version
2.5.x
Audience
anonymous
Part Number
MK-HCPCS007-08

You can retrieve a list of all users of the HCP for cloud scale system by user ID, display name, and realm. You can also filter the list to retrieve a subset.

HTTP request syntax (URI)

POST https://host_ip:9099/mapi/v1/user/list

Request structure

The request body is:

{
  "count": [nnnn],
  "startingFrom": ["uuid"],
  "nameFilter": ["match_string"]
}
Parameter Required Type Description
count No Integer The number of users to return. Up to 1000 users; default: 1000.
startingFrom No UUID The UUID to start from. Leave blank to start from the beginning of the list.
nameFilter No String A string used to filter the list to return only names that start with this string.

Response structure

The response body structure is:

[
  {
    "displayName": "",
    "id": "",
    "realmId": ""
  }
  .
  .
  .
]

Parameter

Type

Description

displayName String The display name of the user.
id UUID The ID of the user.
realmId String The realm of the user.

Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
401 Unauthorized Access was denied because credentials are not valid.
405 Method Not Allowed The specified HTTP method is not allowed for user data. Resend using POST.

Example

Request example:

POST https://10.10.24.195:9099/mapi/v1/user/list

JSON request:

{
  "count": 1,
  "startingFrom": "3fa85f64-0810-1954-b3fc-2c963f66afa6",
  "nameFilter": ""
}

JSON response:

[
  {
    "displayName": "Zhang.Guo-Ming@company.com",
    "id": "3fa85f64-0810-1954-b3fc-2c963f66afa6"
    "realmId": "2d64d267-a23b-54c8-9be5-a3832faad4b2"
  }
]