n/a

generate-av

generate-av (POST)

Generate Authentication Vector

{apiRoot}/nhss-ueau/<apiVersion>/generate-av

POST

The HSS calculates a fresh Authentication Vector taking into account the received information (imsi, serving network name, authentication method)

AvGenerationRequest

M

1

Contains input parameters for Authentication Vector calculation

AvGenerationResponse

M

1

200 OK

Upon success, a response body containing the generated authentication vector shall be returned

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– AUTHENTICATION_REJECTED

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

AvGenerationRequest

6.1.6.2.2

Contains imsi, authentication method, serving network name, resynchronization info

AvGenerationResponse

6.1.6.2.3

Contains the calculated Authentication Vector

AuthType

3GPP TS 29.503 [13]

ServingNetworkName

3GPP TS 29.503 [13]

ResynchronizationInfo

3GPP TS 29.503 [13]

AvEapAkaPrime

3GPP TS 29.503 [13]

Av5GHeAka

3GPP TS 29.503 [13]

ProblemDetails

3GPP TS 29.571 [7]

Response body of error response messages.

RedirectResponse

3GPP TS 29.571 [7]

Response body of redirect response messages.

imsi

string

M

1

pattern: "[0-9]{5,15}"

authType

AuthType

M

1

Indicates the authentication method; "EAP_AKA_PRIME" or "5G_AKA"

servingNetworkName

ServingNetworkName

M

1

resynchronizationInfo

ResynchronizationInfo

O

0..1

avEapAkaPrime

AvEapAkaPrime

C

0..1

shall be present if av5GHeAka is absent, otherwise shall be absent.

av5GHeAka

Av5GHeAka

C

0..1

shall be present if avEapAkaPrime is absent, otherwise shall be absent.

AUTHENTICATION_REJECTED

403 Forbidden

The user cannot be authenticated

USER_NOT_FOUND

404 Not Found

The user does not exist in the HPLMN

UeContextInPgwData
(Document)

/{ueId}/ue-context-in-pgw-data

GET

Retrieve the UE’s Context in PGW Data

Subscriptions

(Collection)

/{ueId}/subscriptions

POST

Create a subscription

Individual Subscription

(Document)

/{ueId}/subscriptions/{subscriptionId}

DELETE

Delete the subscription identified by {subscriptionId}, i.e. unsubscribe

PATCH

Modify the subscription identified by {subscriptionId}

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

ueId

Represents the UE identifier with type IMSI.

pattern: "^(imsi-[0-9]{5,15}|.+)$"

n/a

n/a

UeContextInPgwData

M

1

200 OK

A response body containing the UeContextInPgwData shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– DATA_NOT_FOUND

NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.1.1

apiVersion

See clause 6.1.1

ueId

Represents the IMSI of the subscriber.
pattern: "^(imsi-[0-9]{5,15})$"

n/a

SubscriptionData

M

1

The subscription that is to be created.

SubscriptionData

M

1

201 Created

Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

ProblemDetails

O

0..1

501 Not Implemented

The "cause" attribute may be used to indicate one of the following application errors:

– UNSUPPORTED_RESOURCE_URI

This response shall not be cached.

NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.1.1

apiVersion

See clause 6.1.1

ueId

Represents the IMSI of the subscriber
pattern: "^(imsi-[0-9]{5,15})$"

subscriptionId

The subscriptionId identifies an individual subscription to notifications.

n/a

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– SUBSCRIPTION_NOT_FOUND (see 3GPP TS 29.500 [4] table 5.2.7.2-1)

NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

n/a

array(PatchItem)

M

1

It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [13].

n/a

204 No Content

Upon success, a response with no content is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– SUBSCRIPTION_NOT_FOUND (see 3GPP TS 29.500 [4] table 5.2.7.2-1)

ProblemDetails

O

0..1

403 Forbidden

One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:

– MODIFICATION_NOT_ALLOWED (see 3GPP TS 29.500 [4] table 5.2.7.2-1)

NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

n/a

ModificationNotification

M

1

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– CONTEXT_NOT_FOUND

See table 6.2.7.3-1 for the description of this error.

NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Location

string

M

1

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

UeContextInPgwData

6.2.6.2.2

SubscriptionData

6.2.6.2.3

Subscription Data

SubscriptionDataSets

6.2.6.2.4

UE Subscription Data Sets

PgwInfo

