Britive Application Environments API

openapi: 3.2.0
info:
  title: Britive Services API Documentation Application Environments 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: Application Environments
  description: Manage Application Environments
paths:
  /api/apps/{appContainerId}/environments:
    get:
      tags:
      - Application Environments
      summary: Get details of all environments present in the system
      operationId: environments_3
      parameters:
      - name: appContainerId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /api/apps/{appContainerId}/environments/{environmentId}:
    delete:
      tags:
      - Application Environments
      summary: Delete an environment within an application
      description: This applies to the following applications - AWS Standalone, SalesForce, and ServiceNow.
      operationId: environments
      parameters:
      - name: appContainerId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
    get:
      tags:
      - Application Environments
      summary: Get an environment within an application
      operationId: environments_1
      parameters:
      - name: appContainerId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /api/apps/{appContainerId}/environments/{environmentId}/groups/{groupId}/accounts:
    get:
      tags:
      - Application Environments
      summary: Get accounts associated with a group for a given application and environment
      operationId: getEnvironmentGroupUsers
      parameters:
      - name: appContainerId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Size'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /api/apps/{appContainerId}/environments/{environmentId}/scans:
    get:
      tags:
      - Application Environments
      summary: Submit a scan for the application and environment IDs provided in the request and returns the taskID.
      description: You can use the Check Scan Status API to find the status of the scan task.
      operationId: environmentScan
      parameters:
      - name: appContainerId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
    post:
      tags:
      - Application Environments
      summary: Submits a scan for specified application and environment
      description: You can use the Check Scan Status API to find the status of the scan task.
      operationId: environmentScan_1
      parameters:
      - name: appContainerId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
components:
  parameters:
    Sort:
      name: sort
      in: query
      required: false
      description: parameter to specify the sort parameter and direction
      schema:
        type: string
    Size:
      name: size
      in: query
      required: false
      description: parameter to specify the number of records to retrieve per page
      schema:
        type: integer
        default: 20
    Page:
      name: page
      in: query
      required: false
      description: Parameter to specify the page number of the records to retrieve
      schema:
        type: integer
        default: 0
  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/.