REST API to Enable MFA in Oracle Access Manager

Enable/Disable TOTP based MFA

put

oam/services/rest/access/api/v1/control/feature

The configuration at the requested path is used to set mfa enable flag for TOTP based MFA

Request

Supported Media Types

text/xml, application/xml

Root Schema : componentType

Type: object

Show Source

componentType(required): string

The provided configuration updates the componenttype to TOTP.

{
    "type":"object",
    "properties":{
        "componentType":{
            "type":"string",
            "description":"The provided configuration updates the componenttype to TOTP. "
        }
    },
    "required":[
        "componentType"
    ]
}

Response

Supported Media Types

201 Response

Path of the modified configuration

Root Schema : schema

Type: string(*/*)

404 Response

Error

Root Schema : errorresponse

Type: object

Show Source

errorCode: string
errorDesc: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

Examples

The following example shows sample request to enable MFA in OAM.

Sample Request

curl -X PUT \
https://<ManagedServerHost>:<ManagedServerPort>/oam/services/rest/access/api/v1/control/feature?state=enable&componentName=mfa \
-H 'Accept: application/json' \
-H 'Authorization: Basic dGVzdDp0ZXN0=' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \