Environments
The environments in your organization.
Table-Specific Information
We recommend using the built-in Client Application Developer role to read and write data for this table.
SELECT
Reading data from this table requires Read Environment/orgmgt:read:environment permission.The driver uses the PingOne Platform API to process WHERE clause conditions built with the following columns and operators.
- Id supports the following operators: =, IN.
All other filters are processed client-side within the driver.
For example, the following queries are processed server-side:
SELECT * FROM Information.Environments WHERE Id = 'e2434246-9a5d-41d2-b2f0-fb1d18847b7c';
SELECT * FROM Information.Environments WHERE Id IN ('e2434246-9a5d-41d2-b2f0-fb1d18847b7c', '0780564a-7451-4358-960b-c5e9a2c9ea14');
INSERT
Creating data in this table requires Create Environment/orgmgt:create:environment permission.Refer to the query example below:
INSERT INTO Information.Environments (Name, Description, Type, Region) VALUES ('Environment 1', 'Environment 1', 'SANDBOX', 'EU')
If a worker application creates a new environment, that worker application is given Identity Data Admin and Client Application Developer role assignments for that environment automatically by PingOne. Additionally, if the worker application doesn't have the Environment Admin role assigned for the organization, the worker app is also assigned the Environment Admin role for the new environment. For more information regarding this, refer to Create Environment from the PingOne Platform API documentation.
This should occur only when the driver uses OAuthClient (client_credentials grant type) to authenticate and connect to PingOne. Only the worker application can perform Identity Data Admin operations in that environment. However, the worker application can give the same role assignments to another user or another worker application.
NOTE: Whenever you create an environment, make sure that you assign the same roles which were automatically assigned to the worker application to any administrator users which need to access the application's secret, otherwise you might risk not being able to access the application's secret. You can easily achieve this by INSERT-ing through the UserAdminRoleAssignments table right after creating the environment. For more information regarding this, refer to PingOne Limitations in Administrator Roles.
UPDATE
Updating data in this table requires Update Environment/orgmgt:update:environment permission.Refer to the query example below:
UPDATE Information.Environments SET Description = 'My Environment' WHERE Id = 'e2434246-9a5d-41d2-b2f0-fb1d18847b7c'
DELETE
Deleting data from this table requires Delete Environment/orgmgt:delete:environment permission.Refer to the query example below:
DELETE FROM Information.Environments WHERE Id = 'e2434246-9a5d-41d2-b2f0-fb1d18847b7c'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The environment identifier (UUID). | |
| Name | String | False |
The name of the environment. Must be unique within the organization. | |
| Description | String | False |
The environment's description. | |
| Type | String | False |
The type of the environment. Possible values are: 'PRODUCTION' and 'SANDBOX'. | |
| OrganizationId | String | True | Information.Organizations.Id |
The identifier (UUID) of the organization in which the environment exists. |
| CreatedAt | Datetime | True |
The time at which the environment was created. | |
| UpdatedAt | Datetime | True |
The time at which the environment was last updated. | |
| Region | String | False |
The region in which this environment will be used. Possible values are: 'NA', 'CA', 'EU', 'AU', and 'AP'. | |
| IconURL | String | False |
The URL referencing the image to use for the environment icon. | |
| LicenseId | String | False | Information.Licenses.Id |
The identifier (UUID) of the license associated with the environment. |
| Status | String | True |
The status of the environment. Possible values are: 'ACTIVE' and 'DELETE_PENDING'. | |
| SoftDeletedAt | Datetime | True |
The time when the environment was soft-deleted (status was set to 'DELETE_PENDING'). | |
| HardDeleteAllowedAt | Datetime | True |
The time when the PingOne administrator is allowed to delete the environment permanently. |