Jump to

• Request
• Response

createAdminProfile

post

/ccadmin/v1/adminProfiles/

Create Admin Profile. Creates a new admin user profile.

Request

Supported Media Types

• application/json

Body ()

Root Schema : createAdminProfile_request

Type: object

Show Source

• active(optional): boolean
  True if the user is active; false if the user is deactivated.
• email: string
  Email address for user profile. This will also be used as the login property of the newly created user.
• firstName: string
  First (given) name of the new user.
• lastName: 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"
        }
    },
    "required":[
        "firstName",
        "lastName",
        "email"
    ],
    "example":{
        "firstName":"Amber",
        "lastName":"Admin",
        "roles":[
            "adminRole"
        ],
        "active":true,
        "email":"[e-mail]"
    }
}

Example:

{
    "firstName":"Amber",
    "lastName":"Admin",
    "roles":[
        "adminRole"
    ],
    "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 : createAdminProfile_response

Type: object

Show Source

• id(optional): string
  The ID of the newly created profile.

{
    "properties":{
        "id":{
            "description":"The ID of the newly created profile.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "id":"iuser10060"
}

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