3GPP TS 29.503 [13]

ModificationNotification

3GPP TS 29.503 [13]

NfInstanceId

3GPP TS 29.571 [7]

Network Function Instance Identifier

Uri

3GPP TS 29.571 [7]

Uniform Resource Identifier

DateTime

3GPP TS 29.571 [7]

ProblemDetails

3GPP TS 29.571 [7]

Response body of error response messages.

RedirectResponse

3GPP TS 29.571 [7]

Response body of redirect response messages.

Fqdn

3GPP TS 29.571 [7]

Fully Qualified Domain Name

pgwInfo

array(PgwInfo)

O

1..N

Information about the APNs and PGW-C+SMF FQDNs used in interworking with UDM

emergencyFqdn

Fqdn

O

0..1

PGW-C+SMF FQDN for emergency session

emergencyPlmnId

PlmnId

O

0..1

PLMN where the PGW-C+SMF for emergency session is located

emergencyIpAddr

IpAddress

O

0..1

IP address of the PGW-C+SMF for emergency session

emergencyRegistrationTime

DateTime

O

0..1

Time of PGW-C+SMF for emergency session Registration.

nfInstanceId

NfInstanceId

M

1

Identity of the NF Instance creating the subscription.

callbackReference

Uri

M

1

URI provided by the NF service consumer to receive notifications

monitoredResourceUris

array(Uri)

M

1..N

A set of URIs that identify the resources for which a change triggers a notification.

The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].

See NOTE 1.

expires

DateTime

O

0..1

If present in a POST request, it indicates the point in time at which the subscription expires.

Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned.

immediateReport

boolean

O

0..1

This IE indicates whether immediate report is needed or not.

When present, this IE shall be set as following:

– true: immediate report is required

– false (default) immediate report is not required

report

SubscriptionDataSets

C

0..1

This IE shall be present in Subscribe response, if the immediateReport attribute is set to "true" in Subscribe request.

When present, this IE shall contain the representation of subscription data sets that to be monitored, i.e. listed in monitoredResourceUris attribute.

NOTE 1: The HSS should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies (caused by e.g. an SCP) in the base URI part.

ueContextInPgwData

UeContextInPgwData

O

0..1

UE Context in PGW Data

USER_NOT_FOUND

404 Not Found

The user does not exist.

DATA_NOT_FOUND

404 Not Found

The requested data is not found/does not exist.

CONTEXT_NOT_FOUND

404 Not Found

It is used during the modification of an existing subscription when no corresponding context exists.

n/a

deregister-sn

deregister-sn (POST)

Requesting MME/SGSN deregistration

n/a

imei-update

imei-update

(POST)

Requests the update of the IMEI of the UE stored in HSS

n/a

roaming-status-update

roaming-status-update

(POST)

Requests the update of the roaming status of the UE stored in HSS

{apiRoot}/nhss-uecm/<apiVersion>/deregister-sn

POST

Requesting MME/SGSN deregistration.

DeregistrationRequest

M

1

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

ImeiUpdateInfo

M

1

ImeiUpdateResponse

M

1

200 OK

Upon success, a response body containing the IMEI(SV) stored previously in HSS shall be returned.

n/a

204 No Content

Upon success, if the HSS does not have any IMEI(SV) values stored for the UE, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– CONTEXT_NOT_FOUND

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

RoamingStatusUpdateInfo

M

1

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– CONTEXT_NOT_FOUND

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

DeregistrationRequest

6.3.6.2.2

Contains IMSI, deregistration reason

ImeiUpdateInfo

6.3.6.2.3

Contains IMSI, new IMEI(SV)

ImeiUpdateResponse

6.3.6.2.4

Contains the previous IMEI(SV) stored in HSS

RoamingStatusUpdateInfo

6.3.6.2.5

Contains PLMN-ID where the UE is located

Guami

3GPP TS 29.571 [7]

ProblemDetails

3GPP TS 29.571 [7]

Response body of error response messages.

RedirectResponse

3GPP TS 29.571 [7]

Response body of redirect response messages.

PlmnId

3GPP TS 29.571 [7]

imsi

string

M

1

pattern: "^[0-9]{5,15}$"

deregReason

DeregistrationReason

M

1

String, see clause 6.3.6.3.3

guami

Guami

O

0..1

The GUAMI identifying the AMF where the UE is registered. May be used by the HSS based on operator policy to decide whether a registered VLR shall be cancelled.

