Cloud Administration Retrieve License Usage API

Document created by RSA Information Design and Development Employee on Jul 21, 2020Last modified by RSA Information Design and Development Employee on Oct 20, 2020
Version 5Show Document
  • View in full screen mode

Use the Cloud Administration Retrieve License Usage API 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 RSA SecurID Authenticate app installed. The customer can then order additional licenses from RSA 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

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.

                        
MethodRequest URLResponse BodyResponse Body TypeResponse Codes
GET /AdminInterface/restapi/v1/licenseusage

License information

application/json200, 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>

Property Response Descriptions

The following table shows property response descriptions and data types.

                                      
PropertyDescriptionData Type
mfaLicensesUsedNumber of users who registered a device with the RSA SecurID Authenticate app installed.Integer
usersWithThirdPartyFidoAuthenticatorsNumber of users with third-party FIDO authenticators. See FIDO for a list of supported authenticators.Integer
smsAndVoiceTokencodesSentTotal number of SMS and Voice tokencodes sent for the current month.Integer
monthOfSmsAndVoiceTokencodesSentNumeric 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

Example Response

The following example shows a response.

{

"mfaLicensesUsed": 11,

"usersWithThirdPartyFidoAuthenticators": 22,

"smsAndVoiceTokencodesSent": 33,

"monthOfSmsAndVoiceTokencodesSent": 10,

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

}

Response Codes

The following table shows response codes for this API.

                       
CodeDescription
200Operation completed successfully.
403Not authorized to perform the request.
500Internal error occurred when processing the request.

 

 

 

You are here
Table of Contents > Cloud Administration APIs > Cloud Administration Retrieve License Usage API

Attachments

    Outcomes