Cloud Administration Retrieve License Usage API Version 1Cloud Administration Retrieve License Usage API Version 1
Use the Cloud Administration Retrieve License Usage API Version 1 to retrieve MFA license usage to monitor for license compliance. The MFA license measures the number of users who have registered a device with the SecurID Authenticate app installed. The customer can then order additional licenses from SecurID if needed.
The API allows administrators to access the following data:
Number of MFA licenses used
Number of users with third-party FIDO authenticators
Number of SMS and Voice tokencodes sent for the current month
Number of active users for the current month and previous month
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|
|application/json||200, 403, 500|
Request ExampleRequest Example
The following example displays a REST API request to retrieve license usage information.
Authorization: Bearer <JWT token>
Property Response DescriptionsProperty Response Descriptions
The following table shows property response descriptions and data types.
Number of users who registered a device with the SecurID Authenticate app installed.
Number of users with third-party FIDO authenticators. See FIDO for a list of supported authenticators.
Total number of SMS and Voice tokencodes sent for the current month.
|monthOfSmsAndVoiceTokencodesSent||Numeric representation of the current month, for example, 1 = January, 2 = February, and so forth.||Integer|
UTC date and time when this information was collected, for example, 2020-05-19T16:29:59.000 UTC.
|ISO 8601 Date Time|
|activeUsersThisMonth||Number of active users in the current month. An active user either has a registered authenticator or who authenticated successfully. For details see Cloud Administration Console Dashboard.||Integer|
|monthOfActiveUsersThisMonth||Numeric representation of the current month, for example, 1 = January, 2 = February, and so forth.||Integer|
|activeUsersLastMonth||Number of active users in the previous month.||Integer|
|monthOfActiveUsersLastMonth||Numeric representation of the previous month, for example, 1 = January, 2 = February, and so forth.||Integer|
Example ResponseExample Response
The following example shows a response.
Response CodesResponse Codes
The following table shows response codes for this API.
|200||Operation completed successfully.|
|403||Not authorized to perform the request.|
|500||Internal error occurred when processing the request.|