Each environment has one license only. The property values of the license resource specify the licensing boundaries. The license identifies the organization that owns the license, the licensing package type, and the expiration date for the license. The following entitlements are also defined in the licensing package:

For environments:

For users and applications:

License data model

Property Description
assignedEnvironmentsCount An integer that specifies the total number of environments associated with this license.
beginsAt The date and time this license begins.
environments.allowConnections A boolean that specifies whether the license supports creation of a application connections in the specified environment.
environments.allowCustomDomain A boolean that specifies whether the license supports creation of a custom domain in the specified environment.
environments.allowCustomSchema A boolean that specifies whether the license supports using custom schema attributes in the specified environment.
environments.allowProduction A boolean that specifies whether production environments are allowed.
environments.max An integer that specifies the maximum number of environments allowed.
environments.regions A string that specifies the allowed regions associated with environments. Options are NA, EU, and AP.
expiresAt The date and time this license expires. TRIAL licenses stop access to PingOne services at expiration. All other licenses trigger an event to send a notification when the license expires but do not block services.
id A string that specifies the license resource’s unique identifier.
intelligence.allowGeoVelocity A boolean that specifies whether to use the intelligence geo-velocity feature. For TRIAL (unpaid) licenses, the default value is true. For ADMIN, GLOBAL, RISK, and MFARISK, the default value is true.
intelligence.allowReputation A boolean that specifies whether to use the intelligence IP reputation feature. For TRIAL (unpaid) licenses, the default value is true. For ADMIN, GLOBAL, RISK, and MFARISK, the default value is true.
intelligence.allowDataConsent A boolean that specifies whether the customer has opted in to allow user and event behavior analytics (UEBA) data collection.
intelligence.allowRisk A boolean that specifies whether your license permits you to configure risk features such as sign-on policies that include rules to detect anomalous changes to your locations (such as impossible travel). This capability is supported for TRIAL, RISK, and MFARISK license packages. Note: The sharing of user data to enable our machine-learning engine, which is integral to PingOne Risk, is captured in the license property license.intelligence.allowDataConsent, but it is not set to true by default in any license package. This license capability always requires active consent by the customer before it can be enabled, and if consent is given, then it allows the full scope of intelligence features included in PingOne Risk (and PingOne Risk plus MFA).
mfa.allowPushNotification A boolean that specifies whether push notifications are allowed. For TRIAL (unpaid) licenses, the default value is true. For other license package types, adoption of the feature determines the default value.
mfa.allowMfaNotificationsOutsideWhitelist A boolean that specifies whether the license supports sending notifications outside of the environment’s whitelist.
mfa.allowFido2Devices A boolean that specifies whether FIDO2 devices are allowed. For TRIAL (unpaid) licenses, the default value is true. For other license package types, adoption of the feature determines the default value.
name A string that specifies a descriptive name for the license. This is a required property in a license name update request. Valid characters consists of any Unicode letter, mark, numeric character, forward slash, dot, apostrophe, underscore, space, or hyphen. The maximum length of a name is 255 characters.
organization.id A string that specifies the organization resource’s unique identifier associated with the license.
package A string that specifies the license template on which this license is based. This is a required property. Options are TRIAL, STANDARD, PREMIUM, MFA, RISK, MFARISK, and GLOBAL.
replacesLicense.id A string that specifies the license ID of the license that is replaced by this license.
replacedByLicense.id A string that specifies the license ID of the license that replaces this license.
status A string that specifies the status of the license. Options are ACTIVE, EXPIRED, and FUTURE.
terminatesAt An optional attribute that designates the exact date and time when this license terminates access to PingOne services. This attribute can be added to any licensing package.
users.allowPasswordManagementNotifications A boolean that specifies whether the license supports sending password management notifications.
users.allowIdentityProviders A boolean that specifies whether the license supports using external identity providers in the specified environment.
users.allowMyAccount A boolean that specifies whether the license supports using My Account capabilities in the specified environment.
users.allowPasswordManagementNotifications A boolean that specifies whether the license supports using password management capabilities in the specified environment.
users.allowPasswordOnlyAuthentication A boolean that specifies whether the license supports using password only login capabilities in the specified environment.
users.allowPasswordPolicy A boolean that specifies whether the license supports using password policies in the specified environment.
users.allowProvisioning A boolean that specifies whether the license supports using provisioning capabilities in the specified environment.
users.allowRoleAssignment A boolean that specifies whether the license supports role assignments in the specified environment.
users.users.allowVerificationFlow A boolean that specifies whether the license supports using verification flows in the specified environment.
users.allowUpdateSelf A boolean that specifies whether the license supports allowing users to update their own profile.
users.entitledToSupport A boolean that specifies whether the license allows PingOne support.
users.max An integer that specifies the maximum number of users allowed per environment.
users.annualActiveIncluded An integer that specifies a soft limit on the number of active identities across all environments on the license per year. This property is not visible if a value is not provided at the time the license is created.
users.monthlyActiveIncluded An integer that specifies a soft limit on the number of active identities across all environments on the license per month. This property is not visible if a value is not provided at the time the license is created.

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.