gates
Gets a gate
GET
/
gates
/
{gateId}
Path Parameters
gateId
string
requiredID of the gate
Required string length:
36
Response
200 - application/json
id
string
requiredRequired string length:
36
name
string
requiredHuman-readable name of the gate. This should be something helpful to organize gates.
rules
object[]
requiredThe 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.
outcome
enum<string>
requiredAvailable 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.
Was this page helpful?