REST API for Oracle Commerce Cloud December 2017

createAdminProfile

post

/ccadmin/v1/adminProfiles/

Create Admin Profile. Creates a new admin user profile.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : createAdminProfile_request

Example


{
    "firstName":"Amber",
    "lastName":"Admin",
    "roles":[
        "adminRole"
    ],
    "active":true,
    "email":"amber@example.com"
}

Properties

active: Type: boolean

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

Required: true

Email address for user profile. This will also be used as the login property of the newly created user.
firstName: Type: string

Required: true

First (given) name of the new user.
lastName: Type: string

Required: true

Last name (surname) of the new user.
roles: Type: array roles

Additional Properties Allowed:

Array of roles assigned to this profile.

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.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createAdminProfile_response

Properties

id: Type: string

The ID of the newly created profile.

Example application/json


{
    "id":"iuser10060"
}

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 Request:

{
  "firstName": "Amber",
  "lastName": "Admin",
  "roles": ["adminRole"],
  "active": true,
  "email": "amber@example.com"
}

Sample Response Payload returned by endpoint:

{"id": "iuser10060"}