Jump to

• Request
• Response

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: string
  ID of the user profile to be updated.

Body ()

Root Schema : updateAdminProfile_request

Type: object

Show Source

• active(optional): boolean
  True if the user is active; false if the user is deactivated.
• email(optional): string
  Email address for user profile. This will also be used as the login property of the newly created user.
• firstName(optional): string
  First (given) name of the new user.
• lastName(optional): string
  Last name (surname) of the new user.
• roles(optional): array roles
  Array of roles to assign to this profile.

{
    "properties":{
        "firstName":{
            "description":"First (given) name of the new user.",
            "type":"string"
        },
        "lastName":{
            "description":"Last name (surname) of the new user.",
            "type":"string"
        },
        "roles":{
            "description":"Array of roles to assign to this profile.",
            "type":"array",
            "items":{
                "description":"Repository ID of role.",
                "type":"string"
            }
        },
        "active":{
            "description":"True if the user is active; false if the user is deactivated.",
            "type":"boolean"
        },
        "email":{
            "description":"Email address for user profile. This will also be used as the login property of the newly created user.",
            "type":"string"
        }
    },
    "example":{
        "firstName":"Amber",
        "lastName":"Admin",
        "active":true,
        "email":"[e-mail]"
    }
}

Example:

{
    "firstName":"Amber",
    "lastName":"Admin",
    "active":true,
    "email":"[e-mail]"
}

Nested Schema : roles

Type: array

Array of roles to assign to this profile.

Show Source

• Array of: string
  Repository ID of role.

{
    "description":"Array of roles to assign to this profile.",
    "type":"array",
    "items":{
        "description":"Repository ID of role.",
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateAdminProfile_response

Type: object

Show Source

• active(optional): boolean
  True if the user is active; false if the user is deactivated.
• email(optional): string
  Email address and login name of the profile.
• firstName(optional): string
  First name of the profile.
• id(optional): string
  ID of this profile.
• lastName(optional): string
  Last name of user.
• registrationDate(optional): string
  User's registration date.
• roles(optional): array roles
  Array of roles assigned to this profile.
• tourComplete(optional): boolean
  True if the user has completed the walk-through tour of the admin product.

{
    "properties":{
        "lastName":{
            "description":"Last name of user.",
            "type":"string"
        },
        "firstName":{
            "description":"First name of the profile.",
            "type":"string"
        },
        "tourComplete":{
            "description":"True if the user has completed the walk-through tour of the admin product.",
            "type":"boolean"
        },
        "roles":{
            "description":"Array of roles assigned to this profile.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of role.",
                        "type":"string"
                    }
                }
            }
        },
        "registrationDate":{
            "description":"User's registration date.",
            "type":"string"
        },
        "active":{
            "description":"True if the user is active; false if the user is deactivated.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of this profile.",
            "type":"string"
        },
        "email":{
            "description":"Email address and login name of the profile.",
            "type":"string"
        }
    }
}

Nested Schema : roles

Type: array

Array of roles assigned to this profile.

Show Source

• Array of: object items

{
    "description":"Array of roles assigned to this profile.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository ID of role.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  Repository ID of role.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of role.",
            "type":"string"
        }
    }
}

Example Response (application/json)

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

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top