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 requests API

Operations related to requests

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

This API exposes 8 operations across 6 paths, and defines 19 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 6 paths 19 schemas 4 GET4 POST

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 requests API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 8

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

requests 8

Operations related to requests

GET
/requests
Get requests
getRequests 9 params → 200
POST
/requests
Create an access request
createRequest body → 200
GET
/requests/relaydeprecated
Get requests via Relay
getRequestsRelay 7 params → 200
GET
/requests/{id}
Get request by ID
getRequest 1 param → 200
POST
/requests/{id}/approve
Approve an access request
approveRequest 1 param body → 200
POST
/requests/{id}/deny
Deny an access request
denyRequest 1 param body → 200
GET
/requests/{id}/comments
Returns a list of comments for a specific request.
getRequestComments 1 param → 200
POST
/requests/{id}/comments
Comment on an access request
createRequestComment 1 param body → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Request (13 properties), CreateRequestInfo (8 properties), RequestedItem (7 properties), RequestComment (6 properties). Each schema is shown below with its type and property counts.

Request
object
Request Object Description The Request object is used to represent a request. Usage Example Returned from the GET Requests endpoint.
13 properties 6 required
RequestConnection
object
3 properties 3 required
RequestedItem
object
Requested Item Object Description The RequestedItem object is used to represent a request target item. Usage Example Returned from the GET Requests endpoint.
7 properties
RequestCustomFieldResponse
object
3 properties 3 required
RequestReviewerStages
object
The stages configuration for a request item
5 properties 3 required
PageInfo
object
4 properties 4 required
RequestTemplateCustomFieldTypeEnum
string
The type of the custom request field.
RequestReviewer
object
A reviewer in a request stage
3 properties 2 required
RequestCommentList
object
A paginated list of request comments
1 property 1 required
ReviewStageOperator
string
The operator to apply to reviewers in a stage
RequestStage
object
A stage in the request review process
3 properties 3 required
RequestApprovalEnum
string
The decision level for the approval
CreateRequestInfo
object
All the information needed for creating a request
8 properties 4 required
RequestComment
object
Request Comment Object Description The RequestComment object is used to represent a comment on a request. Usage Example Returned from the GET Requests endpoint…
6 properties 4 required
RequestItemStages
object
The stages configuration for a request item
3 properties 2 required
TicketingProviderEnum
string
The third party ticketing platform provider.
RequestList
object
Request List Description The RequestList object is used to represent a list of requests. Usage Example Returned from the GET Requests endpoint.
2 properties
RequestStatusEnum
string
Request Status Description The RequestStatus enum is used to represent the status of a request. Usage Example Returned from the GET Requests endpoint.
RequestEdge
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opal-security-requests-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 requests 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.