Home
Vantage
Administrator Guide
Information about the Administration section of Vantage, and the tasks that you can do in this part of the software.
Administration
Teams
API keys
API authentication examples
Authenticate a third-party application with cURL
When you need to use the Vantage API and cURL to implement third-party authentication, you can use this example to help you.

Vantage
- Introduction
  An overview of Vantage.
- Administrator Guide
  Information about the Administration section of Vantage, and the tasks that you can do in this part of the software.
  - Administration
    - Administration page
      The administration page lets a user with administrator privileges configure settings and do other tasks.
    - System
    - Teams
      - Organizations
        The Organizations page shows your organizations, which are logical subdivisions within your Vantage account.
      - Groups
        The Groups page shows all the user groups in your organization, and lets you create and configure groups.
      - Users
        The Users page shows all the users that have been assigned in Vantage.
      - API keys
        API keys in Vantage
        For third-party applications that integrate with Vantage, you must use API keys to authenticate them.
        API authentication
        Once you have the API key name and token from Vantage, you can define your API calls, including enabling authentication of a third-party application.
        Considerations when you connect multiple applications to Vantage
        It is important to choose the correct approach when you want to connect multiple applications to Vantage. In many cases, you can create a single user that all of your applications use to access Vantage. However, if you have several applications that perform different kinds of task, each application may need its own user dedicated to its exclusive use.
        API Keys
        The API Keys page shows a list of all the API keys for every organization in the account.
        Generate an API key
        Before you can use an API key, you must generate one.
        Revoke an API key
        Once an API key has been created, you cannot edit it. You can only revoke it.
        API authentication examples
        Authenticate a third-party application with Postman
        When you need to use the Vantage API and Postman to implement third-party authentication, you can use this example to help you.
        Authenticate a third-party application with cURL
        When you need to use the Vantage API and cURL to implement third-party authentication, you can use this example to help you.
        Authenticate a third-party application with Ruby on Rails
        When you need to use the Vantage API and Ruby on Rails to implement third-party authentication, you can use this example to help you.
    - Organization Settings
  - Migration
  - SAML integration
- User Guide
  Information about the main features of Vantage and the tasks that you can do from the user interface (UI).
- Print format documentation
  A list of all the print-format documentation that is available for Vantage.

Authenticate a third-party application with cURL

When you need to use the Vantage API and cURL to implement third-party authentication, you can use this example to help you.

cURL is an open source command-line interface (CLI) tool for data transfer that is often used in API development. You can use cURL to send your key name and key token via hypertext transfer protocol secure (HTTPS) and receive an authorization token in return.

In the terminal, enter your command. For example:

export KEY_NAME="AK12345"
export KEY_TOKEN="abcdabcdabcd"  
curl -sSL -D - "https://VANTAGE_URL/api/v1/keys/sign_in" 
-H  "accept: */*" -H  "Content-Type: application/json" 
-d "{\"key_name\":\"$KEY_NAME\",\"key_token\":\"$KEY_TOKEN\"}" 
-o /dev/null

Vantage returns a response that's similar to this partial example:

HTTP/2 200 
content-type: application/json; charset=utf-8
content-length: 608
authorization: Bearer abcabcbac
[...]

Pass the authorization string with your subsequent cURL requests. For example, you can request the list of alerts:
```
curl -X GET "https://VANTAGE_URL/api/v1/alerts" 
-H  "accept: */*" -H  "Authorization: Bearer abcabcbac"
```