openapi: 3.2.0
info:
  title: 3gpp-mbs-session MBS Session Subscriptions API
  version: 1.3.0
  description: "API for MBS Session Management.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-mbs-session/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: MBS Session Subscriptions
paths:
  /mbs-sessions/subscriptions:
    get:
      summary: Retrieve all the active MBS Sessions subscriptions.
      operationId: ReadMBSSessionsSubscs
      tags:
      - MBS Session Subscriptions
      responses:
        '200':
          description: 'OK. All the active MBS Session Subscriptions resources managed by the NEF are returned.

            '
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MbsSessionSubsc'
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29122_CommonData.yaml#/components/responses/406
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    post:
      summary: Request the creation of a new Individual MBS Session subscription resource.
      operationId: CreateMBSSessionsSubsc
      tags:
      - MBS Session Subscriptions
      requestBody:
        description: Request the creation of a new MBS Session subscription resource.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MbsSessionSubsc'
      responses:
        '201':
          description: 'Created. Successful creation of a new Individual MBS Session subscription.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MbsSessionSubsc'
          headers:
            Location:
              description: Contains the URI of the newly created resource, according to the structure {apiRoot}/3gpp-mbs-session/v1/mbs-sessions/subscriptions/{subscriptionId}
              required: true
              schema:
                type: string
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
      callbacks:
        MBSSessionStatusNotification:
          '{$request.body#/notificationUri}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/MbsSessionStatusNotif'
              responses:
                '204':
                  description: No Content. Successful reception of the notification.
                '307':
                  $ref: TS29122_CommonData.yaml#/components/responses/307
                '308':
                  $ref: TS29122_CommonData.yaml#/components/responses/308
                '400':
                  $ref: TS29122_CommonData.yaml#/components/responses/400
                '401':
                  $ref: TS29122_CommonData.yaml#/components/responses/401
                '403':
                  $ref: TS29122_CommonData.yaml#/components/responses/403
                '404':
                  $ref: TS29122_CommonData.yaml#/components/responses/404
                '411':
                  $ref: TS29122_CommonData.yaml#/components/responses/411
                '413':
                  $ref: TS29122_CommonData.yaml#/components/responses/413
                '415':
                  $ref: TS29122_CommonData.yaml#/components/responses/415
                '429':
                  $ref: TS29122_CommonData.yaml#/components/responses/429
                '500':
                  $ref: TS29122_CommonData.yaml#/components/responses/500
                '503':
                  $ref: TS29122_CommonData.yaml#/components/responses/503
                default:
                  $ref: TS29122_CommonData.yaml#/components/responses/default
components:
  schemas:
    MbsSessionStatusNotif:
      description: Represents an MBS Session Status notification.
      type: object
      properties:
        eventList:
          $ref: TS29571_CommonData.yaml#/components/schemas/MbsSessionEventReportList
      required:
      - eventList
    MbsSessionSubsc:
      description: Represents an MBS Session Subscription.
      type: object
      properties:
        afId:
          type: string
        subscription:
          $ref: TS29571_CommonData.yaml#/components/schemas/MbsSessionSubscription
        subscriptionId:
          type: string
      required:
      - afId
      - subscription
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: '3GPP TS 29.522 V19.5.0; 5G System; Network Exposure Function Northbound APIs.

    '
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/