REST API for Oracle Commerce Cloud December 2017

getAuthenticatorInfo

post

/ccadmin/v1/adminProfiles/getAuthenticatorInfo

Gets authenticator info based on the provided token.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : getAuthenticatorInfo_request

Example


{
    "token":"sampleToken123123123"
}

Properties

token: Type: string

Token representing the authenticator information to fetch.

Response

Supported Media Types

application/json

200 Response

The following model is returned when the operation succeeds.

Body

Root Schema : getAuthenticatorInfo_response

Properties

omaLink: Type: string

Oracle Mobile Authenticator (OMA) application-specific link to create an entry in OMA.
qrCodeLink: Type: string

Link to a QR code representation of the OMA link.
secretKey: Type: string

Key that can be used to manually create an entry in an authenticator application.

Example application/json


{
    "omaLink":"oraclemobileauthenticator://settings?AccountName::=hostname/sample.user@example.com&SharedSecretValue::=1234567890ABCDEFGHIJKLMNOPQRUSTV",
    "secretKey":"1234567890ABCDEFGHIJKLMNOPQRUSTV",
    "omaQRCodeLink":"http://www.example.com/qr?code=oraclemobileauthenticator://settings?AccountName::=hostname/sample.user@example.com&SharedSecretValue::=1234567890ABCDEFGHIJKLMNOPQRUSTV"
}

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| |------------------|------------------| |83045|Unable to find authenticator information for the token provided.|

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:

{"token": "sampleToken123123123"}

Sample Response Payload returned by endpoint:

{
  "omaLink": "oraclemobileauthenticator://settings?AccountName::=hostname/sample.user@example.com&SharedSecretValue::=1234567890ABCDEFGHIJKLMNOPQRUSTV",
  "secretKey": "1234567890ABCDEFGHIJKLMNOPQRUSTV",
  "omaQRCodeLink": "http://www.example.com/qr?code=oraclemobileauthenticator://settings?AccountName::=hostname/sample.user@example.com&SharedSecretValue::=1234567890ABCDEFGHIJKLMNOPQRUSTV"
}