Step 1: Initiate SMS Enrollment
POST {{HOST}}/admin/v1/MyAuthenticationFactorEnroller
This step requests to enroll in the SMS factor.
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 value for id returned in 'Get my information' displayName: display name for the device countryCode: country code for the mobile phone number phoneNumber: the mobile phone number
In the response deviceId and requestId should be passed in the next step.
Request Body
{"schemas"=>["urn:ietf:params:scim:schemas:oracle:idcs:AuthenticationFactorEnroller"], "user"=>{"value"=>"c810ff4522eb437abac013291c1984d1"}, "displayName"=>"Joes's Personal Phone", "countryCode"=>"+44", "phoneNumber"=>"1122334455", "authnFactors"=>["SMS"]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Authorization | string |
RESPONSES
status: Created
{"schemas":["urn:ietf:params:scim:schemas:oracle:idcs:AuthenticationFactorEnroller"],"user":{"value":"c810ff4522eb437abac013291c1984d1","$ref":"https://example.identitycloud.com/admin/v1/Users/c810ff4522eb437abac013291c1984d1"},"displayName":"Joe's Personal Phone","countryCode":"+44","phoneNumber":"XXXXXXX455","authnFactors":["SMS"],"meta":{"resourceType":"MyAuthenticationFactorEnroller","location":"https://example.identitycloud.com/admin/v1/MyAuthenticationFactorEnroller"},"deviceId":"92142250e2ab4608b5c6532eb73e3d7c","requestId":"a0a7f9bf-13a8-43f3-bcc7-2087dc3f7a18o-o1548346179"}