Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
Gates

Creates a new gate for the project environment

post/environments/{environmentId}/gates

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Request body

namestring required

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

outcome'scope' | 'siteAccess' | 'block' required
scopestring

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.

Example request

{
  "name": "Super User Gate",
  "scope": "superuser",
  "rules": [
    {
      "address": {
        "networkId": 1,
        "contractAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834"
      },
      "filter": {
        "tokenId": "0x01"
      }
    }
  ]
}

Response

Successfully created

idstring required
namestring required

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

scopestring

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.

enabledAtstring date-time nullable

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

outcome'scope' | 'siteAccess' | 'block' required

Example response

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "name": "Super User Gate",
  "scope": "superuser",
  "rules": [
    {
      "address": {
        "networkId": 1,
        "contractAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834"
      },
      "filter": {
        "tokenId": "0x01"
      }
    }
  ]
}