Configuring API Authentication

The authentication method for an API is set using the Manage API Auth form. The following steps allow the user to configure authentication settings for APIs as well as to copy settings from one API to another:

  1. On the APIX.XL ribbon, click the Manage API Auth button to open the Manage API Auth form.Manage API
  2. APIX™ currently supports the following authentication types: SSL Certificate, JWT OAuth, OAuth, Token, NTLM, and Basic Authentication.Auth Types

The authentication types currently supported by APIX™ are detailed below:

SSL Certificate
JWT OAuth
OAuth
Token
NTLM
Basic Authentication

SSL Certificate

  1. Select SSL_Certificate as the AUTH TYPE and click the EDIT button.SSL
  2. Once the Certificates form opens, choose between User storage or Local machine storage. The selection will display all available certificates for the chosen location.SSL Storage
  3. Select the correct certificate and click the SAVE button.
  4. The user will be returned to the Manage API Auth form. There, CURRENT SETTINGS will display the details of the selected authentication type. Review and click the OK button.Manage

JWT OAuth

  1. Select JWT_OAuth as the AUTH TYPE and click the EDIT button. JWT Edit
  2. In the JWT OAUTH form, enter the CLIENT ID, browse and select the PRIVATE KEY and PUBLIC CERTIFICATE files, and choose the ENVIRONMENT.JWT Environment
  3. Click the SAVE button.
  4. The user will be returned to the Manage API Auth form. CURRENT SETTINGS will display the details of the selected authentication type. Review and click the OK button.JWT Manage

OAuth

  1. Select OAuth as the AUTH TYPE and click the EDIT button.OAuth edit
  2. In the OAUTH form, enter URL, CLIENT ID, CLIENT SECRET, and SCOPE (if applicable).OAuth Scope
  3. Click the SAVE button.
  4. The user will be returned to the Manage API Auth form. CURRENT SETTINGS will display the details of the selected authentication type. Review and click the OK button.OAuth Manage

Token

  1. Select Token as the AUTH TYPE and click the EDIT button.Token Edit
  2. In the Token form, select TYPE and enter TOKEN NAME and TOKEN VALUE.Token Type
  3. Click the SAVE button.
  4. The user will be returned to the Manage API Auth form and CURRENT SETTINGS will display the details of the selected authentication type. Review and click the OK button.Token Manage

NTLM

  1. Select NTLM as the AUTH TYPE and click the OK button. NTLM Edit

Basic Authentication

  1. Select Basic as the AUTH TYPE and click the EDIT button.Basic edit
  2. In the Basic form, enter USER ID and PASSWORD.Basic form
  3. Click the SAVE button.
  4. The user will be returned to the Manage API Auth form and CURRENT SETTINGS will display the details of the selected authentication type. Review and click the OK button.Basic manage

Copying Authentication Settings

  1. Launch the Manage API Auth form by clicking the Manage API Auth button on the APIX.XL ribbon.
  2. Identify the API Auth settings that are to be copied and click the COPY button.Settings Edit
  3. On the Copy form, select the APIs to which the settings should be applied and click the COPY button.Settings
  4. Click the OK button on the confirmation window.
  5. The user will be returned to the Manage API Auth form and CURRENT SETTINGS for the selected APIs will display the details of the copied authentication type. Review and click the OK button.Settings manage

← Loading an API Locally
Publishing an API to APIX.Hub™ →