---
title: "POST /access-rules"
method: POST
path: "/access-rules"
tags: ["access-rules"]
---

# POST /access-rules

`POST /access-rules`

Creates a new access rule config for the given group_id.

## Request body

- UpdateAccessRuleInfo — # UpdateAccessRuleInfo Object ### Description The `UpdateAccessRuleInfo` object is used as an input to the UpdateAccessRule and CreateAccessRule API.
  - `name` string, required — The name of the access rule.
  - `description` string, required — A description of the group.
  - `admin_owner_id` string, uuid, required — The ID of the owner of the group.
  - `status` 'ACTIVE' | 'PAUSED', required — The status of the access rule.
  - `ruleClauses` RuleClauses, required
    - `when` RuleConjunction, required
      - `clauses` RuleDisjunction[], required
        - `selectors` TagSelector[], required
          - `key` string, required
          - `value` string, required
          - `connection_id` string, uuid, required
        - `attribute_selectors` UserAttributeSelector[]
          - `attribute` 'HR_IDP_STATUS', required
          - `values` string[], required
    - `unless` RuleConjunction
      - `clauses` RuleDisjunction[], required
        - `selectors` TagSelector[], required
          - `key` string, required
          - `value` string, required
          - `connection_id` string, uuid, required
        - `attribute_selectors` UserAttributeSelector[]
          - `attribute` 'HR_IDP_STATUS', required
          - `values` string[], required

## Response `201`

The created access rule config for the group.

- AccessRule — # 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.
  - `name` string, required — The name of the access rule.
  - `description` string, required — A description of the group.
  - `admin_owner_id` string, uuid, required — The ID of the owner of the group.
  - `status` 'ACTIVE' | 'PAUSED', required — The status of the access rule.
  - `ruleClauses` RuleClauses, required
    - `when` RuleConjunction, required
      - `clauses` RuleDisjunction[], required
        - `selectors` TagSelector[], required
          - `key` string, required
          - `value` string, required
          - `connection_id` string, uuid, required
        - `attribute_selectors` UserAttributeSelector[]
          - `attribute` 'HR_IDP_STATUS', required
          - `values` string[], required
    - `unless` RuleConjunction
      - `clauses` RuleDisjunction[], required
        - `selectors` TagSelector[], required
          - `key` string, required
          - `value` string, required
          - `connection_id` string, uuid, required
        - `attribute_selectors` UserAttributeSelector[]
          - `attribute` 'HR_IDP_STATUS', required
          - `values` string[], required

---

[API](https://skmtc.net/opal/apis/opal-api.md) · [All operations](https://skmtc.net/opal/apis/opal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/opal/opal-api/revisions/13b58df96d40/schema)