Read All Licenses

GET {{apiPath}}/organizations/{{orgID}}/licenses

The following sample shows the GET /organizations/{{orgID}}/licenses operation to return the complete list of license resources associated with the specified organization. In the Authorization request header field, the accessToken value is your full base64url-encoded JSON web token generated by the authentication service.

An organization can have several licenses, including multiple active licenses (an environment can have one license only). For organizations with more than one license, you can use a filter with the GET /organizations/{{orgID}}/licenses operation to return the list of licenses in descending order.

curl -X "GET" "https://api.pingone.com/v1/organizations/{{orgID}}/licenses?filter=beginsAt lt "{{now}}"&order=-beginsAt" \\
-H 'Authorization: Bearer {{accessToken}}'

In the request, the {{now}} filter parameter represents a datetime value in the format 2019-06-25T16:55:44.225Z. The order=-beginsAt parameter orders the list showing the most recent license first.

In addition, you can use the filtering expression filter=status eq "active" to return licenses that have a status value of ACTIVE.

curl -X "GET" "https://api.pingone.com/v1/organizations/{{orgID}}/licenses?filter=status eq "active" \\
-H 'Authorization: Bearer {{accessToken}}'

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses"}},"_embedded":{"licenses":[{"_links":{"self":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"},"organization":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda"}},"advancedServices":{"pingId":{"included":true,"type":"FULL"}},"assignedEnvironmentsCount":6,"authorize":{"allowApiAccessManagement":true,"allowDynamicAuthorization":true},"beginsAt":"2019-06-06T19:29:13.671Z","credentials":{"allowCredentials":true,"allowPushNotifications":true},"environments":{"allowAddResources":true,"allowConnections":true,"allowCustomDomain":true,"allowCustomSchema":true,"allowProduction":true,"max":50,"regions":["EU","NORTH_AMERICA"]},"expiresAt":"2099-12-31T00:00:00.000Z","fraud":{"allowBotMaliciousDeviceDetection":true,"allowAccountProtection":true,"allowAccountTakeoverDetection":true,"allowNewAccountFraudDetection":true,"allowCredentialSharingDetection":true,"allowDataEnrichment":true},"gateways":{"allowLdapGateway":true,"allowKerberosGateway":true,"allowRadiusGateway":true},"id":"57f0efac-37d9-4a17-8a35-196bb3362983","intelligence":{"allowReputation":true,"allowGeoVelocity":true,"allowAnonymousNetworkDetection":true,"allowDataConsent":true,"allowRisk":true,"allowAdvancedPredictors":true,"allowIntelligenceProtect":true,"numberOfProtectTransactions":0},"mfa":{"allowPushNotification":true,"allowNotificationOutsideWhitelist":true,"allowFido2Devices":true,"allowVoiceOtp":true,"allowEmailOtp":true,"allowSmsOtp":true,"allowTotp":true},"name":"Updated North America Test License.","orchestrate":{"allowOrchestration":true,"allowAdminAccess":true,"flows":{"max":100}},"organization":{"id":"bed432e6-676a-4ebe-b5a5-6b3b54e46bda"},"package":"INTERNAL","status":"ACTIVE","users":{"max":10000000,"hardLimitMax":11000000,"annualActiveIncluded":10000000,"allowPasswordPolicy":true,"allowPasswordManagementNotifications":true,"allowVerificationFlow":true,"allowIdentityProviders":true,"allowMyAccount":true,"allowProvisioning":true,"allowInboundProvisioning":true,"allowRoleAssignment":true,"allowPasswordOnlyAuthentication":true,"allowUpdateSelf":true,"entitledToSupport":true},"verify":{"allowPushNotifications":true,"allowDocumentMatch":true,"allowFaceMatch":true,"allowManualIdInspection":false,"allowAamva":true,"allowVoice":true,"numberOfManualIDStepUpInspection":0,"numberOfDigitalVerifications":0,"numberOfUniversalCapture":0,"numberOfAAMVA":0,"numberOfVoiceBiometrics":0}},{"_links":{"self":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/72949234-446e-4bdd-963f-1c69fb205b1c"},"organization":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda"}},"advancedServices":{"pingId":{"included":false,"type":"NONE"}},"assignedEnvironmentsCount":0,"authorize":{"allowApiAccessManagement":false,"allowDynamicAuthorization":false},"beginsAt":"2020-12-16T00:00:00.000Z","credentials":{"allowCredentials":false,"allowPushNotifications":false},"environments":{"allowAddResources":false,"allowConnections":true,"allowCustomDomain":false,"allowCustomSchema":false,"allowProduction":false,"max":5,"regions":["NORTH_AMERICA"]},"expiresAt":"2021-01-15T00:00:00.000Z","fraud":{"allowBotMaliciousDeviceDetection":false,"allowAccountProtection":false,"allowAccountTakeoverDetection":false,"allowNewAccountFraudDetection":false,"allowCredentialSharingDetection":false,"allowDataEnrichment":false},"gateways":{"allowLdapGateway":false,"allowKerberosGateway":false,"allowRadiusGateway":false},"id":"72949234-446e-4bdd-963f-1c69fb205b1c","intelligence":{"allowReputation":true,"allowGeoVelocity":true,"allowAnonymousNetworkDetection":true,"allowDataConsent":false,"allowRisk":true,"allowAdvancedPredictors":true,"allowIntelligenceProtect":false,"numberOfProtectTransactions":0},"mfa":{"allowPushNotification":false,"allowNotificationOutsideWhitelist":false,"allowFido2Devices":false,"allowVoiceOtp":false,"allowEmailOtp":false,"allowSmsOtp":false,"allowTotp":false},"name":"RISKTRIAL","orchestrate":{"allowOrchestration":false,"allowAdminAccess":false,"flows":{"max":0}},"organization":{"id":"bed432e6-676a-4ebe-b5a5-6b3b54e46bda"},"package":"RISKTRIAL","status":"TERMINATED","terminatesAt":"2021-01-15T00:00:00.000Z","users":{"max":0,"hardLimitMax":0,"annualActiveIncluded":1000,"allowPasswordPolicy":false,"allowPasswordManagementNotifications":false,"allowVerificationFlow":false,"allowIdentityProviders":false,"allowMyAccount":false,"allowProvisioning":false,"allowInboundProvisioning":false,"allowRoleAssignment":false,"allowPasswordOnlyAuthentication":false,"allowUpdateSelf":false,"entitledToSupport":false},"verify":{"allowPushNotifications":false,"allowDocumentMatch":false,"allowFaceMatch":false,"allowManualIdInspection":false,"allowAamva":false,"allowVoice":false,"numberOfManualIDStepUpInspection":0,"numberOfDigitalVerifications":0,"numberOfUniversalCapture":0,"numberOfAAMVA":0,"numberOfVoiceBiometrics":0}},{"_links":{"self":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/c951c5fa-44a3-42b8-a1e2-050d017773f9"},"organization":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda"}},"advancedServices":{"pingId":{"included":false,"type":"NONE"}},"assignedEnvironmentsCount":0,"authorize":{"allowApiAccessManagement":false,"allowDynamicAuthorization":false},"beginsAt":"2020-09-30T00:00:00.000Z","credentials":{"allowCredentials":false,"allowPushNotifications":false},"environments":{"allowAddResources":false,"allowConnections":true,"allowCustomDomain":false,"allowCustomSchema":false,"allowProduction":false,"max":5,"regions":["NORTH_AMERICA"]},"expiresAt":"2020-10-30T00:00:00.000Z","fraud":{"allowBotMaliciousDeviceDetection":false,"allowAccountProtection":false,"allowAccountTakeoverDetection":false,"allowNewAccountFraudDetection":false,"allowCredentialSharingDetection":false,"allowDataEnrichment":false},"gateways":{"allowLdapGateway":false,"allowKerberosGateway":false,"allowRadiusGateway":true},"id":"c951c5fa-44a3-42b8-a1e2-050d017773f9","intelligence":{"allowReputation":false,"allowGeoVelocity":false,"allowAnonymousNetworkDetection":false,"allowDataConsent":false,"allowRisk":false,"allowAdvancedPredictors":false,"allowIntelligenceProtect":false,"numberOfProtectTransactions":0},"mfa":{"allowPushNotification":true,"allowNotificationOutsideWhitelist":false,"allowFido2Devices":true,"allowVoiceOtp":true,"allowEmailOtp":true,"allowSmsOtp":true,"allowTotp":true},"name":"MFA TRIAL","orchestrate":{"allowOrchestration":false,"allowAdminAccess":false,"flows":{"max":0}},"organization":{"id":"bed432e6-676a-4ebe-b5a5-6b3b54e46bda"},"package":"MFA TRIAL","status":"TERMINATED","terminatesAt":"2020-10-30T00:00:00.000Z","users":{"max":1000000,"hardLimitMax":1100000,"annualActiveIncluded":1000,"allowPasswordPolicy":false,"allowPasswordManagementNotifications":false,"allowVerificationFlow":false,"allowIdentityProviders":false,"allowMyAccount":true,"allowProvisioning":false,"allowInboundProvisioning":false,"allowRoleAssignment":false,"allowPasswordOnlyAuthentication":false,"allowUpdateSelf":false,"entitledToSupport":false},"verify":{"allowPushNotifications":false,"allowDocumentMatch":false,"allowFaceMatch":false,"allowManualIdInspection":false,"allowAamva":false,"allowVoice":false,"numberOfManualIDStepUpInspection":0,"numberOfDigitalVerifications":0,"numberOfUniversalCapture":0,"numberOfAAMVA":0,"numberOfVoiceBiometrics":0}}]},"count":3,"size":3}