API references

SafeNet Trusted Access (STA) includes the following APIs:

• REST API for STA: Provides programmatic access to management and logging functions of STA, including account information, application management, user and group management.

• SCIM API for STA: Includes inbound REST endpoints for the SCIM 2.0 model. You can connect a user repository that supports outbound SCIM directly to STA, and use the SCIM protocol to provision your users into STA.

• WSDL BSIDCA API: Provides SOAP-based web API methods for automating account, token, and user management functions for STA and SafeNet Authentication Service Private Cloud Edition (SAS PCE).

REST and SCIM APIs for STA

To use the REST and SCIM APIs for STA, you need the following:

• API key for authentication

• Endpoint URL to access the APIs

• Tenant code for your virtual server or account

• API documentation that describes the endpoints, methods, requests, and responses

Get an API key

1. On the STA Access Management console, select Settings > API Keys.

   

2. Generate an API key.

Endpoint URL

The endpoint URL is the entry point to all API calls.

You can find the endpoint URL on the STA Access Management console in Settings > API Keys.

• To copy the endpoint URL and use it to configure your custom API client, select the Copy to clipboard icon .

Tenant code

The tenant code is the unique identifier for a virtual server or account. To use the STA APIs, you need to provide your tenant code with each request, which ensures that each virtual server can access only their data.

The tenant code consists of 10 alphanumeric characters (ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789), such as Q41RKXHPWU.

• On the API Keys page, find your tenant code in the Endpoint URL:

  

You can also find your tenant code in the self-service and user portal URLs:

• On the STA Token Management console, you can find the tenant code in Self-Service > Configuring Self-Service > Self-Service Policy > Self-Service Unique URL.

  

• On the STA Access Management console, find the tenant code in the URL for the user portal application in Applications > User Portal.

  

API documentation

The API reference documentation describes the endpoints, methods, requests, and responses.

1. Select Settings > API Keys.

   

2. Select the Read API documentation link. The API documentation opens in a new tab.

Try out the API and test your API key

The easiest way to try out the API is to access it from the API documentation.

1. On the STA Access Management console, select Settings > API Keys.

2. Select the Read API documentation link.

   The API documentation opens in a new tab.

3. Select Authorize.

   

4. In the Value field, enter your API key.

   

5. Select Authorize and then select Close.

   You are now authorized to use the API and can try any of the API calls. The API key is automatically included in the header of the API calls.

6. Under Diagnostics, expand the authorized endpoint:

   /api/v1/tenants/{tenantCode}/authorized

7. Select Try it out.

   

8. Under Parameters, enter your tenantCode.

9. Select Execute.