Get the current License.

Prev Next
Get
/license

Get the current License.

Security
HTTP
Type bearer
Responses
200

License details including usage.

Expand All
object

License details and current usage.

licenses
Array of object (License)
object
maxUsers
number

The maximum users allowed by the license.

Example200.0
maxPortalUsers
number

The maximum Portal users allowed by the license.

Example200.0
maxServiceUsers
number

The maximum Service users allowed by the license.

Example200.0
usersLeaseTimeHours
number

Number of hours User Licenses will be reserved for users before they are reclaimable by others.

Example720.0
portalUsersLeaseTimeHours
number

Number of hours User Licenses will be reserved for Portal users before they are reclaimable by others.

Example720.0
serviceUsersLeaseTimeHours
number

Number of hours User Licenses will be reserved for Service users before they are reclaimable by others.

Example720.0
maxSites
number

The maximum sites allowed by the license. If it's the usage details, then it's the amount of sites in the system at present.

Example5.0
maxAccessPolicies
number

The maximum access policies allowed by the license. If it's the usage details, then it's the amount of access policies in the system at present.

Example5.0
maxConnectorGroups
number

The maximum Connector groups allowed by the license.

Example150.0
riskEngine
boolean

Whether the Risk Engine feature is enabled.

applicationDiscovery
boolean

Whether the Application Discovery feature is enabled.

digitalExperienceMonitoring
boolean

Whether the Digital Experience Monitoring feature is enabled.

id
string (uuid)

Unique ID for the license.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
version
number

License version. There can be only one v1 License in the system, while v2 Licenses can be added as extra.

Example2.0
type
number

Type of the license. 1: production, 2: installation, 3: test, 4: built-in, 5: aws built-in, 6: metered

Example2.0
request
string

Request code for the license. If built-in license is in place, use this code to get a license. It's based on the CA certificate.

Example1675ab19fe2
expiration
string (date-time)

The expiration date of the license.

error
string

Error message if the License is not invalid.

ExampleLicense has expired.
entitled
object (LicenseEntitlement)

License entitlement details.

maxUsers
number

The maximum users allowed by the license.

Example200.0
maxPortalUsers
number

The maximum Portal users allowed by the license.

Example200.0
maxServiceUsers
number

The maximum Service users allowed by the license.

Example200.0
usersLeaseTimeHours
number

Number of hours User Licenses will be reserved for users before they are reclaimable by others.

Example720.0
portalUsersLeaseTimeHours
number

Number of hours User Licenses will be reserved for Portal users before they are reclaimable by others.

Example720.0
serviceUsersLeaseTimeHours
number

Number of hours User Licenses will be reserved for Service users before they are reclaimable by others.

Example720.0
maxSites
number

The maximum sites allowed by the license. If it's the usage details, then it's the amount of sites in the system at present.

Example5.0
maxAccessPolicies
number

The maximum access policies allowed by the license. If it's the usage details, then it's the amount of access policies in the system at present.

Example5.0
maxConnectorGroups
number

The maximum Connector groups allowed by the license.

Example150.0
riskEngine
boolean

Whether the Risk Engine feature is enabled.

applicationDiscovery
boolean

Whether the Application Discovery feature is enabled.

digitalExperienceMonitoring
boolean

Whether the Digital Experience Monitoring feature is enabled.

requestCode
string

Request code for the license. Use this code to get a license. It's based on the CA certificate.

usage
object

License usage information.

users
number

The amount of licensed users in the system at present.

Example152.0
portalUsers
number

The amount of licensed portal users in the system at present.

Example24.0
serviceUsers
number

The amount of licensed service users in the system at present.

Example2.0
sites
number

The amount of Sites in the system at present.

Example3.0
connectorGroups
number

The amount of grouped Connector clients in the system at present.

Example4.0
multiUserClients
number

The amount of licensed multi-user clients in the system at present.

Example10.0
clientTypes
object

Counts of the current client types in the system at present.

full
number

The amount of full client types in the system at present.

Example10.0
full_multi
number

The amount of full multi client types in the system at present.

Example10.0
full_always_on
number

The amount of full always on client types in the system at present.

Example10.0
lite
number

The amount of lite client types in the system at present.

Example10.0
headless
number

The amount of headless client types in the system at present.

Example10.0
headless_always_on
number

The amount of full always on client types in the system at present.

Example10.0
connector
number

The amount of connector client types in the system at present.

Example10.0
sso
number

The amount of sso client types in the system at present.

Example10.0
web
number

The amount of web client types in the system at present.

Example10.0
unknown
number

The amount of unknown client types in the system at present.

Example10.0
mfaProviders
number

The amount of non-built-in MFA Providers in the system at present.

Example1.0
deviceScripts
number

The amount of non-built-in Device Claim Scripts in the system at present.

Example3.0
criteriaScripts
number

The amount of non-built-in Criteria Scripts in the system at present.

Example3.0
entitlementScripts
number

The amount of non-built-in EntitlementScripts in the system at present.

Example3.0
userScripts
number

The amount of non-built-in User Claim Scripts in the system at present.

Example3.0
fallbackSites
number

The amount of fallback Sites in the system at present.

Example1.0
nearestSites
number

The amount of nearest Sites in the system at present.

Example1.0
localSites
number

The amount of local Sites in the system at present.

Example1.0
profileGroups
number

The amount of Profile Groups in the system at present.

Example2.0
applianceCustomizations
number

The amount of Appliance Customizations in the system at present.

Example2.0
ringfenceRules
number

The amount of non-built-in Ringfence Rules in the system at present.

Example2.0
otpSeeds
number

The amount of Time-based OTP Seeds in the system at present.

Example2.0
fido2Devices
number

The amount of FIDO2 devices in the system at present.

Example2.0
identityProviders
object

The amount of non-built-in Identity Providers in the system at present broken out by type.

ldap
number
ldapCertificate
number
radius
number
saml
number
oidc
number
policies
object

The amount of Policies in the system at present broken out by type.

access
number
stop
number
device
number
dns
number
admin
number
mixed
number
riskModel
boolean

Whether the risk model is utilized or not.

401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.