Britive Access Request Tag Membership API

Manage tag memberships granted via access requests

OpenAPI Specification

britive-access-request-tag-membership-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Britive Services API Documentation Access Request Tag Membership API
  version: v1
  description: API documentation for Users, Tags, Identity providers, Applications, Reporting, Audit logs, Tenants, SSO, Profiles, Password policies, MFA, Access Builder Settings, 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: Access Request Tag Membership
  description: Manage tag memberships granted via access requests
paths:
  /api/user-tags/{tagId}/requested-memberships:
    parameters:
    - in: path
      name: tagId
      required: true
      schema:
        type: string
      description: ID of the user tag
    - $ref: '#/components/parameters/Page'
    - $ref: '#/components/parameters/PageSize'
    - $ref: '#/components/parameters/Sort'
    get:
      tags:
      - Access Request Tag Membership
      summary: Get requested memberships of a tag
      description: Returns users whose is_user_requested flag is true for the given tag.
      operationId: getTagRequestedMemberships
      parameters:
      - name: filter
        in: query
        required: false
        description: SCIM-style filter string
        schema:
          type: string
      - name: searchText
        in: query
        required: false
        description: Free-text search on user name
        schema:
          type: string
      responses:
        '200':
          description: Paginated list of requested memberships
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSummary'
        '404':
          description: Tag not found
  /api/user-tags/{tagId}/requested-memberships/{userId}:
    parameters:
    - in: path
      name: tagId
      required: true
      schema:
        type: string
      description: ID of the user tag
    - in: path
      name: userId
      required: true
      schema:
        type: string
      description: External string ID of the user (e.g. puXXXXXX)
    delete:
      tags:
      - Access Request Tag Membership
      summary: Remove a requested membership from a tag
      description: 'Clears the is_user_requested flag for the specified user in the tag. If this was the only active access path, the row is deleted and deprovisioning is triggered.

        '
      operationId: removeTagRequestedMembership
      responses:
        '200':
          description: Requested membership removed successfully
        '404':
          description: Tag not found
components:
  parameters:
    Sort:
      name: sort
      in: query
      required: false
      description: parameter to specify the sort parameter and direction
      schema:
        type: string
    Page:
      name: page
      in: query
      required: false
      description: Parameter to specify the page number of the records to retrieve
      schema:
        type: integer
        default: 0
    PageSize:
      name: size
      in: query
      required: false
      description: Parameter to specify the number of records to retrieve per page
      schema:
        type: integer
        default: 20
  schemas:
    UserDto:
      type: object
      x-exclude-from-codegen: 'true'
      properties:
        id:
          type: string
        userName:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
    UserSummary:
      type: object
      x-exclude-from-codegen: 'true'
      properties:
        count:
          type: integer
          format: int64
        page:
          type: integer
        size:
          type: integer
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserDto'
  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: 372
  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/.