openapi: 3.2.0
info:
  title: 3gpp-ue-address UE Address(es) Information Retrieval 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(es) Information Retrieval
paths:
  /retrieve:
    post:
      summary: Request to retrieve UE Address information.
      operationId: RetrieveUEAddress
      tags:
      - UE Address(es) Information Retrieval
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UeAddressReq'
      responses:
        '200':
          description: 'OK. The UE Address information request is successfully processed, and UE address information is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UeAddressInfo'
        '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:
    UeAddressInfo:
      description: Represents UE Address information.
      type: object
      properties:
        ueIpAddrs:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/IpAddr
          minItems: 1
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - ueIpAddrs
    UeAddressReq:
      description: Represents the parameters to request the retrieval of UE Address information.
      type: object
      properties:
        afId:
          type: string
        gpsi:
          $ref: TS29571_CommonData.yaml#/components/schemas/Gpsi
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - afId
      - gpsi
  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/