openapi: 3.2.0
info:
  title: 3gpp-ue-address Individual UE Address Subscription (Document) 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: Individual UE Address Subscription (Document)
paths:
  /subscriptions/{subscriptionId}:
    parameters:
    - name: subscriptionId
      in: path
      description: Represents the identifier of the Individual UE Address Subscription resource.
      required: true
      schema:
        type: string
    get:
      summary: Request to retrieve an existing Individual UE Address Subscription resource.
      operationId: GetIndUEAddrSubsc
      tags:
      - Individual UE Address Subscription (Document)
      responses:
        '200':
          description: 'OK. The requested Individual UE Address Subscription resource is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UeAddrSubsc'
        '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
    delete:
      summary: Request the deletion of an existing Individual UE Address Subscription resource.
      operationId: DeleteIndUEAddrSubsc
      tags:
      - Individual UE Address Subscription (Document)
      responses:
        '204':
          description: 'No Content. . The Individual UE Address Subscription resource is successfully deleted.

            '
        '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:
    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
    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/