How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Opal Security

Opal Security Groups API

Operations related to groups

Documentation Provider Profile APIs.io OpenAPI GitHub

Opal Security Groups API is one of 22 APIs that Opal Security publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 28 operations across 15 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.opal.dev/v1.

28 operations 15 paths 39 schemas 3 DELETE13 GET4 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.opal.dev/v1
Authentication
HTTP Bearer
Contact
Opal Team
Resource Areas
1

Authentication & Security 1

Opal Security Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 28

Across 15 paths, the API surfaces 28 operations — 3 DELETE, 13 GET, 4 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 28

Operations related to groups

GET
/groups
Get groups
getGroups 6 params → 200
PUT
/groups
Update groups
updateGroups body → 200
POST
/groups
Create group
createGroup body → 200
GET
/groups/{group_id}
Get group by ID
getGroup 1 param → 200
DELETE
/groups/{group_id}
Delete group
delete_group 1 param → 200
GET
/groups/{group_id}/message-channels
Get group message channels
get_group_message_channels 1 param → 200
PUT
/groups/{group_id}/message-channels
Set group message channels
set_group_message_channels 1 param body → 200
GET
/groups/{group_id}/on-call-schedules
Get group on call schedules
get_group_on_call_schedules 1 param → 200
PUT
/groups/{group_id}/on-call-schedules
Set group on call schedules
set_group_on_call_schedules 1 param body → 200
GET
/groups/{group_id}/resources
Get group resources
get_group_resources 1 param → 200
PUT
/groups/{group_id}/resources
Set group resources
set_group_resources 1 param body → 200
GET
/groups/{group_id}/containing-groups
Get nested groups
get_group_containing_groups 2 params → 200
POST
/groups/{group_id}/containing-groups
Add group containing group
add_group_containing_group 1 param body → 200
GET
/groups/{group_id}/containing-groups/{containing_group_id}
Get nested group by ID
get_group_containing_group 2 params → 200
DELETE
/groups/{group_id}/containing-groups/{containing_group_id}
Remove group containing group
remove_group_containing_group 3 params → 204
POST
/groups/{group_id}/resources/{resource_id}
Add group resource
add_group_resource 3 params body → 200
GET
/groups/{group_id}/visibility
Get group visibility
get_group_visibility 1 param → 200
PUT
/groups/{group_id}/visibility
Set group visibility
set_group_visibility 1 param body → 200
GET
/groups/{group_id}/reviewersdeprecated
Get group reviewers
get_group_reviewers 1 param → 200
PUT
/groups/{group_id}/reviewersdeprecated
Set group reviewers
set_group_reviewers 1 param body → 200
GET
/groups/{group_id}/reviewer-stagesdeprecated
Get group reviewer stages
get_group_reviewer_stages 1 param → 200
PUT
/groups/{group_id}/reviewer-stagesdeprecated
Set group reviewer stages
set_group_reviewer_stages 1 param body → 200
GET
/groups/{group_id}/tags
Get group tags
get_group_tags 1 param → 200
GET
/groups/{group_id}/users
Get group users
get_group_users 3 params → 200
PUT
/groups/{group_id}/users/{user_id}
Update group user
update_group_user 2 params body → 200
POST
/groups/{group_id}/users/{user_id}
Add group user
add_group_user 4 params body → 200
DELETE
/groups/{group_id}/users/{user_id}
Delete group user
delete_group_user 3 params → 200
GET
/groups/users/{user_id}
Get user groups
get_user_groups 3 params → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are GroupRemoteInfo (30 properties), Group (29 properties), UpdateGroupInfo (21 properties), RequestConfiguration (11 properties). Each schema is shown below with its type and property counts.

