5.2.2 Service Operations

29.5033GPP5G SystemRelease 18Stage 3TSUnified Data Management Services

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

5.2.2.1 Introduction

For the Nudm_SubscriberDataManagement service the following service operations are defined:

– Get

– Subscribe

– ModifySubscription

– Unsubscribe

– Notification

– Info

The Nudm_SubscriberDataManagement Service is used by Consumer NFs (AMF, SMF, SMSF, GMLC, NEF, 5G DDNMF, NWDAF, DCCF, trusted AF) to retrieve the UE’s individual subscription data relevant to the consumer NF from the UDM by means of the Get service operation. If the consumer NF supports the feature "sharedData" (see clause 6.1.8), the retrieved individual subscription data for the UE may contain shared data identifier identifying additional parts of subscription data shared by several UEs. If so, the Nudm_SubscriberDataManagement Service is also used by Consumer NFs to retrieve shared subscription data from the UDM by means of the Get service operation unless the shared data is already cached. The retrieved shared data shall be cached as long as the consumer NF serves an UE for which the shared data is relevant.

It is also used by Consumer NFs to subscribe to notifications of data change by means of the Subscribe service operation. If the consumer NF supports the feature "sharedData" (see clause 6.1.8), the consumer NF may also subscribe to notifications of shared data change by means of the Subscribe service operation.

It is also used to modify an existing subscription by means of the ModifySubscription service operation. If the consumer NF supports the feature "sharedData" (see clause 6.1.8), the consumer NF may also modify an existing subscription to notifications of shared data change by means of the ModifySubscription service operation.

It is also used to unsubscribe from notifications of data changes by means of the Unsubscribe service operation. If the feature "sharedData" (see clause 6.1.8) is supported, it may also be used to unsubscribe from notifications of shared data changes by means of the Unsubscribe service operation.

It is also used by the Consumer NFs (AMF, SMF, SMSF, NEF, GMLC, 5G DDNMF, NWDAF, DCCF, trusted AF) that have previously subscribed, to get notified by means of the Notification service operation when UDM decides to modify the subscribed data. If the feature "sharedData" (see clause 6.1.8) is supported by the consumer NF and the consumer NF has previously subscribed to notifications of shared data change, it is also used by the consumer NF to get notified by means of the Notification service operation when the UDM decides to modify the subscribed shared data.

It is also used by Consumer NFs to provide the information about the status of the subscription data management procedures.

5.2.2.2 Get

5.2.2.2.1 General

The following procedures using the Get service operation are supported:

– Slice Selection Subscription Data Retrieval

– Access and Mobility Subscription Data Retrieval

– SMF Selection Subscription Data Retrieval

– Session Management Subscription Data Retrieval

– SMS Subscription Data Retrieval

– SMS Management Subscription Data Retrieval

– UE Context in SMF Data Retrieval

– UE Context in SMSF Data Retrieval

– Retrieval Of Multiple Data Sets

– Identifier Translation

– Shared Subscription Data Retrieval

– Trace Data Retrieval

– LCS Privacy Data Retrieval

– Group Identifier Translation

– LCS Mobile Originated Data Retrieval

– Enhanced Coverage Restriction Data Retrieval

– V2X Subscription Data Retrieval

– LCS Broadcast Assistance Subscription Data Retrieval

– UE Context in AMF Data Retrieval

– ProSe Subscription Data Retrieval

– Individual Shared Subscription Data Retrieval

– 5MBS Subscription Data Retrieval

– User Consent Subscription Data Retrieval

– Multiple Identifiers Translation

When the feature SharedData (see clause 6.1.8) is supported and the retrieved UE-individual data (i.e. data other than Shared Subscription Data) contain SharedDataIds, the NF service consumer shall also retrieve the shared data identified by the received shared data Ids unless the identified shared data are already available at the NF service consumer. The order of sequence of sharedDataIds within UE-individual data is significant: Individual data take precedence over shared data unless the feature SharedDataTreatment is supported in which case treatment instructions may be applicable; shared data "SharedDataX" identified by a sharedDataId X takes precedence over shared data "SharedDataY" identified by a sharedDataId Y if X appears immediately before Y within the list of SharedDataIds in the UE-individual data unless the feature SharedDataTreatment is supported in which case the treatment instructions associated to SharedDataY are applicable after treatment instructions associated to SharedDataX have been applied.

5.2.2.2.2 Slice Selection Subscription Data Retrieval

Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE’s NSSAI (see also clause 5.15.5.2.1 of 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3] figure 4.2.2.2.3-1 step 3). In this example scenario the NSSAI is retrieved by the AMF, see clause 6.1.3.2.1 for other scenarios that can retrieve the NSSAI. The request contains the UE’s identity (/{supi}), the type of the requested information (/nssai) and query parameters (supported-features, plmn-id).

