Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Access the interactive Armor API (https://developer.armor.com/). 
  2. Click the Authentication section. 
  3. Click POST /auth/authorize
  4. On the right side, under Data Type, click Example Value
  5. Click the yellow field below Example Value. 
    • This action will populate the empty field on the left. 
  6. On the left, in the field under Value, remove the sample login credentials, and then enter your AMP username and password.  
  7. In Parameter content type, select application/json
  8. Click Try it out!
  9. Under Response Body, copy the code, including the equal sign ( = ).
  10. Locate and select POST /auth/token
  11. On the right side, under Data Type, click Example Value
  12. Click the yellow field below Example Value.
    • This action will populate the empty field on the left.  
  13. On the left, in the field under Value, remove the sample code, and then paste your code.
  14. In Parameter content type, select application/json
  15. Click Try it out!
    • This will display the access_token
  16. Under Response Body, copy the access_token
  17. Scroll up, and then in the Authorization field, enter FH-AUTH, followed by the copied access_token
    • A typical authorization credential should display as FH-AUTH afecb1543c3de8654.
  18. Click Authorize
    • The screen will refresh.
Excerpt
hiddentrue

test

  1. (Optional) You can click Authentication, and then click Get / me to find the account number for your other accounts. 
  2. Step 2: Locate your authorization code

    There are two ways to authenticate into the tool: 

    • Via the API tool and AMP
    • Via the command line


    Via Swagger and AMP



Via the command line how to handle a user with multiple accounts

  1. Enter the login information for the Armor Management Portal (AMP). Review the following example.   

    Code Block
    POST /auth/authorize
     
    {
      "username": "user@domain.com",
      "password": "password123%^&"
    }
  2. If the authentication is successful, you will receive the authorization code (code). Review the following example. 

    Code Block
    {
     "redirect_uri": null,
     "code": "<<base64-hash>>"
     "success": true
    }
  3. Redeem the authorization code (code) to retrieve the access token. Review the following example.   

    Code Block
    POST /auth/token
     
    {
      "code":"<<base64-hash>>"
      "grant_type":"authorization_code"
    }
  4. If the request is successful, you will receive the access token (access_token). You must redeem this token within two minutes of the previous request. Review the following example. 

    Code Block
    {
     "access_token": "<<32-bit-uuid>>",
     "id_token": "<<base64-hash>>",
     "expires_in": 1800,
     "token_type": "Bearer"
    }
  5. Go to apidoc.tde.armorlabs.co.
  6. In Authorization, enter the access token (access_token). 
  7. In X-Account-Context, enter the ID for the account. 
    • You can use the GET https://api.armor.com/me API to find the account ID (id)
  8. Click Authorize. You can now use the form to locate and test API calls before you enter the command line. 

...

Note

This section only applies to API call that require input parameters.

Warning

Although the button to execute the call is displayed as Try it out!, this feature is a live version of the Armor API. Certain calls will cause real-time changes to your environment.

  1. Click the desired API section (Account Management, Infrastructure, Authentication, Security, Network Services, Support), and then click the desired API call.  
  2. On the right, under Data Type, click Example Value.
  3. Click the yellow field below Example Value. 
    • This action will populate the empty field on the left. 
  4. On the left, in the field under Value, remove the sample code, and then make your desired changes. 
  5. In Parameter content type, select application/json
  6. Click Try it out! 
    • The fields below will populate with your changes, including the expected results. You can copy these fields and paste the information into the command line. 

...

Additional information

For more information on the Armor APIs, see Armor API Guide

...