Passer au contenu principal
PATCH
Go

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id
string
requis

ID of the rule to retrieve.

Corps

script
string
défaut:function (user, context, callback) { callback(null, user, context); }

Code to be executed when this rule runs.

Minimum string length: 1
name
string
défaut:my-rule

Name of this rule.

Pattern: ^[a-zA-Z0-9]([ \-a-zA-Z0-9]*[a-zA-Z0-9])?$
order
number
défaut:2

Order that this rule should execute in relative to other rules. Lower-valued rules execute first.

Plage requise: x >= 0
enabled
boolean
défaut:true

Whether the rule is enabled (true), or disabled (false).

Réponse

Rule successfully updated.

name
string
défaut:rule_1

Name of this rule.

id
string
défaut:con_0000000000000001

ID of this rule.

enabled
boolean
défaut:true

Whether the rule is enabled (true), or disabled (false).

script
string
défaut:function (user, context, callback) { callback(null, user, context); }

Code to be executed when this rule runs.

order
number
défaut:1

Order that this rule should execute in relative to other rules. Lower-valued rules execute first.

stage
string
défaut:login_success

Execution stage of this rule. Can be login_success, login_failure, or pre_authorize.