Skip to main content
POST
/
environments
/
{environmentId}
/
allowlists
Create an allowlist for the environment
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/allowlists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "An example name",
  "scope": "An example name"
}
'
{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "name": "<string>",
  "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
  "enabledAt": "2023-11-07T05:31:56Z",
  "scope": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

Fields necessary to create a new allowlist

​
name
string
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
scope
string
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

​
outcome
enum<string>
Available options:
scope,
siteAccess,
block

Response

Created

​
id
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
name
string
required

Human-readable name of the allowlist

​
projectEnvironmentId
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
enabledAt
string<date-time> | null

ISO 8601 timestamp of when the allowlist was enabled, or null if disabled

​
scope
string | null

Space-delimited permission scopes granted to matched users

​
outcome
enum<string>
Available options:
scope,
siteAccess,
block