The examples that follow show common actions to find and manage gateway instances resources. You need the Environment Admin role to perform operations on gateway entities.

Gateway LDAP instance view data model

A gateway instance represents a single Docker container that runs on-premise with the configuration for a gateway. PingOne provides a read-only view of the gateway’s status and identifying information.

Property Description
connected A boolean that specifies whether or not the gateway instance has one or more connections. This is a required property.
credential.id A string that specifies the ID of the credential used by the gateway instance to create a websocket connection. The ID of the credential is the gateway credential’s jti claim. This is a required property.
currentErrors An array of strings that lists the messages that are maintained by the gateway instance.
gateway.id A string that specifies the gateway ID. This is a required property.
healthStatus An enumeration that specifies whether or not the gateway is in a healthy state. Options are HEALTHY, DEGRADED, UNHEALTHY. This is a required property.
hostname A string that specifies the hostname of the container running in the customer’s infrastructure. This is a required property.
id A string that specifies the instance ID of the gateway. The gateway instance ID is created by the gateway when it starts up.
initializedAt A timestamp that specifies when gateway was initialized (when the first connect to PingOne was made).
lastReportedAt A timestamp that specifies the last reported timestamp, heartbeat, or other message.
version.versionNumber A string that specifies the version number of the gateway running for the instance. This is a required property.
version.updateStatus An enumeration that specifies one of the following values:
  • AT_LATEST: The gateway instance’s version is at or after the supported version marked latest.
  • UPGRADE_AVAILABLE: The gateway instance’s version is at the supported version that is marked recommended but there is a later supported version marked recommended.
  • UPGRADE_RECOMMENDED: The gateway instance’s version is at a known version but the version is not marked as recommended or latest. The version has greater than 30 days support.
  • UPGRADE_REQUIRED: The gateway instance’s version is at a known version but the version is not marked as recommended or latest. The version has support ending within the next month.
  • NOT_SUPPORTED: The gateway instance’s version is not known or supported.

Gateway LDAP instance data model

Property Description
busyPercentage An integer that specifies the gateway instance’s busy percentage. When this percentage is high, then more instances should be added.
operationsPerSecond A number that specifies the recent throughput of the gateway instance.
responseTimeMillis A number that specifies the processing time of the gateway instance in milliseconds.

Response codes

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