Britive Tag Access Requests API

openapi: 3.2.0
info:
  title: Britive Services API Documentation Tag Access Requests 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: Tag Access Requests
  description: Browse tags available for access request
paths:
  /api/access-requests/tags:
    get:
      tags:
      - Tag Access Requests
      summary: List requestable tags
      description: Returns tags where the current user is not already a member and the tag is marked as requestable.
      operationId: getRequestableTags
      parameters:
      - name: filter
        in: query
        required: false
        description: SCIM-style filter string (e.g. `name co "foo"`)
        schema:
          type: string
      - name: searchText
        in: query
        required: false
        description: Free-text search on tag name
        schema:
          type: string
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: Paginated list of requestable tags
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestableTagPageDto'
    post:
      tags:
      - Tag Access Requests
      summary: Submit a tag access request
      operationId: submitTagAccessRequest
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagAccessRequest'
      responses:
        '202':
          description: Accepted
        '400':
          description: Invalid request payload
  /api/access-requests/tags/{tagId}/app-profiles:
    get:
      tags:
      - Tag Access Requests
      summary: List application profiles for a tag
      description: Returns application profiles accessible via the given tag.
      operationId: getTagAppProfiles
      parameters:
      - name: tagId
        in: path
        required: true
        schema:
          type: string
      - name: filter
        in: query
        required: false
        description: SCIM-style filter string (e.g. `name co "foo"`)
        schema:
          type: string
      - name: searchText
        in: query
        required: false
        description: Free-text search on profile name
        schema:
          type: string
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: Paginated list of application profiles for the tag
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagAppProfilePageDto'
        '404':
          description: Tag not found
  /api/access-requests/tags/{tagId}/approvers:
    get:
      tags:
      - Tag Access Requests
      summary: Get approvers for a tag
      operationId: getApproversForTag
      parameters:
      - name: tagId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Approvers object
          content:
            application/json:
              schema:
                type: object
        '404':
          description: Invalid tagId
  /api/access-requests/tags/{tagId}/resources:
    get:
      tags:
      - Tag Access Requests
      summary: List resources for a tag
      description: Returns resources accessible via the given tag.
      operationId: getTagResources
      parameters:
      - name: tagId
        in: path
        required: true
        schema:
          type: string
      - name: filter
        in: query
        required: false
        description: SCIM-style filter string (e.g. `name co "foo"`)
        schema:
          type: string
      - name: searchText
        in: query
        required: false
        description: Free-text search on resource name
        schema:
          type: string
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: Paginated list of resources for the tag
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResourcePageDto'
        '404':
          description: Tag not found
  /api/access-requests/tags/{tagId}/secrets:
    get:
      tags:
      - Tag Access Requests
      summary: List secrets for a tag
      description: Returns secrets accessible via the given tag.
      operationId: getTagSecrets
      parameters:
      - name: tagId
        in: path
        required: true
        schema:
          type: string
      - name: filter
        in: query
        required: false
        description: SCIM-style filter string (e.g. `name co "foo"`)
        schema:
          type: string
      - name: searchText
        in: query
        required: false
        description: Free-text search on secret name
        schema:
          type: string
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: Paginated list of secrets for the tag
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagSecretPageDto'
        '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:
    TagResourceSummaryDto:
      type: object
      properties:
        resourceId:
          type: string
        name:
          type: string
          description: Resource name
        description:
          type: string
        resourceLabels:
          type: object
          description: 'Map of label key to list of label values (e.g. {env: [prod, staging]})'
          additionalProperties:
            type: array
            items:
              type: string
        resourceLabelColorMap:
          type: object
          description: 'Map of label key to display color (e.g. {env: ''#FF0000''})'
          additionalProperties:
            type: string
        profileName:
          type: string
          description: Comma-separated resource profile name(s) linking this tag to the resource
        resourceTypeIconUrl:
          type: string
          description: Icon URL for the resource type
    TagAppProfileSummaryDto:
      type: object
      properties:
        profileId:
          type: string
        name:
          type: string
        description:
          type: string
        associations:
          type: integer
          format: int64
          description: Total number of identity associations (users/tags) for this profile
        application:
          type: string
          description: Application instance name
        applicationId:
          type: string
          description: Application instance ID
        applicationType:
          type: string
          description: Catalog application type (e.g. AWS, GCP)
        permissionsCount:
          type: integer
          description: Number of permissions assigned to this profile
    TagSecretSummaryDto:
      type: object
      properties:
        secretId:
          type: string
        name:
          type: string
        description:
          type: string
        path:
          type: string
    RequestableTagSummaryDto:
      type: object
      properties:
        tagId:
          type: string
        name:
          type: string
        description:
          type: string
        summary:
          type: string
          description: 'Count summary: e.g. ''3 Application profiles, 2 Resources, 1 Secret'''
        external:
          type: boolean
          description: Whether the tag is externally managed (e.g. synced from an identity provider)
    TagSecretPageDto:
      type: object
      properties:
        count:
          type: integer
          format: int64
        page:
          type: integer
        size:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/TagSecretSummaryDto'
    TagAppProfilePageDto:
      type: object
      properties:
        count:
          type: integer
          format: int64
        page:
          type: integer
        size:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/TagAppProfileSummaryDto'
    TagResourcePageDto:
      type: object
      properties:
        count:
          type: integer
          format: int64
        page:
          type: integer
        size:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/TagResourceSummaryDto'
    RequestableTagPageDto:
      type: object
      properties:
        count:
          type: integer
          format: int64
        page:
          type: integer
        size:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/RequestableTagSummaryDto'
    TagAccessRequest:
      type: object
      required:
      - tagId
      - justification
      properties:
        tenantId:
          type: string
        userId:
          type: string
        tagId:
          type: string
          description: Unique identifier of the tag
        justification:
          type: string
          description: Reason for requesting access
        context:
          type: object
          additionalProperties:
            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: 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/.