imsi

string

M

1

IMSI of the subscriber.

pattern: "^[0-9]{5,15}$"

imei

string

C

0..1

IMEI of the UE as described in 3GPP TS 23.003 [15], clause 6.2.1; it shall not include the Check Digit.

pattern: "^[0-9]{14}$"

imeisv

string

C

0..1

IMEISV of the UE as described in 3GPP TS 23.003 [15], clause 6.2.2.

pattern: "^[0-9]{16}$"

NOTE: Exactly one of attributes "imei" or "imeisv" shall be present.

previousImei

string

C

0..1

Previous IMEI of the UE as described in 3GPP TS 23.003 [15], clause 6.2.1; it shall not include the Check Digit.

It shall be included if the HSS has an IMEI value stored for the UE.

pattern: "^[0-9]{14}$"

previousImeisv

string

C

0..1

IMEISV of the UE as described in 3GPP TS 23.003 [15], clause 6.2.2.

It shall be included if the HSS has an IMEISV value stored for the UE.

pattern: "^[0-9]{16}$"

NOTE: At least one of attributes "previousImei" or "previousImeisv" shall be present.

imsi

string

M

1

IMSI of the subscriber.

pattern: "^[0-9]{5,15}$"

plmnId

PlmnId

M

1

PLMN-ID where the UE is located.

"UE_INITIAL_AND_SINGLE_REGISTRATION"

This value is used when the UDM needs to indicate to HSS that the MME/SGSN, if any, shall be cancelled due to an initial registration for single registration.

"UE_INITIAL_AND_DUAL_REGISTRATION"

This value is used when the UDM needs to indicate to HSS that an SGSN shall be cancelled (due to initial registration), but the MME shall not be cancelled (due to dual registration).

"EPS_TO_5GS_MOBILITY"

This value is used when the UDM needs to indicate to HSS that the MME/SGSN, if any, shall be cancelled due to a mobility event (i.e. for single registration which is not an initial registration).

USER_NOT_FOUND

404 Not Found

The user does not exist.

CONTEXT_NOT_FOUND

404 Not Found

It is used when no corresponding UE context exists.

EeSubscriptions
(Collection)

/{ueId}/ee-subscriptions

POST

Create a subscription

Individual subscription
(Document)

/{ueId}/ee-subscriptions/{subscriptionId}

PATCH

Update the subscription identified by {subscriptionId}

DELETE

Delete the subscription identified by {subscriptionId}, i.e. unsubscribe

apiRoot

See clause 6.4.1

ueId

Represents the identity of the UE in the HSS (IMSI) or the identity of a group of UEs.

– If representing a single UE, this parameter shall contain the IMSI of the UE.

pattern: See type Imsi in clause 6.4.6.3.2 of this document.

– If representing a group of UEs, this parameter shall contain the External Group Id.

pattern: "^extgroupid-[^@]+@[^@]+$"

(NOTE)

NOTE: If the HSS supports GBEE feature, the ueId can contain the External Group Id, or ueId can only contain IMSI of the UE.

n/a

EeSubscription

M

1

The subscription that is to be created

CreatedEeSubscription

M

1

201 Created

Upon success, a response body containing a representation of the created Individual subscription resource shall be returned, along with event reports that might be immediately available at the HSS.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– MONITORING_NOT_ALLOWED

– MAXIMUM_RESOURCES_EXCEEDED

– MTC_PROVIDER_NOT_ALLOWED

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

ProblemDetails

O

0..1

501 Not Implemented

The "cause" attribute may be used to indicate one of the following application errors:

– UNSUPPORTED_MONITORING_EVENT_TYPE

– UNSUPPORTED_MONITORING_REPORT_OPTIONS

This response shall not be cached.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.4.1

ueId

Represents the identity of the UE in the HSS (IMSI)

pattern: See type Imsi in clause 6.4.6.3.2 of this document.

subscriptionId

The subscriptionId identifies an individual subscription to notifications

The type is string.

n/a

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

array(PatchItem)

M

1..N

Items describe the modifications to the Event Subscription

n/a

204 No Content

Upon success, an empty response body shall be returned.

PatchResult

M

1

200 OK

Upon success, the execution report is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

ProblemDetails

O

0..1

403 Forbidden

One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:

– MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

n/a

array(MonitoringReport)

M

