About Auth Armor API

91 views 0 Updated on October 13, 2021

Auth Armor has a simple and easy to use REST based API. You can find the Swagger documentation here: https://api.autharmor.com.

The API has two endpoints. One for Invites, and one for Auth Requests.

Authentication to the API is done via Oauth Client Credentials.

Creating OAuth Client

Procedure

  1. Log in to the Auth Armor application.
  2. In the left pane, click API Access.
    The API Access page appears where you can add, view and manage your current API credentials. 

    API Access
  3. Click Create new API client.
    The Add New Oauth Client page appears.

    Auth Client
    1. In the fields, enter the nickname for your client and an optional description.
    2. In the Allowed Permissions, click the appropriate permission button for the API client.
      The API credentials can have one or both permissions. 
    3. Click Create new OAuth Client.
      The Add New Oauth Client page appears with a message for the successful creation of the client and also the client_id and client_secret. 

      api client created
  4. Copy the client ID and client secret.
    Although, you can create additional secrets later if needed, you cannot get the current client ID and client secret values afterward.

Managing Secrets

After creating the Oauth Client, you can access the API Access page to view the secret details, add new secrets, and manage the existing secrets.

mceclip2.png

You can also click the Edit button for the secret and update the secret details. You can also disable the secret, if required.

mceclip4.png

Using the Auth Armor API

Once you have your API access, you can start using the API. Use the Postman tool and use the Swagger JSON file (https://api.autharmor.com/swagger/v1/swagger.json)

You can set Postman to use Oauth2 Client Credentials for Authentication. 

mceclip5.png

Now you are ready to use the API. Auth Armor also offers several libraries and SDK’s to help with development. Be sure to check out our GitHub page at https://github.com/autharmor

For more information about API Access, see Api Access.

Was this helpful?