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
Root Schema : registerAdmin_request
Type:
Show Source
object
-
confirmPassword(optional):
string
Confirm password to set for the admin account(required to confirm user)
-
op:
string
operation
-
password(optional):
string
Password to set for the admin account(required to confirm user)
-
token:
string
oAuth token
-
userName(optional):
string
userName of the admin account(required to confirm user)
Example:
{
"op":"validateToken",
"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0Mzk0NDIxNzAsInN1YiI6ImFkbWluIiwiaXNzIjoicmVnaXN0ZXJBZG1pbiIsImlhdCI6MTQzODgzNzM3MH0%253D.I5DjhUEgvKiWYjEHWTiax3QRGt7er%252BkqrJHW%252F1w9Z5I%253D"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : registerAdmin_response
Type:
Show Source
object
-
success(optional):
boolean
operation status
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|
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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