Get Users
List the existing users. Only admin users can retrieve this information. This action is currently restricted to users mapped through VMware Identity Manager
Request
URLURL
https://vrni.example.com/api/ni/settings/users
Query Parameters
Query Parameters
string
cursor
Optional
Cursor from previous response
number
size
Optional
Page size of results
string
type
Required
Type of user
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
PagedUserListResponse of type(s) application/json
{
"cursor": "MTA=",
"results": [
{
"display_name": "alley martin",
"domain": "vidmlabs.com",
"id": "alleymartin123@vidmlabs.com",
"role": "ADMIN",
"user_type": "VIDM",
"username": "alleyMartin123"
}
],
"total_count": 101
}
string
cursor
Optional
This property has no documentation
integer
total_count
Optional
This property has no documentation
Errors
500
Internal Error
Code Samples
cURL Command
curl https://vrni.example.com/api/ni/settings/users?type=string
On This Page
Settings Operations
post
post
post
post
post
post
post
delete
delete
delete
delete
delete
delete
delete
delete
delete
delete
post
post
get
get
get
get
get
get
get
get
get
get
get
post
put
