Britive Approvals API

openapi: 3.2.0
info:
  title: Secret Manager Approvals API
  version: v1
  description: API documentation for Secret Manager, Policy Administration, Notifications, Approval service, etc.
servers:
- url: https://{tenantURL}
  description: The primary server
  variables:
    tenantURL:
      default: test.britive-app.com
      description: The host of the server
security:
- bearerAuth: []
tags:
- name: Approvals
paths:
  /api/v1/approvals/:
    get:
      tags:
      - Approvals
      summary: Get the list of all approval requests
      operationId: getApprovals
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: requestType
        description: Specifies the type of request
        in: query
        schema:
          pattern: \s*(myRequests|myApprovals)\s*
          type: string
          enum:
          - myRequests
          - myApprovals
      - name: pageToken
        description: Autogenerated token for next page of records in case the results are more than one page. Append this token in requested API URL to access the next set of pages.
        in: query
        schema:
          type: string
      - name: consumer
        in: query
        schema:
          type: string
      - name: activeStatus
        in: query
        schema:
          type: string
          default: all
          enum:
          - all
          - active
          - inactive
      - name: createdWithinDays
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
  /api/v1/approvals/revoke:
    post:
      tags:
      - Approvals
      summary: Revoke bulk requests
      operationId: revokeBulkApprovals
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevokeData'
        required: true
      responses:
        '202':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
  /api/v1/approvals/{id}:
    patch:
      tags:
      - Approvals
      summary: Approve/Reject/Revoke a specified request
      operationId: handleApproval
      parameters:
      - name: approveRequest
        in: query
        required: true
        schema:
          pattern: \s*(yes|no|revoke)\s*
          type: string
          enum:
          - 'yes'
          - 'no'
          - revoke
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: killSession
        in: query
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
    delete:
      tags:
      - Approvals
      summary: Cancel approval request
      operationId: cancelApprovalRequestMyRequest
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
    get:
      tags:
      - Approvals
      summary: Get approval request details
      operationId: getApproval
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: requestType
        in: query
        schema:
          pattern: \s*(myRequests|myApprovals)\s*
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    RevokeData:
      type: object
      properties:
        revokerComment:
          maxLength: '255'
          minLength: '1'
          type: string
        killSession:
          type: boolean
        approvals:
          type: array
          items:
            type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-api-evangelist:
  assembled_from: https://docs.britive.com/apidocs/ (one OpenAPI fragment per operation page, .md variant)
  assembled_on: '2026-08-08'
  fragments: 71
  note: Britive publishes this contract only as per-operation fragments inside its Document360 API reference. This file is the faithful union of those fragments; the verbatim assembly is in openapi/_original/.