Request body to create a new gate. The gate will be not enabled by default.

​
name
string
required

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

Example:

"Super User Gate"

​
outcome
enum<string>
required
Available options:
scope,
siteAccess,
block
​
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.

Definition for a single rule in a Gate. This will check for the presence of a token or NFT, given the contract address, in the wallet of a user being evaluated. For multi-wallet users, we will check all wallets. If a filter is defined, then we will also check that the filter checks apply to the user

​
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.

Example:

"superuser"

Was this page helpful?