REST API for Oracle Commerce Cloud December 2017

updateAdminProfile

put

/ccadmin/v1/adminProfiles/{id}

Update Admin Profile. Updates a given admin user profile by id.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

ID of the user profile to be updated.

Body Parameter

Root Schema : updateAdminProfile_request

Example


{
    "firstName":"Amber",
    "lastName":"Admin",
    "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

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

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

Last name (surname) of the new user.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateAdminProfile_response

Properties

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


{
    "lastName":"Admin",
    "firstName":"Amber",
    "tourComplete":true,
    "roles":[
        {
            "repositoryId":"adminRole"
        }
    ],
    "registrationDate":"2014-09-25 14:33:49.68",
    "active":true,
    "id":"iuser260015",
    "email":"amber@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 Request:

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

Sample Response Payload returned by endpoint:

{
  "lastName": "Admin",
  "firstName": "Amber",
  "tourComplete": true,
  "roles": [{"repositoryId": "adminRole"}],
  "registrationDate": "2014-09-25 14:33:49.68",
  "active": true,
  "id": "iuser260015",
  "email": "amber@example.com"
}