Step 1: Initiate Offline OTP Enrollment

POST {{HOST}}/admin/v1/MyAuthenticationFactorEnroller

Prerequisites for this step: - Use the 'Obtain ME access_token' to obtain a valid access token. - Use 'Get my information' to obtain the user 'id' value.

In the request, the client must pass the following attributes:

  • value: the id of the user returned in 'Get My Information'
  • $ref: the hostname of the tenant and the value for id returned in 'Get my information'

In the response, the deviceId and requestId are passed in the next step. The value for qrCodeContent should be decoded using a base64 decoder: https://www.base64decode.org/

The decoded string should then be entered in a QR Code Generator: https://www.the-qrcode-generator.com/

Scan the QR code generated with an authenticator such as Oracle Mobile Authenticator.

The otpCode generated is passed in the request in step 2.

Request Body

{"schemas"=>["urn:ietf:params:scim:schemas:oracle:idcs:AuthenticationFactorEnroller"], "user"=>{"value"=>"4d7ef2bed0e64ab9befa13bddf0e7440", "$ref"=>"https://example.identitycloud.com/admin/v1/Users/4d7ef2bed0e64ab9befa13bddf0e7440"}, "authnFactors"=>["TOTP"], "isDeviceOffline"=>true}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring

RESPONSES

status: Created

{"schemas":["urn:ietf:params:scim:schemas:oracle:idcs:AuthenticationFactorEnroller"],"user":{"value":"4d7ef2bed0e64ab9befa13bddf0e7440","$ref":"https://example.idetitycloud.com/admin/v1/Users/4d7ef2bed0e64ab9befa13bddf0e7440"},"authnFactors":["TOTP"],"isDeviceOffline":true,"meta":{"resourceType":"MyAuthenticationFactorEnroller","location":"https://example.idetitycloud.com/admin/v1/MyAuthenticationFactorEnroller"},"deviceId":"ddbeca400f5841bd82e0a324068e1b0b","displayName":"Joe's Phone","requestId":"30f61b36-a942-4db1-bca6-fbc63003190a","qrCodeImgContent":"aVZCT1J3MEtHZ29BQUFBTlNVaEVVZ0FBQVBv.......QUFBQUJKUlU1RXJrSmdnZz09","qrCodeContent":"b3RwYXV0aDovL3RvdHAvcmhvZGdzb............JMZW5ndGg9MjA0OCZTU0U9QmFzZTMy","qrCodeImgType":"PNG"}