Cloud Administration Retrieve License Usage API Version 2Cloud Administration Retrieve License Usage API Version 2
Use the Cloud Administration Retrieve License Usage API Version 2 to retrieve the following information for the current month and previous 12 months:
-
Number of MFA licenses used
-
Number of users with third-party FIDO authenticators
-
Number of SMS and Voice tokencodes sent
-
Number of active users
Use this information to monitor for license compliance. The MFA license measures the number of users who have registered a device with the SecurID app installed. Your organization can then order additional licenses from SecurID if needed.
AuthenticationAuthentication
Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration APIs.
Administrative RolesAdministrative Roles
This API must use an API key that is associated with the Super Admin or Help Desk role. For more information, see Manage the Cloud Administration API Keys.
Software Developer KitSoftware Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Request RequirementsRequest Requirements
Use the following information to retrieve license usage information.
Method | Request URL | Response Body | Response Body Type | Response Codes |
---|---|---|---|---|
GET | AdminInterface/restapi/v2/licenseusage |
License information |
application/json | 200, 403, 500 |
Request ExampleRequest Example
The following example displays a REST API request to retrieve license usage information.
GET /AdminInterface/restapi/v2/licenseusage
Accept: application/json
Authorization: Bearer <JWT token>
Response Property DescriptionsResponse Property Descriptions
The following table shows response property descriptions and data types.
Property | Description | Data Type |
---|---|---|
mfaLicensesUsed |
Number of users who registered a device with the SecurID app installed in the given month. |
Integer |
usersWithThirdPartyFidoAuthenticators |
Number of users with third-party FIDO authenticators in the given month. See FIDO for a list of supported authenticators. |
Integer |
smsAndVoiceTokencodesSent |
Number of SMS and Voice tokencodes sent in the given month. |
Integer |
lastUpdatedAt |
UTC date and time when this information was collected, for example, 2021-05-19T16:29:59.000Z. Used for the current month only. |
ISO 8601 Date Time |
activeUsers | Number of active users in the given month. An active user either has a registered authenticator or who authenticated successfully. For details see Cloud Administration Console Dashboard. | Integer |
month | The current month in yyyy-mm format. | String |
Example ResponseExample Response
The following example shows a response.
[{"mfaLicensesUsed":0,"smsAndVoiceTokencodesSent":0,"month":"2021-02","lastUpdatedAt":"2021-02-01T20:55:45.000Z","activeUsers":1,"usersWithThirdPartyFidoAuthenticators":1},
{"mfaLicensesUsed":0,"smsAndVoiceTokencodesSent":0,"month":"2021-01","activeUsers":1,"usersWithThirdPartyFidoAuthenticators":1},
{"mfaLicensesUsed":0,"smsAndVoiceTokencodesSent":0,"month":"2020-12","activeUsers":1,"usersWithThirdPartyFidoAuthenticators":1},
{"mfaLicensesUsed":0,"smsAndVoiceTokencodesSent":0,"month":"2020-11","activeUsers":1,"usersWithThirdPartyFidoAuthenticators":1}]
Response CodesResponse Codes
The following table shows response codes for this API.
Code | Description |
---|---|
200 | Operation completed successfully. |
403 | Not authorized to perform the request. |
500 | Internal error occurred when processing the request. |
429 | Too many requests. |