1..N

A list of MonitoringReports each of which contains information regarding the occurred event

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– CONTEXT_NOT_FOUND

NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Location

string

M

1

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

EeSubscription

6.4.6.2.2

A subscription to Notifications

CreatedEeSubscription

6.4.6.2.3

MonitoringConfiguration

6.4.6.2.4

Monitoring Configuration

MonitoringReport

6.4.6.2.5

Monitoring Report

Report

6.4.6.2.6

ReportingOptions

6.4.6.2.7

LocationReportingConfiguration

6.4.6.2.8

ReachabilityForSmsReport

6.4.6.2.9

LossConnectivityConfiguration

6.4.6.2.10

ReachabilityForDataConfiguration

6.4.6.2.11

PduSessionStatusCfg

6.4.6.2.12

Reporting configuration for events related to PDN connectivity Status

ReachabilityForDataReport

6.4.6.2.13

Report of "UE_REACHABILITY_FOR_DATA" event

FailedMonitoringConfiguration

6.4.6.2.14

Failed Monitoring Configuration in the EE subscription

EventType

6.4.6.3.3

LocationAccuracy

6.4.6.3.4

FailedCause

6.4.6.3.5

Failed cause of the failed Monitoring Configuration in the EE subscription

Uri

3GPP TS 29.571 [7]

Uniform Resource Identifier

SupportedFeatures

3GPP TS 29.571 [7]

See 3GPP TS 29.500 [4] clause 6.6

DateTime

3GPP TS 29.571 [7]

PatchResult

3GPP TS 29.571 [7]

DurationSec

3GPP TS 29.571 [7]

DiameterIdentity

3GPP TS 29.571 [7]

Dnn

3GPP TS 29.571 [7]

Data Network Name with Network Identifier only.

ProblemDetails

3GPP TS 29.571 [7]

Response body of error response messages.

RedirectResponse

3GPP TS 29.571 [7]

Response body of redirect response messages.

MtcProviderInformation

3GPP TS 29.571 [7]

MTC Provider Information

DiameterIdentity

3GPP TS 29.571 [7]

Diameter Identify (FQDN)

LossConnectivityReport

3GPP TS 29.503 [13]

Report of "LOSS_OF_CONNECTIVITY" event

LocationReport

3GPP TS 29.503 [13]

Report of "LOCATION_REPORTING" event

PdnConnectivityStatReport

3GPP TS 29.503 [13]

Report of "PDN_CONNECTIVITY_STATUS" event

callbackReference

Uri

M

1

URI provided by the NF service consumer to receive notifications

monitoringConfigurations

map(MonitoringConfiguration)

O

1..N

A map (list of key-value pairs where referenceId converted from integer to string serves as key) of MonitoringConfigurations

scefId

DiameterIdentity

O

0..1

Diameter Identify (FQDN) of the SCEF

scefDiamRealm

DiameterIdentity

O

0..1

When present, It contains the Diameter realm of the SCEF to which the monitered reports may be sent in EPC.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.4.8

reportingOptions

ReportingOptions

O

0..1

This IE may be included if the NF service consumer wants to describe how the reports of the event are to be generated.

If this attribute is not present in the request, it means that the NF service consumer does not specify any maximum number of reports or any expiry time for the subscription; still, the NF service producer (HSS) may set an expiry time in the response to the subscription creation (see clause 6.4.6.2.7).

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for Monitoring Configuration authorization.

externalIdentifier

string

O

0..1

Represents a single external Identifier or a group of external Identifiers:

– If representing a single external identifier:
pattern: "^extid-[^@]+@[^@]+$"

– If representing a group of external identifiers:
pattern: "^extgroupid-[^@]+@[^@]+$"

eeSubscription

EeSubscription

M

1

This IE shall contain the representation of the created event subscription.

eventReports

array(MonitoringReport)

O

1..N

This IE may be included when the NF consumer has indicated supporting of ERIR feature in the subscription creation request (see clause 6.4.8).

This IE when present, shall contain the status of events that are requested for immediate reporting as well, if those events are available at the time of subscription.

ERIR

failedMonitoringConfigs

map(FailedMonitoringConfiguration)

O

1..N

A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration;

see clause 6.4.6.2.14.

This IE is used to indicate the failed subscriptions of event monitoring configuration and the failed cause for them.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.4.8

eventType

EventType

M

1

Event type

