REST API for Oracle Commerce Cloud December 2017

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: Type: integer

The number of items per block
offset: Type: integer

startingIndex the index of the first item to return
sort: Type: string

Sort Option id: Sort order
totalResults: Type: boolean

flag to include total count of items

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listAdminProfiles_response

Properties

items: Type: array items

Additional Properties Allowed:

list of profile items matching the query parameters

Nested Schema : items

Type: array

list of profile items matching the query parameters

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

actions: Type: array actions

Additional Properties Allowed:

Array of roles assigned to this profile.
active: Type: boolean

True if the user is active; false if the user is deactivated.
email: Type: string

Email address and login name of the profile.
firstName: Type: string

First name of the profile.
id: Type: string

ID of this profile.
lastName: Type: string

Last name of user.
registrationDate: Type: string

User's registration date.
roles: Type: array roles

Additional Properties Allowed:

Array of roles assigned to this profile.
tourComplete: Type: boolean

True if the user has completed the walk-through tour of the admin product.

Nested Schema : actions

Type: array

Array of roles assigned to this profile.

Items

Type: string

Nested Schema : roles

Type: array

Array of roles assigned to this profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository ID of role.

Example 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

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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"
  }]
}