openapi: 3.2.0
info:
  title: 3gpp-mbs-us MBS User Services API
  version: 1.1.0
  description: "API for MBS User Service.  \n© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-mbs-us/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 User Services
paths:
  /mbs-user-services:
    get:
      summary: Retrieve all the active MBS User Service resources managed by the NEF.
      tags:
      - MBS User Services
      operationId: RetrieveMBSUserServices
      responses:
        '200':
          description: 'OK. All the active MBS User Services managed by the NEF are returned.

            '
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService
                minItems: 0
        '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 User Service resource.
      tags:
      - MBS User Services
      operationId: CreateMBSUserService
      requestBody:
        description: 'Contains the parameters to request the creation of a new MBS User Service at the NEF.

          '
        required: true
        content:
          application/json:
            schema:
              $ref: TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService
      responses:
        '201':
          description: 'Created. A new MBS User Service is successfully created and a representation of the created Individual MBS User Service resource is returned.

            '
          content:
            application/json:
              schema:
                $ref: TS29580_Nmbsf_MBSUserService.yaml#/components/schemas/MBSUserService
          headers:
            Location:
              description: 'Contains the URI of the newly created resource, according to the structure {apiRoot}/3gpp-mbs-us/v1/mbs-user-services/{mbsUserServId}

                '
              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
components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: '3GPP TS 29.522 V18.6.0; 5G System; Network Exposure Function Northbound APIs.

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