openapi: 3.2.0
info:
  title: GMDviaMBMSbyMB2 Individual TMGI Allocation Operation API
  description: "API for Group Message Delivery via MBMS by MB2  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
  version: 1.4.0
servers:
- url: '{apiRoot}/3gpp-group-message-delivery-mb2/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: Individual TMGI Allocation Operation
paths:
  /{scsAsId}/tmgi-allocation/{tmgi}:
    get:
      summary: Read a TMGI Allocation resource for a given SCS/AS and a TMGI.
      operationId: FetchIndTMGIAllocation
      tags:
      - Individual TMGI Allocation Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: tmgi
        in: path
        description: TMGI
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK (successful query of TMGI Allocation resource)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TMGIAllocation'
        '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
    put:
      summary: Updates an existing TMGI Allocation resource for a given SCS/AS and a TMGI.
      operationId: UpdateIndTMGIAllocation
      tags:
      - Individual TMGI Allocation Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: tmgi
        in: path
        description: TMGI
        required: true
        schema:
          type: string
      requestBody:
        description: representation of the TMGI Allocation to be updated in the SCEF
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TMGIAllocation'
      responses:
        '200':
          description: successful creation of an TMGI Allocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TMGIAllocation'
        '204':
          description: 'The TMGI expiration time renewal is successful, and no content is to be sent in the response message body.

            '
        '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
    patch:
      summary: Updates an existing TMGI Allocation resource for a given SCS/AS and a TMGI.
      operationId: ModifyIndTMGIAllocation
      tags:
      - Individual TMGI Allocation Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: tmgi
        in: path
        description: TMGI
        required: true
        schema:
          type: string
      requestBody:
        description: representation of the TMGI Allocation to be updated in the SCEF
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/TMGIAllocationPatch'
      responses:
        '200':
          description: successful creation of an TMGI Allocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TMGIAllocation'
        '204':
          description: 'The TMGI expiration time renewal is successful, and no content is to be sent in the response message body.

            '
        '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
    delete:
      summary: Deletes an existing TMGI Allocation resource for a given SCS/AS and a TMGI.
      operationId: DeleteTMGIAllocation
      tags:
      - Individual TMGI Allocation Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: tmgi
        in: path
        description: TMGI
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content, successful deletion of an TMGI Allocation
        '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
        '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:
    TMGIAllocationPatch:
      description: 'Represents the parameters to request the modification of a TMGI Allocation resource.

        '
      type: object
      properties:
        externalGroupId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
        mbmsLocArea:
          $ref: '#/components/schemas/MbmsLocArea'
    MbmsLocArea:
      description: 'Represents a user location area whithin which is sent a group message delivery via MBMS request.

        '
      type: object
      properties:
        cellId:
          type: array
          items:
            type: string
          minItems: 1
          description: 'Indicates a Cell Global Identification of the user which identifies the cell the UE is registered.

            '
        enodeBId:
          type: array
          items:
            type: string
          minItems: 1
          description: Indicates an eNodeB in which the UE is currently located.
        geographicArea:
          type: array
          items:
            $ref: TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea
          minItems: 1
          description: Identifies a geographic area of the user where the UE is located.
        mbmsServiceAreaId:
          type: array
          items:
            type: string
          minItems: 1
          description: Identifies an MBMS Service Area Identity of the user where the UE is located.
        civicAddress:
          type: array
          items:
            $ref: TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress
          minItems: 1
          description: Identifies a civic address of the user where the UE is located.
    TMGIAllocation:
      description: Represents an individual TMGI Allocation resource.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        externalGroupId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
        mbmsLocArea:
          $ref: '#/components/schemas/MbmsLocArea'
        tmgiExpiration:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTimeRo
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: 3GPP TS 29.122 V19.5.0 T8 reference point for Northbound APIs
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/