listAdminProfiles
get
/ccadmin/v1/adminProfiles
List Admin Profiles. Returns a paged list of the admin user profiles in the system.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The number of items per block
-
offset(optional): integer
startingIndex the index of the first item to return
-
sort(optional): string
Sort Option id: Sort order
-
totalResults(optional): boolean
flag to include total count of items
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listAdminProfiles_response
Type:
Show Source
object
-
items(optional):
array items
list of profile items matching the query parameters
Nested Schema : items
Type:
Show Source
object
-
actions(optional):
array actions
Array of roles assigned to this profile.
-
active(optional):
boolean
True if the user is active; false if the user is deactivated.
-
email(optional):
string
Email address and login name of the profile.
-
firstName(optional):
string
First name of the profile.
-
id(optional):
string
ID of this profile.
-
lastName(optional):
string
Last name of user.
-
registrationDate(optional):
string
User's registration date.
-
roles(optional):
array roles
Array of roles assigned to this profile.
-
tourComplete(optional):
boolean
True if the user has completed the walk-through tour of the admin product.
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
Repository ID of role.
Example Response (application/json)
{
"total":10999,
"totalResults":10999,
"offset":100,
"limit":1,
"items":[
{
"lastName":"Smith",
"firstName":"Bob",
"tourComplete":true,
"roles":[
{
"repositoryId":"adminRole"
}
],
"registrationDate":"2014-09-24 13:50:00",
"active":true,
"id":"exampleuser1122",
"email":"bsmith@example.com"
}
]
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code