REST API for Oracle Commerce Cloud December 2017

resetAuthenticatorKey

post

/ccadmin/v1/adminProfiles/resetAuthenticatorKey

Authenticated endpoint that will reset a user's authenticator (secret) key. This is only callable by Administrator users.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : resetAuthenticatorKey_request

Example


{
    "email":"amber@example.com"
}

Properties

email: Type: string

Email address for user profile whose secret key will be reset.

Response

Supported Media Types

application/json

200 Response

The following model is returned when the operation succeeds.

Body

Root Schema : resetAuthenticatorKey_response

Properties

success: Type: boolean

True if the secret key was reset successfully, false if not.

Example 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| |------------------|------------------| |83072|Unable to get the hostname for key generation.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{"email": "amber@example.com"}

Sample Response Payload returned by endpoint:

{"success": "true"}