1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Internal Profiles

updateAdminProfile

put

/ccadmin/v1/adminProfiles/{id}

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

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updateAdminProfile_request
Type: object
Show Source
Example:
{
    "firstName":"Amber",
    "lastName":"Admin",
    "roles":[
        "adminRole"
    ],
    "active":true,
    "email":"amber@example.com"
}
Nested Schema : roles
Type: array
Array of roles to assign to this profile.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateAdminProfile_response
Type: object
Show Source
Nested Schema : roles
Type: array
Array of roles assigned to this profile.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "lastName":"Admin",
    "firstName":"Amber",
    "external":false,
    "tourComplete":true,
    "createdBy":"admin",
    "roles":[
        {
            "repositoryId":"adminRole"
        }
    ],
    "repositoryId":"iuser260015",
    "registrationDate":"2014-09-24T12:00:00.000Z",
    "active":true,
    "id":"iuser260015",
    "rolesLastModified":"2021-02-22T12:00:00.000Z",
    "email":"amber@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| |------------------|------------------| |22000|If the profile id passed is null or empty| |22003|If the email passed is null or empty| |22006|If profile already exists| |22007|If invalid input is provided| |23001|If there was any internal error while updating the profile| |23006|If the email is invalid| |23012|If the last name passed is empty| |23013|If the first name passed is empty| |23037|If user tries to deactivate current logged in user| |89001|If invalid roles are provided| |89002|If the roles passed are null or empty| |89012|If the roles passed do not contain atleast one privilege| |89013|If user tries to remove admin privilege from self|
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