curl --request PUT \
--url https://use.hoop.dev/api/access-requests/rules/{name} \
--header 'Content-Type: application/json' \
--data '
{
"access_type": "command",
"approval_required_groups": [
"developers",
"analysts"
],
"connection_names": [
"pgdemo",
"mysql-prod"
],
"force_approval_groups": [
"admin"
],
"name": "default-access-request-rule",
"reviewers_groups": [
"sre",
"dba"
],
"access_max_duration": 3600,
"all_groups_must_approve": false,
"attributes": [
"production",
"pii"
],
"description": "Access request rule for production databases",
"min_approvals": 2,
"skip_review_groups": [
"sre"
]
}
'import requests
url = "https://use.hoop.dev/api/access-requests/rules/{name}"
payload = {
"access_type": "command",
"approval_required_groups": ["developers", "analysts"],
"connection_names": ["pgdemo", "mysql-prod"],
"force_approval_groups": ["admin"],
"name": "default-access-request-rule",
"reviewers_groups": ["sre", "dba"],
"access_max_duration": 3600,
"all_groups_must_approve": False,
"attributes": ["production", "pii"],
"description": "Access request rule for production databases",
"min_approvals": 2,
"skip_review_groups": ["sre"]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
access_type: 'command',
approval_required_groups: ['developers', 'analysts'],
connection_names: ['pgdemo', 'mysql-prod'],
force_approval_groups: ['admin'],
name: 'default-access-request-rule',
reviewers_groups: ['sre', 'dba'],
access_max_duration: 3600,
all_groups_must_approve: false,
attributes: ['production', 'pii'],
description: 'Access request rule for production databases',
min_approvals: 2,
skip_review_groups: ['sre']
})
};
fetch('https://use.hoop.dev/api/access-requests/rules/{name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://use.hoop.dev/api/access-requests/rules/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'access_type' => 'command',
'approval_required_groups' => [
'developers',
'analysts'
],
'connection_names' => [
'pgdemo',
'mysql-prod'
],
'force_approval_groups' => [
'admin'
],
'name' => 'default-access-request-rule',
'reviewers_groups' => [
'sre',
'dba'
],
'access_max_duration' => 3600,
'all_groups_must_approve' => false,
'attributes' => [
'production',
'pii'
],
'description' => 'Access request rule for production databases',
'min_approvals' => 2,
'skip_review_groups' => [
'sre'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://use.hoop.dev/api/access-requests/rules/{name}"
payload := strings.NewReader("{\n \"access_type\": \"command\",\n \"approval_required_groups\": [\n \"developers\",\n \"analysts\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"force_approval_groups\": [\n \"admin\"\n ],\n \"name\": \"default-access-request-rule\",\n \"reviewers_groups\": [\n \"sre\",\n \"dba\"\n ],\n \"access_max_duration\": 3600,\n \"all_groups_must_approve\": false,\n \"attributes\": [\n \"production\",\n \"pii\"\n ],\n \"description\": \"Access request rule for production databases\",\n \"min_approvals\": 2,\n \"skip_review_groups\": [\n \"sre\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://use.hoop.dev/api/access-requests/rules/{name}")
.header("Content-Type", "application/json")
.body("{\n \"access_type\": \"command\",\n \"approval_required_groups\": [\n \"developers\",\n \"analysts\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"force_approval_groups\": [\n \"admin\"\n ],\n \"name\": \"default-access-request-rule\",\n \"reviewers_groups\": [\n \"sre\",\n \"dba\"\n ],\n \"access_max_duration\": 3600,\n \"all_groups_must_approve\": false,\n \"attributes\": [\n \"production\",\n \"pii\"\n ],\n \"description\": \"Access request rule for production databases\",\n \"min_approvals\": 2,\n \"skip_review_groups\": [\n \"sre\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/access-requests/rules/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"access_type\": \"command\",\n \"approval_required_groups\": [\n \"developers\",\n \"analysts\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"force_approval_groups\": [\n \"admin\"\n ],\n \"name\": \"default-access-request-rule\",\n \"reviewers_groups\": [\n \"sre\",\n \"dba\"\n ],\n \"access_max_duration\": 3600,\n \"all_groups_must_approve\": false,\n \"attributes\": [\n \"production\",\n \"pii\"\n ],\n \"description\": \"Access request rule for production databases\",\n \"min_approvals\": 2,\n \"skip_review_groups\": [\n \"sre\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"access_max_duration": 3600,
"access_type": "command",
"all_groups_must_approve": false,
"approval_required_groups": [
"developers",
"analysts"
],
"attributes": [
"production",
"pii"
],
"connection_names": [
"pgdemo",
"mysql-prod"
],
"created_at": "2024-07-25T15:56:35.317601Z",
"description": "Access control rule for production databases",
"force_approval_groups": [
"admin"
],
"id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"managed_by": "hoop",
"min_approvals": 2,
"name": "default-access-request-rule",
"reviewers_groups": [
"sre",
"dba"
],
"skip_review_groups": [
"sre"
],
"updated_at": "2024-07-25T15:56:35.317601Z"
}{
"message": "the error description"
}{
"message": "the error description"
}{
"message": "the error description"
}{
"message": "the error description"
}Update Access Request Rule
Update an access request rule by ID
curl --request PUT \
--url https://use.hoop.dev/api/access-requests/rules/{name} \
--header 'Content-Type: application/json' \
--data '
{
"access_type": "command",
"approval_required_groups": [
"developers",
"analysts"
],
"connection_names": [
"pgdemo",
"mysql-prod"
],
"force_approval_groups": [
"admin"
],
"name": "default-access-request-rule",
"reviewers_groups": [
"sre",
"dba"
],
"access_max_duration": 3600,
"all_groups_must_approve": false,
"attributes": [
"production",
"pii"
],
"description": "Access request rule for production databases",
"min_approvals": 2,
"skip_review_groups": [
"sre"
]
}
'import requests
url = "https://use.hoop.dev/api/access-requests/rules/{name}"
payload = {
"access_type": "command",
"approval_required_groups": ["developers", "analysts"],
"connection_names": ["pgdemo", "mysql-prod"],
"force_approval_groups": ["admin"],
"name": "default-access-request-rule",
"reviewers_groups": ["sre", "dba"],
"access_max_duration": 3600,
"all_groups_must_approve": False,
"attributes": ["production", "pii"],
"description": "Access request rule for production databases",
"min_approvals": 2,
"skip_review_groups": ["sre"]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
access_type: 'command',
approval_required_groups: ['developers', 'analysts'],
connection_names: ['pgdemo', 'mysql-prod'],
force_approval_groups: ['admin'],
name: 'default-access-request-rule',
reviewers_groups: ['sre', 'dba'],
access_max_duration: 3600,
all_groups_must_approve: false,
attributes: ['production', 'pii'],
description: 'Access request rule for production databases',
min_approvals: 2,
skip_review_groups: ['sre']
})
};
fetch('https://use.hoop.dev/api/access-requests/rules/{name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://use.hoop.dev/api/access-requests/rules/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'access_type' => 'command',
'approval_required_groups' => [
'developers',
'analysts'
],
'connection_names' => [
'pgdemo',
'mysql-prod'
],
'force_approval_groups' => [
'admin'
],
'name' => 'default-access-request-rule',
'reviewers_groups' => [
'sre',
'dba'
],
'access_max_duration' => 3600,
'all_groups_must_approve' => false,
'attributes' => [
'production',
'pii'
],
'description' => 'Access request rule for production databases',
'min_approvals' => 2,
'skip_review_groups' => [
'sre'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://use.hoop.dev/api/access-requests/rules/{name}"
payload := strings.NewReader("{\n \"access_type\": \"command\",\n \"approval_required_groups\": [\n \"developers\",\n \"analysts\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"force_approval_groups\": [\n \"admin\"\n ],\n \"name\": \"default-access-request-rule\",\n \"reviewers_groups\": [\n \"sre\",\n \"dba\"\n ],\n \"access_max_duration\": 3600,\n \"all_groups_must_approve\": false,\n \"attributes\": [\n \"production\",\n \"pii\"\n ],\n \"description\": \"Access request rule for production databases\",\n \"min_approvals\": 2,\n \"skip_review_groups\": [\n \"sre\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://use.hoop.dev/api/access-requests/rules/{name}")
.header("Content-Type", "application/json")
.body("{\n \"access_type\": \"command\",\n \"approval_required_groups\": [\n \"developers\",\n \"analysts\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"force_approval_groups\": [\n \"admin\"\n ],\n \"name\": \"default-access-request-rule\",\n \"reviewers_groups\": [\n \"sre\",\n \"dba\"\n ],\n \"access_max_duration\": 3600,\n \"all_groups_must_approve\": false,\n \"attributes\": [\n \"production\",\n \"pii\"\n ],\n \"description\": \"Access request rule for production databases\",\n \"min_approvals\": 2,\n \"skip_review_groups\": [\n \"sre\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/access-requests/rules/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"access_type\": \"command\",\n \"approval_required_groups\": [\n \"developers\",\n \"analysts\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"force_approval_groups\": [\n \"admin\"\n ],\n \"name\": \"default-access-request-rule\",\n \"reviewers_groups\": [\n \"sre\",\n \"dba\"\n ],\n \"access_max_duration\": 3600,\n \"all_groups_must_approve\": false,\n \"attributes\": [\n \"production\",\n \"pii\"\n ],\n \"description\": \"Access request rule for production databases\",\n \"min_approvals\": 2,\n \"skip_review_groups\": [\n \"sre\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"access_max_duration": 3600,
"access_type": "command",
"all_groups_must_approve": false,
"approval_required_groups": [
"developers",
"analysts"
],
"attributes": [
"production",
"pii"
],
"connection_names": [
"pgdemo",
"mysql-prod"
],
"created_at": "2024-07-25T15:56:35.317601Z",
"description": "Access control rule for production databases",
"force_approval_groups": [
"admin"
],
"id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"managed_by": "hoop",
"min_approvals": 2,
"name": "default-access-request-rule",
"reviewers_groups": [
"sre",
"dba"
],
"skip_review_groups": [
"sre"
],
"updated_at": "2024-07-25T15:56:35.317601Z"
}{
"message": "the error description"
}{
"message": "the error description"
}{
"message": "the error description"
}{
"message": "the error description"
}Path Parameters
Access request Rule ID
Body
The request body resource
The access type
jit, command, jit_command "command"
User groups whose members require approval to access. An empty list makes the rule apply to all user groups (every requester requires approval)
["developers", "analysts"]
Connection names that this rule applies to
["pgdemo", "mysql-prod"]
Groups that can force approve sessions
["admin"]
The name of the access request rule
"default-access-request-rule"
Groups that can review sessions
["sre", "dba"]
Maximum access duration in seconds
3600
Whether all groups must approve
false
Attributes associated with this access request rule
["production", "pii"]
The description of the access request rule
"Access request rule for production databases"
Minimum number of approvals required
2
Groups whose members skip the approval review. Only allowed when approval_required_groups is empty
["sre"]
Response
OK
Maximum access duration in seconds
3600
The access type
jit, command, jit_command "command"
Whether all groups must approve
false
Groups that require approval
["developers", "analysts"]
Attributes associated with this access request rule
["production", "pii"]
Connection names that this rule applies to
["pgdemo", "mysql-prod"]
The time the resource was created
"2024-07-25T15:56:35.317601Z"
The description of the access request rule
"Access control rule for production databases"
Groups that can force approve sessions
["admin"]
The resource identifier
"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7"
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
"hoop"
Minimum number of approvals required
2
The name of the access request rule
"default-access-request-rule"
Groups that can review sessions
["sre", "dba"]
Groups whose members skip the approval review. Only honored when approval_required_groups is empty
["sre"]
The time the resource was updated
"2024-07-25T15:56:35.317601Z"
Was this page helpful?