Skip to main content
GET
/
access-rules
/
{access_rule_id}
cURL
curl --request GET \
  --url https://api.opal.dev/v1/access-rules/{access_rule_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.opal.dev/v1/access-rules/{access_rule_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opal.dev/v1/access-rules/{access_rule_id}', 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://api.opal.dev/v1/access-rules/{access_rule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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://api.opal.dev/v1/access-rules/{access_rule_id}"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.opal.dev/v1/access-rules/{access_rule_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.opal.dev/v1/access-rules/{access_rule_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "access_rule_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "name": "Platform Engineering",
  "description": "This access rule represents all platform engineers in the company.",
  "admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "status": "ACTIVE",
  "ruleClauses": {
    "when": {
      "clauses": [
        {
          "selectors": [
            {
              "key": "<string>",
              "value": "<string>",
              "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "attribute_selectors": [
            {
              "attribute": "HR_IDP_STATUS",
              "values": [
                "<string>"
              ]
            }
          ]
        }
      ]
    },
    "unless": {
      "clauses": [
        {
          "selectors": [
            {
              "key": "<string>",
              "value": "<string>",
              "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "attribute_selectors": [
            {
              "attribute": "HR_IDP_STATUS",
              "values": [
                "<string>"
              ]
            }
          ]
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

access_rule_id
string<uuid>
required

The access rule ID (group ID) of the access rule.

Response

200 - application/json

The access rules for the group.

Access Rule Object

Description

The AccessRule object is used to represent an access rule configuration.

Usage Example

List access rules from the GET /access-rules endpoint, or retrieve a single access rule from the GET /access-rules/{access_rule_id} endpoint.

access_rule_id
string<uuid>
required

The ID (group ID) of the access rule.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

name
string
required

The name of the access rule.

Example:

"Platform Engineering"

description
string
required

A description of the group.

Example:

"This access rule represents all platform engineers in the company."

admin_owner_id
string<uuid>
required

The ID of the owner of the group.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

status
enum<string>
required

The status of the access rule.

Available options:
ACTIVE,
PAUSED
Example:

"ACTIVE"

ruleClauses
object
required
Last modified on July 10, 2026