Admin API reference guide
This page outlines the admin endpoint, which allows you to manage and review licenses in Immuta.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
POST /admin/license
Add a license key to the Immuta tenant to increase the number of seats or enable features.
licenseKey
string The license key, as a payload.
Yes
licenseKey
string The license key.
id
integer The ID of the license.
uuid
string The unique universal identifier.
features
array The features included in the license.
handlers
array The data handlers included in the license.
expires
timestamp The date the license expires.
seats
integer The number of user seats available.
createdAt
timestamp The date the license key was generated.
notice
string This notice appears on the login page.
noticeOnExpire
string This notice appears on the login page after the license expires.
This example request adds a license key (saved in the example-payload.json file) to the Immuta tenant.
GET
/admin/license
GET
/admin/license/licenseStatus
GET /admin/license
Get a list of all license keys.
id
integer The ID of the license.
uuid
string The unique universal identifier.
features
array The features included in the license.
handlers
array The data handlers included in the license.
expires
timestamp The date the license expires.
seats
integer The number of user seats available.
createdAt
timestamp The date the license key was generated.
notice
string This notice appears on the login page.
noticeOnExpire
string This notice appears on the login page after the license expires.
This example request gets the license key for the https://www.organization.immuta.com Immuta tenant.
GET /admin/license/licenseStatus
Get the status of a license key's features and seat capacity.
activeUserCount
integer The number of active users in the Immuta tenant.
licenseSeats
integer The total number of seats available in the license.
canAddUser
boolean When true, the administrator can add user accounts to the Immuta tenant.
hardSeats
integer The number of licensed seats available.
This example request gets the number of seats and active users for the license key associated with the https://www.organization.immuta.com Immuta tenant.
GET /admin/license/usage
Get the license usage summary. This endpoint returns a summary of the number of active and inactive users and a list of users.
offset
integer The start index of the records to return. You can combine the offset and size parameters to return a specific set of user records. For example, to return the second and third user records in the response, you would set offset=1 and size=2. The default start index is 0.
No
size
integer The number of user records to return. The default size is 10.
No
users
array[] An array of user records.
users.userType
string The type of user. Value can be dataConsumer or policyOwner.
users.name
string The name of the user.
users.email
string The user's email address.
users.iamid
string The IAM the user belongs to.
users.userid
string The user's username.
users.active
boolean If true, the user is active. This is determined by whether Immuta has tracked any activity by the user in the last year.
summary
object The summary of license usage that covers all users, not just the subset returned by a call to this endpoint.
summary.dataConsumers
array Includes a summary of the dataConsumers type.
summary.dataConsumers.totalCount
integer The total number of users of this type known to Immuta.
summary.dataConsumers.activeCount
integer The number of active data consumers known to Immuta, determined by whether Immuta has tracked any activity by the user in the last year. Minimum value is 0.
summary.dataConsumers.inactiveCount
integer The number of inactive data consumers known to Immuta, determined by whether Immuta has tracked any activity by the user in the last year. Minimum value is 0.
summary.policyOwners
object Includes a summary of the policyOwners type.
summary.policyOwners.totalCount
integer The total number of users of this type known to Immuta.
This request gets the license usage for 5 users in the https://www.organization.immuta.com Immuta tenant.
DELETE /admin/license/{licenseId}
Delete the specified license key.
licenseId
integer The ID of the license key you want to delete.
Yes
id
integer The license key ID.
licenseKey
string The license key.
seats
integer The number of seats in the license.
softSeats
integer The number of users that can be added beyond seats without access being blocked.
expires
timestamp The date the license expires.
uuid
string The unique universal identifier.
deleted
boolean If true, the license key has been deleted.
features
array The features included in the license.
handlers
array The data handlers included in the license.
hardExpiration
boolean When true, all data access is blocked when the license expires.
notice
string This notice appears on the login page.
noticeOnExpire
string This notice appears on the login page after the license expires.
createdAt
timestamp The date the license key was generated.
updatedAt
timestamp The date the license key was deleted.
hardDelete
boolean If true, the license key cannot be re-added after it is deleted.
expired
boolean If true, the license has expired.
This example request deletes the license key with the ID 1.
.
.