OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Nudm Context Management Service provides the NF consumer of the information related to UE's transaction information, allows the NF consumer to register and deregister its information for the serving UE in the UDM, and allows the NF consumer to update some UE context information in the UDM.
Reference: 3GPP TS 29.503 Unified Data Management Services, version 15.3.0
OpenAPI Version: 3.0.0
Version: '1.1.0.alpha-3'
Title: 'Nudm_UECM'
Description: |
Nudm Context Management Service.
© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
URL: '{apiRoot}/nudm-uecm/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501.
- oAuth2ClientCredentials:
- nudm-uecm
- {}
put:
Summary: register as AMF for 3GPP access
Operation ID: 3GppRegistration
Tags:
- AMF registration for 3GPP access
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
Required/Optional: true
Responses:
'201':
Description: Created
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-3gpp-access'
Required/Optional: true
Schema:
Type: string
'200':
Description: OK
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
'204':
Description: No content
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
Callbacks:
deregistrationeNotification:
'{request.body#/deregCallbackUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/DeregistrationData'
Responses:
'204':
Description: Successful Notification response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
pcscfRestorationNotification:
'{request.body#/pcscfRestorationCallbackUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/PcscfRestorationNotification'
Responses:
'204':
Description: Successful Notification response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
patch:
Summary: Update a parameter in the AMF registration for 3GPP access
Operation ID: Update3GppRegistration
Tags:
- Parameter update in the AMF registration for 3GPP access
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: supported-features
In: query
Description: Features required to be supported by the target NF
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Request Body:
Content:
application/merge-patch+json:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistrationModification'
Required/Optional: true
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'
'204':
Description: Expected response to a valid request
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'422':
Description: Unprocessable Request
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
get:
Summary: retrieve the AMF registration for 3GPP access information
Operation ID: Get3GppRegistration
Tags:
- AMF 3Gpp-access Registration Info Retrieval
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
Method: Post
Summary: trigger AMF for 3GPP access deregistration
Operation ID: deregAMF
Tags:
- Trigger AMF for 3GPP access deregistration
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AmfDeregInfo'
Required/Optional: true
Responses:
'204':
Description: No content
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
Method: Post
Summary: Updates the PEI in the 3GPP access registration context
Operation ID: PeiUpdate
Tags:
- PEI Update
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/PeiUpdateInfo'
Required/Optional: true
Responses:
'204':
Description: No content
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
put:
Summary: register as AMF for non-3GPP access
Operation ID: Non3GppRegistration
Tags:
- AMF registration for non-3GPP access
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AmfNon3GppAccessRegistration'
Required/Optional: true
Responses:
'201':
Description: Created
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AmfNon3GppAccessRegistration'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-non-3gpp-access'
Required/Optional: true
Schema:
Type: string
'200':
Description: OK
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AmfNon3GppAccessRegistration'
'204':
Description: No Content
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
Callbacks:
deregistrationeNotification:
'{request.body#/deregCallbackUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/DeregistrationData'
Responses:
'204':
Description: Successful Notification response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
pcscfRestorationNotification:
'{request.body#/pcscfRestorationCallbackUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/PcscfRestorationNotification'
Responses:
'204':
Description: Successful Notification response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
patch:
Summary: update a parameter in the AMF registration for non-3GPP access
Operation ID: UpdateNon3GppRegistration
Tags:
- Parameter update in the AMF registration for non-3GPP access
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: supported-features
In: query
Description: Features required to be supported by the target NF
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Request Body:
Content:
application/merge-patch+json:
Schema:
Reference: '#/components/schemas/AmfNon3GppAccessRegistrationModification'
Required/Optional: true
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'
'204':
Description: Expected response to a valid request
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'422':
Description: Unprocessable Request
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
get:
Summary: retrieve the AMF registration for non-3GPP access information
Operation ID: GetNon3GppRegistration
Tags:
- AMF non-3GPP-access Registration Info Retrieval
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AmfNon3GppAccessRegistration'
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
get:
Summary: retrieve the SMF registration information
Operation ID: GetSmfRegistration
Tags:
- SMF SmfRegistration
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: single-nssai
In: query
Content:
Application/JSON:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
- Name: dnn
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
- Name: supported-features
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistrationInfo'
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
put:
Summary: register as SMF
Operation ID: Registration
Tags:
- SMF SmfRegistration
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: pduSessionId
In: path
Description: Identifier of the PDU session
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
Required/Optional: true
Responses:
'201':
Description: Created
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smf-registrations/{pduSessionId}'
Required/Optional: true
Schema:
Type: string
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
'204':
Description: No content
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
Callbacks:
deregistrationeNotification:
'{request.body#/deregCallbackUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/DeregistrationData'
Responses:
'204':
Description: Successful Notification response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
pcscfRestorationNotification:
'{request.body#/pcscfRestorationCallbackUri}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/PcscfRestorationNotification'
Responses:
'204':
Description: Successful Notification response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
delete:
Summary: delete an SMF registration
Operation ID: SmfDeregistration
Tags:
- SMF Deregistration
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: pduSessionId
In: path
Description: Identifier of the PDU session
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
- Name: smf-set-id
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
Responses:
'204':
Description: Expected response to a valid request
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'422':
Description: Unprocessable Request
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
get:
Summary: get an SMF registration
Operation ID: RetrieveSmfRegistration
Tags:
- Retrieve SMF Registration
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: pduSessionId
In: path
Description: Identifier of the PDU session
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
put:
Summary: register as SMSF for 3GPP access
Operation ID: 3GppSmsfRegistration
Tags:
- SMSF registration for 3GPP access
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
Required/Optional: true
Responses:
'201':
Description: Created
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-3gpp-access'
Required/Optional: true
Schema:
Type: string
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
'204':
Description: No content
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
delete:
Summary: delete the SMSF registration for 3GPP access
Operation ID: 3GppSmsfDeregistration
Tags:
- SMSF Deregistration for 3GPP Access
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: smsf-set-id
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
Responses:
'204':
Description: Expected response to a valid request
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'422':
Description: Unprocessable Request
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
get:
Summary: retrieve the SMSF registration for 3GPP access information
Operation ID: Get3GppSmsfRegistration
Tags:
- SMSF 3GPP access Registration Info Retrieval
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
- Name: supported-features
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
put:
Summary: register as SMSF for non-3GPP access
Operation ID: Non3GppSmsfRegistration
Tags:
- SMSF registration for non-3GPP access
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
Required/Optional: true
Responses:
'201':
Description: Created
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-non-3gpp-access'
Required/Optional: true
Schema:
Type: string
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
'204':
Description: No content
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
delete:
Summary: delete SMSF registration for non 3GPP access
Operation ID: Non3GppSmsfDeregistration
Tags:
- SMSF Deregistration for non-3GPP access
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- Name: smsf-set-id
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
Responses:
'204':
Description: Expected response to a valid request
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'422':
Description: Unprocessable Request
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
get:
Summary: retrieve the SMSF registration for non-3GPP access information
Operation ID: GetNon3GppSmsfRegistration
Tags:
- SMSF non-3GPP access Registration Info Retrieval
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
- Name: supported-features
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
Method: Post
Summary: Trigger the Restoration of the P-CSCF
Operation ID: Trigger P-CSCF Restoration
Tags:
- Trigger P-CSCF Restoration
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/TriggerRequest'
Required/Optional: true
Responses:
'204':
Description: Successful response
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'501':
Reference: 'TS29571_CommonData.yaml#/components/responses/501'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
get:
Summary: retrieve the target UE's location information
Operation ID: GetLocationInfo
Tags:
- UE Location Information retrieval
Parameters:
- Name: ueId
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/LocationInfo'
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
securitySchemes:
oAuth2ClientCredentials:
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nudm-uecm: Access to the nudm-uecm API
schemas:
# COMPLEX TYPES:
Amf3GppAccessRegistration:
Type: object
Required:
- amfInstanceId
- deregCallbackUri
- guami
- ratType
Properties:
amfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
purgeFlag:
Reference: '#/components/schemas/PurgeFlag'
pei:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei'
imsVoPs:
Reference: '#/components/schemas/ImsVoPs'
deregCallbackUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
amfServiceNameDereg:
Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
pcscfRestorationCallbackUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
amfServiceNamePcscfRest:
Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
initialRegistrationInd:
Type: boolean
guami:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Guami'
backupAmfInfo:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo'
minItems: 1
drFlag:
Reference: '#/components/schemas/DualRegistrationFlag'
ratType:
Reference: 'TS29571_CommonData.yaml#/components/schemas/RatType'
urrpIndicator:
Type: boolean
amfEeSubscriptionId:
Type: string
epsInterworkingInfo:
Reference: '#/components/schemas/EpsInterworkingInfo'
ueSrvccCapability:
Type: boolean
nid:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Nid'
registrationTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
vgmlcAddressIpv4:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
vgmlcAddressIpv6:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
vgmlcFqdn:
Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
Amf3GppAccessRegistrationModification:
Type: object
Required:
- guami
Properties:
guami:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Guami'
purgeFlag:
Reference: '#/components/schemas/PurgeFlag'
pei:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei'
imsVoPs:
Reference: '#/components/schemas/ImsVoPs'
backupAmfInfo:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo'
epsInterworkingInfo:
Reference: '#/components/schemas/EpsInterworkingInfo'
ueSrvccCapability:
Type: boolean
nullable: true
EpsInterworkingInfo:
Type: object
Properties:
epsIwkPgws:
Description: A map (list of key-value pairs where Dnn serves as key) of EpsIwkPgws
Type: object
additionalProperties:
Reference: '#/components/schemas/EpsIwkPgw'
EpsIwkPgw:
Type: object
Required:
- pgwFqdn
- smfInstanceId
Properties:
pgwFqdn:
Type: string
smfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
AmfNon3GppAccessRegistration:
Type: object
Required:
- amfInstanceId
- imsVoPs
- deregCallbackUri
- guami
- ratType
Properties:
amfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
purgeFlag:
Reference: '#/components/schemas/PurgeFlag'
pei:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei'
imsVoPs:
Reference: '#/components/schemas/ImsVoPs'
deregCallbackUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
amfServiceNameDereg:
Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
pcscfRestorationCallbackUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
amfServiceNamePcscfRest:
Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
guami:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Guami'
backupAmfInfo:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo'
minItems: 1
ratType:
Reference: 'TS29571_CommonData.yaml#/components/schemas/RatType'
urrpIndicator:
Type: boolean
amfEeSubscriptionId:
Type: string
nid:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Nid'
registrationTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
vgmlcAddressIpv4:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
vgmlcAddressIpv6:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
vgmlcFqdn:
Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
AmfNon3GppAccessRegistrationModification:
Type: object
Required:
- guami
Properties:
guami:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Guami'
purgeFlag:
Reference: '#/components/schemas/PurgeFlag'
pei:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei'
imsVoPs:
Reference: '#/components/schemas/ImsVoPs'
backupAmfInfo:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo'
SmfRegistration:
Type: object
Required:
- smfInstanceId
- pduSessionId
- singleNssai
- plmnId
Properties:
smfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
smfSetId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
pduSessionId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
singleNssai:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
dnn:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
emergencyServices:
Type: boolean
pcscfRestorationCallbackUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
plmnId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
pgwFqdn:
Type: string
epdgInd:
Type: boolean
Default: false
deregCallbackUri:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
registrationReason:
Reference: '#/components/schemas/RegistrationReason'
registrationTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
SmsfRegistration:
Type: object
Required:
- smsfInstanceId
- plmnId
Properties:
smsfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
smsfSetId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
plmnId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
smsfMAPAddress:
Reference: '#/components/schemas/E164Number'
smsfDiameterAddress:
Reference: '#/components/schemas/NetworkNodeDiameterAddress'
registrationTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
DeregistrationData:
Type: object
Required:
- deregReason
- accessType
Properties:
deregReason:
Reference: '#/components/schemas/DeregistrationReason'
accessType:
Reference: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
pduSessionId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
newSmfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
PcscfRestorationNotification:
Type: object
Required:
- supi
Properties:
supi:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
NetworkNodeDiameterAddress:
Type: object
Required:
-name
- realm
Properties:
name:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity'
realm:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity'
TriggerRequest:
Type: object
Required:
- supi
Properties:
supi:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
SmfRegistrationInfo:
Type: object
Required:
- smfRegistrationList
Properties:
smfRegistrationList:
Type: array
Items:
Reference: '#/components/schemas/SmfRegistration'
minItems: 1
AmfDeregInfo:
Type: object
Required:
- deregReason
Properties:
deregReason:
Reference: '#/components/schemas/DeregistrationReason'
LocationInfo:
Type: object
Required:
- registrationLocationInfoList
Properties:
supi:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
gpsi:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
registrationLocationInfoList:
Type: array
Items:
Reference: '#/components/schemas/RegistrationLocationInfo'
minItems: 1
maxItems: 2
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
RegistrationLocationInfo:
Type: object
CmInfoReport:
Type: object
Required:
- newCmInfoList
Properties:
oldCmInfoList:
Type: array
Items:
Reference: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmInfo'
minItems: 1
maxItems: 2
newCmInfoList:
Type: array
Items:
Reference: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmInfo'
minItems: 1
maxItems: 2
VgmlcAddress:
Type: object
Properties:
vgmlcAddressIpv4:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
vgmlcAddressIpv6:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
vgmlcFqdn:
Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
PeiUpdateInfo:
Type: object
Required:
- pei
Properties:
pei:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei'
# SIMPLE TYPES:
PurgeFlag:
Type: boolean
E164Number:
Type: string
Pattern: '^[0-9]{1,15}$'
DualRegistrationFlag:
Type: boolean
# ENUMS:
ImsVoPs:
anyOf:
- type: string
enum:
- HOMOGENEOUS_SUPPORT
- HOMOGENEOUS_NON_SUPPORT
- NON_HOMOGENEOUS_OR_UNKNOWN
- type: string
DeregistrationReason:
anyOf:
- type: string
enum:
- UE_INITIAL_REGISTRATION
- UE_REGISTRATION_AREA_CHANGE
- SUBSCRIPTION_WITHDRAWN
- 5GS_TO_EPS_MOBILITY
- 5GS_TO_EPS_MOBILITY_UE_INITIAL_REGISTRATION
- REREGISTRATION_REQUIRED
- SMF_CONTEXT_TRANSFERRED
- type: string
RegistrationReason:
anyOf:
- type: string
enum:
- SMF_CONTEXT_TRANSFERRED
- type: string
Description: 3GPP TS 29.503 Unified Data Management Services, version 16.3.0
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'