listAdminProfiles

get

/ccadmin/v1/adminProfiles

List Admin Profiles. Returns a paged list of the admin user profiles in the system.

Request

Supported Media Types
Query Parameters
  • 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" ]
  • The number of items per block
  • startingIndex the index of the first to return
  • SCIM query to search on the internal profiles properties.
  • Sort Option id: Sort order
  • flag to include total count of items
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listAdminProfiles_response
Type: object
Show Source
Nested Schema : items
Type: array
list of profile items matching the query parameters
Show Source
Nested Schema : sort
Type: array
An array that specifies the sort order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : accessRights
Type: array
Access rights of the user
Show Source
Nested Schema : roles
Type: array
Array of roles assigned to this profile.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : accessRights
Type: array
Access rights assigned to the role
Show Source
Nested Schema : category
Type: array
Category of the role
Show Source
Nested Schema : securityCriteria
Type: array
Security criteria assigned to the role
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • Whether this property should be sorted ascending ("asc") or descending ("dsc").
  • 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|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top