Skip to main content
GET
/
access-requests
/
rules
/
{name}
Get Access Request Rule
curl --request GET \
  --url https://use.hoop.dev/api/access-requests/rules/{name}
import requests

url = "https://use.hoop.dev/api/access-requests/rules/{name}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

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 => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://use.hoop.dev/api/access-requests/rules/{name}"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/access-requests/rules/{name}")
.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::Get.new(url)

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",
  "min_approvals": 2,
  "name": "default-access-request-rule",
  "reviewers_groups": [
    "sre",
    "dba"
  ],
  "updated_at": "2024-07-25T15:56:35.317601Z"
}
{
"message": "the error description"
}
{
"message": "the error description"
}
{
"message": "the error description"
}

Path Parameters

name
string
required

Access request rule Name

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:
["developers", "analysts"]
attributes
string[]

Attributes associated with this access request rule

Example:
["production", "pii"]
connection_names
string[]

Connection names that this rule applies to

Example:
["pgdemo", "mysql-prod"]
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:
["admin"]
id
string<uuid>
read-only

The resource identifier

Example:

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

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:
["sre", "dba"]
updated_at
string
read-only

The time the resource was updated

Example:

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