PingOne Platform APIs

Read Environment Capabilities

 

GET {{apiPath}}/environments/{{envID}}/capabilities

Use the GET {{apiPath}}/environments/{{envID}}/capabilities operation to return the specified environment’s current capabilities.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/capabilities' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/capabilities")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/environments/{{envID}}/capabilities"
  method := "GET"

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

  if err != nil {
    fmt.Println(err)
    return
  }
  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))
}
GET /environments/{{envID}}/capabilities HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/capabilities")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/capabilities",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/capabilities',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

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

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/capabilities');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
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 "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/capabilities")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/capabilities")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

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/capabilities"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "canAddResources": true,
    "canAssignUsersRoles": true,
    "canContactSupport": true,
    "canCreateConnections": true,
    "canCreateCustomDomain": true,
    "canPromoteToProd": true,
    "canSendMfaNotificationsOutsideWhitelist": true,
    "canSendPasswordManagementNotifications": true,
    "canSendVerificationFlowNotifications": true,
    "canUseAamva": true,
    "canUseAamvaTransactions": false,
    "canUseAccountProtection": false,
    "canUseAccountTakeoverDetection": false,
    "canUseApiAccessManagement": true,
    "canUseBotMaliciousDeviceDetection": false,
    "canUseCredentialSharingDetection": false,
    "canUseCredentials": false,
    "canUseCredentialsPushNotifications": false,
    "canUseCustomSchema": true,
    "canUseDaVinciAdminPortal": true,
    "canUseDataAnalyticsSupport": true,
    "canUseDigitalVerifications": false,
    "canUseDocumentMatch": true,
    "canUseDynamicAuthorization": true,
    "canUseEmailOtp": true,
    "canUseFaceMatch": true,
    "canUseFraudDataEnrichment": false,
    "canUseIdentities": true,
    "canUseIdentityProviders": true,
    "canUseInboundProvisioning": true,
    "canUseIntelligence": true,
    "canUseIntelligenceAdvancedPredictors": true,
    "canUseIntelligenceAnonymousNetworkDetection": true,
    "canUseIntelligenceDataConsent": true,
    "canUseIntelligenceGeoVelocity": true,
    "canUseIntelligenceProtect": true,
    "canUseIntelligenceReputation": true,
    "canUseIntelligenceRisk": true,
    "canUseKerberosGateway": true,
    "canUseLdapGateway": true,
    "canUseManualIDStepUpInspection": false,
    "canUseManualIdInspection": false,
    "canUseMfa": true,
    "canUseMfaFido2Devices": true,
    "canUseMfaPushNotifications": true,
    "canUseMfaVoiceOtp": true,
    "canUseMyAccount": true,
    "canUseNewAccountFraudDetection": false,
    "canUseOrchestration": true,
    "canUsePasswordManagement": true,
    "canUsePasswordOnlyAuthentication": true,
    "canUsePasswordPolicy": true,
    "canUsePlatform": true,
    "canUseProtectTransactions": false,
    "canUseProvisioning": true,
    "canUseRadiusGateway": true,
    "canUseSmsOtp": true,
    "canUseTotp": true,
    "canUseUniversalCapture": false,
    "canUseVerificationFlow": true,
    "canUseVerify": true,
    "canUseVerifyPushNotifications": true,
    "canUseVerifyVoice": true,
    "canUseVoiceBiometrics": false,
    "canUsersUpdateSelf": true,
    "environmentId": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
}