5.5 Nhss_gbaSubscriberDataManagement Service

29.5623GPP5G SystemHome Subscriber Server (HSS) servicesRelease 18Stage 3TS

5.5.1 Service Description

See 3GPP TS 33.220 [6], clause X.2.1.2.

5.5.2 Service Operations

5.5.2.1 Introduction

For the Nhss_gbaSubscriberDataManagement service the following service operations are defined:

– Get

– Subscribe

– Unsubscribe

– Modification of subscription

– Notification

The Nhss_gbaSubscriberDataManagement Service is used by Consumer NFs (GBA BSF) to:

– fetch the GBA subscriber data for the UE

– subscribe/unsubscribe, and to be notified, when data previously requested have changed

5.5.2.2 Get

5.5.2.2.1 General

The following procedures using the Get service operation are supported:

– Retrieval of GBA subscriber data

5.5.2.2.2 Retrieval of GBA subscriber data

Figure 5.5.2.2.2-1 shows a scenario where the GBA BSF sends a request to the HSS to retrieve the GBA subscriber data. The request contains the UE’s identity (/{ueId}) which shall be one of IMSI, MSISDN, IMPI, IMPU.

Figure 5.5.2.2.2-1: Retrieval of GBA subscriber data

1. The GBA BSF sends a GET request to the resource representing the UE’s GBA subscriber data.

2a. Upon success, the HSS responds with "200 OK" with the GBA subscriber data (containing, e.g. the GBA User Security Settings, GUSS) in the response body, and HSS supported features.

2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to fetch the requested data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.5.2.3 Subscribe

5.5.2.3.1 General

The following procedures using the Subscribe service operation are supported:

– Subscription to changes on the GBA subscriber data

5.5.2.3.2 Subscription to changes on the GBA subscriber data

Figure 5.5.2.3.2-1 shows a scenario where the GBA BSF sends a request to the HSS to subscribe to changes on a previously retrieved GBA subscriber data. The request contains the UE’s identity (/{ueId}) which shall be one of IMSI, MSISDN, IMPI, IMPU.

Figure 5.5.2.3.2-1: Subscription to changes on the GBA subscriber data

1. The GBA BSF sends a POST request to the collection resource representing the subscriptions to changes on the UE’s GBA subscriber data. The request body contains a URI where subsequent notification shall be sent by HSS.

2a. Upon success, the HSS responds with "200 OK" with the GBA SDM subscription data in the response body, and HSS supported features.

2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to subscribe to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.5.2.4 Unsubscribe

5.5.2.4.1 General

The following procedures using the Unsubscribe service operation are supported:

– Unsubscribe to changes on the GBA subscriber data

5.5.2.4.2 Unsubscribe to changes on the GBA subscriber data

Figure 5.5.2.4.2-1 shows a scenario where the GBA BSF sends a request to the HSS to unsubscribe to changes on a previously retrieved GBA subscriber data. The request contains the UE’s identity (/{ueId}) which shall be one of IMSI, MSISDN, IMPI, IMPU.

Figure 5.5.2.4.2-1: Deletion of a subscription to changes on the GBA subscriber data

1. The GBA BSF sends a DELETE request to the resource representing the individual subscription (subscriptionID) to changes on the UE’s GBA subscriber data.

2a. Upon success, the HSS responds with "204 No Content".

2b. If the operation is not authorized due to, e.g. received UE identity not being allowed for GBA services, or the requesting node not being authorized to subscribe/unsubscribe to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

2c. If the UE identity is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.5.2.5 Modification of Subscription

5.5.2.5.1 General

The following procedures using the Modification of Subscription service operation are supported:

– Modification of Subscription to changes on the GBA subscriber data

5.5.2.5.2 Modification of Subscription to changes on the GBA subscriber data

Figure 5.5.2.5.2-1 shows a scenario where the GBA BSF sends a request to the HSS to modify a subscription to changes (e.g. to extend its expiration lifetime) on a previously retrieved GBA subscriber data. The request contains the UE’s identity (/{ueId}) which shall be one of IMSI, MSISDN, IMPI, IMPU.

Figure 5.5.2.5.2-1: Modification of Subscription to changes on the GBA subscriber data

1. The GBA BSF sends a PATCH request to the resource representing the individual subscription to changes on the UE’s GBA subscriber data (identified by its subscriptionID).

2a. Upon success, if some of the changes, but not all, have been accepted, the HSS responds with "200 OK" with the new GBA SDM subscription data in the response body.

2b. Upon success, if all the changes have been accepted, the HSS responds with "204 No Content".

2c. If the operation is not authorized due to the requesting node not being authorized to modify the subscription to changes on GBA subscriber data, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

2d. If the subscriptionId is not found in HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.5.2.5 Notify

5.5.2.5.1 General

The following procedures using the Notify service operation are supported:

– Notification of changes on the GBA subscriber data

5.5.2.5.2 Notification of changes on the GBA subscriber data

Figure 5.5.2.5.2-1 shows a scenario where the HSS sends a notification to the GBA BSF to inform of changes on a previously retrieved GBA subscriber data.

Figure 5.5.2.5.2-1: Subscription to changes on of GBA User Security data

1. The GBA BSF sends a POST request to the notification URI previously provided by the GBA BSF during the subscription request (see clause 5.5.2.3.1).

2a. Upon success, the HSS responds with "204 No Content".

2b. If the UE identity contained in the NotificationData is not found in GBA BSF, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in "ProblemDetails" data structure).

In the case of redirection, the GBA BSF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another GBA BSF instance capable of handling the notification request.