Jump to

• Request
• Response
• Examples

Get Factor Enrollment Status

get

/mfa/v1/users/{userGUID}/factors/{factorId}

Request

Path Parameters

• factorId: string
  Unique identifier of an enrolled factor. In case of SECURITY_QUESTIONS method, the factorId is set to 'SecurityQuestions'.
• userGUID: string
  Unique identifier of a user

Header Parameters

• Authorization: string
  Provide a valid OAuth Access Token that has the 'MFA Client' scope.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body

Example Response (application/jsocon)

{
    "status":"success",
    "factorId":"8ff0e0b725164fb8a2ac8da1321c5eb9",
    "factorStatus":"ENROLLED",
    "methods":[
        "TOTP",
        "PUSH"
    ]
}

Back to Top

Examples

The following example shows how to retrieve the status of the activation of an Online TOTP or PUSH Notification enrollment by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

Note:

There is an Oracle Identity Cloud Service Factor Enrollment Postman collection available. Download the collection and example environment with variables from the idcs-factor-enrollment-api folder within GitHub and import them into a REST client.

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.

curl
-X GET
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/mfa/v1/users/{userGUID}/factors/{factorId}

Example of a Response Body

The following example shows the example response body in JSON format when polling for the status of the activation of an Online TOTP or PUSH Notification enrollment:

Pending Status

{
    "status": "pending",
    "factorId": "a5286a1014a34043b4cce16eca806029",
    "factorStatus": "ENROLLMENT_INITIATED"
}

Enrolled Status

{
    "status": "success",
    "factorId": "6b6bb140859f4b98bf8de23090fb2eeb",
    "factorStatus": "ENROLLED",
    "methods": [
        "PUSH",
        "TOTP"
    ]
}

Back to Top