👩‍🏫
Big ACL Docs
big-acl.comStatusSupport
  • Welcome
  • What is Big ACL ?
  • Getting started
    • Signing up
    • Authoring your first rule
    • Writing Effective Rules
  • Key Concepts
    • Lifecycle of an Authorization Rule
    • Managing Exceptions
  • Authorization Landscape
    • RBAC
    • ABAC
    • ReBAC
    • CEDAR
    • XACML
    • Zanzibar
    • OAuth 2.0 Rich Authorization Requests
  • API
    • Authentication
    • Authorization
  • Connectors
    • Spring Security
    • Open Policy Agent
    • Amazon Verified Permissions
Powered by GitBook
On this page
  • Introduction to API Key Authentication
  • Obtaining an API Key
  • Making Authenticated Requests

Was this helpful?

  1. API

Authentication

This page explains how to authenticate with the Big ACL API using API Keys.

PreviousAPINextAuthorization

Last updated 2 months ago

Was this helpful?

Introduction to API Key Authentication

An API Key is a unique identifier that you attach to each request to verify that you have the permissions to access protected endpoints. Once you have your API Key, simply include it in the appropriate header when making requests.

Note: The Big ACL API does not support OAuth2 authentication at this time. The only supported mechanism is API Key-based authentication.

Obtaining an API Key

Here are the steps to create and retrieve an API Key:

  1. Log into the Big ACL Platform Navigate to your Big ACL dashboard and enter your username and password.

  2. Go to Applications Settings Once logged in, go to the Applications section.

  3. Create an Application In the API Keys area, retrieve the existing key.

Making Authenticated Requests

When you are ready to make requests to the Big ACL API, you need to include your API Key in the request header. Below is an example using an HTTP request with curl:

curl --request GET \
     --url https://api.big-acl.com \
     --header 'Authorization: Bearer YOUR_API_KEY'

Replace YOUR_API_KEY with the actual key you obtained in the previous step.

HTTP Headers

  • Authorization: The header must include Bearer followed by your API Key. This is the standard format for Big ACL authentication.