openapi: 3.2.0
info:
  title: 3gpp-ueid Individual UE ID Mapping Information Provisioning (Document) 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: Individual UE ID Mapping Information Provisioning (Document)
paths:
  /{afId}/pp/{ppId}:
    parameters:
    - name: afId
      in: path
      description: Represents the identifier of the AF.
      required: true
      schema:
        type: string
    - name: ppId
      in: path
      description: 'Represents the identifier of the Individual UE ID Mapping Information Provisioning resource.

        '
      required: true
      schema:
        type: string
    get:
      summary: Request to retrieve an existing Individual UE ID Mapping Information Provisioning resource.
      operationId: GetIndUeIdMappingProvisioning
      tags:
      - Individual UE ID Mapping Information Provisioning (Document)
      responses:
        '200':
          description: 'OK. The requested Individual UE ID Mapping Information Provisioning resource is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UeIdMappingInfo'
        '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
    put:
      summary: Request the update of an existing Individual UE ID Mapping Information Provisioning resource.
      operationId: UpdateIndUeIdMappingProvisioning
      tags:
      - Individual UE ID Mapping Information Provisioning (Document)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UeIdMappingInfo'
      responses:
        '200':
          description: 'OK. The Individual UE ID Mapping Information Provisioning resource is successfully updated and a representation of the updated resource is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UeIdMappingInfo'
        '204':
          description: 'No Content. The Individual UE ID Mapping Information Provisioning resource is successfully updated and no content is returned in the response body.

            '
        '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
    patch:
      summary: Request the modification of an existing Individual UE ID Mapping Information Provisioning resource.
      operationId: ModifyIndUeIdMappingProvisioning
      tags:
      - Individual UE ID Mapping Information Provisioning (Document)
      requestBody:
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/UeIdMappingInfoPatch'
      responses:
        '200':
          description: 'OK. The Individual UE ID Mapping Information Provisioning resource is successfully modified and a representation of the updated resource is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UeIdMappingInfo'
        '204':
          description: 'No Content. The Individual UE ID Mapping Information Provisioning resource is successfully modified and no content is returned in the response body.

            '
        '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
    delete:
      summary: Request the deletion of an existing Individual UE ID Mapping Information Provisioning resource.
      operationId: DeleteIndUeIdMappingProvisioning
      tags:
      - Individual UE ID Mapping Information Provisioning (Document)
      responses:
        '204':
          description: 'No Content. The Individual UE ID Mapping Information Provisioning 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:
    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
    UeIdMappingInfoPatch:
      description: 'Represents the requested modification to a UE ID Mapping Information Provisioning.

        '
      type: object
      properties:
        rsUeIdMappingInfo:
          $ref: '#/components/schemas/RangSlUeIdMappInfo'
  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/