Rehive logo
Powered by Redocly

authenticator-rules

List authenticator rules

SecurityapiAuth
Request
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/authenticator-rules/
Request samples 
rehive.admin.authenticator_rules.get()
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create authenticator rule

SecurityapiAuth
Request
Request Body schema:
required
type
required
string
  • authentication - Authentication
  • authorization - Authorization
  • setup - Setup
Enum: "authentication" "authorization" "setup"
durability
required
string
  • ephemeral - Ephemeral
  • durable - Durable
  • permanent - Permanent
Enum: "ephemeral" "durable" "permanent"
authenticator_types
required
Array of strings
Items Enum: "totp" "sms" "static"
permissions
Array of strings or null
group
string
duration
integer or null [ -2147483648 .. 2147483647 ]
session_age
integer or null [ -2147483648 .. 2147483647 ]
Responses
201
post/3/admin/authenticator-rules/
Request samples
{
  • "type": "authentication",
  • "durability": "ephemeral",
  • "authenticator_types": [
    ],
  • "permissions": [
    ],
  • "group": "string",
  • "duration": -2147483648,
  • "session_age": -2147483648
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve authenticator rule

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/admin/authenticator-rules/{identifier}/
Request samples 
rehive.admin.authenticator_rules.get(authenticator_rule_id)
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update athenticator rule

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
required
durability
required
string
  • ephemeral - Ephemeral
  • durable - Durable
  • permanent - Permanent
Enum: "ephemeral" "durable" "permanent"
authenticator_types
required
Array of strings
Items Enum: "totp" "sms" "static"
permissions
Array of strings or null
duration
integer or null [ -2147483648 .. 2147483647 ]
session_age
integer or null [ -2147483648 .. 2147483647 ]
Responses
200
put/3/admin/authenticator-rules/{identifier}/
Request samples
{
  • "durability": "ephemeral",
  • "authenticator_types": [
    ],
  • "permissions": [
    ],
  • "duration": -2147483648,
  • "session_age": -2147483648
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update athenticator rule

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Request Body schema:
durability
string
  • ephemeral - Ephemeral
  • durable - Durable
  • permanent - Permanent
Enum: "ephemeral" "durable" "permanent"
authenticator_types
Array of strings
Items Enum: "totp" "sms" "static"
permissions
Array of strings or null
duration
integer or null [ -2147483648 .. 2147483647 ]
session_age
integer or null [ -2147483648 .. 2147483647 ]
Responses
200
patch/3/admin/authenticator-rules/{identifier}/
Request samples
{
  • "durability": "ephemeral",
  • "authenticator_types": [
    ],
  • "permissions": [
    ],
  • "duration": -2147483648,
  • "session_age": -2147483648
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete authenticator rule

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
delete/3/admin/authenticator-rules/{identifier}/
Request samples 
rehive.admin.authenticator_rules.delete(authenticator_rule_id)
Response samples
application/json
{
  • "status": "sucess"
}
➔ Next to bank-accounts