Applies to: Microsoft Cloud App Security
The Microsoft Cloud App Security API provides programmatic access to Cloud App Security through REST API endpoints. Applications can use the API to perform read and update operations on Cloud App Security data and objects. For example, the Cloud App Security API supports the following common operations for a user object:
- Upload log files for Cloud Discovery
- Generate block scripts
- List activities, alerts, and policy reports
- Dismiss or resolve alerts
To see the full documentation of the API, in the Cloud App Security portal go to Help > API documentation.
In order to access the API, you have to create an API token and use it in your software to connect to the Cloud App Security API.
The API tokens tab enables you to help you manage all the API tokens of your tenant.
Generate a token
On the Settings menu, select Security extensions and then API tokens.
Click the plus icon, Generate new token and provide a name to identify the token in the future, and click Next.
Copy the token value and save it somewhere for recovery - if you lose it you need to regenerate the token. The token has the privileges of the user who issued it. For example, a security reader can't issue a token that can alter data.
You can filter the tokens by status: Active, Inactive, or Generated.
- Generated are tokens that have never been used.
- Active are tokens that were generated and were used within the past seven days.
- Inactive were used but there was no activity in the last seven days.
After you generate a new token, you'll be provided with a new URL to use to access the Cloud App Security portal.
The generic portal URL continues to work but is considerably slower than the custom URL provided with your token. If you forget the URL at any time, you can view it by going to the ? icon in the menu and selecting About.
If you are using Azure Active Directory Privileged Identity Management role activation, your API token will only be effective once the role is activated. For more information, see Activate my Azure AD roles in PIM.
API token management
The API token page includes a table of all the API tokens that were generated.
Full admins see all tokens generated for this tenant. Other users only see the tokens that they generated themselves.
The table provides details about when the token was generated and when it was last used and allows you to revoke the token.
After a token is revoked, it's removed from the table, and the software that was using it fails to make API calls until a new token is provided.
- SIEM connectors and log collectors also use API tokens. These tokens should be managed from the log collectors and SIEM agent sections and do not appear in this table.
- Deprovisioned users API tokens are retained in Cloud App Security but cannot be used. Any attempt to use them will result in a permission denied response. However, we recommend that such tokens are revoked on the API tokens page.
If you run into any problems, we're here to help. To get assistance or support for your product issue, please open a support ticket.