Skip to main content

New-Scale Security Operations PlatformNew-Scale Security Operations Platform Administration Guide

Access Control APIs

The Access Control APIs provide a way to programmatically view users, roles, and API keys that are configured in your environment. You can use the APIs to retrieve this type of information without the need to log into the New-Scale Security Operations Platform and navigate the Settings options. The table below lists the current actions that can be managed via APIs.

To access these API endpoints, you must have an API key with Access Control permissions. For information about creating API keys, see Create an API Key in the API Get Started Guide.

The following table lists the Access Control APIs that are available. For specific information about API request and response parameters, see the Exabeam API Reference Guide and use the left navigation panel to find the Access Control endpoints.

Endpoint

Summary

Description

Response

GET access-control/v1/users

View Users

Retrieve a list of configured users.

Returns a JSON array of information about each user, including Name, IdP, Email, Roles, Status, and Last Login.

GET access-control/v1/roles

View Roles

Retrieve a list of configured roles.

Returns a JSON array for each role, both default and custom, including the associated permissions for each role.

GET access-control/v1/apikeys

View API Keys

Retrieve a list of configure API keys.

Returns a JSON array of information about each API key, including the key Name, ID, and the last time it was used.