Skip to main content
PUT
Update Access Request Rule

Path Parameters

id
string
required

Access request Rule ID

Body

application/json

The request body resource

access_type
enum<string>
required

The access type

Available options:
jit,
command
Example:

"command"

approval_required_groups
string[]
required

User groups whose members require approval to access. An empty list makes the rule apply to all user groups (every requester requires approval)

Example:
connection_names
string[]
required

Connection names that this rule applies to

Example:
force_approval_groups
string[]
required

Groups that can force approve sessions

Example:
name
string
required

The name of the access request rule

Example:

"default-access-request-rule"

reviewers_groups
string[]
required

Groups that can review sessions

Example:
access_max_duration
integer

Maximum access duration in seconds

Example:

3600

all_groups_must_approve
boolean

Whether all groups must approve

Example:

false

attributes
string[]

Attributes associated with this access request rule

Example:
description
string

The description of the access request rule

Example:

"Access request rule for production databases"

min_approvals
integer

Minimum number of approvals required

Example:

2

Response

OK

access_max_duration
integer

Maximum access duration in seconds

Example:

3600

access_type
enum<string>

The access type

Available options:
jit,
command
Example:

"command"

all_groups_must_approve
boolean

Whether all groups must approve

Example:

false

approval_required_groups
string[]

Groups that require approval

Example:
attributes
string[]

Attributes associated with this access request rule

Example:
connection_names
string[]

Connection names that this rule applies to

Example:
created_at
string
read-only

The time the resource was created

Example:

"2024-07-25T15:56:35.317601Z"

description
string

The description of the access request rule

Example:

"Access control rule for production databases"

force_approval_groups
string[]

Groups that can force approve sessions

Example:
id
string<uuid>
read-only

The resource identifier

Example:

"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7"

managed_by
string
read-only

Set to "hoop" when the rule is materialized and lifecycle-managed by a protection profile; only approval settings and group lists can be changed on managed rules, and they cannot be deleted

Example:

"hoop"

min_approvals
integer

Minimum number of approvals required

Example:

2

name
string

The name of the access request rule

Example:

"default-access-request-rule"

reviewers_groups
string[]

Groups that can review sessions

Example:
updated_at
string
read-only

The time the resource was updated

Example:

"2024-07-25T15:56:35.317601Z"