Capabilities


Capability declarations

The capabilities service provides operations to determine what an organization or an environment is capable of doing within PingOne with respect to:

  • The organization’s current PingOne for Customers license.

  • The current utilization of PingOne for Customers resources.

  • The current PingOne for Customers system limits.

Capabilities API operations

The capabilities endpoints support the following operations:

For hands-on experience with the capabilities API endpoints, click the Run in Postman button below to download a Postman collection that you can import and open in your local Postman application.

Organization capabilities data model

Property Description
assignableLicenses.allowProduction A boolean that specifies whether the license allows production environments.
assignableLicenses.id A string that specifies the license ID for a license that can be assigned to the organization.
assignableLicenses.name A string that specifies the name of a license that can be assigned to the organization.
assignableLicenses.supportedRegions An array that specifies the names of the supported regions for a license that can be assigned to the organization.
canCreateEnvironment A boolean that specifies whether the organization can create an environment. A return value of false specifies that the organization’s maximum number of environments has been reached.
canUsePlatform A boolean that specifies the status of the associated license. Return values are true (ACTIVE) and false (TERMINATED).

Environment capabilities data model

Property Description
canPromoteToProd A boolean that specifies whether the environment’s type property can be promoted from SANDBOX to PRODUCTION.
canUseMfaPushNotifications A boolean that specifies whether the license supports MFA push authentication for mobile applications in the specified environment.
canUsePlatform A boolean that specifies the status of the associated license. Return values are true (ACTIVE) and false (TERMINATED).

Response codes

Code Message
200 Successful operation.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request.
404 The requested resource was not found.

Endpoint examples

You need Organization Admin role or the Environment Admin role to get the capabilities for an organization or an environment, respectively. For more information about roles, see Roles.

Get organization capabilities

The following sample shows the GET /organizations/<organizationId>/capabilities operation to return the organization’s current capabilities:

curl -X GET "https://api.pingone.com/v1/organizations/<organizationId>/capabilities" \
-H "Authorization: Bearer jwtToken"

The response data looks like this:

{
  "assignableLicenses": [
    {
      "id": "57f0efac-37d9-4a17-8a35-196bb3362983",
      "name": "INTERNAL",
      "supportedRegions": [
        "NORTH_AMERICA",
        "EU"
      ],
      "allowProduction": true
    }
  ],
  "canCreateEnvironment": true,
  "canUsePlatform": true
}

Get environment capabilities

The following sample shows the GET /environments/<environmentId>/capabilities operation to return the specified environment’s current capabilities:

curl -X GET "https://api.pingone.com/v1//environments/<environmentId>/capabilities" \
-H "Authorization: Bearer jwtToken"

The response data looks like this:

{
  "canPromoteToProd": true,
  "canUseMfaPushNotifications": true,
  "canUsePlatform": true
}