Britive System Announcements API

openapi: 3.2.0
info:
  title: Britive Services API Documentation System Announcements 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: System Announcements
  description: Manage the system announcements
paths:
  /api/banner:
    get:
      tags:
      - System Announcements
      summary: Get system announcements information
      operationId: getBanner
      responses:
        '200':
          description: System announcements information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BannerDto'
  /api/settings/banner:
    get:
      tags:
      - System Announcements
      summary: Get system announcements information
      operationId: getBannerSettings
      responses:
        '200':
          description: System announcements information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BannerSettingsDto'
    post:
      tags:
      - System Announcements
      summary: Manage system announcements
      operationId: postBannerSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BannerSettingsDto'
            example:
              status: 'ON'
              messageType: INFO
              message: Test message.
              messageSchedule:
                startDate: '2024-02-20 20:00:00'
                endDate: '2024-02-21 20:00:00'
                timeZone: Asia/Kolkata
        required: true
      responses:
        '201':
          description: Banner updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BannerSettingsDto'
components:
  schemas:
    MessageSchedule:
      type: object
      properties:
        startDate:
          type: string
          description: Expected date format is 'yyyy-MM-dd HH:mm:ss'
        endDate:
          type: string
          description: Expected date format is 'yyyy-MM-dd HH:mm:ss'
        timeZone:
          type: string
          description: Valid time zone values according to standards.
    BannerSettingsDto:
      required:
      - status
      type: object
      properties:
        status:
          type: string
          description: Allowed values are 'ON' and 'OFF'
        messageType:
          type: string
          description: Allowed values are 'INFO', 'WARNING' and 'CAUTION'
        message:
          type: string
        messageSchedule:
          $ref: '#/components/schemas/MessageSchedule'
    BannerDto:
      required:
      - message
      - messageType
      type: object
      properties:
        messageType:
          type: string
          description: Allowed values are 'INFO', 'WARNING' and 'CAUTION'
        message:
          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/.