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
maxPortalUsers
number

The maximum Portal users allowed by the license.

Example200
maxServiceUsers
number

The maximum Service users allowed by the license.

Example200
usersLeaseTimeHours
number

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

Example720
portalUsersLeaseTimeHours
number

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

Example720
serviceUsersLeaseTimeHours
number

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

Example720
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
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
maxConnectorGroups
number

The maximum Connector groups allowed by the license.

Example150
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.

collectiveReplication
boolean

Whether the Collective Replication feature is enabled.

verifiedDnsNames
object
names
Array of string

The DNS names allowed by the license.

string
hashes
Array of string

The DNS names' hashes allowed by the license.

string
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
type
number

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

Example2
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
maxPortalUsers
number

The maximum Portal users allowed by the license.

Example200
maxServiceUsers
number

The maximum Service users allowed by the license.

Example200
usersLeaseTimeHours
number

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

Example720
portalUsersLeaseTimeHours
number

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

Example720
serviceUsersLeaseTimeHours
number

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

Example720
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
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
maxConnectorGroups
number

The maximum Connector groups allowed by the license.

Example150
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.

collectiveReplication
boolean

Whether the Collective Replication feature is enabled.

verifiedDnsNames
object
names
Array of string

The DNS names allowed by the license.

string
hashes
Array of string

The DNS names' hashes allowed by the license.

string
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
portalUsers
number

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

Example24
serviceUsers
number

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

Example2
sites
number

The amount of Sites in the system at present.

Example3
connectorGroups
number

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

Example4
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
full_multi
number

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

Example10
full_always_on
number

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

Example10
lite
number

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

Example10
headless
number

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

Example10
headless_always_on
number

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

Example10
connector
number

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

Example10
sso
number

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

Example10
web
number

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

Example10
unknown
number

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

Example10
mfaProviders
number

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

Example1
deviceScripts
number

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

Example3
criteriaScripts
number

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

Example3
entitlementScripts
number

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

Example3
userScripts
number

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

Example3
fallbackSites
number

The amount of fallback Sites in the system at present.

Example1
nearestSites
number

The amount of nearest Sites in the system at present.

Example1
localSites
number

The amount of local Sites in the system at present.

Example1
profileGroups
number

The amount of Profile Groups in the system at present.

Example2
applianceCustomizations
number

The amount of Appliance Customizations in the system at present.

Example2
ringfenceRules
number

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

Example2
otpSeeds
number

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

Example2
fido2Devices
number

The amount of FIDO2 devices in the system at present.

Example2
sitesConnectedViaBroker
number

The amount of sites Connection Brokers are connected to.

Example2
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.

geoLocationUpdates
string

GeoIP provider in use.

Valid values[ "Disabled", "Default", "Maxmind", "IPInfo", "Custom" ]
ExampleDefault
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.