Cloud 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 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

Authentication

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 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 Kit

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to retrieve license usage information.

Method Request URL Response Body Response Body Type Response Codes
GET AdminInterface/restapi/v1/licenseusage

License information

 application/json 200, 403, 500

Request Example

The following example displays a REST API request to retrieve license usage information.

GET /AdminInterface/restapi/v1/licenseusage

Accept: application/json

Authorization: Bearer <JWT token>

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

 Integer
usersWithThirdPartyFidoAuthenticators

Number of users with third-party FIDO authenticators. See FIDO for a list of supported authenticators.

 Integer
smsAndVoiceTokencodesSent

Total number of SMS and Voice tokencodes sent for the current month.

 Integer
monthOfSmsAndVoiceTokencodesSent Numeric representation of the current month, for example, 1 = January, 2 = February, and so forth. Integer

lastUpdated

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 Response

The following example shows a response.

{

"mfaLicensesUsed": 11,

"usersWithThirdPartyFidoAuthenticators": 22,

"smsAndVoiceTokencodesSent": 33,

"monthOfSmsAndVoiceTokencodesSent": 10,

"lastUpdated": "2020-10-01T15:01:23.954Z",

"activeUsersThisMonth":18,

"monthOfActiveUsersThisMonth":10,

"activeUsersLastMonth":5,

"monthOfActiveUsersLastMonth":8

}

Response Codes

The following table shows response codes for this API.

Code Description
200 Operation completed successfully.
403 Not authorized to perform the request.
429 Too many requests.
500 Internal error occurred when processing the request.