API for CAG Information Parameters Provisioning. 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-caginfo-pp
version: 1.0.0
description: |
API for CAG Information Parameters Provisioning.
© 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-caginfo-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 CAG Information Parameters Provisionings at the NEF.
operationId: GetCagInfoParamProvisionings
tags:
- CAG Information Parameters Provisionings (Collection)
responses:
'200':
description: >
OK. All the active CAG Information Parameters Provisioning resources managed by the
NEF are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CagInfoPpData'
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 CAG Information Parameters Provisioning.
tags:
- CAG Information Parameters Provisionings (Collection)
operationId: CreateCagInfoParamProvisioning
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CagInfoPpData'
responses:
'201':
description: >
Created. Successful creation of a new Individual CAG Information Parameters Provisioning
resource and a representation of the created resource is returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/CagInfoPpData'
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 CAG Information Parameters Provisioning
resource.
required: true
schema:
type: string
get:
summary: Retrieve an existing Individual CAG Information Parameters Provisioning resource.
operationId: GetIndCagInfoParamProvisioning
tags:
- Individual CAG Information Parameters Provisioning (Document)
responses:
'200':
description: >
OK. The requested Individual CAG Information Parameters Provisioning resource is
successfully returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/CagInfoPpData'
'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 CAG Information Parameters Provisioning resource.
operationId: UpdateIndCagInfoParamProvisioning
tags:
- Individual CAG Information Parameters Provisioning (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CagInfoPpData'
responses:
'200':
description: >
OK. The Individual CAG Information 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/CagInfoPpData'
'204':
description: >
No Content. The Individual CAG Information 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: Modify an existing Individual CAG Information Parameters Provisioning resource.
operationId: ModifyIndCagInfoParamProvisioning
tags:
- Individual CAG Information Parameters Provisioning (Document)
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/CagInfoPpDataPatch'
responses:
'200':
description: >
OK. The Individual CAG Information 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/CagInfoPpData'
'204':
description: >
No Content. The Individual CAG Information 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 CAG Information Parameters Provisioning resource.
operationId: DeleteIndCagInfoParamProvisioning
tags:
- Individual CAG Information Parameters Provisioning (Document)
responses:
'204':
description: >
No Content. The Individual CAG Information 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
#
CagInfoPpData:
description: Represents the CAG Information Parameters Provisioning.
type: object
properties:
afId:
type: string
cagInfos:
type: array
items:
$ref: '#/components/schemas/CagInformation'
minItems: 1
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- afId
CagInfoPpDataPatch:
description: >
Represents the requested modifications to a CAG Information Parameters Provisioning.
type: object
properties:
cagInfos:
type: array
items:
$ref: '#/components/schemas/CagInformation'
minItems: 1
CagInformation:
description: Represents the CAG information.
type: object
properties:
ueList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
minItems: 1
cagProvInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/CagProvisionInformation'
required:
- ueList
- cagProvInfo
#
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#