Identity Exposure: Complete API Reference and New Guides
Tenable has expanded the Tenable Identity Exposure API documentation with descriptions for all 131 endpoints, including their parameters, request body properties, response properties, data types, and response codes. Endpoint reference pages also identify the required license types and role permissions, where applicable, so you can see what each request requires before you send it.
The API itself has not changed. Existing API requests and responses continue to work as before.
What's New in the API Reference
The updated reference includes:
- Descriptions for every endpoint and the parameters and properties they use
- Required license types and role permissions, where applicable
- Mappings between API terminology and the terms used in the Tenable Identity Exposure interface
- Response codes and descriptions of when to expect errors such as
400or404 - Data types and formats for request and response properties
New Guides
Tenable has also published the following guides to help you work with the Identity Exposure API:
| Guide | Description |
|---|---|
| Get Started | Explains how to find your instance URL, generate and refresh API keys, and authenticate using the x-api-key header or a sign-in token. |
| Terminology | Maps API terminology, such as infrastructure, directory, and checker, to the corresponding terms used in the interface. |
| License Types | Explains the license type codes listed in endpoint descriptions and how to determine which features your license includes. |
| Customize Security Profiles | Explains how to stage Indicator of Exposure options on a security profile and then commit or discard the changes. |
The Roles and Permissions pages now include new sections describing the Tenable Identity Exposure role and permission model.
Updated API Reference URLs
Each endpoint now has a consistent name and operationId, so the reference pages use new URLs. Links to the previous reference pages redirect to their replacements.
For example:
| Endpoint | Name | Update |
|---|---|---|
| GET /api/profiles | List profiles | Reference page URL changed from get_api-profiles to tie-profiles-list. |
| GET /api/infrastructures/{infrastructureId}/directories/{directoryId}/deviances | List deviances | Reference page URL changed from get_api-infrastructures-infrastructureid-directories-directoryid-deviances to tie-deviances-list. |
| POST /api/api-key | Create API key | Reference page URL changed from post_api-api-key to tie-current-user-create-api-key. |
CautionIf you generate client code or collections from the downloadable OpenAPI file, regenerate them to incorporate the updated
operationIdvalues and consistently named schemas. Generated method and type names will change, although the underlying API endpoints, requests, and responses remain unchanged.
For more information about Tenable Identity Exposure, see the Tenable One Identity Exposure SaaS User Guide.