StepSecurity API (Tenant Access)

circle-info

This page covers API access for managing all organizations under your tenant. If you only need access for a single organization, refer to this page

To access and interact with StepSecurity’s API, you must obtain an API key. StepSecurity provides both Tenant API keys for full access and read-only API keys for safely retrieving data without making changes. Use your Tenant’s API key management features, including key rotation, for secure handling. The API key enables you to authenticate requests and explore available endpoints through the Swagger documentation.

Authorizing API Access in StepSecurity

Step 1: Navigate to the API Key Section

  • Under Integrations, select StepSecurity API

Step 2: Copy the API Key

API settings showing Swagger documentation
API Settings

Step 3: Click Authorize on the API documentation section.

API settings showing Swagger documentation
API Settings

Step 4: Paste Your API Key

  • A pop-up window will appear.

  • Paste the copied API key into the Value field.

  • Click Authorize.

API settings showing Swagger documentation
API Settings

Step 5: Test API Endpoints

  • Select an API endpoint from the documentation.

  • Click Try it out.

  • Fill in any required parameters.

  • Click Execute to send the request.

API settings showing Swagger documentation
API Settings

Last updated

Was this helpful?