OnCallScheduleIDList
object
A list of on call schedule Opal UUIDs. To get the matching remote IDs, use the /on-call-schedules endpoints.
1 property 1 required
GroupRemoteInfo
object
Information that defines the remote group. This replaces the deprecated remoteid and metadata fields. If remoteinfo is provided, a group will be imported into…
30 properties
SyncTask
object
Represents a sync task that has been completed, either successfully or with errors.
2 properties 2 required
MessageChannelList
object
1 property 1 required
RiskSensitivityEnum
string
Indicates the level of potential impact misuse or unauthorized access may incur.
PropagationStatusEnum
string
The status of whether the user has been synced to the group or resource in the remote system.
GroupResource
object
GroupResource Object Description The GroupResource object is used to represent a relationship between a group and a resource.
6 properties 3 required
GroupTypeEnum
string
The type of the group.
UpdateGroupInfoList
object
1 property 1 required
CreateRequestConfigurationInfoList
object
CreateRequestConfigurationInfoList Object Description The CreateRequestConfigurationInfoList object is used as an input to the CreateRequestConfigurations API.…
1 property 1 required
ReviewerStageList
object
1 property 1 required
Condition
object
Condition Object Description The Condition object is used to represent a condition. Usage Example Used to match request configurations to users in RequestConfi…
2 properties
ReviewerStage
object
A reviewer stage.
5 properties 4 required
OnCallSchedule
object
OnCallSchedule Object Description The OnCallSchedule object is used to represent an on call schedule. Usage Example Update a groups on call schedule from the U…
4 properties 1 required
PropagationStatus
object
The state of whether the push action was propagated to the remote system. If this is null, the access was synced from the remote system.
1 property 1 required
VisibilityInfo
object
Visibility infomation of an entity.
2 properties 1 required
Tag
object
Tag Object Description The Tag object is used to represent a tag. Usage Example Get tags from the GET Tag endpoint.
6 properties 1 required
VisibilityTypeEnum
string
The visibility level of the entity.
GroupAccessLevel
object
Access Level Object Description The GroupAccessLevel object is used to represent the level of access that a user has to a group or a group has to a group. The…
2 properties 2 required
GroupResourceList
object
1 property 1 required
OnCallScheduleProviderEnum
string
The third party provider of the on call schedule.
ResourceAccessLevel
object
Access Level Object Description The AccessLevel object is used to represent the level of access that a principal has. The "default" access level is a AccessLev…
2 properties 2 required
ResourceWithAccessLevel
object
Information about a resource and corresponding access level
2 properties 1 required
MessageChannelIDList
object
A list of message channel IDs.
1 property 1 required
Group
object
Group Object Description The Group object is used to represent a group. Usage Example Update from the UPDATE Groups endpoint.
29 properties 1 required
GroupUser
object
Group Access User Object Description The GroupAccessUser object is used to represent a user with access to a group. Usage Example Fetch from the LIST GroupUser…
9 properties 6 required
GroupContainingGroupList
object
1 property 1 required
ReviewerIDList
object
A list of reviewer IDs.
1 property 1 required
GroupContainingGroup
object
GroupContainingGroup Object Description The GroupContainingGroup object is used to represent a relationship between a group and a group.
3 properties 1 required
OnCallScheduleList
object
1 property 1 required
RequestConfiguration
object
Request Configuration Object Description The RequestConfiguration object is used to represent a request configuration. Usage Example Returned from the GET Requ…
11 properties 6 required
TagsList
object
1 property 1 required
UpdateGroupInfo
object
UpdateGroupInfo Object Description The UpdateGroupInfo object is used as an input to the UpdateGroup API.
21 properties 1 required
MessageChannel
object
MessageChannel Object Description The MessageChannel object is used to represent a message channel. Usage Example Update a groups message channel from the UPDA…
5 properties 1 required
PaginatedGroupsList
object
3 properties 1 required
GroupUserList
object
3 properties
UpdateGroupResourcesInfo
object
1 property 1 required
CreateGroupInfo
object
CreateGroupInfo Object Description The CreateGroupInfo object is used to store creation info for a group. Usage Example Use in the POST Groups endpoint.
9 properties 3 required
MessageChannelProviderEnum
string
The third party provider of the message channel.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opal-security-groups-api-openapi.yml Raw ↑

Other APIs Opal Security publishes across the network.

Opal Security Access Rules API
AE Profile APIs.io
Opal Security Apps API
AE Profile APIs.io
Opal Security Bundles API
AE Profile APIs.io
Opal Security Configuration Templates API
AE Profile APIs.io
Opal Security Delegations API
AE Profile APIs.io
Opal Security Event Streams API
AE Profile APIs.io
Opal Security Events API
AE Profile APIs.io
Opal Security Group Bindings API
AE Profile APIs.io
Opal Security Idp Group Mappings API
AE Profile APIs.io
Opal Security Message Channels API
AE Profile APIs.io
Opal Security Non Human Identities API
AE Profile APIs.io
Opal Security On Call Schedules API
AE Profile APIs.io
#Group
← Back to O APIs
API Details
ID
opal-security:opal-security-groups-api
Base URL
https://api.opal.dev/v1
Docs
https://docs.opal.dev/
Provider
Opal Security
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=opal-security-groups-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/opal-security-groups-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Opal Security Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.