Figure 5.2.2.2.2-1: Requesting a UE’s NSSAI

1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE’s subscribed NSSAI, with query parameters indicating the supported-features and/or plmn-id.

2a. On success, the UDM responds with "200 OK" with the message body containing the UE’s NSSAI as relevant for the requesting NF service consumer.

2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.3 Access and Mobility Subscription Data Retrieval

Figure 5.2.2.2.3-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE’s Access and Mobility Subscription data (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE’s identity (/{supi}), the type of the requested information (/am-data) and query parameters (supported-features, plmn-id).

Figure 5.2.2.2.3-1: Requesting a UE’s Access and Mobility Subscription Data

1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE’s Access and Mobility Subscription Data, with query parameters indicating the supported-features and/or plmn-id.

2a. On Success, the UDM responds with "200 OK" with the message body containing the UE’s Access and Mobility Subscription Data as relevant for the requesting NF service consumer.

NOTE 1: If the UDM initiated a request to obtain SoR information from the SOR-AF, the UDM starts an operator configurable timer up to which the UDM shall wait for a response from the SOR-AF for retrieving the SoR information. The UDM responds back to the NF service consumer for Access and Mobility Subscription Data Retrieval service operation before the timer expires. If the SOR-AF has not provided a response with the SoR information before the timer expires, the UDM shall behave as specified in clause C.2 of 3GPP°TS°23.122 [20] (step 3d). As described in clause C.2 of 3GPP°TS°23.122 [20] (step 4), if UDM supports SOR-CMCI, then UDM indicates in the response to NF service consumer (i.e. AMF) to send acknowledgement that will include the "ME support of SOR-CMCI". UDM will also delete the "ME support of SOR-CMCI" updating AuthenticationSoR of Nudr_DataRepository service as specified in 3GPP TS 29.505 [10] clause 5.2.25, if the UE is performing initial registration or emergency registration. UDM will decide whether to provide SOR-CMCI based on "usimSupportOfSorCmci" retrieved via AuthenticationSoR of Nudr_DataRepository service as specified in 3GPP TS 29.505 [10] clause 5.2.25.

NOTE 2: Upon reception of any Nudm_EventExposure operation or Nudm_PP operation, or when the validity of an event subscription or provisioned parameter with its associated maximum latency, maximum response time or DL Buffering Suggested Packet Count value expires, UDM may need to adjust the values of active time and/or periodic registration timer and/or DL Buffering Suggested Packet Count. The UDM shall notify AMF and/or SMF if the values are updated (see clause 4.15.3.2.3b and 4.15.6.3a of 3GPP TS 23.502 [3]).

NOTE 3: If UPU data have previously been provisioned, but have not yet been acknowledged by the UE, e.g. because no AMF was registered at provisioning time, the UDM needs to convey the UPU data (after AUSF protection) within 200 OK AccessAndMobilitySubscriptionDatato to the AMF.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.4 SMF Selection Subscription Data Retrieval

Figure 5.2.2.2.4-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE’s SMF Selection Subscription data (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE’s identity (/{supi}), the type of the requested information (/smf-select-data) and query parameters (supported-features, plmn-id).

Figure 5.2.2.2.4-1: Requesting a UE’s SMF Selection Subscription Data

1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE’s SMF Selection Subscription Data, with query parameters indicating the supported-features and/or plmn-id.

2a. On success, the UDM responds with "200 OK" with the message body containing the UE’s SMF Selection Subscription Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.5 Session Management Subscription Data Retrieval

Figure 5.2.2.2.5-1 shows a scenario where the NF service consumer (e.g. SMF) sends a request to the UDM to receive the UE’s session management subscription data (see also 3GPP TS 23.502 [3] figure 4.3.2.2.1-1 step 4a-4b). The request contains the UE’s identity (/{supi}), the type of the requested information (/sm-data), and query parameters (single-nssai, dnn, supported-features, plmn-id).

Figure 5.2.2.2.5-1: Requesting a UE’s Session Management Subscription Data

1. The NF service consumer (e.g. SMF) sends a GET request to the resource representing the UE’s session management subscription data, with query parameters indicating the selected network slice and/or the DNN and/or supported-features and/or plmn-id.

2a. On success, the UDM responds with "200 OK", the message body containing the UE’s session management subscription data (an array of SessionManagementSubscriptionData objects and/or SharedDataIds, one array element per S-NSSAI) as relevant for the requesting NF service consumer.

2b. If there is no valid subscription data for the UE, or if the UE subscription data exists, but the requested session management subscription is not available (e.g. query parameter contains network slice and/or DNN that does not belong to the UE subscription), HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.6 SMS Subscription Data Retrieval

Figure 5.2.2.2.6-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE’s SMS Subscription Data (see also 3GPP TS 23.502 [3], clause 4.13.3.1). The request contains the UE’s identity (/{supi}) and the type of the requested information (/sms-data).

Figure 5.2.2.2.6-1: Requesting UE’s SMS Subscription Data

1. The NF Service Consumer (e.g. AMF) sends a GET request to the resource representing the UE’s SMS Subscription Data.

2. The UDM responds with "200 OK" with the message body containing the UE’s SMS Subscription Data.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.7 SMS Management Subscription Data Retrieval

Figure 5.2.2.2.7-1 shows a scenario where the NF service consumer (e.g. SMSF) sends a request to the UDM to receive the UE’s SMS Management Subscription Data (see also 3GPP TS 23.502 [3], clause 4.13.3.1). The request contains the UE’s identity (/{supi}) and the type of the requested information (/sms-mng-data).

Figure 5.2.2.2.7-1: Requesting UE’s SMS Management Subscription Data

1. The NF Service Consumer (e.g. SMSF) sends a GET request to the resource representing the UE’s SMS Management Subscription Data.

2. The UDM responds with "200 OK" with the message body containing the UE’s SMS Management Subscription Data.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.8 UE Context In SMF Data Retrieval

Figure 5.2.2.2.8-1 shows a scenario where the NF service consumer (e.g. AMF, NWDAF, DCCF) sends a request to the UDM to receive the UE’s Context In SMF data (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE’s identity (/{supi}), the type of the requested information (/ue-context-in-smf-data) and query parameters (supported-features).

Figure 5.2.2.2.8-1: Requesting a UE’s Context in SMF Data

1. The NF service consumer (e.g. AMF) shall send a GET request to the resource representing the UE’s Context In SMF Data, with query parameters indicating the supported-features.

2a. On Success, the UDM shall respond with "200 OK" with the message body containing the UE’s Context In SMF Data as relevant for the requesting NF service consumer. If no PDU session is stored in the UDM the UEContextInSmfData within "200 OK" shall be empty.

2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" may be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.9 Retrieval Of Multiple Data Sets

Figure 5.2.2.2.9-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive multiple data sets. In this example scenario the UE’s Access and Mobility Subscription data and the the UE’s SMF Selection Subscription data are retrieved with a single request; see clause 6.1.3.11.3.1 for other data sets that can be retrieved with a single request. The request contains the UE’s identity (/{supi}) and query parameters identifying the requested data sets (in this example: ?dataset-names=AM, SMF_SEL). The data sets allowed in multiple data sets retrieval are listed in table 6.1.6.3.3-1.

Figure 5.2.2.2.9-1: Retrieval of Multiple Data Sets

1. The NF Service Consumer (e.g. AMF) sends a GET request to the resource representing the supi. Query parameters indicate the requested data sets.

2. The UDM responds with "200 OK" with the message body containing the requested and available data sets. When not all requested data sets are available at the UDM (e.g. no Trace Data), only the requested and available data sets are returned in a "200 OK" response.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.10 Identifier Translation

Figure 5.2.2.2.10-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to receive the SUPI/GPSI that corresponds to the provided GPSI/SUPI (see also 3GPP TS 23.502 [3] clause 4.13.2.2, clause 4.13.7.2) and clause 4.15.z. The request contains the UE’s identity (/{ueId}) which shall be a SUPI or GPSI and the type of the requested information (/id-translation-result).

NOTE: This service operation can be used by a Rel-15 GMLC during 5GS-MT-LR procedure to get the SUPI of a UE from GPSI, as an authorized NF service consumer of Nudm_SubscriberDataManagement service.

Figure 5.2.2.2.10-1: Identifier Translation

1. The NF Service Consumer (e.g. NEF) shall send a GET request to the resource representing the IdTranslationResult, with query parameters indicating the supported-features and/or necessary information used for identifier translation (e.g. af-id, app-port-id, etc.).

2a. On success, the UDM shall respond with "200 OK" with the message body containing the UE’s requested identity (GPSI or SUPI).

If the expected result of identifier translation is GPSI and the AF specific query parameters (e.g. af-id, app-port-id, af-service-id, mtc-provider-info, etc) are provided, the UDM shall take the provided AF specific information into account to determine the GPSI (i.e. External Identifier) to be returned for the UE.

2c. If the AF included in the request is not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.11 Shared Subscription Data Retrieval

Figure 5.2.2.2.11-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the shared subscription data. The request contains the type of the requested information (/shared-data) and query parameters (supported-features, shared-data-ids).

Figure 5.2.2.2.11-1: Requesting shared data

1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the SharedData, with query parameters indicating the supported-features and shared-data-ids.

2a. On success, the UDM responds with "200 OK" with the message body containing the SharedData.

2b. If there is no valid shared data for one or more of the shared-data-ids, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.12 UE Context In SMSF Data Retrieval

Figure 5.2.2.2.12-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE’s Context In SMSF data. The request contains the UE’s identity (/{supi}), the type of the requested information (/ue-context-in-smsf-data) and query parameters (supported-features).

Figure 5.2.2.2.12-1: Requesting a UE’s Context in SMSF Data

1. The NF service consumer (e.g. AMF) shall send a GET request to the resource representing the UE’s Context In SMSF Data, with query parameters indicating the supported-features.

2a. On Success, the UDM shall respond with "200 OK" with the message body containing the UE’s Context In SMSF Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.13 Trace data Retrieval

Figure 5.2.2.2.13-1 shows a scenario where the NF service consumer (e.g. AMF, SMF) sends a request to the UDM to receive the UE’s trace data. The request contains the UE’s identity (/{supi}), the type of the requested information (/trace-data) and query parameters.

Figure 5.2.2.2.13-1: Requesting a UE’s trace Data

1. The NF service consumer (e.g. AMF, SMF) shall send a GET request to the resource representing the UE’s trace Data, with query parameters.

2a. On Success, the UDM shall respond with "200 OK" with the message body containing the UE’s trace data response as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.14 Group Identifier Translation

Figure 5.2.2.2.14-1 shows a scenario where the NF service consumer (e.g NEF, GMLC) sends a request to the UDM to receive the Internal Group Identifier that corresponds to the provided External Group Identifier and / or the list of the UE identifiers (e.g. SUPIs, GPSIs) that belong to the provided External Group Identifier.

The NF service consumer (e.g TSCTSF) may also send a request to the UDM to receive the list of the UE identifiers (e.g. SUPIs) that corresponds to the provided External Group Identifier (see 3GPP TS 23.502 [3] clause 4.15.9.2 and clause 4.15.9.4)

Figure 5.2.2.2.14-1: External Group Identifier Translation

1. The NF Service Consumer (e.g. NEF, GMLC, TSCTSF) shall send a GET request to the resource representing the group identifiers handled by UDM; the External Group Identifier is passed in a query parameter of the request URI, and an indication is also passed if the list of UE identifiers that belong to the provided External Group Identifier are required.

2a. On success, the UDM shall respond with "200 OK" with the message body containing the Internal Group Identifier and / or the list of UE identifiers that belong to the provided External Group Identifier.

2b. If there is no valid data for this group, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

2c. If the AF included in the request is not allowed to perform this operation for the group, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

Figure 5.2.2.2.14-2 shows another scenario where the NF service consumer (e.g NEF, GMLC) sends a request to the to receive the External Group Identifier that corresponds to the provided Internal Group Identifier and optionally, the list of the UE identifiers (e.g. SUPIs , GPSIs) pertaining to such group or the NF service consumer (e.g TSCTSF) sends a request to the UDM to receive the list of the UE identifiers (e.g. SUPIs) that corresponds to the provided Internal Group Identifier (see 3GPP TS 23.502 [3] clause 4.15.9.2 and clause 4.15.9.4).

Figure 5.2.2.2.14-2: Internal Group Identifier Translation

1. The NF Service Consumer (e.g. NEF, GMLC, TSCTSF) shall send a GET request to the resource representing the Internal Group Identifiers handled by UDM; the Internal Group Identifier is passed in a query parameter of the request URI, and an indication is also passed if the list of UE identifiers that belong to the provided Internal Group Identifier are required.

2a. On success, the UDM shall respond with "200 OK" with the message body containing the corresponding External Group Identifier and / or the list of UE identifiers that belong to the provided Internal Group Identifier.

2b. If there is no valid data for this group, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.15 LCS Privacy Data Retrieval

Figure 5.2.2.2.15-1 shows a scenario where the NF service consumer (e.g. HGMLC, NEF) sends a request to the UDM to receive the UE’s LCS Privacy Subscription data (see 3GPP TS 23.273 [38] figure 6.1.2-1 step 2, figure 6.3.1-1 step 2, figure 6.5.1-1 step 7 and figure 6.8.1 step 3). The request contains the UE’s identity (/{ueId}), the type of the requested information (/lcs-privacy-data) and query parameters (supported-features).

Figure 5.2.2.2.15-1: Requesting a UE’s LCS Privacy Data

1. The NF service consumer (e.g. HGMLC, NEF) sends a GET request to the resource representing the UE’s Lcs Privacy Subscription Data, with query parameters indicating the supported-features.

2a. On Success, the UDM responds with "200 OK" with the message body containing the UE’s Lcs Privacy Subscription Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.16 LCS Mobile Originated Data Retrieval

Figure 5.2.2.2.16-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE’s LCS Mobile Originated Subscription data (see 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE’s identity (/{supi}), the type of the requested information (/lcs-mo-data) and query parameters (supported-features).

Figure 5.2.2.2.16-1: Requesting a UE’s LCS Mobile Originated Data

1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE’s LCS Mobile Originated Subscription Data, with query parameters indicating the supported-features.

2a. On Success, the UDM responds with "200 OK" with the message body containing the UE’s LCS Mobile Originated Subscription Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.17 Enhanced Coverage Restriction Data Retrieval

Figure 5.2.2.2.17-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to retrieve a UE’s subscribed Enhanced Coverage Restriction data (see also 3GPP TS 23.502 [3] figure 4.27.1-1 step 3 and 7). The request contains the identifier of the UE (/{supi}), the type of the requested information (/am-data/ecr-data) and query parameters (supported-features).

Figure 5.2.2.2.17-1: NF service consumer retrieves Enhance Coverage Restriction Data

1. The NF service consumer (e.g. NEF) sends a GET request to the resource that represents a UE’s subscribed Enhanced Coverage Restriction data, with query parameters indicating the supported-features.

2a. On success, the UDM responds with "200 OK", the message body containing the UE’s subscribed Enhanced Coverage Restriction data as relevant for the requesting NF service consumer.

2b. If there is no valid subscribed Enhanced Coverage Restriction data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.18 V2X Subscription Data Retrieval

Figure 5.2.2.2.18-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to retrieve a UE’s subscribed V2X data (see also 3GPP TS 23.287 [51] clause 6.5.2). The request contains the identifier of the UE (/{supi}), the type of the requested information (/v2x-data) and query parameters (supported-features).

Figure 5.2.2.2.18-1: NF service consumer retrieves V2X Subscription Data

1. The NF service consumer (e.g. AMF) sends a GET request to the resource that represents a UE’s subscribed V2X data, with query parameters indicating the supported-features.

2a. On success, the UDM responds with "200 OK", the message body containing the UE’s subscribed V2X data as relevant for the requesting NF service consumer.

2b. If there is no valid subscribed V2X data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.19 LCS Broadcast Assistance Subscription Data Retrieval

Figure 5.2.2.2.19-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE’s LCS Broadcast Assistance Subscription data (see 3GPP TS 23.273 [38]). The request contains the UE’s identity (/{supi}), the type of the requested information (/lcs-bca-data) and query parameters (supported-features, plmn-id).

Figure 5.2.2.2.19-1: Requesting a UE’s LCS Broadcast Assistance Subscription Data

1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE’s Lcs Location Assistance Subscription Data, with query parameters indicating the supported-features and/or plmn-id.

2a. On Success, the UDM responds with "200 OK" with the message body containing the UE’s Lcs Location Assistance Subscription Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.20 UE Context In AMF Data Retrieval

Figure 5.2.2.2.20-1 shows a scenario where the NF service consumer (e.g. HSS, NWDAF, DCCF) sends a request to the UDM to receive the UE’s Context In AMF data (see 3GPP TS 23.632 [32] figure 5.3.4-1 step 2 and 3 and also 3GPP TS 23.288[35]). The request contains the UE’s identity (/{supi}), the type of the requested information (/ue-context-in-amf-data) and query parameters (supported-features).

Figure 5.2.2.2.20-1: Requesting a UE’s Context in AMF Data

1. The NF service consumer (e.g. HSS) shall send a GET request to the resource representing the UE’s Context In AMF Data, with query parameters indicating the supported-features.

2a. On Success, the UDM shall respond with "200 OK" with the message body containing the UE’s Context In AMF Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.21 Individual Shared Subscription Data Retrieval

Figure 5.2.2.2.21-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the individual shared subscription data indicated by the sharedDataId. The request contains the type of the requested information (/shared-data/{sharedDataId} and query parameters (supported-features)).

Figure 5.2.2.2.21-1: Requesting shared data

1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the individual SharedData indicated by the sharedDataId.

2a. On success, the UDM responds with "200 OK" with the message body containing the individual SharedData.

2b. If there is no valid individual SharedData indicated by the sharedDataId, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.22 Prose Subscription Data Retrieval

Figure 5.2.2.2.22-1 shows a scenario where the NF service consumer (e.g. 5G DDNMF) sends a request to the UDM to receive the UE’s ProSe Subscription Data. The request contains the UE’s identity (/{supi}), the type of the requested information (/prose-data) and query parameters (supported-features).

Figure 5.2.2.2.22-1: Requesting a UE’s ProSe Subscription Data

1. The NF service consumer (e.g. 5G DDNMF) sends a GET request to the resource representing the UE’s ProSe Subscription Data, with query parameters indicating the supported-features.

2a. On Success, the UDM responds with "200 OK" with the message body containing the UE’s ProSe Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.23 5MBS Subscription Data Retrieval

Figure 5.2.2.2.23-1 shows a scenario where the NF service consumer (e.g. SMF) sends a request to the UDM to receive the UE’s 5MBS Subscription Data. The request contains the UE’s identity (/{supi}), the type of the requested information (/mbs-data) and query parameters (supported-features).

Figure 5.2.2.2.23-1: Requesting a UE’s 5MBS Subscription Data

1. The NF service consumer (e.g. SMF) sends a GET request to the resource representing the UE’s 5MBS Subscription Data, with query parameters indicating the supported-features.

2a. On Success, the UDM responds with "200 OK" with the message body containing the UE’s 5MBS Subscription Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.24 User Consent Subscription Data Retrieval

Figure 5.2.2.2.24-1 shows a scenario where the NF service consumer (e.g. NWDAF, DCCF, NEF, trusted AF) sends a request to the UDM to receive the UE’s User Consent Subscription Data. The request contains the UE’s identity (/{supi}), the type of the requested information (/uc-data) and query parameters (uc-purpose and/or supported-features).

Figure 5.2.2.2.24-1: Requesting a UE’s User Consent Subscription Data

1. The NF service consumer (e.g. NWDAF, DCCF, NEF, trusted AF) sends a GET request to the resource representing the UE’s User Consent Subscription Data, with query parameters indicating the uc-purpose and/or supported-features.

2a. On Success, the UDM responds with "200 OK" with the message body containing the UE’s User Consent Subscription Data as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.2.25 Multiple Identifiers Translation

Figure 5.2.2.2.25-1 shows a scenario where the NF service consumer (e.g TSCTSF) sends a request to the UDM to receive the list of the UE identifiers (i.e. SUPIs) that corresponds to the provided UE identifiers (i.e. GPSIs) (see 3GPP TS 23.502 [3] clause 4.15.9.2 and clause 4.15.9.4).

Figure 5.2.2.2.25: GPSIs Translation

1. The NF Service Consumer (e.g. TSCTSF) shall send a GET request to the resource representing the list of GPSIs handled by UDM; the list of GPSIs are passed in a query parameter of the request URI.

2a. On success, the UDM shall respond with "200 OK" with the message body containing the list of UE Identifiers with list of SUPIs that belong to each provided GPSI.

2b. If there is no valid data for this list of GPSIs, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

5.2.2.3 Subscribe

5.2.2.3.1 General

The following procedures using the Subscribe service operation are supported:

– Subscription to notification of data change (for UE individual data)

– Subscription to notification of shared data change

5.2.2.3.2 Subscription to notifications of data change

Figure 5.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the UDM to subscribe to notifications of data change (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains a callback URI and the URI of the monitored resource.

Figure 5.2.2.3.2-1: NF service consumer subscribes to notifications

1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (…/{ueId}/sdm-subscriptions), to create a subscription as present in message body. The payload body of the POST request shall contain a representation of the individual subscription resource to be created. An NF consumer supporting the "LimitedSubscriptions" feature shall create only one unique subscription per UE (identified by the ueId in URI) without additional filter criteria, or with a specific filter criteria (e.g. dnn and/or singleNssai), and set the "uniqueSubscription" IE with the value "true" in request body.

2a. On success, the UDM responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription.

In case of partial success, "201 Created" should contain only the monitores resource Uris that are supported by the UDM.

2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the SdmSubscription parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

"501 Not Implemented" shall be returned only when none of the montitoredResourceUris are supported by the UDM.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.

5.2.2.3.3 Subscription to notifications of shared data change

Figure 5.2.2.3.3-1 shows a scenario where the NF service consumer sends a request to the UDM to subscribe to notifications of shared data change. The request contains a callback URI and the URI of the monitored resource.

Figure 5.2.2.3.3-1: NF service consumer subscribes to notifications of shared data change

1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (…/shared-data-subscriptions), to create a subscription as present in message body. The payload body of the POST request shall contain a representation of the shared data individual subscription resource to be created. An NF consumer supporting the "LimitedSubscriptions" feature shall create only one unique shared data individual subscription and set the "uniqueSubscription" IE with the value "true" in request body.

2. On success, the UDM responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.

5.2.2.4 Unsubscribe

5.2.2.4.1 General

The following procedures using the Unsubscribe service operation are supported:

– Unsubscribe to notification of data change (for UE individual data)

– Unsubscribe to notifications of shared data change

5.2.2.4.2 Unsubscribe to notifications of data change

Figure 5.2.2.4.2-1 shows a scenario where the NF service consumer sends a request to the UDM to unsubscribe from notifications of data changes (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.2.2.4.2-1: NF service consumer unsubscribes to notifications

1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation.

2a. On success, the UDM responds with "204 No Content".

2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body.

5.2.2.4.3 Unsubscribe to notifications of shared data change

Figure 5.2.2.4.3-1 shows a scenario where the NF service consumer sends a request to the UDM to unsubscribe from notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.2.2.4.3-1: NF service consumer unsubscribes to notifications for shared data

1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation.

2a. On success, the UDM responds with "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body.

5.2.2.5 Notification

5.2.2.5.1 General

The following procedures using the Notification service operation are supported:

– Data change notification to NF, including the updates of UE’s Subscriber Data indicated by the "subscription data Type" input and additional UE’s UDM-related parameters.

– Delivery of UE Parameters Update Data to the UE via control plane procedure as defined in 3GPP TS 23.502 [3] clause 4.20.

5.2.2.5.2 Data Change Notification To NF

Figure 5.2.2.5.2-1 shows a scenario where the UDM notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change (see also 3GPP TS 23.502 [3] clause 4.5.1 or 3GPP TS 23.502 [3] clause 4.5.2) or shared data change. The delivery of UE Parameters Update Data to the UE via control plane procedure is also conveyed using this notification, as defined in 3GPP TS 23.502 [3] clause 4.20.The notification request shall be sent to the callbackReference URI as previously received in the SdmSubscription (see clause 6.1.6.2.3).

Figure 5.2.2.5.2-1: Subscription Data Change Notification

1. The UDM sends a POST request to the callbackReference as provided by the NF service consumer during the subscription.

2a. On success, the NF service consumer responds with "204 No Content".

2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.1.5.2-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information.

NOTE 1: If the NF service consumer detects that the received Data Change Notification contains an origValue that does not match the currently stored value, it can re-sync by using the Nudm_SDM_Get service operation.

NOTE 2: When the notification is used for the delivery of UE Parameter Update Data to the UE, the trigger for UDM to start this procedure is out of the scope of this specification. This can be based, e.g., on O&M commands or provisioning orders. When a given UE parameter can be updated either in the USIM or in the ME side of the UE (e.g., Routing Indicator, see 3GPP TS 23.502 [3] clause 4.20.1) it is assumed that the trigger for the UE parameter update procedure includes an indication to the UDM of the target for the UE parameters update (i.e., USIM or ME). This indication is used by the UDM to decide which UE parameter update data set type to use and whether the UE parameter update requires secured packet protection via SP-AF.

5.2.2.6 Info

5.2.2.6.1 General

The following procedures using the Info service operation are supported:

– Providing acknowledgement from the UE to UDM about successful delivery of Steering of Roaming information via the AMF as defined in 3GPP TS 23.122 [20]

– Providing acknowledgement from the UE to UDM about successful delivery of updated Default Configured NSSAI or UICC data (Secured-Packet, containing e.g. Routing indicator) via the AMF as defined in 3GPP TS 23.502 [3].

– Providing acknowledgement from the UE to the UDM about successful delivery of the Network Slicing Subscription Change Indication.

– Providing acknowledgement from the UE to UDM about successful delivery of CAG configuration (see 3GPP TS 23.501 [2] clause 5.30.3.3).

– Providing indication from AMF to UDM about unsuccessful delivery of Steering of Roaming Information, updated Default Configured NSSAI or UICC data, Network Slicing Subscription Change Indication or Network Slicing Subscription Change Indication.

– Triggering update of Steering of Roaming information at the UE due to "initial registration" or "emergency registration" in a VPLMN.

5.2.2.6.2 Providing acknowledgement of Steering of Roaming

Figure 5.2.2.6.2-1 shows a scenario where the NF service consumer (e.g. AMF) sends the UE acknowledgement to the UDM (see also 3GPP TS 23.122 [20] Annex C). The request contains the UE’s identity (/{supi}), the type of the acknowledgement information (/am-data/sor-ack), and the SOR-MAC-Iue.

Figure 5.2.2.6.2-1: Providing acknowledgement of Steering of Roaming

1. The NF service consumer (e.g. AMF) sends a PUT request to the resource representing the UE’s Access and Mobility Subscription Data, with the AcknowledgeInfo (SOR-MAC-Iue received from the UE, or UE not reachable indication).

2. The UDM responds with "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body.

5.2.2.6.3 Providing acknowledgement of UE parameters update

Figure 5.2.2.6.3-1 shows a scenario where the NF service consumer (e.g. AMF) sends the UE acknowledgement to the UDM (see also 3GPP TS 23.502 [3]). The request contains the UE’s identity (/{supi}), the type of the acknowledgement information (/am-data/upu-ack), and the UPU-MAC-Iue.

Figure 5.2.2.6.3-1: Providing acknowledgement of UE parameters update

1. The NF service consumer (e.g. AMF) sends a PUT request to the resource representing the UE’s Access and Mobility Subscription Data, with the AcknowledgeInfo(UPU-MAC-I_UE received from the UE, or UE not reachable indication).

2. The UDM responds with "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body.

5.2.2.6.4 Providing acknowledgement of UE for Network Slicing Subscription Change

Figure 5.2.2.6.4-1 shows a scenario where the NF service consumer (e.g. AMF) sends the UE acknowledgement to the UDM (see also 3GPP TS 23.502 [3]). The request contains the UE’s identity (/{supi}) and the type of the acknowledgement information (/am-data/subscribed-snssais-ack).

Figure 5.2.2.6.4-1: Providing acknowledgement of UE for Network Slicing Subscription Change

1. The NF service consumer (e.g. AMF) sends a PUT request to the resource representing the UE’s Access and Mobility Subscription Data, with the AcknowledgeInfo.

2. The UDM responds with "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body.

5.2.2.6.5 Providing acknowledgement of UE for CAG configuration change

Figure 5.2.2.6.5-1 shows a scenario where the NF service consumer (e.g. AMF) sends the UE acknowledgement to the UDM (see also 3GPP TS 23.502 [3]). The request contains the UE’s identity (/{supi}) and the type of the acknowledgement information (/am-data/cag-ack).

Figure 5.2.2.6.5-1: Providing acknowledgement of UE for CAG configuration change

1. The NF service consumer (e.g. AMF) sends a PUT request to the resource representing the UE’s Access and Mobility Subscription Data, with the AcknowledgeInfo.

2. The UDM responds with "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body.

5.2.2.6.6 Triggering Update of Steering Of Roaming information

Figure 5.2.2.6.6-1 shows a scenario where the NF service consumer (e.g. AMF) sends the request to the UDM to trigger the update of Steering of Roaming information at the UE. The request contains the UE’s identity (/{supi}), the type of request (/am-data/update-sor) and the VPLMN ID.

Figure 5.2.2.6.6-1: Triggering update of Steering Of Roaming information

1. The NF service consumer (e.g. AMF) sends a POST request to the resource representing the UE’s Access and Mobility Subscription Data, with the request to update the Steering of Roaming information at the UE.

2. The UDM responds with "200 OK" containing the updated Sor Information.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.

5.2.2.7 ModifySubscription

5.2.2.7.1 General

The following procedures using the ModifySubscription service operation are supported:

– Modification of a Subscription to notification of data change (for UE individual data)

– Modification of a Subscription to notification of shared data change

The ModifySubscription service operation can be used for the following purpose:

– Extend the expiry time of SdmSubscription;

– Modify the resource URIs to be monitored, e.g. add/remove resource URIs to/from the monitored resource URI list.

5.2.2.7.2 Modification of a subscription to notifications of data change

Figure 5.2.2.7.2-1 shows a scenario where the NF service consumer sends a request to the UDM to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.2.2.7.2-1: NF service consumer modifies a subscription to notifications

1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation.

The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. to add/remove specific resource URIs from the monitored resource URI list.

2a. On success, the UDM responds with "200 OK".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body.

5.2.2.7.3 Modification of a subscription to notifications of shared data change

Figure 5.2.2.7.3-1 shows a scenario where the NF service consumer sends a request to the UDM to modifya subscription to notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.2.2.7.3-1: NF service consumer modifies a subscription to notifications for shared data

1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation.

The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. for the purposes to add/remove specific resource URIs from the monitored resource URI list.

2a. On success, the UDM responds with "200 OK".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body.