Authentication

​

Authentication Objects and Purpose

​

Authentication Steps

​

1 - Obtaining an API key

• Name: a description that helps you recognize the key.
• Permissions:
  • Default: the key inherits your current role permissions. If you can access a tenant, the key can access that tenant. If you are an organization administrator, the key has organization administrator access. If your role changes, the key’s access changes with it.
  • Restricted: the key only has the permissions you select. You can only select permissions that your role allows.
• Expiration date (optional): the key stops working at 00:00 (your local time) on that date. Setting an expiration date is recommended. Without one, the key never expires.

​

2 - Obtaining an API Token

curl --request POST \
  --url https://api.flare.io/tokens/generate \
  --header 'Authorization: <api-key>'

​

3 - Access an API endpoint

curl --request GET \
  --url https://api.flare.io/tokens/test \
  --header 'Authorization: Bearer <api-token>'

​

Finding tenant IDs

​

End-to-End Examples

import os
import requests


api_key = os.environ.get("FLARE_API_KEY")
if not api_key:
    raise Exception("Please provide an API key")

# Generate the API token.
token: str = requests.post(
    "https://api.flare.io/tokens/generate",
    headers={
        "Authorization": api_key,
    },
).json()["token"]

# Now we can use our token to access the testing endpoint.
resp = requests.get(
    "https://api.flare.io/tokens/test",
    headers={
        "Authorization": f"Bearer {token}",
    },
)
print(resp.json())

import os

from flareio import FlareApiClient


api_key = os.environ.get("FLARE_API_KEY")
if not api_key:
    raise Exception("Please provide an API key")

client = FlareApiClient(api_key=api_key)

# Generate the API token.
token: str = client.generate_token()

# Now we can use our token to access the testing endpoint.
resp = client.get("/tokens/test")
print(resp.json())