Opal Security

Opal Security Groups API

Operations related to groups

GitHub OpenAPI

Operations 28

GET /groups Get groups #
PUT /groups Update groups #
POST /groups Create group #
GET /groups/{group_id} Get group by ID #
DELETE /groups/{group_id} Delete group #
GET /groups/{group_id}/message-channels Get group message channels #
PUT /groups/{group_id}/message-channels Set group message channels #
GET /groups/{group_id}/on-call-schedules Get group on call schedules #
PUT /groups/{group_id}/on-call-schedules Set group on call schedules #
GET /groups/{group_id}/resources Get group resources #
PUT /groups/{group_id}/resources Set group resources #
GET /groups/{group_id}/containing-groups Get nested groups #
POST /groups/{group_id}/containing-groups Add group containing group #
GET /groups/{group_id}/containing-groups/{containing_group_id} Get nested group by ID #
DELETE /groups/{group_id}/containing-groups/{containing_group_id} Remove group containing group #
POST /groups/{group_id}/resources/{resource_id} Add group resource #
GET /groups/{group_id}/visibility Get group visibility #
PUT /groups/{group_id}/visibility Set group visibility #
GET /groups/{group_id}/reviewers Get group reviewers #
PUT /groups/{group_id}/reviewers Set group reviewers #
GET /groups/{group_id}/reviewer-stages Get group reviewer stages #
PUT /groups/{group_id}/reviewer-stages Set group reviewer stages #
GET /groups/{group_id}/tags Get group tags #
GET /groups/{group_id}/users Get group users #
PUT /groups/{group_id}/users/{user_id} Update group user #
POST /groups/{group_id}/users/{user_id} Add group user #
DELETE /groups/{group_id}/users/{user_id} Delete group user #
GET /groups/users/{user_id} Get user groups #

Documentation

📖
Documentation
https://docs.opal.dev/
📖
APIReference
https://docs.opal.dev/api-reference/access-rules/get-access-rules

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/openapi/opal-security-groups-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/errors/opal-security-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/data-model/opal-security-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/conventions/opal-security-conventions.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/asyncapi/opal-security-events-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/opal-security-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

opal-security-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: hello@opal.dev
    name: Opal Team
    url: https://www.opal.dev/
  description: The Opal API is a RESTful API that allows you to interact with the Opal Security platform programmatically.
  title: Opal Groups API
  version: '1.0'
servers:
- description: Production
  url: https://api.opal.dev/v1
tags:


# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/openapi/opal-security-groups-api-openapi.yml