Ping Identity Metrics API
Operations that support retrieving metrics
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/ping-identity-metrics-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.1.1
info:
title: PingOne Platform Configuration Management Metrics API
version: 2026.01.07-beta
description: PingOne is a cloud-based framework for secure identity access management. The PingOne API gives developers the tools to integrate enterprise and third-party applications with the PingOne platform.
contact:
name: Ping Identity Developer Experiences
url: https://developer.pingidentity.com
email: devex@pingidentity.com
license:
identifier: Apache-2.0
name: Apache 2.0
servers:
- url: https://api.pingone.{tld}/{basePath}
variables:
basePath:
default: v1
tld:
enum:
- eu
- com
- asia
- com.au
- ca
- sg
default: com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Metrics
description: Operations that support retrieving metrics
paths:
/environments/{environmentID}/totalIdentities:
get:
operationId: getTotalIdentities
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- name: filter
in: query
schema:
type: string
- $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
- $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
responses:
'200':
description: Successful operation.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.directory.totalidentitiesdashboard.data.TotalIdentitiesCountDTOCollectionResponse'
application/json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.directory.totalidentitiesdashboard.data.TotalIdentitiesCountDTOCollectionResponse'
'400':
$ref: '#/components/responses/http.400.BadRequest'
'401':
$ref: '#/components/responses/http.401.Unauthorized'
'403':
$ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
'429':
$ref: '#/components/responses/http.429.TooManyRequests'
'500':
$ref: '#/components/responses/http.500.InternalServerError'
'502':
$ref: '#/components/responses/http.502.BadGateway'
'503':
$ref: '#/components/responses/http.503.ServiceUnavailable'
x-permission: orgmgt:read:environment
tags:
- Metrics
components:
schemas:
com.pingidentity.ApiErrorResponse:
type: object
properties:
code:
type: string
title: General Error Code
details:
type: array
items:
$ref: '#/components/schemas/com.pingidentity.ErrorDetail'
title: General Error Details
id:
type: string
title: General Error Id
message:
type: string
title: General Error Message
title: General Error
com.pingidentity.pingone.directory.totalidentitiesdashboard.data.TotalIdentitiesCountDTOCollectionResponse:
type: object
properties:
_embedded:
type: object
properties:
totalIdentities:
type: array
items:
allOf:
- $ref: '#/components/schemas/com.pingidentity.pingone.directory.totalidentitiesdashboard.data.TotalIdentitiesCountDTO'
title: Directory Total Identities Count Collection Response _embedded Total Identity
title: Directory Total Identities Count Collection Response _embedded Total Identities
title: Directory Total Identities Count Collection Response _embedded
_links:
type: object
properties:
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: Directory Total Identities Count Collection Response _links
count:
type: integer
format: int32
title: Directory Total Identities Count Collection Response Count
size:
type: integer
format: int32
title: Directory Total Identities Count Collection Response Size
title: Directory Total Identities Count Collection Response
com.pingidentity.ApiErrorResponse.400:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Bad Request Error Id
code:
type: string
enum:
- INVALID_DATA
- INVALID_REQUEST
- REQUEST_FAILED
minLength: 1
title: Bad Request Error Code
message:
type: string
minLength: 1
title: Bad Request Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- ACCOUNT_NOT_USABLE
- CONSTRAINT_VIOLATION
- EMPTY_VALUE
- INVALID_FILTER
- INVALID_OTP
- INVALID_PARAMETER
- INVALID_VALUE
- MFA_AUTH_METHODS_CONFLICT
- NO_PASSWORD
- OUT_OF_RANGE
- REQUIRED_VALUE
- SIZE_LIMIT_EXCEEDED
- UNIQUENESS_VIOLATION
minLength: 1
title: Bad Request Error Detail Code
message:
type: string
minLength: 1
title: Bad Request Error Detail Message
innerError:
type: object
properties:
allowedPattern:
type: string
title: Bad Request Error Detail Inner Error Allowed Pattern
allowedValues:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Allowed Value
title: Bad Request Error Detail Inner Error Allowed Values
claim:
type: string
title: Bad Request Error Detail Inner Error Claim
existingId:
type: string
format: uuid
title: Bad Request Error Detail Inner Error Existing Id
maximumValue:
type: number
title: Bad Request Error Detail Inner Error Maximum Value
quotaLimit:
type: number
title: Bad Request Error Detail Inner Error Quota Limit
quotaResetTime:
type: string
format: date-time
title: Bad Request Error Detail Inner Error Quota Reset Time
rangeMaximumValue:
type: number
title: Bad Request Error Detail Inner Error Range Maximum Value
rangeMinimumValue:
type: number
title: Bad Request Error Detail Inner Error Range Minimum Value
supportedAttributes:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Supported Attribute
title: Bad Request Error Detail Inner Error Supported Attributes
supportedOperators:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Supported Operator
title: Bad Request Error Detail Inner Error Supported Operators
additionalProperties: true
title: Bad Request Error Detail Inner Error
target:
type: string
title: Bad Request Error Detail Target
required:
- code
- message
title: Bad Request Error Detail
title: Bad Request Error Details
required:
- id
- code
- message
title: Bad Request Error
com.pingidentity.ErrorDetail:
type: object
properties:
code:
type: string
title: General Error Detail Code
innerError:
type: object
additionalProperties:
type: object
title: General Error Detail Inner Error Additional Properties
title: General Error Detail Inner Error
message:
type: string
title: General Error Detail Message
target:
type: string
title: General Error Detail Target
title: General Error Detail
com.pingidentity.ApiErrorResponse.403:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
code:
type: string
enum:
- ACCESS_FAILED
minLength: 1
title: Forbidden Error Code
message:
type: string
minLength: 1
title: Forbidden Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- INSUFFICIENT_PERMISSIONS
- LICENSE_EXCEEDED
minLength: 1
title: Forbidden Error Detail Code
message:
type: string
minLength: 1
title: Forbidden Error Detail Message
innerError:
type: object
properties:
quotaLimit:
type: number
title: Forbidden Error Detail Inner Error Quota Limit
additionalProperties: true
title: Forbidden Error Detail Inner Error
target:
type: string
title: Forbidden Error Detail Target
required:
- code
- message
title: Forbidden Error Detail
title: Forbidden Error Details
id:
type: string
format: uuid
title: Forbidden Error Id
required:
- code
- message
title: Forbidden Error
com.pingidentity.pingone.directory.totalidentitiesdashboard.data.TotalIdentitiesCountDTO:
type: object
properties:
date:
type: integer
format: unix-date-time
title: Directory Total Identities Count Response Date
totalIdentities:
type: integer
format: int32
title: Directory Total Identities Count Response Total Identities
title: Directory Total Identities Count Response
com.pingidentity.api.response.Link:
type: object
properties:
href:
type: string
format: uri
minLength: 1
title: JSON HAL Link Href
name:
type: string
title: JSON HAL Link Name
profile:
type: string
format: uri
title: JSON HAL Link Profile
title:
type: string
format: uri
title: JSON HAL Link Title
type:
type: string
title: JSON HAL Link Type
required:
- href
readOnly: true
title: JSON HAL Link
com.pingidentity.ApiErrorResponse.500:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Internal Server Error Id
code:
type: string
enum:
- UNEXPECTED_ERROR
minLength: 1
title: Internal Server Error Code
message:
type: string
minLength: 1
title: Internal Server Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
minLength: 1
title: Internal Server Error Detail Code
message:
type: string
minLength: 1
title: Internal Server Error Detail Message
innerError:
type: object
additionalProperties: true
title: Internal Server Error Detail Inner Error
target:
type: string
title: Internal Server Error Detail Target
required:
- code
- message
title: Internal Server Error Detail
title: Internal Server Error Details
required:
- id
- code
- message
title: Internal Server Error
com.pingidentity.ApiErrorResponse.401:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Unauthorized Error Id
code:
type: string
enum:
- ACCESS_FAILED
minLength: 1
title: Unauthorized Error Code
message:
type: string
minLength: 1
title: Unauthorized Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- INSUFFICIENT_PERMISSIONS
- INVALID_TOKEN
minLength: 1
title: Unauthorized Error Detail Code
message:
type: string
minLength: 1
title: Unauthorized Error Detail Message
innerError:
type: object
additionalProperties: true
title: Unauthorized Error Detail Inner Error
target:
type: string
title: Unauthorized Error Detail Target
required:
- code
- message
title: Unauthorized Error Detail
title: Unauthorized Error Details
required:
- id
- code
- message
title: Unauthorized Error
com.pingidentity.ApiErrorResponse.429:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
code:
type: string
enum:
- REQUEST_LIMITED
minLength: 1
title: Too Many Requests Error Code
message:
type: string
minLength: 1
title: Too Many Requests Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- LIMIT_EXCEEDED
- QUOTA_EXCEEDED
minLength: 1
title: Too Many Requests Error Detail Code
message:
type: string
minLength: 1
title: Too Many Requests Error Detail Message
innerError:
type: object
properties:
quotaLimit:
type: number
title: Too Many Requests Error Detail Inner Error Quota Limit
quotaResetTime:
type: string
format: date-time
title: Too Many Requests Error Detail Inner Error Quota Reset Time
retryAfter:
type: string
format: date-time
title: Too Many Requests Error Detail Inner Error Retry After
additionalProperties: true
title: Too Many Requests Error Detail Inner Error
target:
type: string
title: Too Many Requests Error Detail Target
required:
- code
- message
title: Too Many Requests Error Detail
title: Too Many Requests Error Details
id:
type: string
format: uuid
title: Too Many Requests Error Id
required:
- code
- message
title: Too Many Requests Error
responses:
http.502.BadGateway:
description: Bad Gateway
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse'
http.403.Forbidden.P14C63085.DOCS8830:
description: 'Forbidden - Note: This may occur if the environment doesn''t exist. Check for environment existence with GET /environments/{environmentID} first. - Note: This may be due to eventual consistency if the environment was recently created. Try again after a short delay.'
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.403'
x-pingone-p14c-63085: true
x-pingone-docs-8830: true
http.400.BadRequest:
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.400'
http.503.ServiceUnavailable:
description: Service Unavailable
headers:
Retry-After:
$ref: '#/components/headers/http.RetryAfter'
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse'
http.401.Unauthorized:
description: Unauthorized
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.401'
http.500.InternalServerError:
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.500'
http.429.TooManyRequests:
description: Too Many Requests
headers:
Retry-After:
$ref: '#/components/headers/http.RetryAfter'
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.429'
parameters:
com.pingidentity.path.environments.environmentID:
name: environmentID
in: path
required: true
schema:
type: string
format: uuid
com.pingidentity.header.ExternalSessionID:
schema:
type: string
minLength: 1
name: X-Ping-External-Session-ID
in: header
com.pingidentity.header.ExternalTransactionID:
schema:
type: string
minLength: 1
name: X-Ping-External-Transaction-ID
in: header
headers:
http.RetryAfter:
schema:
oneOf:
- type: integer
format: int32
- type: string
title: Retry-After Header
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: /as/token
scopes: {}
authorizationCode:
authorizationUrl: /as/authorize
tokenUrl: /as/token
refreshUrl: /as/token
scopes: {}
x-permissions:
- name: davinci:create:applications
- name: davinci:create:connections
- name: davinci:create:constructs
- name: davinci:create:dvFlows
- name: davinci:create:flowPolicies
- name: davinci:delete:applications
- name: davinci:delete:connections
- name: davinci:delete:constructs
- name: davinci:delete:dvFlows
- name: davinci:delete:flowPolicies
- name: davinci:delete:flowVersions
- name: davinci:read:applications
- name: davinci:read:connections
- name: davinci:read:connectors
- name: davinci:read:constructs
- name: davinci:read:dvFlows
- name: davinci:read:flowPolicies
- name: davinci:read:flowVersions
- name: davinci:update:applications
- name: davinci:update:connections
- name: davinci:update:constructs
- name: davinci:update:dvFlows
- name: davinci:update:flowPolicies
- name: davinci:update:flowVersions
- name: flowPolicies:read:flowPolicy
- name: orgmgt:create:environment
- name: orgmgt:delete:environment
- name: orgmgt:read:environment
- name: orgmgt:update:environment
- name: promotion:create:snapshot
- name: promotion:read:snapshot