immediateFlag

boolean

O

0..1

Indicates if an immediate event report in the subscription response indicating current value / status of the event is required, if available. If the flag is not present, then immediate reporting may be skipped.

locationReportingConfiguration

LocationReportingConfiguration

C

0..1

Shall be present if eventType is "LOCATION_REPORTING"

lossConnectivityConfiguration

LossConnectivityConfiguration

O

0..1

May be present if eventType is "LOSS_OF_CONNECTIVITY".

reachabilityForDataConfiguration

ReachabilityForDataConfiguration

O

0..1

May be present if eventType is "UE_REACHABILITY_FOR_DATA"

pduSessionStatusCfg

PduSessionStatusCfg

O

0..1

may be present if eventType is "PDN_CONNECTIVITY_STATUS"

idleStatusInd

boolean

O

0..1

Idle Status Indication request.

May be present if eventType is "UE_REACHABILITY_FOR_DATA" or "AVAILABILITY_AFTER_DDN_FAILURE"

When present, this IE shall be set as following:

– true: Idle status indication is requested

– false (default): Idle status indication is not requested

referenceId

ReferenceId

M

1

Shall contain the Reference ID which was provided as the key of the associated monitoring configuration in subscription request. The consumer can use this IE to uniquely associate the report with the corresponding event that was requested to be monitored.

eventType

EventType

M

1

String; see clause 6.4.6.3.3

only the following values are allowed:

"UE_REACHABILITY_FOR_SMS"

"UE_REACHABILITY_FOR_DATA"

"LOSS_OF_CONNECTIVITY"

"LOCATION_REPORTING"

"PDN_CONNECTIVITY_STATUS"

timeStamp

DateTime

M

1

Point in time at which the event occured

report

Report

O

0..1

Shall be present if eventType is "UE_REACHABILITY_FOR_SMS"

"UE_REACHABILITY_FOR_DATA"

"LOSS_OF_CONNECTIVITY"

"LOCATION_REPORTING"

"PDN_CONNECTIVITY_STATUS"

reachabilityForSmsReport

ReachabilityForSmsReport

O

0..1

Reports the UE reachacbility for SMS

reachabilityForDataReport

ReachabilityForDataReport

O

0..1

Reports the UE reachacbility for Data

lossConnectivityReport

LossConnectivityReport

O

0..1

Reports the Loss of Connectivity

locationReport

LocationReport

O

0..1

Reports the UE Location

pdnConnectivityStatReport

PdnConnectivityStatReport

O

0..1

Reports the PDN Connectivity Status

maxNumOfReports

MaxNumOfReports

O

0..1

Maximum number of reports. If not present, the NF service consumer does not specify any maximum number of reports to be received.

(NOTE)

expiry

DateTime

C

0..1

This IE shall be included in an event subscription response, if, based on operator policy, the HSS needs to include an expiry time, and may be included in an event subscription request. When present, this IE shall represent the time at which monitoring shall cease and the subscription becomes invalid. If the maxNumOfReports included in an event subscription response is 1 and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp.

(NOTE)

reportPeriod

DurationSec

C

0..1

Indicates the interval time between which the event notification is reported, may be present if event type is "LOCATION_REPORTING"

NOTE: If parameter "maxNumOfReports" and "expiry" are included at the same time, the subscription will expire as soon as one of the conditions is met.

currentLocation

boolean

M

1

true: Indicates that current location is requested.

false: Indicates that last known location is requested.

accuracy

LocationAccuracy

C

0..1

Indicates whether Cell-level or TA-level accuracy is requested. Shall be present when current location is requested.

reachabilitySmsStatus

boolean

M

1

true: UE is reachable for SMS

false: UE is not reachable for SMS

maxAvailabilityTime

DateTime

O

0..1

Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.).

maxDetectionTime

DurationSec

O

0..1

When present, it indicates the configured Maximum Detection Time

maximumLatency

DurationSec

O

0..1

When present, it indicates the configured Maximum Latency. (NOTE)

maximumResponseTime

DurationSec

O

0..1

When present, it indicates the configured Maximum Response Time. (NOTE)

suggestedPacketNumDl

integer

O

0..1

When present, it indicates the configured Suggested number of downlink packets. (NOTE)

NOTE: At least one of maximumLatency, maximumResponseTime or suggestedPacketNumDl shall be present

apn

Dnn

O

0..1

