API Authorization

HTTP requests can be authorized using access keys. Access keys are attached to roles to limit the scope of what they provide access to. Access keys can be managed via https://app.bird.com/settings/security/access-keys

Keep in mind to always limit the access keys permissions by assigning the minimum required access roles to it

Creating an access key

In this example we will create an access key that will attach the access role that was created in the access roles example

Generate a new access key

1. The first step is to give the access key a meaningful name and description.

2. Next attach one or more roles to the access key

3. Finally create the access key

   

   Create an access key

Authorize HTTP requests with access keys

In order to authenticate HTTP requests with an access key, you must provide it in the Authorization HTTP header with the following format. Replace <access-key> with your valid access key.

Authorization: AccessKey <access-key>