openapi: 3.2.0
info:
  title: 3gpp-ueid UE ID Mapping Information Provisionings (Collection) API
  version: 1.2.0
  description: "API for UE ID service.\n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-ueid/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 ID Mapping Information Provisionings (Collection)
paths:
  /{afId}/pp:
    parameters:
    - name: afId
      in: path
      description: Represents the identifier of the AF.
      required: true
      schema:
        type: string
    get:
      summary: Request to retrieve all the active UE ID Mapping Information Provisionings at the NEF.
      operationId: GetUeIdMappingProvisionings
      tags:
      - UE ID Mapping Information Provisionings (Collection)
      responses:
        '200':
          description: 'OK. All the Individual UE ID Mapping Information Provisioning resource(s) managed by the NEF are returned. If there are no existing Individual UE ID Mapping Information Provisioning resources at the NEF, an empty array is returned.

            '
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UeIdMappingInfo'
                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
components:
  schemas:
    UeIdMappingInfo:
      description: 'Represents the UE ID Mapping Information Provisioning.

        '
      type: object
      properties:
        rsUeIdMappingInfo:
          $ref: '#/components/schemas/RangSlUeIdMappInfo'
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
    RangSlUeIdMappInfo:
      description: 'Represents the Ranging/Sidelink UE ID mapping information between the Application Layer ID and the GPSI.

        '
      type: object
      properties:
        appLayerId:
          $ref: TS29571_CommonData.yaml#/components/schemas/ApplicationlayerId
        gpsi:
          $ref: TS29571_CommonData.yaml#/components/schemas/Gpsi
      required:
      - appLayerId
      - 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/