When present, it indicates the APN for which the event is monitored.

reachabilityDataStatus

boolean

M

1

true: UE is reachable for Data

false: UE is not reachable for Data

maxAvailabilityTime

DateTime

O

0..1

Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.).

eventType

EventType

M

1

Contains the Event type, see clause 6.4.6.3.3

failedCause

FailedCause

M

1

Contains the failed cause of the subscription of the event monitoring.

ReferenceId

integer

ReferenceId is used as key in a map of MonitoringConfigurations; see clause 6.4.6.2.4.

ReferenceId is used as key in a map of FailedMonitoringConfiguration; see clause 6.4.6.2.3.

The numeric value should not be higher than 2^64-1 (i.e. it should be possible to convey it in an unsigned 64 integer Information Element, used in other protocols), if interworking with the Event Exposure framework in EPC is required.

Imsi

string

IMSI

pattern: ‘^(imsi-[0-9]{5,15})$’

UeIdOrGroupId

string

Contains the UE identifier or the Group Identifier of the UE.

pattern: ‘^(imsi-[0-9]{5,15}|extgroupid-[^@]+@[^@]+|.+$)’

MaxNumOfReports

integer

Maximum number of reports.

Minimum: 1

"LOSS_OF_CONNECTIVITY"

Loss of connectivity event

"UE_REACHABILITY_FOR_DATA"

UE reachability for Data, implements the "UE Reachability for Data" event as specified in 3GPP TS 23.682 [18].

When this event is subscribed by an NF service consumer, the HSS shall send an Insert Subscriber Data Request message to the MME/SGSN for the UE with the Monitoring-Type AVP set to the value UE_REACHABILITY and the Reachability-Information AVP set to the value REACHABLE_FOR_DATA, see clause 5.2.2.1.3 of 3GPP TS 29.272 [17].

"UE_REACHABILITY_FOR_SMS"

UE reachability for SMS, implements the "UE Reachability for SMS Delivery" event as specified in 3GPP TS 23.682 [18].

This event only supports One-Time reporting.

"LOCATION_REPORTING"

Location Reporting event

"COMMUNICATION_FAILURE"

Communication Failure event

"AVAILABILITY_AFTER_DDN_FAILURE"

Availability after DDN failure event

"PDN_CONNECTIVITY_STATUS"

PDN Connectivity Status event

"CELL_LEVEL"

Change of cell shall be reported, equivalent to the value "CGI-ECGI (0)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21].

"RAN_NODE_LEVEL"

change of serving RAN node shall be reported, equivalent to the value "eNB (1)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21].

"TA_LEVEL"

Change of TA shall be reported, equivalent to the value " LA-TA-RA (2)" of Accuracy IE of HSS Diameter interface as specified in clause 8.4.17 of 3GPP TS 29.336 [21].

"MTC_PROVIDER_NOT_ALLOWED"

MTC Provider is now allowed to perform monitoring for the requested event type.

"MONITORING_NOT_ALLOWED"

The subscriber does not have the necessary subscription for monitoring with the requested Event Type.

"UNSUPPORTED_MONITORING_EVENT_TYPE"

The required event type is unsupported.

"UNSUPPORTED_MONITORING_REPORT_OPTIONS"

The monitoring configuration for the required event type contains unsupported report options.

"UNSPECIFIED"

The failed cause is unspecified.

MONITORING_NOT_ALLOWED

403 Forbidden

The subscriber does not have the necessary subscription for monitoring with the requested Event Type.

MTC_PROVIDER_NOT_ALLOWED

403 Forbidden

MTC Provider not authorized to perform monitoring configuration.

USER_NOT_FOUND

404 Not Found

The user does not exist

CONTEXT_NOT_FOUND

404 Not Found

It is used when no corresponding context exists.

UNSUPPORTED_MONITORING_EVENT_TYPE

501 Not Implemented

The monitoring configuration contains unsupported event type.

UNSUPPORTED_MONITORING_REPORT_OPTIONS

501 Not Implemented

The monitoring configuration contains unsupported report options.

1

ERIR

Event Reports in Response

An NF consumer supporting this feature shall be able to handle the event reports within the Event Subscription Create Response, as specified in clause 5.5.2.2.2.

2

GBEE

Support of Group-based Event Exposure.

This feature bit indicates whether the Nhss_EventExposure Service support Group-based Event Exposure or not.