Enter your email Address

  • Home
  • Home
Expand All Collapse All
  • Adding a User
  • New Blocks Testing
  • Alert Box Testing
  • About Infinity
    • Features in Infinity
    • Why Infinity?
  • Getting Started with Infinity
    • Contacting Infinity
  • Authoring Environment
    • How do Infinity features work?
      • Using Columns
      • Using Anchor Links
      • Using Tabs
      • Shortcode Testing
      • Image Zoom
      • Using Notes, Tips, Warnings
      • Using Audio and Video
      • Using Bullet Icons
      • Using Code Blocks
      • Using Collapsible Panels
      • Using Tables
      • Using File Attachment
    • Adding a new topic
    • Block Editor
      • Paragraph Block
      • Header Block
      • List Block
      • Image Block
      • Media and Text Block
      • Notices Block
      • File Block
      • Video Block
      • Code Block
      • Table Block
    • Adding links
      • Creating links to sections within a topic
    • Opening a topic in Edit mode
    • Quick Editing Topic Parameters
    • Adding Special Characters
    • Topic Content Statistics
    • Publishing a Topic
    • Updating a published topic
      • Updating a published topic for a later release
    • Public and Private Topics
      • Password Protecting a Topic
      • Role Based Access to Topic
    • Creating Table of Contents (TOC)
    • Categories
      • Creating a New Category
  • Reviews and Commenting
    • Comments Panel
    • Adding Review Comments
    • Editorial Comments Column
  • Media Library
    • About Media Library
    • Adding a Media to the Library
    • Inserting Media to the Topic
  • PDF Creation
    • Creating PDF of Single Topic
    • Creating PDF of Multiple Topics
  • Tools
    • Broken Link Check
  • Topic Revisions
    • Viewing Topic Revisions
    • Comparing Topic Revisions
    • Restoring the Topic Revision
  • FAQs
    • Managing FAQs
  • About Auth Armor API

About Auth Armor API

311 views 2 Updated on January 10, 2022

Export Pdf

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
  • Managing Secrets
  • Using the Auth Armor API

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?

2 Yes  No
Recent Topics
  • Alert Box Testing
  • New Blocks Testing
  • Adding a User
  • Using Code Blocks
  • Using Anchor Links
Popular Topics
  • New Blocks Testing
  • About Infinity
  • About Auth Armor API
  • Block Editor
  • Adding Special Characters
Tags
column column with image publishing single column
Infinity, a simple yet powerful cloud based authoring environment for technical writers to prepare technical documentation collaboratively.
Categories
  • Video tutorials
  • Knowledge base
  • FAQs
Support
  • Documentation
  • Forum
Need Support?
If you need any further help, don't hesitate to send contact us usign any of the following options:
[email protected]
+91 9922113311 | +91 7588623823
  • Privacy Policy
  • Terms of Use
  • Copyright © 2022 by QuickDraft LLP. All Rights Reserved.