3GPP UE Address Subscriptions (Collection) API

openapi: 3.2.0
info:
  title: 3gpp-ue-address UE Address Subscriptions (Collection) API
  version: 1.1.0
  description: "API for UE Address service.\n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-ue-address/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: UE Address Subscriptions (Collection)
paths:
  /subscriptions:
    get:
      summary: Request to retrieve all the active UE Address Subscriptions.
      operationId: GetUEAddrSubscs
      tags:
      - UE Address Subscriptions (Collection)
      parameters:
      - name: supp-feat
        in: query
        description: 'Contains the list of supported features among the ones defined in clause 5.35.6.

          '
        required: false
        schema:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      responses:
        '200':
          description: 'OK. All the Individual UE Address Subscription resources managed by the NEF are returned. If there are no existing Individual UE Address Subscription resources managed at the NEF, an empty array is returned.

            '
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UeAddrSubsc'
                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 UE Address Subscription at the NEF.
      operationId: CreateUEAddrSubsc
      tags:
      - UE Address Subscriptions (Collection)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UeAddrSubsc'
      responses:
        '201':
          description: 'Created. A representation of the created Individual UE Address Subscription resource is returned in the response body

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UeAddrSubsc'
          headers:
            Location:
              description: Contains the URI of the newly created resource.
              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:
        notification:
          '{$request.body#/notifUri}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/UeAddrNotif'
              responses:
                '204':
                  description: 'No Content. The UE Address Notification is successfully received and processed.

                    '
                '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:
    UeAddrSubsc:
      description: Represents the UE Address Subscription.
      type: object
      properties:
        notifUri:
          $ref: TS29122_CommonData.yaml#/components/schemas/Uri
        notifId:
          type: string
        afId:
          type: string
        ueAddrInfo:
          $ref: '#/components/schemas/UeAddrInfo'
        immRepInd:
          type: boolean
          description: 'Indicates whether immediate reporting shall be included in the corresponding response if Available.

            '
        immReport:
          $ref: TS29564_Nupf_EventExposure.yaml#/components/schemas/UeNatMappingInfo
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - notifUri
      - notifId
      - afId
    UeAddrNotif:
      description: Represents the UE Address Notification.
      type: object
      properties:
        notifId:
          type: string
        uePubAddrInfo:
          $ref: TS29564_Nupf_EventExposure.yaml#/components/schemas/UeNatMappingInfo
      required:
      - notifId
      - uePubAddrInfo
    UeAddrInfo:
      description: Represents the UE Public Address information.
      type: object
      properties:
        uePrivateIpAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/IpAddr
        ipDomain:
          type: string
        remoteIpv4Addr:
          $ref: TS29571_CommonData.yaml#/components/schemas/Ipv4Addr
        remoteIpv6Addr:
          $ref: TS29571_CommonData.yaml#/components/schemas/Ipv6Addr
        remotePortNumber:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uint16
      required:
      - uePrivateIpAddr
      oneOf:
      - required:
        - remoteIpv4Addr
      - required:
        - remoteIpv6Addr
  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/