PingOne Platform APIs

Gateway Credentials

The gateway instance running within your infrastructure authenticates with PingOne through a gateway credential. The examples that follow show common actions to create and manage gateway credentials.

You need the Environment Admin role to perform operations on gateway entities.

Gateway credentials data model

Property Type Required? Mutable? Description

createdAt

Date

N/A

Read-only

The date the credential was created in Coordinated Universal Time (UTC).

id

String

N/A

Read-only

The auto-generated ID for this credential. This is the JWT’s jti claim.

lastUsedAt

Date

N/A

Read-only

The date the credential was last used in UTC.

token

String

N/A

Read-only

The signed JWT for the gateway credential. This property is present only when the gateway credential is created.

Gateway credentials token claims

The gateway credential includes the following claims:

Claim Type Description

aud

String

The names of resources that this token is intended for (for example, https://api.pingone.com).

authUrl

String

The authorization server URL (for example, https://auth.pingone.com).

consoleUrl

String

The admin console URL (for example, https://console.pingone.com).

environmentId

String

The environment ID of the authenticated user or application.

environmentName

String

The name of the PingOne environment.

gatewayId

String

The PingOne gateway ID.

gatewayName

String

The name of the PingOne gateway.

gatewayType

String

The PingOne gateway type. Options are LDAP, API_GATEWAY_INTEGRATION, PING_FEDERATE, RADIUS, and AUTHORIZE.

iat

Integer

The timestamp, measured in the number of seconds since January 1, 1970, UTC, indicating when this token was originally issued, as defined in JWT RFC7519.

iss

String

The per-environment issue URI: wss://gateways.pingone.com.

jti

String

The UUID for the token.

organizationId

String

The PingOne organization ID of the authenticated user or application.

organizationName

String

The name of the PingOne organization.

region

String

The target region’s name.

targetClusterEnvironment

String

The name of the PingOne target cluster environment.

targetGeography

String

The target’s region. Options are NA, CA, EU, AU, SG, or AP.

Response codes

Code Message

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

404

The requested resource was not found.