The Cloud Administration APIs are REST-based web service interfaces you can use to create clients that perform administrative operations.
Note: You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Information for Super Admins
The following information is for Super Admins:
- Manage the Cloud Administration API Keys
- Administration Log Messages for the Cloud Authentication Service
- User Event Monitor Messages for the Cloud Authentication Service
Note: When you create API keys, you must assign the Super Administrator role to keys that will be used in the Cloud Administration Add/Remove High-Risk User API and Cloud Administration Retrieve High-Risk User List API. This role ensures that the API has the appropriate administrative permissions in the Cloud Authentication Service.
Information for Application Client Developers
The following information is for the developer who builds client applications that can interact with these APIs.
|Authentication for the Cloud Administration APIs||Authenticate using a JSON Web Token (JWT).|
|Cloud Administration Event Log API||Retrieve audit log events from the Cloud Authentication Service. You can import these events into your security information and event management (SIEM) solution, such as RSA NetWitness.|
|Cloud Administration User Event Log API||Retrieve user event logs from the Cloud Authentication Service. You can import these events into your security and event management solution, such as RSA NetWitness.|
|Cloud Administration User Details API||Retrieve device and other details about individual users.|
|Cloud Administration Authenticator Details API|| |
Retrieve device details about individual users.
|Cloud Administration Delete User Device API|| |
Delete devices for individual users.
|Cloud Administration Retrieve Authentication Audit Logs API||Retrieve authentication audit logs.|
|Cloud Administration Update SMS and Voice Phone API||Update the user's phone numbers for SMS Tokencodes and Voice Tokencodes.|
|Cloud Administration Unlock User Tokencodes API||Unlock users' Authenticate Tokencodes, SMS Tokencodes, and Voice Tokencodes.|
|Cloud Administration User Status API||Update a user's status from Disabled to Enabled, or from Enabled to Disabled.|
|Cloud Administration Mark User Deleted API||Mark a disabled user as pending deletion. You can also undelete a user if marking that user for deletion was a mistake.|
|Cloud Administration Synchronize User API||Synchronize a user between an identity source and the Cloud Authentication Service.|
|Cloud Administration User Status API|| |
Find a user by searching for a string in the user's email address.
|Cloud Administration Health Check API||Receive frequent updates on the Cloud Authentication Service availability.|
|Cloud Administration Retrieve Device Registration Code API|| |
Generate a code so that users can register their iOS, Android, and Windows devices.
|Cloud Administration Enable Emergency Tokencode API||Enable Emergency Tokencode for a user.|
|Cloud Administration Disable Emergency Tokencode API||Disable Emergency Tokencode for a user.|
|Cloud Administration Add/Remove High-Risk User API||Add or remove one or more users from the high-risk user list. (Premium Edition)|
|Cloud Administration Retrieve High-Risk User List API||Retrieve a list of users who are identified as high risk. (Premium Edition)|
API Date and Time Format
The RSA Cloud Administration REST APIs format date and time timestamps as strings in ISO 8601 format using the UTC time standard. All APIs format timestamps with the complete date plus hours, minutes, seconds, and milliseconds using the ISO 8601 format:
In UTC time, an example of the returned string value is:
We want your feedback! Tell us what you think of this page.