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
-
expand: string
Expand query param: comma separated values that can be used to expand profile's roles and access rights information. Possible values for this query parameter are 'roles' and 'accessRights'Allowed Values:
[ "roles", "accessRights" ] -
limit: integer
The number of items per block
-
offset: integer
startingIndex the index of the first to return
-
q: string
SCIM query to search on the internal profiles properties.
-
sort: string
Sort Option id: Sort order
-
totalResults: 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:
array items
list of profile items matching the query parameters
-
limit:
string
Number of items to be fetched.
-
offset:
string
The offset provided.
-
sort:
array sort
An array that specifies the sort order.
-
total:
string
Total number of items matching the searched string.
-
totalResults:
string
Total number of items matching the searched string.
Nested Schema : items
Type:
Show Source
object-
accessRights:
array accessRights
Access rights of the user
-
active:
boolean
True if the user is active; false if the user is deactivated.
-
createdBy:
string
ID of the user that created this profile
-
email:
string
Email address and login name of the profile.
-
external:
boolean
True if the user was created externally
-
firstName:
string
First name of the profile.
-
id:
string
ID of this profile.
-
lastName:
string
Last name of the profile.
-
registrationDate:
string
User's registration date.
-
repositoryId:
string
Repository ID of this profile.
-
roles:
array roles
Array of roles assigned to this profile.
-
rolesLastModified:
string
Roles last modified timestamp.
-
tourComplete:
boolean
True if the user has completed the walk-through tour of the admin product.
Nested Schema : items
Type:
Show Source
object-
displayName:
string
Display name of the access right.
-
id:
string
ID of the access right.
-
repositoryId:
string
Repository ID of the access right.
-
type:
string
Type of the access right.
Nested Schema : items
Type:
Show Source
object-
accessRights:
array accessRights
Access rights assigned to the role
-
category:
array category
Category of the role
-
id:
string
ID of the role.
-
name:
string
Name of the role.
-
repositoryId:
string
Repository ID of the role.
-
securityCriteria:
array securityCriteria
Security criteria assigned to the role
Nested Schema : items
Type:
Show Source
object-
displayName:
string
Display name of the access right.
-
id:
string
ID of the access right.
-
repositoryId:
string
Repository ID of the access right.
-
type:
string
Type of the access right.
Nested Schema : items
Type:
Show Source
object-
displayName:
string
Display name of the role category.
-
id:
string
ID of the role category.
-
repositoryId:
string
Repository ID of the role category.
Nested Schema : items
Type:
Show Source
object-
id:
string
ID of the security criteria.
-
name:
string
Name of the security criteria.
-
repositoryId:
string
Repository ID of the security criteria.
Nested Schema : items
Type:
Show Source
object-
order:
string
Whether this property should be sorted ascending ("asc") or descending ("dsc").
-
property:
string
The name of the property to use for sorting.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":250,
"sort":[
{
"property":"id",
"order":"asc"
}
],
"items":[
{
"lastName":"Smith",
"firstName":"Bob",
"external":false,
"tourComplete":true,
"createdBy":"admin",
"roles":[
{
"repositoryId":"adminRole"
}
],
"repositoryId":"exampleuser1122",
"registrationDate":"2014-09-24T12:00:00.000Z",
"active":true,
"id":"exampleuser1122",
"rolesLastModified":"2021-02-22T12:00:00.000Z",
"email":"bsmith@example.com"
}
]
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100070|Invalid Query Expression|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code