Gate

id

string

required

Required string length: 36

name

string

required

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

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.

Show child attributes

outcome

enum<string>

required

Available options:

scope,

siteAccess,

block

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.

enabledAt

string | null

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