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

For information about managing access to this API, see Accessing the Cloud Administration APIs.

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.

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.

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.

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.