API for the IMS Parameters Provisioning Service. An OpenAPI 3.0.0 document with 2 path(s), API version 1.0.0, published verbatim by 3GPP in 3GPP TS 29.522 as part of the 5G NEF Northbound (Network Exposure) suite and mirrored in the public 3GPP Forge GitLab repository.
openapi: 3.0.0
info:
title: 3gpp-ims-pp
version: 1.0.0
description: |
API for the IMS Parameters Provisioning Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
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/'
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/3gpp-ims-pp/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
paths:
/pp:
get:
summary: Request to retrieve all the active IMS Parameters Provisionings at the NEF.
operationId: GetImsParamProvisionings
tags:
- IMS Parameters Provisionings (Collection)
responses:
'200':
description: >
OK. All the Individual IMS Parameters Provisioning resource(s) managed by the
NEF are returned.
If there are no existing Individual IMS Parameters Provisioning resources managed at
the NEF, an empty array is returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ImsPpData'
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 IMS Parameters Provisioning.
operationId: CreateImsParamProvisioning
tags:
- IMS Parameters Provisionings (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImsPpData'
responses:
'201':
description: >
Created. A representation of the created Individual IMS Parameters Provisioning
resource is returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/ImsPpData'
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'
/pp/{ppId}:
parameters:
- name: ppId
in: path
description: >
Represents the identifier of the Individual IMS Parameters Provisioning
resource.
required: true
schema:
type: string
get:
summary: Retrieve an existing Individual IMS Parameters Provisioning resource.
operationId: GetIndImsParamProvisioning
tags:
- Individual IMS Parameters Provisioning (Document)
responses:
'200':
description: >
OK. The requested "Individual IMS Parameters Provisioning" resource is
successfully returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/ImsPpData'
'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: Update an existing Individual IMS Parameters Provisioning resource.
operationId: UpdateIndImsParamProvisioning
tags:
- Individual IMS Parameters Provisioning (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImsPpData'
responses:
'200':
description: >
OK. The Individual IMS Parameters 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/ImsPpData'
'204':
description: >
No Content. The Individual IMS Parameters 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 IMS Parameters Provisioning resource.
operationId: ModifyIndImsParamProvisioning
tags:
- Individual IMS Parameters Provisioning (Document)
requestBody:
required: true
content:
application/json-patch+json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
minItems: 1
responses:
'200':
description: >
OK. The Individual IMS Parameters 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/ImsPpData'
'204':
description: >
No Content. The Individual IMS Parameters 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: Delete an existing Individual IMS Parameters Provisioning resource.
operationId: DeleteIndImsParamProvisioning
tags:
- Individual IMS Parameters Provisioning (Document)
responses:
'204':
description: >
No Content. The Individual IMS Parameters 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:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
#
# STRUCTURED DATA TYPES
#
ImsPpData:
description: Represents the IMS Parameters Provisioning data.
type: object
properties:
afId:
type: string
imsData:
$ref: '#/components/schemas/ImsData'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- afId
ImsData:
description: Represents the IMS parameters data for provisioning.
type: object
properties:
tgtUeId:
$ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsPublicId'
rcdPropData:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RcdProperties'
required:
- tgtUeId
#
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#