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

Opal Security owners API

Operations related to owners

Opal Security owners 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 Owners. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

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

8 operations 4 paths 9 schemas 1 DELETE4 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 8

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

owners 8

Operations related to owners

GET
/owners
Get owners
get_owners 3 params → 200
POST
/owners
Creates an owner.
createOwner body → 200
PUT
/owners
Bulk updates a list of owners.
updateOwners body → 200
GET
/owners/{owner_id}
Get owner by ID
getOwner 1 param → 200
DELETE
/owners/{owner_id}
Deletes an owner.
delete_owner 1 param → 200
GET
/owners/name/{owner_name}
Returns an Owner object. Does not support owners with / in their name, use /owners?name=... instead.
getOwnerFromName 1 param → 200
GET
/owners/{owner_id}/users
Gets the list of users for this owner, in escalation priority order if applicable.
get_owner_users 1 param → 200
PUT
/owners/{owner_id}/users
Sets the list of users for this owner. If escalation is enabled, the order of this list is the escalation priority order of the users. If the owner has a source group, adding or removing users from t…
set_owner_users 1 param body → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are User (7 properties), Owner (6 properties), CreateOwnerInfo (6 properties), UpdateOwnerInfo (6 properties). Each schema is shown below with its type and property counts.

UpdateOwnerInfoList
object
1 property 1 required
PaginatedOwnersList
object
3 properties 1 required
Owner
object
Owner Object Description The Owner object is used to represent an owner.
6 properties 1 required
UserIDList
object
A list of user IDs.
1 property 1 required
UpdateOwnerInfo
object
UpdateOwnerInfo Object Description The UpdateOwnerInfo object is used as an input to the UpdateOwner API.
6 properties 1 required
User
object
User Object Description The User object is used to represent a user. Usage Example Fetch from the LIST Sessions endpoint.
7 properties 6 required
CreateOwnerInfo
object
CreateOwnerInfo Object Description The CreateOwnerInfo object is used to store creation info for an owner. Usage Example Use in the POST Owners endpoint.
6 properties 2 required
UserHrIdpStatusEnum
string
User status pulled from an HR/IDP provider.
UserList
object
A list of users.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Opal Security publishes across the network.

Opal Security access-rules API
Opal Security apps API
Opal Security bundles API
Opal Security configuration-templates API
Opal Security delegations API
Opal Security event-streams API
Opal Security events API
Opal Security group-bindings API
Opal Security groups API
Opal Security idp-group-mappings API
Opal Security message-channels API
Opal Security non-human-identities API
Where this information came from

This is an independent, third-party profile of Opal Security owners 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.