Get the User List

Gets a list of users that have a role or that belong to a group with a role.

Authorizations: All

Requests

CODE

GET /apis/users/enabled

Response

Success

Array of users that have a role or that belong to a group with a role. Example:

JSON

{
 "data": [{
    "assets": [],
    "displayName": "contrib",
    "dn": "cn=contrib,dccalypso,dc=haivision,dc=com",
    "email": "",
    "id": "b70df497-baf3-4512-a2eb-25fd51f87a35",
    "roles": [
      "<roleID>" ],
    "sessions": [],
    "shares": {
      "assets": {
        "2f02b038-2d99-442d-b9d7-629459f9449b": {
          "mode": "EDIT"
        }
      },
      "sessions": {
        "0fb77a60-f7af-4c54-bf27-38e0a36924a1": {
          "mode": "OWN"
        },
        "2f8dce6d-fd8b-459e-890f-97965c88df40": {
          "mode": "WATCH"
        }
      }
    },
    "userAttribute": "cn",
    "userContext": "dc=calypso,dc=haivision,dc=com",
    "userObjectClass": "(objectClass=person)",
    "username": "contrib"
  },
  {
    "assets": [],
    "displayName": "InfoDev",
    "dn": "cn=infodev,dc=calypso,dc=haivision,dc=com",
    "email": "infodev@haivision.com",
    "id": "4ef8ffa6-231e-41e1-aaa3-57cc4743668e",
      "roles": [
      "<roleID>"
    ],
    "sessions": [],
    "shares": {
      "assets": {
        "523bbda2-e7bc-4e97-b622-e461938c9a03": {
          "mode": "EDIT"
        }
      }
    },
    "userAttribute": "cn",
    "userContext": "dc=calypso,dc=haivision,dc=com",
    "userObjectClass": "(objectClass=person)",
    "username": "infodev"
  }
],
"paging": {
  "results": 2,
  "pageSize": 15
}
}

Caution

Only the id, username, displayName, and email properties are supported. Other attributes are subject to change and should not be used in a production application.

Error

Code	Payload	Description
`404`	`{"code":"040012","name":"NoResults",` `"message":"No results", "httpStatusCode":404}`	No users available.
`500`	`{"code":"070000","name":"InternalServer",` `"message":<Error message>, "httpStatusCode":500}`	Error retrieving users.