Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

About the API Security Page

To access this page, click Administration > API Security.

Customer administrators can allow specified users to access protected service or resources using access tokens. The following security mechanisms are supported:

  • API keys—Authorized users such as administrators can create new API keys for a specific user (or service account) from the Juniper Security Director Cloud portal. They can also configure roles and access privileges for the user.

  • OAuth 2.0—This option enables customers to leverage their existing Identity Providers (IdPs) to authenticate users, and assign successfully authenticated users and service accounts to a given role. Note that the roles assigned by the IdPs must also be created on Security Director Cloud. The supported IdPs are Okta and Entra ID (Azure AD).

Juniper Security Director Cloud supports Swagger 2.0 REST API specifications in JSON format. To access the Swagger API specification, open a web browser and enter https://base-url/sd-swagger/, where base-url is the root address of the website or application. You can access APIs for the following management functions:

  • Identity and access management (IAM)

  • PAC Manager

  • Service Location

  • Sites

While IAM APIs are available to both Juniper Security Director Cloud customers and Junos SRX Series firewall customers, PAC Manager, Service location, and Sites APIs are available only to Juniper Security Director Cloud customers.

To use an API key or OAuth token, add it to the HTTP header requests. For example, x-api-key: abcdef12345 and x-oauth2-token: abcdef12345.

Tasks You Can Perform

You can perform the following tasks from this page:

Field Descriptions

Table 1 provides guidelines on using the fields on the API Keys tab.

Table 1: Fields on the API Security—API Keys Tab

Field

Description

Name

The name of the API key.

API Key

API key is hidden.

Description

A brief description about the API key.

User Account Name

Name of the user who generated the API key.

Created Date

The date and time when the API key was generated.

Expiry Date

The date and time until the API key is valid. The default is one year from the time of creation.

Table 2 provides guidelines on using the fields on the OAuth Server tab.

Table 2: Fields on the API Security-OAuth Servers Tab

Field

Description

Name

Name of the OAuth server.

Issuer

Issuer of the OAuth server.

Public Key

Specifies the Privacy Enhanced Mail (PEM) file or JSON Web Key Set Universal Resource Identifier URI (jwks_uri) for your IdP.

User Account Name

Name of the user who added the OAuth server.

OAuth ID

OAuth ID is autogenerated when you add an OAuth server.