openapi: 3.2.0
info:
  title: 3gpp-mbs-tmgi MBS TMGI Deallocation API
  version: 1.2.0
  description: "API for the allocation, deallocation and management of TMGI(s) for MBS.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-mbs-tmgi/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 TMGI Deallocation
paths:
  /deallocate:
    post:
      summary: Request the deallocation of MBS TMGI(s).
      operationId: DeallocateTmgi
      tags:
      - MBS TMGI Deallocation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TmgiDeallocRequest'
      responses:
        '204':
          description: No Content. Successful case, the TMGI(s) are deallocated.
        '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:
    TmgiDeallocRequest:
      description: Represents information to request the deallocation of MBS TMGI(s).
      type: object
      properties:
        afId:
          type: string
        tmgis:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Tmgi
          minItems: 1
      required:
      - afId
      - tmgis
  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/