Jump to

• Request
• Response

registerAdmin

post

/ccadmin/v1/adminRegister

Register Admin. Endpoint to initiate and confirm regisration of admin users.Auth token should be set in Authorization header

Request

Supported Media Types

• application/json

Body ()

Root Schema : registerAdmin_request

Type: object

Show Source

• confirmPassword: string
  Confirm password to set for the admin account(required to confirm user)
• op(required): string
  operation
• password: string
  Password to set for the admin account(required to confirm user)
• token(required): string
  oAuth token
• userName: string
  userName of the admin account(required to confirm user)

{
    "properties":{
        "op":{
            "description":"operation",
            "type":"string"
        },
        "password":{
            "description":"Password to set for the admin account(required to confirm user)",
            "type":"string"
        },
        "confirmPassword":{
            "description":"Confirm password to set for the admin account(required to confirm user)",
            "type":"string"
        },
        "userName":{
            "description":"userName of the admin account(required to confirm user)",
            "type":"string"
        },
        "token":{
            "description":"oAuth token",
            "type":"string"
        }
    },
    "required":[
        "op",
        "token"
    ],
    "example":{
        "op":"validateToken",
        "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0Mzk0NDIxNzAsInN1YiI6ImFkbWluIiwiaXNzIjoicmVnaXN0ZXJBZG1pbiIsImlhdCI6MTQzODgzNzM3MH0%253D.I5DjhUEgvKiWYjEHWTiax3QRGt7er%252BkqrJHW%252F1w9Z5I%253D"
    }
}

Example:

{
    "op":"validateToken",
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0Mzk0NDIxNzAsInN1YiI6ImFkbWluIiwiaXNzIjoicmVnaXN0ZXJBZG1pbiIsImlhdCI6MTQzODgzNzM3MH0%253D.I5DjhUEgvKiWYjEHWTiax3QRGt7er%252BkqrJHW%252F1w9Z5I%253D"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : registerAdmin_response

Type: object

Show Source

• success: boolean
  operation status

{
    "properties":{
        "success":{
            "description":"operation status",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

{
    "success":"true"
}

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| |------------------|------------------| |83008|Invalid operation.| |83009|Invalid token| |83004|Error in input parameters. (Required parameters are missing)| |83003|Internal error| |83000|Register admin initiate error.| |83011|Token expired| |83010|User already registered| |83002|Error occurred while confirming user| |83013|User name provided is invalid| |83012|New password and confirm password did not match|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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