PingOne Platform APIs

Update Administrator Security (External IdP)

 

PUT {{apiPath}}/environments/{{envID}}/adminConfig

This PUT {{apiPath}}/environment/{{envID}}/adminConfig operation updates the administrator sign-on configuration to use an external IdP for PingOne admin sign-ons. Set the authenticationMethod, and (optionally) the provider.id properties to use an external IdP.

Request Model
Property Type Required?

allowedMethods

Object

Optional

authenticationMethod

String

Required

mfaStatus

String

Required

provider.id

UUID

Optional

recovery

Boolean

Required

Refer to the Administrator security data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "authenticationMethod": "EXTERNAL",
    "recovery": true,
    "mfaStatus": "ENFORCE",
    "provider": {
        "id": "{{providerID}}"
    }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/adminConfig' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "authenticationMethod": "EXTERNAL",
    "recovery": true,
    "mfaStatus": "ENFORCE",
    "provider": {
        "id": "{{providerID}}"
    }
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/adminConfig")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""authenticationMethod"": ""EXTERNAL""," + "\n" +
@"    ""recovery"": true," + "\n" +
@"    ""mfaStatus"": ""ENFORCE""," + "\n" +
@"    ""provider"": {" + "\n" +
@"        ""id"": ""{{providerID}}""" + "\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}}/adminConfig"
  method := "PUT"

  payload := strings.NewReader(`{
    "authenticationMethod": "EXTERNAL",
    "recovery": true,
    "mfaStatus": "ENFORCE",
    "provider": {
        "id": "{{providerID}}"
    }
}`)

  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))
}
PUT /environments/{{envID}}/adminConfig HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "authenticationMethod": "EXTERNAL",
    "recovery": true,
    "mfaStatus": "ENFORCE",
    "provider": {
        "id": "{{providerID}}"
    }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"authenticationMethod\": \"EXTERNAL\",\n    \"recovery\": true,\n    \"mfaStatus\": \"ENFORCE\",\n    \"provider\": {\n        \"id\": \"{{providerID}}\"\n    }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/adminConfig")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/adminConfig",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "authenticationMethod": "EXTERNAL",
    "recovery": true,
    "mfaStatus": "ENFORCE",
    "provider": {
      "id": "{{providerID}}"
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/adminConfig',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "authenticationMethod": "EXTERNAL",
    "recovery": true,
    "mfaStatus": "ENFORCE",
    "provider": {
      "id": "{{providerID}}"
    }
  })

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

url = "{{apiPath}}/environments/{{envID}}/adminConfig"

payload = json.dumps({
  "authenticationMethod": "EXTERNAL",
  "recovery": True,
  "mfaStatus": "ENFORCE",
  "provider": {
    "id": "{{providerID}}"
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/adminConfig');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "authenticationMethod": "EXTERNAL",\n    "recovery": true,\n    "mfaStatus": "ENFORCE",\n    "provider": {\n        "id": "{{providerID}}"\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}}/adminConfig")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "authenticationMethod": "EXTERNAL",
  "recovery": true,
  "mfaStatus": "ENFORCE",
  "provider": {
    "id": "{{providerID}}"
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"authenticationMethod\": \"EXTERNAL\",\n    \"recovery\": true,\n    \"mfaStatus\": \"ENFORCE\",\n    \"provider\": {\n        \"id\": \"{{providerID}}\"\n    }\n}"
let postData = parameters.data(using: .utf8)

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

request.httpMethod = "PUT"
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

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/adminConfig"
        }
    },
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "authenticationMethod": "EXTERNAL",
    "recovery": true,
    "provider": {
        "id": "52f6dd18-c4e6-48c2-8037-74b569625bae"
    },
    "mfaStatus": "ENFORCE",
    "allowedMethods": {
        "EMAIL": "{\"enabled\":true}",
        "TOTP": "{\"enabled\":true}",
        "FIDO2": "{\"enabled\":true}"
    },
    "hasFido2Capabilities": true,
    "isPingIDInBOM": true,
    "createdAt": "2024-09-18T20:31:16.671Z",
    "updatedAt": "2025-02-26T18:14:05.897Z"
}