PingOne Platform APIs

Step 6: Create a sign-on policy MFA action

POST {{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions

This step associates a sign-on policy action with the new sign-on policy you created in Step 5. The POST {{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions operation creates the sign-on policy action resource, which is associated with the sign-on policy ({{policyID}}) specified in the request URL.

PingOne includes a MULTI_FACTOR_AUTHENTICATION sign-on policy action type that can return multiple status conditions, which result in more than one operation to complete the sign-on flow.

For a sign-on action that supports a multi-factor authentication action, the sign-on policy action must enable at least one MFA device type. This use case enables the authenticator device type option, and it disables the sms and email device types.

In this sample, the priority property is set to 10, which indicates that this action is not set to the highest priority and might not be the first sign-on policy action executed, if there ares more than one sign-on policy actions associated with the sign-on policy.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "priority": 10,
    "type": "MULTI_FACTOR_AUTHENTICATION",
    "condition": {
        "anonymousNetwork": [
            "1.1.1.1/10"
        ],
        "valid": "${flow.request.http.remoteIp}"
    },
    "recovery": {
        "enabled": false
    },
    "authenticator": {
        "enabled": true
    },
    "email": {
        "enabled": false
    },
    "sms": {
        "enabled": false
    },
    "applications": [
        {
            "id": "{{mfaNativeAppId}}",
            "autoEnrollment": {
                "enabled": true
            },
            "deviceAuthorization": {
                "enabled": true,
                "extraVerification": "permissive"
            }
        }
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "priority": 10,
    "type": "MULTI_FACTOR_AUTHENTICATION",
    "condition": {
        "anonymousNetwork": [
            "1.1.1.1/10"
        ],
        "valid": "${flow.request.http.remoteIp}"
    },
    "recovery": {
        "enabled": false
    },
    "authenticator": {
        "enabled": true
    },
    "email": {
        "enabled": false
    },
    "sms": {
        "enabled": false
    },
    "applications": [
        {
            "id": "{{mfaNativeAppId}}",
            "autoEnrollment": {
                "enabled": true
            },
            "deviceAuthorization": {
                "enabled": true,
                "extraVerification": "permissive"
            }
        }
    ]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""priority"": 10," + "\n" +
@"    ""type"": ""MULTI_FACTOR_AUTHENTICATION""," + "\n" +
@"    ""condition"": {" + "\n" +
@"        ""anonymousNetwork"": [" + "\n" +
@"            ""1.1.1.1/10""" + "\n" +
@"        ]," + "\n" +
@"        ""valid"": ""${flow.request.http.remoteIp}""" + "\n" +
@"    }," + "\n" +
@"    ""recovery"": {" + "\n" +
@"        ""enabled"": false" + "\n" +
@"    }," + "\n" +
@"    ""authenticator"": {" + "\n" +
@"        ""enabled"": true" + "\n" +
@"    }," + "\n" +
@"    ""email"": {" + "\n" +
@"        ""enabled"": false" + "\n" +
@"    }," + "\n" +
@"    ""sms"": {" + "\n" +
@"        ""enabled"": false" + "\n" +
@"    }," + "\n" +
@"    ""applications"": [" + "\n" +
@"        {" + "\n" +
@"            ""id"": ""{{mfaNativeAppId}}""," + "\n" +
@"            ""autoEnrollment"": {" + "\n" +
@"                ""enabled"": true" + "\n" +
@"            }," + "\n" +
@"            ""deviceAuthorization"": {" + "\n" +
@"                ""enabled"": true," + "\n" +
@"                ""extraVerification"": ""permissive""" + "\n" +
@"            }" + "\n" +
@"        }" + "\n" +
@"    ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions"
  method := "POST"

  payload := strings.NewReader(`{
    "priority": 10,
    "type": "MULTI_FACTOR_AUTHENTICATION",
    "condition": {
        "anonymousNetwork": [
            "1.1.1.1/10"
        ],
        "valid": "${flow.request.http.remoteIp}"
    },
    "recovery": {
        "enabled": false
    },
    "authenticator": {
        "enabled": true
    },
    "email": {
        "enabled": false
    },
    "sms": {
        "enabled": false
    },
    "applications": [
        {
            "id": "{{mfaNativeAppId}}",
            "autoEnrollment": {
                "enabled": true
            },
            "deviceAuthorization": {
                "enabled": true,
                "extraVerification": "permissive"
            }
        }
    ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
POST /environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "priority": 10,
    "type": "MULTI_FACTOR_AUTHENTICATION",
    "condition": {
        "anonymousNetwork": [
            "1.1.1.1/10"
        ],
        "valid": "${flow.request.http.remoteIp}"
    },
    "recovery": {
        "enabled": false
    },
    "authenticator": {
        "enabled": true
    },
    "email": {
        "enabled": false
    },
    "sms": {
        "enabled": false
    },
    "applications": [
        {
            "id": "{{mfaNativeAppId}}",
            "autoEnrollment": {
                "enabled": true
            },
            "deviceAuthorization": {
                "enabled": true,
                "extraVerification": "permissive"
            }
        }
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"priority\": 10,\n    \"type\": \"MULTI_FACTOR_AUTHENTICATION\",\n    \"condition\": {\n        \"anonymousNetwork\": [\n            \"1.1.1.1/10\"\n        ],\n        \"valid\": \"${flow.request.http.remoteIp}\"\n    },\n    \"recovery\": {\n        \"enabled\": false\n    },\n    \"authenticator\": {\n        \"enabled\": true\n    },\n    \"email\": {\n        \"enabled\": false\n    },\n    \"sms\": {\n        \"enabled\": false\n    },\n    \"applications\": [\n        {\n            \"id\": \"{{mfaNativeAppId}}\",\n            \"autoEnrollment\": {\n                \"enabled\": true\n            },\n            \"deviceAuthorization\": {\n                \"enabled\": true,\n                \"extraVerification\": \"permissive\"\n            }\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "priority": 10,
    "type": "MULTI_FACTOR_AUTHENTICATION",
    "condition": {
      "anonymousNetwork": [
        "1.1.1.1/10"
      ],
      "valid": "${flow.request.http.remoteIp}"
    },
    "recovery": {
      "enabled": false
    },
    "authenticator": {
      "enabled": true
    },
    "email": {
      "enabled": false
    },
    "sms": {
      "enabled": false
    },
    "applications": [
      {
        "id": "{{mfaNativeAppId}}",
        "autoEnrollment": {
          "enabled": true
        },
        "deviceAuthorization": {
          "enabled": true,
          "extraVerification": "permissive"
        }
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "priority": 10,
    "type": "MULTI_FACTOR_AUTHENTICATION",
    "condition": {
      "anonymousNetwork": [
        "1.1.1.1/10"
      ],
      "valid": "${flow.request.http.remoteIp}"
    },
    "recovery": {
      "enabled": false
    },
    "authenticator": {
      "enabled": true
    },
    "email": {
      "enabled": false
    },
    "sms": {
      "enabled": false
    },
    "applications": [
      {
        "id": "{{mfaNativeAppId}}",
        "autoEnrollment": {
          "enabled": true
        },
        "deviceAuthorization": {
          "enabled": true,
          "extraVerification": "permissive"
        }
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions"

payload = json.dumps({
  "priority": 10,
  "type": "MULTI_FACTOR_AUTHENTICATION",
  "condition": {
    "anonymousNetwork": [
      "1.1.1.1/10"
    ],
    "valid": "${flow.request.http.remoteIp}"
  },
  "recovery": {
    "enabled": False
  },
  "authenticator": {
    "enabled": True
  },
  "email": {
    "enabled": False
  },
  "sms": {
    "enabled": False
  },
  "applications": [
    {
      "id": "{{mfaNativeAppId}}",
      "autoEnrollment": {
        "enabled": True
      },
      "deviceAuthorization": {
        "enabled": True,
        "extraVerification": "permissive"
      }
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "priority": 10,\n    "type": "MULTI_FACTOR_AUTHENTICATION",\n    "condition": {\n        "anonymousNetwork": [\n            "1.1.1.1/10"\n        ],\n        "valid": "${flow.request.http.remoteIp}"\n    },\n    "recovery": {\n        "enabled": false\n    },\n    "authenticator": {\n        "enabled": true\n    },\n    "email": {\n        "enabled": false\n    },\n    "sms": {\n        "enabled": false\n    },\n    "applications": [\n        {\n            "id": "{{mfaNativeAppId}}",\n            "autoEnrollment": {\n                "enabled": true\n            },\n            "deviceAuthorization": {\n                "enabled": true,\n                "extraVerification": "permissive"\n            }\n        }\n    ]\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "priority": 10,
  "type": "MULTI_FACTOR_AUTHENTICATION",
  "condition": {
    "anonymousNetwork": [
      "1.1.1.1/10"
    ],
    "valid": "\${flow.request.http.remoteIp}"
  },
  "recovery": {
    "enabled": false
  },
  "authenticator": {
    "enabled": true
  },
  "email": {
    "enabled": false
  },
  "sms": {
    "enabled": false
  },
  "applications": [
    {
      "id": "{{mfaNativeAppId}}",
      "autoEnrollment": {
        "enabled": true
      },
      "deviceAuthorization": {
        "enabled": true,
        "extraVerification": "permissive"
      }
    }
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"priority\": 10,\n    \"type\": \"MULTI_FACTOR_AUTHENTICATION\",\n    \"condition\": {\n        \"anonymousNetwork\": [\n            \"1.1.1.1/10\"\n        ],\n        \"valid\": \"${flow.request.http.remoteIp}\"\n    },\n    \"recovery\": {\n        \"enabled\": false\n    },\n    \"authenticator\": {\n        \"enabled\": true\n    },\n    \"email\": {\n        \"enabled\": false\n    },\n    \"sms\": {\n        \"enabled\": false\n    },\n    \"applications\": [\n        {\n            \"id\": \"{{mfaNativeAppId}}\",\n            \"autoEnrollment\": {\n                \"enabled\": true\n            },\n            \"deviceAuthorization\": {\n                \"enabled\": true,\n                \"extraVerification\": \"permissive\"\n            }\n        }\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{mfaPolicyID}}/actions")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

201 Created

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/5e62de2f-6aca-4d17-89b1-608ac4099187/actions/e0d26436-062f-48f4-9cb8-0ac23443ab16"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "signOnPolicy": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/5e62de2f-6aca-4d17-89b1-608ac4099187"
        }
    },
    "id": "e0d26436-062f-48f4-9cb8-0ac23443ab16",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "type": "MULTI_FACTOR_AUTHENTICATION",
    "condition": {
        "anonymousNetwork": [
            "1.1.1.1/10"
        ],
        "valid": "${flow.request.http.remoteIp}"
    },
    "signOnPolicy": {
        "id": "5e62de2f-6aca-4d17-89b1-608ac4099187"
    },
    "priority": 10,
    "sms": {
        "enabled": false
    },
    "authenticator": {
        "enabled": true
    },
    "email": {
        "enabled": false
    },
    "applications": [
        {
            "id": "be32b8c6-dfe0-4a6c-a5a6-4cce5907d6ea",
            "autoEnrollment": {
                "enabled": true
            },
            "push": {
                "enabled": false
            },
            "otp": {
                "enabled": true
            },
            "deviceAuthorization": {
                "enabled": true,
                "extraVerification": "permissive"
            }
        }
    ]
}