PlatformUsers

Endpoints to manage users

PlatformUser

Details about the user, including their name, ID, and email address

Properties

Name	Type	Description	Restrictions
displayName	string	Display name of the user	read-only
email	string	Email address of the user	read-only
firstName	string	First name of the user	read-only
id	string	The unique identifier of the user
lastName	string	Last name of the user	read-only
userName	string	Username of the user	read-only

Example

{
  "displayName": "John Doe",
  "email": "string",
  "firstName": "John",
  "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
  "lastName": "Doe",
  "userName": "string"
}

PlatformUsersListResult

Returns a JSON object with data and @nextLink properties. data contains a list of PlatformUser objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[PlatformUser]	Details about the user, including their name, ID, and email address

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "displayName": "John Doe",
      "email": "string",
      "firstName": "John",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
      "lastName": "Doe",
      "userName": "string"
    }
  ]
}