POST
/
environments
/
{environmentId}
/
gates
Authorization
Path
Body
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/gates \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Super User Gate",
  "outcome": "scope",
  "rules": [
    {
      "address": {
        "contractAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "networkId": 1
      },
      "filter": {},
      "type": "nft"
    }
  ],
  "scope": "superuser"
}'
{
  "enabledAt": "2023-11-07T05:31:56Z",
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "name": "Super User Gate",
  "outcome": "scope",
  "rules": [
    {
      "address": {
        "contractAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "networkId": 1
      },
      "filter": {},
      "type": "nft"
    }
  ],
  "scope": "superuser"
}

Path Parameters

environmentId
string
required

ID of the environment

Body

application/json
name
string
required

Human-readable name of the gate. This should be something helpful to organize gates.

outcome
enum<string>
required
Available options:
scope,
siteAccess
rules
object[]
required

The rules which will be used to evaluate users being verified. If multiple rules are present in a single gate, then all the rules need to apply for the user to gain the scope defined by the gate.

scope
string

String for the resulting scope of the gate. If the rules of the gate apply to the user being verified, then this scope will be surfaced in the JWT. If a scope is not provided for the gate, the default behavior of the gate would be to block access to users that the rules do not currently apply to.

Response

201 - application/json
enabledAt
string | null

If the gate is enabled, then this timestamp will be present.

id
string
required
name
string
required

Human-readable name of the gate. This should be something helpful to organize gates.

outcome
enum<string>
required
Available options:
scope,
siteAccess
rules
object[]
required

The rules which will be used to evaluate users being verified. If multiple rules are present in a single gate, then all the rules need to apply for the user to gain the scope defined by the gate.

scope
string

String for the resulting scope of the gate. If the rules of the gate apply to the user being verified, then this scope will be surfaced in the JWT. If a scope is not provided for the gate, the default behavior of the gate would be to block access to users that the rules do not currently apply to.