Manage Licenses 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.
Admin workflow
Add an Immuta license key
POST
/admin/license
Add a license key to the Immuta tenant to increase the number of seats or enable features.
Query parameters
Response schema
Request example
This example request adds a license key (saved in the example-payload.json
file) to the Immuta tenant.
Copy curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8"
--data @example-payload.json \
https://www.organization.immuta.com/admin/license
Request payload example
Copy {
"licensekey" : "licensekey0123456789abcdefghijklstring"
}
Response example
Copy {
"id" : 1 ,
"licenseKey" : "licensekey0123456789abcdefghijklstring" ,
"seats" : 20 ,
"softSeats" : 0 ,
"expires" : "2022-09-09T00:00:00.000Z" ,
"uuid" : "4ceaf808-the-u-u--id4a753fc5a" ,
"deleted" : false ,
"invalidated" : false ,
"features" : {
"FPE" : {
"enabled" : true
}
} ,
"handlers" : {} ,
"hardExpiration" : false ,
"renewalToken" : null ,
"notice" : null ,
"noticeOnExpire" : null ,
"classifyUsername" : null ,
"classifyToken" : null ,
"createdAt" : "2021-09-09T13:47:02.473Z" ,
"updatedAt" : "2021-10-07T17:55:54.806Z" ,
"expired" : false
}
View license keys
Get a list of license keys
GET
/admin/license
Get a list of all license keys.
Response schema
Request example
This example request gets the license key for the https://www.organization.immuta.com
Immuta tenant.
Copy curl \
--request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://www.organization.immuta.com/admin/license
Response example
Copy [
{
"id" : 1 ,
"uuid" : "4cthe808-uniq-uec9-univ-ersal753fcid" ,
"features" : {
"FPE" : {
"enabled" : true
}
} ,
"handlers" : {} ,
"expires" : "2022-09-09T00:00:00.000Z" ,
"seats" : 20 ,
"createdAt" : "2021-09-09T13:47:02.473Z" ,
"notice" : null ,
"noticeOnExpire" : null
}
]
Get the status of a license
GET
/admin/license/licenseStatus
Get the status of a license key's features and seat capacity.
Response schema
Request example
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.
Copy curl \
--request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://www.organization.immuta.com/admin/license/licenseStatus
Response example
Copy {
"activeUserCount" : 1 ,
"licenseSeats" : 20 ,
"canAddUser" : true ,
"hardSeats" : 20
}
Get license usage
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.
Query parameters
Response schema
Request example
This request gets the license usage for 5 users in the https://www.organization.immuta.com
Immuta tenant.
Copy curl \
--request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://www.organization.immuta.com/admin/license/usage?offset= 0 & size = 5
Response example
Copy {
"summary" : {
"dataConsumers" : {
"totalCount" : 25 ,
"activeCount" : 10 ,
"inactiveCount" : 25
} ,
"policyOwners" : {
"totalCount" : 1
}
} ,
"users" : [{
"userType" : "policyOwner" ,
"name" : "Kris" ,
"email" : "kris@example.com" ,
"userid" : "kris@example.com" ,
"iamid" : "bim"
} ,
{
"userType" : "dataConsumer" ,
"active" : true ,
"name" : "Taylor" ,
"email" : "taylor@example.com" ,
"userid" : "taylor@example.com" ,
"iamid" : "AzureOIDC"
} ,
{
"userType" : "dataConsumer" ,
"active" : true ,
"name" : "Deepu" ,
"email" : "deepu@example.com" ,
"userid" : "deepu@example.com" ,
"iamid" : "AzureSAML"
} ,
{
"userType" : "dataConsumer" ,
"active" : false ,
"name" : "Marc" ,
"email" : "marc@example.com" ,
"userid" : "marc@example.com" ,
"iamid" : "OIDC"
} ,
{
"userType" : "dataConsumer" ,
"active" : true ,
"name" : "Mandeep" ,
"email" : "mandeep@example.com" ,
"userid" : "mandeep@example.com" ,
"iamid" : "SAML"
}
]
}
Delete a license key
DELETE
/admin/license/{licenseId}
Delete the specified license key.
Query parameters
Response schema
Request example
This example request deletes the license key with the ID 1
.
Copy curl \
--request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://www.organization.immuta.com/admin/license/1
Response example
Copy {
"id" : 1 ,
"licenseKey" : "<your-license-key>" ,
"seats" : 20 ,
"softSeats" : 0 ,
"expires" : "2022-09-09T00:00:00.000Z" ,
"uuid" : "4cthe808-uniq-uec9-univ-ersal753fcid" ,
"deleted" : true ,
"invalidated" : false ,
"features" : {
"FPE" : {
"enabled" : true
}
} ,
"handlers" : {} ,
"hardExpiration" : false ,
"notice" : null ,
"noticeOnExpire" : null ,
"createdAt" : "2021-09-09T13:47:02.473Z" ,
"updatedAt" : "2021-09-13T16:53:39.280Z" ,
"hardDelete" : false ,
"expired" : false
}