Registrations

(Document)

/{ueId}/registrations

GET

Retrieve UE’s registration data sets

/{ueId}/registrations/send-routing-info-sm

send-routing-info-sm

(POST)

Retrieve addressing information for SMS delivery

Amf3GppAccessRegistration
(Document)

/{ueId}/registrations/amf-3gpp-access

PUT

Update the AMF registration for 3GPP access

PATCH

Modify the AMF registration for 3GPP access

GET

Retrieve the AMF registration information for 3GPP access

/{ueId}/registrations/amf-3gpp-access/dereg-amf

dereg-amf (POST)

Trigger AMF deregistration due to mobility from 5GC to EPC

/{ueId}/registrations/amf-3gpp-access/pei-update

pei-update

(POST)

Updates the PEI in the 3GPP Access Registration context

/{ueId}/registrations/amf-3gpp-access/roaming-info-update

roaming-info-update

(POST)

Updates the Roaming Information in the AMF 3GPP Registration context

AmfNon3GppAccessRegistration
(Document)

/{ueId}/registrations/amf-non-3gpp-access

PUT

Update the AMF registration for non 3GPP access

PATCH

Modify the AMF registration for non 3GPP access

GET

Retrieve the AMF registration information for non 3GPP access

SmfRegistrations
(Store)

/{ueId}/registrations/smf-registrations

GET

Retrieve the SMF registration information

IndividualSmfRegistration
(Document)

/{ueId}/registrations/smf-registrations/{pduSessionId}

PUT

Create an SMF registration identified by PDU Session Id

DELETE

Delete an individual SMF registration

GET

Retrieve the SMF registration information identified by PDU Session Id.

PATCH

Modify the SMF registration

Smsf3GppAccessRegistration
(Document)

/{ueId}/registrations/smsf-3gpp-access

PUT

Create or Update the SMSF registration

DELETE

Delete the SMSF registration for 3GPP access

GET

Retrieve the SMSF registration information

SmsfNon3GppAccessRegistration
(Document)

/{ueId}/registrations/smsf-non-3gpp-access

PUT

Create or Update the SMSF registration for non 3GPP access

DELETE

Delete the SMSF registration for non 3GPP access

GET

Retrieve the SMSF registration information for non 3GPP access

Location(Document)

/{ueId}/registrations/location

GET

Retrieve the UE’s location information by GMLC or NEF

IpSmGwRegistration
(Document)

/{ueId}/registrations/ip-sm-gw

PUT

Create or Update the IP-SM-GW registration

DELETE

Delete the IP-SM-GW registration

GET

Retrieve the IP-SM-GW registration information

NwdafRegistration
(Document)

/{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId}

PUT

Create an NWDAF registration

DELETE

Delete an individual NWDAF registration

PATCH

Modify the NWDAF registration

NwdafRegistrations
(Store)

/{ueId}/registrations/nwdaf-registrations

GET

Retrieve the NWDAF registration(s) information

apiRoot

string

See clause 6.2.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the PUT and PATCH methods; SUPI (i.e. imsi or nai) or GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

n/a

Amf3GppAccessRegistration

M

1

The AMF registration for 3GPP access is replaced with the received information.

Amf3GppAccessRegistration

M

1

201 Created

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

Amf3GppAccessRegistration

M

1

200 OK

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

n/a

204 No Content

Upon success, an empty response body shall be returned

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

403 Forbidden

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

– UNKNOWN_5GS_SUBSCRIPTION

– NO_PS_SUBSCRIPTION

– ROAMING_NOT_ALLOWED

– ACCESS_NOT_ALLOWED

– RAT_NOT_ALLOWED

– REAUTHENTICATION_REQUIRED

– SNPN_NOT_ALLOWED

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

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-3gpp-access

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

Amf3GppAccessRegistrationModification

M

1

The AMF registration for 3GPP access is modified with the received information.

n/a

204 No Content

Upon success, an empty response body is returned. (NOTE 2)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

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

– INVALID_GUAMI

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_NOT_FOUND

ProblemDetails

O

0..1

422 Unprocessable Entity

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

– UNPROCESSABLE_REQUEST

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

NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

Amf3GppAccessRegistration

M

1

200 OK

Upon success, a response body containing the Amf3GppAccessRegistration shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_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.

dereg-amf

/{ueId}/registrations/amf-3gpp-access/dereg-amf

POST

Trigger AMF deregistration due to mobility from 5GC to EPC

pei-update

/{ueId}/registrations/amf-3gpp-access/pei-update

POST

Updates the stored PEI

roaming-info-update

/{ueId}/registrations/amf-3gpp-access/roaming-info-update

POST

Updates the Roaming information in the AMF 3GPP Registration context

AmfDeregInfo

M

1

Contains the deregistration reason

n/a

204 No Content

Upon success, an empty response body shall be returned

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

PeiUpdateInfo

M

1

Contains the PEI provided by the NF service consumer

n/a

204 No Content

Upon success, an empty response body shall be returned

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

RoamingInfoUpdate

M

1

Contains the roaming information provided by the NF service consumer.

RoamingInfoUpdate

M

1

201 Created

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

n/a

204 No Content

Upon success, an empty response body shall be returned

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See clause 6.2.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the PUT and PATCH methods; SUPI (i.e. imsi or nai) or GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

n/a

AmfNon3GppAccessRegistration

M

1

The AMF registration for non 3GPP access is replaced with the received information.

AmfNon3GppAccessRegistration

M

1

201 Created

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

AmfNon3GppAccessRegistration

M

1

200 OK

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

n/a

204 No Content

Upon success, an empty response body shall be returned

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

403 Forbidden

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

– UNKNOWN_5GS_SUBSCRIPTION

– NO_PS_SUBSCRIPTION

– ROAMING_NOT_ALLOWED

– ACCESS_NOT_ALLOWED

– RAT_NOT_ALLOWED

– REAUTHENTICATION_REQUIRED

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

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-non-3gpp-access

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

AmfNon3GppAccessRegistrationModification

M

1

The AMF registration for non 3GPP access is modified with the received information.

n/a

204 No Content

Upon success, an empty response body shall be returned. (NOTE 2)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 2)

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_NOT_FOUND

ProblemDetails

O

0..1

422 Unprocessable Entity

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

– UNPROCESSABLE_REQUEST

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

NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult.

n/a

n/a

AmfNon3GppAccessRegistration

M

1

200 OK

Upon success, a response body containing the AmfNon3GppAccessRegistration shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_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.

apiRoot

string

See clause 6.4.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

single-nssai

Snssai

O

0..1

When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter.

dnn

Dnn

O

0..1

The DNN shall be the DNN Network Identifier only.

n/a

SmfRegistrationInfo

M

1

200 OK

Upon success, a response body containing the SmfRegistrationInfo shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_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.

apiRoot

string

See clause 6.1.1

ueId

VarUeId

Represents the Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the PUT, DELETE and PATCH methods;
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

pduSessionId

PduSessionId

The pduSessionId identifies an individual SMF registration.

n/a

SmfRegistration

M

1

The registration that is to be created

SmfRegistration

M

1

201 Created

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

SmfRegistration

M

1

200 OK

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

n/a

204 No Content

Upon success, an empty response body shall be returned

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

403 Forbidden

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

– ROAMING_NOT_ALLOWED

– DNN_NOT_ALLOWED

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

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smf-registrations/{pduSessionId}

smf-set-id

NfSetId

O

0..1

The smf-set-id may be used by the UDM to guard against deletion of registrations by NFs that do not belong to the same NF set as the registered SMF.

smf-instance-id

NfInstanceId

O

0..1

If smf-set-id is not present, the smf-instance-id may be used by the UDM to guard against deletion of registrations by NF that is not the registered SMF.

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

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

n/a

n/a

The request body shall be empty.

SmfRegistration

M

1

200 OK

Upon success, a response body containing the SmfRegistration shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_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.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

SmfRegistrationModification

M

1

The SMF registration is modified with the received information.

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 2)

n/a

204 No Content

Upon success, an empty response body is returned. (NOTE 2)

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_NOT_FOUND

ProblemDetails

O

0..1

422 Unprocessable Entity

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

– UNPROCESSABLE_REQUEST

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

NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult.

apiRoot

string

See clause 6.2.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the PUT and DELETE methods; GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

n/a

SmsfRegistration

M

1

The SMSF registration for 3GPP access is created or updated with the received information.

SmsfRegistration

M

1

201 Created

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

SmsfRegistration

M

1

200 OK

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

n/a

204 No Content

Upon success, an empty response body shall be returned

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

403 Forbidden

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

– UNKNOWN_5GS_SUBSCRIPTION

– ACCESS_NOT_ALLOWED

– ROAMING_NOT_ALLOWED

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

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-3gpp-access

ETag

string

O

0..1

Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3.

ETag

string

O

0..1

Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3.

ETag

string

O

0..1

Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3.

smsf-set-id

NfSetId

O

0..1

The smsf-set-id may be used by the UDM to guard against deletion of registrations by NFs that do not belong to the same NF set as the registered SMSF.

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

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

If-Match

string

O

0..1

Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.1

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

SmsfRegistration

M

1

200 OK

Upon success, a response body containing the SmsfRegistration shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_NOT_FOUND

– ABSENT_SUBSCRIBER_SM

ProblemDetails

O

0..1

403 Forbidden

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

– SERVICE_NOT_ALLOWED

– SERVICE_NOT_PROVISIONED

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

apiRoot

string

See clause 6.2.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the PUT and DELETE methods; GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

n/a

SmsfRegistration

M

1

The SMSF registration for non 3GPP access is created or updated with the received information.

SmsfRegistration

M

1

201 Created

Upon success, a response body containing a representation of the created Individual SmsfRegistration for non 3GPP access resource shall be returned.

SmsfRegistration

M

1

200 OK

Upon success, a response body containing a representation of the updated Individual SmsfRegistration for non 3GPP access resource shall be returned.

n/a

204 No Content

Upon success, an empty response body shall be returned

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– UNKNOWN_5GS_SUBSCRIPTION

– ACCESS_NOT_ALLOWED

– ROAMING_NOT_ALLOWED

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

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-non-3gpp-access

ETag

string

O

0..1

Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3.

ETag

string

O

0..1

Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3.

ETag

string

O

0..1

Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3.

smsf-set-id

NfSetId

O

0..1

The smsf-set-id may be used by the UDM to guard against deletion of registrations by NFs that do not belong to the same NF set as than the registered SMSF.

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

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

If-Match

string

O

0..1

Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.1

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

SmsfRegistration

M

1

200 OK

Upon success, a response body containing the SmsfRegistration shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_NOT_FOUND

– ABSENT_SUBSCRIBER_SM

ProblemDetails

O

0..1

403 Forbidden

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

– SERVICE_NOT_ALLOWED

– SERVICE_NOT_PROVISIONED

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

apiRoot

string

See clause 6.4.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

LocationInfo

M

1

200 OK

Upon success, a response body containing the locationInfo shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_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.

apiRoot

See clause 6.2.1

ueId

Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai) or GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: "(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)"

registration-dataset-names

array(RegistrationDataSetName)

O

2..N

If included, this IE shall contain the names of registration data sets to be retrieved.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

single-nssai

Snssai

O

0..1

Only applicable if registration-dataset-names contains SMF_PDU_SESSIONS

When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter.

dnn

Dnn

O

0..1

The DNN shall be the DNN Network Identifier only.

Only applicable if registration-dataset-names contains SMF_PDU_SESSIONS

n/a

RegistrationDataSets

M

1

200 OK

Upon success, a response body containing all the requested UE registration data sets shall be returned.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute shall be set to one of the following application errors:

– CONTEXT_NOT_FOUND

– USER_NOT_FOUND

– ABSENT_SUBSCRIBER_SM (applicable to SMSF registration data sets retrieval)

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors for SMSF data sets retrieval:

– SERVICE_NOT_ALLOWED

– SERVICE_NOT_PROVISIONED

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

send-routing-info-sm

/{ueId}/registrations/send-routing-info-sm

POST

Retrieve addressing information for SMS delivery

RoutingInfoSmRequest

M

1

It may contain supported features, if any, of the NF Service Consumer.

RoutingInfoSmResponse

M

1

200 OK

Upon success, a response body containing the Routing Information for SM shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– ABSENT_SUBSCRIBER_SM

ProblemDetails

O

0..1

403 Forbidden

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

– SERVICE_NOT_ALLOWED

– SERVICE_NOT_PROVISIONED

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

See clause 6.2.1

ueId

Represents the Subscription Identifier (SUPI).
pattern: "(imsi-[0-9]{5,15}|nai-.+|.+)"

n/a

IpSmGwRegistration

M

1

The IP-SM-GW registration is created or updated with the received information.

IpSmGwRegistration

M

1

201 Created

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

IpSmGwRegistration

M

1

200 OK

Upon success, a response body containing a representation of the updated IpSmGwRegistration resource shall be returned.

n/a

204 No Content

Upon success, an empty response body shall be returned

ProblemDetails

O

0..1

403 Forbidden

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

– UNKNOWN_5GS_SUBSCRIPTION

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

n/a

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

n/a

n/a

IpSmGwRegistration

M

1

200 OK

Upon success, a response body containing the IpSmGwRegistration shall be returned.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be set to indicate any of the following application errors:

– USER_NOT_FOUND

– CONTEXT_NOT_FOUND

apiRoot

string

See clause 6.1.1

ueId

VarUeId

Represents the Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the PUT, DELETE and PATCH methods;
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

nwdafRegistrationId

string

nwdafRegistrationId could be the NfInstanceId, the combination of NfSetId and NfInstance ID or other identifier forms of the NWDAF. NWDAF implementation shall secure the global uniqueness of this resource ID.

n/a

NwdafRegistration

M

1

The registration that is to be created

NwdafRegistration

M

1

201 Created

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

NwdafRegistration

M

1

200 OK

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

ProblemDetails

O

0..1

403 Forbidden

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

– UNKNOWN_5GS_SUBSCRIPTION

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

n/a

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

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

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [8] clause 6.6

NwdafRegistrationModification

M

1

The NWDAF registration is modified with the received information.

NwdafRegistration

C

0..1

200 OK

Upon partial success, if the NF service consumer does not support the "PatchReport" feature, the UDM shall return an NwdafRegistration object in the response.

(NOTE 2)

PatchResult

C

0..1

200 OK

Upon success, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature, and in case some of the requested modifications are discarded while the rest of the modification instructions are fully accepted, UDM may return the execution report instead of the whole NwdafRegistration.

(NOTE 2)

n/a

204 No Content

Upon success, an empty response body is returned indicating that all the modification instructions in the PATCH request have been implemented.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_NOT_FOUND

ProblemDetails

O

0..1

422 Unprocessable Entity

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

– UNPROCESSABLE_REQUEST

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

NOTE 2: One of NwdafRegistration or PatchResult shall be returned.

apiRoot

string

See clause 6.1.1

ueId

VarUeId

Represents the Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the GET method;
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

analytics-ids

array(EventId)

O

0..N

Represents the List of analytics Id(s) supplied by NWDAF, see EventId data type defined in 3GPP TS 29.520 [58]

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

The request body shall be empty.

array(NwdafRegistration)

M

1..N

200 OK

Upon success, a response body containing the NwdafRegistration(s) shall be returned. (NOTE 2)

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

– USER_NOT_FOUND

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

NOTE 2: If there are multiple NwdafRegsitration for the same UE, all matched NwdafRegistration(s) will be returned.

Trigger P-CSCF Restoration

/restore-pcscf

POST

The HSS triggers the UDM to notify the registered AMFs or SMFs that have subscribed (implicitly by providing a callback URI during registration) to receive notifications about P-CSCF Restoration.

TriggerRequest

M

1

Identifies the subscriber for whom P-CSCF Restoration is requested

n/a

204 No Content

Upon success, an empty response body shall be returned.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

Deregistration Notification

{deregCallbackUri}

POST

P-CSCF Restoration Notification

{pcscfRestorationCallbackUri}

POST

Data Restoration Notification

{dataRestorationCallbackUri}

POST

n/a

DeregistrationData

M

1

Includes Deregistration Reason

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 resource located on an alternative service instance within the same NF or NF (service) set.

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 resource located on an alternative service instance within the same NF or NF (service) set.

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

Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected

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

Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected

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

PcscfRestorationNotification

M

1

Contains the SUPI and optionally the address of the failed P-CSCF.

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 resource located on an alternative service instance within the same NF or NF (service) set.

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 resource located on an alternative service instance within the same NF or NF (service) set.

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

ProblemDetails

O

0..1

409 Conflict

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

– TEMPORARY_REJECT_REGISTRATION_ONGOING

– TEMPORARY_REJECT_HANDOVER_ONGOING

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

Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected

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

Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected

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

DataRestorationNotification

M

1

Contains identifiers representing those UEs potentially affected by a data-loss event at the UDR.

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 resource located on an alternative service instance within the same NF or NF (service) set.

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 resource located on an alternative service instance within the same NF or NF (service) set.

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

Contains the Callback URI of the target NF Service Consumer to which the request is redirected

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

Contains the Callback URI of the target NF Service Consumer to which the request is redirected

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Amf3GppAccessRegistration

6.2.6.2.2

The complete set of information relevant to the AMF where the UE has registered via 3GPP access.

AmfNon3GppAccessRegistration

6.2.6.2.3

The complete set of information relevant to the AMF where the UE has registered via non 3GPP access.

SmfRegistration

6.2.6.2.4

The complete set of information relevant to an SMF serving the UE

SmsfRegistration

6.2.6.2.6

The complete set of information relevant to the SMSF serving the UE.

DeregistrationData

6.2.6.2.5

Data sent with the Deregistration Notification

Amf3GppAccessRegistrationModification

6.2.6.2.7

Contains attributes of Amf3GppAccessRegistration that can be modified using PATCH

AmfNon3GppAccessRegistrationModification

6.2.6.2.8

Contains attributes of AmfNon3GppAccessRegistration that can be modified using PATCH

PcscfRestorationNotification

6.2.6.2.9

Information sent to the AMF or SMF when P-CSCF restoration is triggered.

NetworkNodeDiameterAddress

6.2.6.2.10

EpsIwkPgw

6.2.6.2.11

TriggerRequest

6.2.6.2.12

AmfDeregInfo

6.2.6.2.13

EpsInterworkingInfo

6.2.6.2.14

LocationInfo

6.2.6.2.15

Information used by (H)GMLC to send Location Service Request

RegistrationLocationInfo

6.2.6.2.16

Serving AMF, optional VGMLC and access type related informations used by (H)GMLC to send Location Request

VgmlcAddress

6.2.6.2.17

The address(es) of VGMLC

PeiUpdateInfo

6.2.6.2.18

RegistrationDataSets

6.2.6.2.19

IpSmGwRegistration

6.2.6.2.20

SmfRegistrationInfo

6.2.6.2.20A

SMF Registration Information

NwdafRegistration

6.2.6.2.21

The complete set of information relevant to an NWDAF serving the UE

NwdafRegistrationModification

6.2.6.2.22

Contains attributes of NwdafRegistration that can be modified using PATCH

SmfRegistrationModification

6.2.6.2.23

Contains attributes of SmfRegistration that can be modified using PATCH

RoamingInfoUpdate

6.2.6.2.24

Roaming Information Update

DataRestorationNotification

6.2.6.2.25

Contains identities representing those UEs potentially affected by a data-loss event at the UDR

PcscfAddress

6.2.6.2.26

Contains the addressing information (IP addresses and/or FQDN) of the P-CSCF

NwdafRegistrationInfo

6.2.6.2.27

List of NwdafRegistration

RoutingInfoSmRequest

6.2.6.2.28

Request body of the send-routing-info-sm custom operation.

RoutingInfoSmResponse

6.2.6.2.29

Addressing information of available nodes for SMS delivery.

IpSmGwInfo

6.2.6.2.30

Addressing information of the IP-SM-GW.

IpSmGwGuidance

6.2.6.2.31

Contains guidance information (e.g. minimum and recommended delivery times) of the IP-SM-GW.

SmsRouterInfo

6.2.6.2.32

Addressing information of the SMS Router configured at the UDM.

PurgeFlag

6.2.6.3.2

This flag indicates whether or not the NF has deregistered.

E164Number

6.2.6.3.2

DualRegistrationFlag

6.2.6.3.2

Dual Registration Flag

DeregistrationReason

6.2.6.3.3

ImsVoPs

6.2.6.3.4

RegistrationReason

6.2.6.3.5

RegistrationDataSetName

6.2.6.3.6

UeReachableInd

6.2.6.3.7

UE Reachable Indication

Dnn

3GPP TS 29.571 [7]

Data Network Name with Network Identifier only.

NfInstanceId

3GPP TS 29.571 [7]

Network Function Instance Identifier

PduSessionId

3GPP TS 29.571 [7]

PDU Session ID

Pei

3GPP TS 29.571 [7]

Permanent Equipment Identifier

ProblemDetails

3GPP TS 29.571 [7]

Common data type used in response bodies

Uri

3GPP TS 29.571 [7]

Uniform Resource Identifier

SupportedFeatures

3GPP TS 29.571 [7]

see 3GPP TS 29.500 [4] clause 6.6

Supi

3GPP TS 29.571 [7]

see 3GPP TS 23.501 [2] clause 5.9.2

Guami

3GPP TS 29.571 [7]

Globally Unique AMF Identifier

PlmnId

3GPP TS 29.571 [7]

PLMN Identity

DiameterIdentity

3GPP TS 29.571 [7]

AccessType

3GPP TS 29.571 [7]

Access Type

BackupAmfInfo

3GPP TS 29.571 [7]

Backup AMFs

PatchResult

3GPP TS 29.571 [7]

Gpsi

3GPP TS 29.571 [7]

Generic Public Subscription Identitfier

Ipv4Addr

3GPP TS 29.571 [7]

IPv4 address

Ipv6Addr

3GPP TS 29.571 [7]

IPv6 address

Snssai

3GPP TS 29.571 [7]

Single NSSAI

RedirectResponse

3GPP TS 29.571 [7]

Response body of the redirect response message

Fqdn

3GPP TS 29.571 [7]

Fully Qualified Domain Name

FqdnRm

3GPP TS 29.571 [7]

Fully Qualified Domain Name, nullable

NfGroupId

3GPP TS 29.571 [7]

NF Group ID

ServiceName

3GPP TS 29.510 [19]

SupiRange

3GPP TS 29.510 [19]

IdentityRange

3GPP TS 29.510 [19]

EventId

3GPP TS 29.520 [58]

Describes the type of analytics.

ContextInfo

6.1.6.2.69

Defined in the Nudm_SDM API.

Contains the HTTP Headers received by the NFs

amfInstanceId

NfInstanceId

M

1

The identity the AMF uses to register in the NRF.

deregCallbackUri

Uri

M

1

A URI provided by the AMF to receive (implicitly subscribed) notifications on deregistration.

The deregistration callback URI shall have unique information within AMF set to identify the UE to be deregistered.

guami

Guami

M

1

This IE shall contain the serving AMF’s GUAMI.

ratType

RatType

M

1

This IE shall indicate the current RAT type of the UE.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.2.8
These are the features supported by the AMF.

purgeFlag

PurgeFlag

O

0..1

This flag indicates whether or not the AMF has deregistered. It shall not be included in the Registration service operation.

pei

Pei

O

0..1

Permanent Equipment Identifier.

Absence of PEI indicates that the PEI is not available at the AMF. In this case the UDM/UDR shall not delete the PEI value stored from a previous registration.

If the UDR supports the PeiResource feature, the UDM shall also use the PeiInfo resource of the UDR to store the received PEI if it is different from the previously stored PEI or if the PeiInfo resource does not exist.

imsVoPs

ImsVoPs

O

0..1

Indicates per UE if "IMS Voice over PS Sessions" is homogeneously supported in all TAs in the serving AMF for the current PLMN and access type, or homogeneously not supported, or if support is non-homogeneous/unknown. Absence of this attribute shall be interpreted as "non homogenous or unknown" support.

amfServiceNameDereg

ServiceName

O

0..1

When present, this IE shall contain the name of the AMF service to which the Deregistration Notification is to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]).

pcscfRestorationCallbackUri

Uri

O

0..1

A URI provided by the AMF to receive (implicitly subscribed) notifications on the need for P-CSCF Restoration.

amfServiceNamePcscfRest

ServiceName

O

0..1

When present, this IE shall contain the name of the AMF service to which P-CSCF Restoration Notifications are to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). This IE may be included if pcscfRestorationCallbackUri is present.

initialRegistrationInd

boolean

C

0..1

This IE shall be included by the AMF and set to true if the UE performs an Initial Registration. If the UE does not perform initial registration it shall be absent or set to false. When present and true, the UDM+HSS is requested to cancel previous registration in SGSN, if any.

Not applicable for Nudr and Nudm_UECM GET operation.

(NOTE 2)

emergencyRegistrationInd

boolean

C

0..1

This IE shall be included by the AMF and set to true if the UE performs an emergency Registration.

Not applicable for Nudr and Nudm_UECM GET operation.

backupAmfInfo

array(BackupAmfInfo)

C

1..N

This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF.

The UDM uses this attribute to do an NRF query in order to invoke later services in a backup AMF, e.g. Namf_EventExposure.

drFlag

DualRegistrationFlag

O

0..1

Dual Registration flag. When present and true, this flag indicates that the UDM+HSS is requested not to send S6a-CLR to the registered MME/SGSN (if any). Otherwise, the registered MME (if any) shall be cancelled.

Not applicable for Nudr and Nudm_UECM GET operation.

urrpIndicator

boolean

O

0..1

This IE indicates whether "UE_REACHABILITY_FOR_SMS" event or "UE_REACHABILITY_FOR_DATA" event for One-Time UE Activity notification (i.e. Max Number Of reports =1) with configuration "INDIRECT_REPORT" for this user has been subscribed or not:

– true: the event has been subscribed

– false, or absence of this attribute: the event for this user is currently not subscribed

(NOTE 1)

amfEeSubscriptionId

Uri

C

0..1

Shall be present if urrpIndicator is true and the UDM has subscribed (e.g. on behalf of NEF) to ReachabilityReport event for "UE Reachability for DL Traffic" at the AMF to receive One-Time UE Activity notification. It contains the subscription Id URI allocated by the AMF as received by the UDM in the HTTP "Location" header of the Namf_EventExposure_Subscribe response.
The UDM shall make use of the Nudr_DataRepository Update service operation (see 3GPP TS 29.504 [9]) to store the amfEeSubscription Id in the UDR.

epsInterworkingInfo

EpsInterworkingInfo

C

0..1

This IE shall be included if the AMF has determined per APN/DNN which PGW-C+SMF is selected for EPS interworking with N26 and the AMF supports EPS interworking of non-3GPP access. For each APN/DNN, only one PGW-C+SMF shall be selected by the AMF for EPS interworking.

ueSrvccCapability

boolean

O

0..1

This IE indicates whether the UE supports 5G SRVCC:

– true: 5G SRVCC is supported by the UE and AMF;

– false, or absence of this attribute: 5G SRVCC is not supported.

registrationTime

DateTime

C

0..1

Time of Amf3GppAccessRegistration.

Shall be present when used on Nudr.

vgmlcAddress

VgmlcAddress

O

0..1

Address of the VGMLC

contextInfo

ContextInfo

C

0..1

This IE if present may contain e.g. the headers received by the UDM along with the Amf3GppAccessRegistration.

Shall be absent on Nudm and may be present on Nudr

noEeSubscriptionInd

boolean

O

0..1

This IE shall be absent on Nudr and may be present on Nudm. This indication is used by UDM to restore any possible ongoing subscription lost, as specified in clause 5.3.2.2.2.

When present, this IE shall indicate whether AMF does not have event exposure subscriptions in UE Context:

– true: No Event Exposure subscription existing in UE Context in AMF.

– false: Event Exposure subscription(s) exist in UE Context in AMF.

supi

Supi

C

0..1

This IE may be included by the AMF in registration requests and should be included by UDM in GET responses when the corresponding GET request provided a GPSI UE identity.

ueReachableInd

UeReachableInd

C

0..1

This IE shall be present if the UE is currently not reachable (e.g. in not allowed areas) or the UE reachability is unknown (e.g. service restriction area of the UE is not received at the AMF during initial registration).

When the UE is not reachable (and based on operator policy when the UE reachability is unknown), the UDM shall keep the urrpIndicator and amfEeSubscriptionId attributes and not generate Reachability Report for the UE.

Absence of this IE shall be interpreted as "REACHABLE".

reRegistrationRequired

boolean

C

0..1

This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM if purgeFlag is also set to true in the same notification.

When Nudr Data Change Notification is received including this attribute and the purgeFlag, both set to true, the UDM uses "REREGISTRATION_REQUIRED" as DeregistrationReason towards AMF.

This attribute shall not be included and set to true if the adminDeregSubWithdrawn attribute is present and set to true.

Absence of this IE shall be interpreted as false.

adminDeregSubWithdrawn

boolean

C

0..1

This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM if the purgeFlag is also set to true in the same notification.

When Nudr Data Change Notification is recevied including this attribute and the purgeFlag, both set to true, the UDM uses "SUBSCRIPTION_WITHDRAWN" as DeregistrationReason towards AMF.

This attribute shall not be included and set to true if the reRegistrationRequired attribute is present and set to true.

Absence of this IE shall be interpreted as false.

dataRestorationCallbackUri

Uri

O

0..1

If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM.

resetIds

array(string)

O

1..N

May be present in registration response messages.
The AMF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId.

disasterRoamingInd

boolean

O

0..1

Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).

When present, this IE shall be set as follows:

– true: Disaster Roaming service is applied;

– false (default): Disaster Roaming service is not applied.

ueMINTCapability

boolean

O

0..1

This IE indicates whether the UE supports MINT:

– true: MINT is supported by the UE;

– false, or absence of this attribute: MINT is not supported.

sorSnpnSiSupported

boolean

O

0..1

This IE may be included by the AMF in registration requests; if present, it shall contain the capability of the UE or ME to support "Steering of Roaming SNPN Selection Information" (SOR-SNPN-SI).

– true: SOR-SNPN-SI is supported

– false or absent: SOR-SNPN-SI is not supported

udrRestartInd

boolean

O

0..1

May be present in request messages from the AMF to the UDM.

If present:

– true: indicates that the registration message sent by the AMF is due to a re-synchronization event, motivated by a previous reception at the AMF of a Data Restoration Notification from the UDM

– false (or absent): indicates that this is a normal registration message (i.e., not motivated by a data restoration notification event)

lastSynchronizationTime

DateTime

O

0..1

This IE is only applicable to the Nudm API and shall not be used on the Nudr API.

It may only be included when "udrRestartInd" attribute is present and set to true.

When present, it contains the timestamp (previously stored by AMF locally, after successful registration at UDM) when profiles in the AMF and in UDM/UDR were synchronized.

NOTE 1: The urrpIndicator attribute shall only be exposed over the Nudr SBI, and it shall not be included by the AMF.

NOTE 2: Regardless of the Dual Registration Flag, the SGSN, if any, is required to be cancelled (see 3GPP TS 23.502 [3] clause 4.11.5.2)

amfInstanceId

NfInstanceId

M

1

The identity the AMF uses to register in the NRF.

deregCallbackUri

Uri

M

1

A URI provided by the AMF to receive (implicitly subscribed) notifications on deregistration.

The deregistration callback URI shall have unique information within AMF set to identify the UE to be deregistered.

guami

Guami

M

1

This IE shall contain the serving AMF’s GUAMI.

ratType

RatType

M

1

This IE shall indicate the current RAT type of the UE.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.2.8
These are the features supported by the AMF.

purgeFlag

PurgeFlag

O

0..1

This flag indicates whether or not the AMF has deregistered. It shall not be included in the Registration service operation.

pei

Pei

O

0..1

Permanent Equipment Identifier

Absence of PEI indicates that the PEI is not available at the AMF. In this case the UDM/UDR shall not delete the PEI value stored from a previous registration.

If the UDR supports the PeiResource feature and the received PEI is of type IMEI(SV), the UDM shall also use the PeiInfo resource of the UDR to store the received PEI if it is different from the previously stored PEI or if the PeiInfo resource does not exist.

imsVoPs

ImsVoPs

M

1

Indicates per UE if "IMS Voice over PS Sessions" is supported, or not supported.

The value NON_HOMOGENEOUS_OR_UNKNOWN is not applicable.

amfServiceNameDereg

ServiceName

O

0..1

When present, this IE shall contain the name of the AMF service to which the Deregistration Notification is to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]).

pcscfRestorationCallbackUri

Uri

O

0..1

A URI provided by the AMF to receive (implicitly subscribed) notifications on the need for P-CSCF Restoration.

amfServiceNamePcscfRest

ServiceName

O

0..1

When present, this IE shall contain the name of the AMF service to which P-CSCF Restoration Notifications are to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). This IE may be included if pcscfRestorationCallbackUri is present.

backupAmfInfo

array(BackupAmfInfo)

C

1..N

This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF.

The UDM uses this attribute to do an NRF query in order to invoke later services in a backup AMF, e.g. Namf_EventExposure.

urrpIndicator

boolean

O

0..1

This IE indicates whether "UE_REACHABILITY_FOR_SMS" event or "UE_REACHABILITY_FOR_DATA" event for One-Time UE Activity notification (i.e. Max Number Of reports =1) with configuration "INDIRECT_REPORT" for this user has been subscribed or not:

– true: the event has been subscribed

– false, or absence of this attribute: the event for this user is currently not subscribed

amfEeSubscriptionId

Uri

C

0..1

Shall be present if urrpIndicator is true and the UDM has subscribed (e.g. on behalf of NEF) to Reachability-Report event for "UE Reachable for DL Traffic" at the AMFto receive One-Time UE Activity notification. It contains the subscription Id URI allocated by the AMF as received by the UDM in the HTTP "Location" header of the Namf_EventExposure_Subscribe response.
The UDM shall make use of the Nudr_DataRepository Update service operation (see 3GPP TS 29.504 [9]) to store the amfEeSubscription Id in the UDR.

registrationTime

DateTime

C

0..1

Time of AmfNon3GppAccessRegistration.

Shall be present when used on Nudr.

vgmlcAddress

VgmlcAddress

O

0..1

Address of the VGMLC

contextInfo

ContextInfo

C

0..1

This IE if present may contain e.g. the headers received by the UDM along with AmfNon3GppAccessRegistration.

Shall be absent on Nudm and may be present on Nudr.

noEeSubscriptionInd

boolean

O

0..1

This IE shall be absent on Nudr and may be present on Nudm. This indication is used by UDM to restore any possible ongoing subscription lost, as specified in clause 5.3.2.2.3.

When present, this IE shall indicate whether AMF does not have event exposure subscriptions in UE Context:

– true: No Event Exposure subscription existing in UE Context in AMF.

– false: Event Exposure subscription(s) exist in UE Context in AMF.

supi

Supi

C

0..1

This IE may be included by the AMF in registration requests and should be included by UDM in GET responses when the corresponding GET request provided a GPSI UE identity.

reRegistrationRequired

boolean

C

0..1

This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM if the purgeFlag is also set to true in the same notification.

When Nudr Data Change Notification is received including this attribute and the purgeFlag, both set to true, the UDM uses "REREGISTRATION_REQUIRED" as DeregistrationReason towards AMF.

This attribute shall not be included and set to true if the adminDeregSubWithdrawn attribute is present and set to true.

Absence of this IE shall be interpreted as false.

adminDeregSubWithdrawn

boolean

C

0..1

This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM if the purgeFlag is also set to true in the same notification.

When Nudr Data Change Notification is recevied including this attribute and the purgeFlag, both set to true, the UDM uses "SUBSCRIPTION_WITHDRAWN" as DeregistrationReason towards AMF.

This attribute shall not be included and set to true if the reRegistrationRequired attribute is present and set to true.

Absence of this IE shall be interpreted as false.

dataRestorationCallbackUri

Uri

O

0..1

If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM.

resetIds

array(string)

O

1..N

May be present in registration response messages.
The AMF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId.

disasterRoamingInd

boolean

O

0..1

Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).

When present, this IE shall be set as follows:

– true: Disaster Roaming service is applied;

– false (default): Disaster Roaming service is not applied.

sorSnpnSiSupported

boolean

O

0..1

This IE may be included by the AMF in registration requests; if present, it shall contain the capability of the UE or ME to support "Steering of Roaming SNPN Selection Information" (SOR-SNPN-SI).

– true: SOR-SNPN-SI is supported

– false or absent: SOR-SNPN-SI is not supported

udrRestartInd

boolean

O

0..1

May be present in request messages from the AMF to the UDM.

If present:

– true: indicates that the registration message sent by the AMF is due to a re-synchronization event, motivated by a previous reception at the AMF of a Data Restoration Notification from the UDM

– false (or absent): indicates that this is a normal registration message (i.e., not motivated by a data restoration notification event)

lastSynchronizationTime

DateTime

O

0..1

This IE is only applicable to the Nudm API and shall not be used on the Nudr API.

It may only be included when "udrRestartInd" attribute is present and set to true.

When present, it contains the timestamp (previously stored by AMF locally, after successful registration at UDM) when profiles in the AMF and in UDM/UDR were synchronized.

NOTE: The urrpIndicator attribute shall only be exposed over the Nudr SBI, and it shall not be included by the AMF.

smfInstanceId

NfInstanceId

M

1

NF Instance Id of the SMF

smfSetId

NfSetId

C

0..1

This IE shall be present if the SMF belongs to a SMF SET.

If present, it indicates the NF Set ID of SMF Set.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.2.8
These are the features supported by the SMF.

pduSessionId

PduSessionId

M

1

PDU Session ID

singleNssai

Snssai

M

1

A single Network Slice Selection Assistance Information.

It shall contain the HPLMN S-NSSAI of the LBO or HR roaming PDU session, or the S-NSSAI in the serving PLMN of the non roaming PDU session.

dnn

Dnn

C

0..1

Data Network Name; shall be present if emergencyServices is false or absent.

When present, this IE shall contain the Network Identifier only.

emergencyServices

boolean

C

0..1

Indication of Emergency Services; absence indicates false.

pcscfRestorationCallbackUri

Uri

O

0..1

a URI provided by the SMF to receive (implicitly subscribed) notifications on the need for P-CSCF Restoration

plmnId

PlmnId

M

1

Serving node PLMN identity.

For a HR PDU session, this IE shall include the PLMN ID of the home network of the UE. For a LBO PDU session, this IE shall include the PLMN ID of the serving network where the UE is registered from.

pgwFqdn

Fqdn

C

0..1

FQDN of the PGW in the "PGW-C+SMF", to be included for interworking with EPS.

pgwIpAddr

IpAddress

O

0..1

IP Address of the PGW in the "PGW-C+SMF", to be included for interworking with EPS.

epdgInd

boolean

O

0..1

Indicate whether access is from ePDG.

true: access from ePDG.

false or absent: not access from ePDG

deregCallbackUri

Uri

O

0..1

A URI provided by the SMF to receive (implicitly subscribed) notifications on deregistration.

The deregistration callback URI shall have unique information within SMF set to identify the UE to be deregistered.

registrationReason

RegistrationReason

O

0..1

Indicates registration reason.

registrationTime

DateTime

C

0..1

Time of SmfRegistration.

Shall be present when used on Nudr.

contextInfo

ContextInfo

C

0..1

This IE if present may contain e.g. the headers received by the UDM along with the SmfRegistration.

Shall be absent on Nudm and may be present on Nudr.

pcfId

NfInstanceId

C

0..1

This IE shall be present if the SMF is indicated to select the same PCF instance for SM Policy Control.

When present, it indicates the PCF Identifier that serving the PDU Session/PDN Connection.

dataRestorationCallbackUri

Uri

O

0..1

If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM.

resetIds

array(string)

O

1..N

May be present in registration response messages.
The SMF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId.

udrRestartInd

boolean

O

0..1

May be present in request messages from the SMF to the UDM.

If present:

– true: indicates that the registration message sent by the SMF is due to a re-synchronization event, motivated by a previous reception at the SMF of a Data Restoration Notification from the UDM.

– false (or absent): indicates that this is a normal registration message (i.e., not motivated by a data restoration notification event)

lastSynchronizationTime

DateTime

O

0..1

This IE is only applicable to the Nudm API and shall not be used on the Nudr API.

It may only be included when "udrRestartInd" attribute is present and set to true.

When present, it contains the timestamp (previously stored by SMF locally, after successful registration at UDM) when profiles in the SMF and in UDM/UDR were synchronized.

pduSessionReActivationRequired

boolean

C

0..1

This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM.

When Nudr Data Change Notification is received including this attribute set to true, the UDM uses "PDU_SESSION_REACTIVATION_REQUIRED" as DeregistrationReason towards SMF. In this case, the SMF shall trigger a network-initiated PDU session release procedure (see clause 4.3.4 of 3GPP TS 23.502 [3]) with 5GSM cause "Reactivation requested" (see clause 8.3.14 of 3GPP TS 24.501 [27]).

Absence of this IE shall be interpreted as false.

deregReason

DeregistrationReason

M

1

String; see clause 6.2.6.3.3

accessType

AccessType

C

0..1

Access type where the UE is deregistered. Shall be present in Deregistration Notifications sent to the AMF.

pduSessionId

PduSessionId

C

0..1

It shall be present if the deregistration of SMF happens.

If present, indicates PDU Session ID for which old SMF is deregistered.

newSmfInstanceId

NfInstanceId

O

0..1

NF Instance Id of the new SMF to which the SMF context is transferred.

smsfInstanceId

NfInstanceId

M

1

NF Instance Id of the SMSF

smsfSetId

NfSetId

C

0..1

This IE shall be present if the SMSF belongs to an SMSF SET.

If present, it indicates the NF Set ID of SMSF Set.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.2.8
These are the features supported by the SMSF.

plmnId

PlmnId

M

1

Serving PLMN identity

This IE shall include the PLMN ID of the serving network where the UE is registered from.

smsfMAPAddress

E164Number

C

0..1

International E.164 number of the SMSF; shall be present if the SMSF supports MAP (see 3GPP TS 29.002 [21])

smsfDiameterAddress

NetworkNodeDiameterAddress

C

0..1

shall be present if the SMSF supports Diameter (see 3GPP TS  29.338 [22])

registrationTime

DateTime

C

0..1

Time of SmsfRegistration.

Shall be present when used on Nudr.

contextInfo

ContextInfo

C

0..1

This IE if present may contain e.g. the headers received by the UDM along with the SmsfRegistration.

Shall be absent on Nudm and may be present on Nudr..

smsfSbiSupInd

boolean

C

0..1

SBI Support Indication of the SMSF. it shall be present if the SMSF support SBI-based MT SM transmit (see clauses 5.3.2.2.5 and 5.3.2.2.6).

Contains the indication on whether or not the SMSF is expecting to support SBI-based MT SM transmit.

– true: the SMSF supports SBI for MT SM transmit.

– false, or absence of this attribute: the SMSF do not support SBI for MT SM transmit.

dataRestorationCallbackUri

Uri

O

0..1

If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM.

resetIds

array(string)

O

1..N

May be present in registration response messages.
The SMSF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId.

udrRestartInd

boolean

O

0..1

May be present in request messages from the SMSF to the UDM.

If present:

– true: indicates that the registration message sent by the SMSF is due to a re-synchronization event, motivated by a previous reception at the SMSF of a Data Restoration Notification from the UDM

– false (or absent): indicates that this is a normal registration message (i.e., not motivated by a data restoration notification event)

lastSynchronizationTime

DateTime

O

0..1

This IE is only applicable to the Nudm API and shall not be used on the Nudr API.

It may only be included when "udrRestartInd" attribute is present and set to true.

When present, it contains the timestamp (previously stored by SMSF locally, after successful registration at UDM) when profiles in the SMSF and in UDM/UDR were synchronized.

guami

Guami

M

1

Guami of the AMF requesting the modification. If the MCC, MNC, AMF Region ID and AMF Set ID within the guami do not match the stored value, the modification request shall be rejected.

purgeFlag

PurgeFlag

O

0..1

This flag indicates whether or not the AMF has deregistered. It shall be included in the Deregistration service operation with a value of "TRUE".

pei

Pei

O

0..1

Permanent Equipment Identifier.

If the UDR supports the PeiResource feature and the received PEI is of type IMEI(SV), the UDM shall in addition to updating the Amf3GppAccessRegistration resource also update the PeiInfo resource of the UDR to store the received PEI if it is different from the previously stored PEI.

imsVoPs

ImsVoPs

O

0..1

Indicates per UE if "IMS Voice over PS Sessions" is homogeneously supported in all TAs in the serving AMF for the current PLMN and access type, or homogeneously not supported, or if support is non-homogeneous/unknown

backupAmfInfo

array(BackupAmfInfo)

C

0..N

This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF for the Modification of the BackupAmfInfo.

The UDM uses this attribute to do an NRF query in order to invoke later services in a backup AMF, e.g. Namf_EventExposure.

An empty array indicates that the complete backupAmfInfo shall be deleted.

epsInterworkingInfo

EpsInterworkingInfo

C

0..1

This IE shall be included if the AMF has determined per APN/DNN which PGW-C+SMF is selected for EPS interworking with N26 and the AMF supports EPS interworking of non-3GPP access. This IE shall also be included to update the PGW-C+SMF information if the AMF selects another PGW-C+SMF for EPS interworking with N26 for the same DNN. For each APN/DNN, only one PGW-C+SMF shall be selected by the AMF for EPS interworking.

ueSrvccCapability

boolean

O

0..1

This IE indicates whether the UE supports 5G SRVCC:

– true: 5G SRVCC is supported by the UE and AMF;

– false: 5G SRVCC is not supported.

ueMINTCapability

boolean

O

0..1

This IE indicates whether the UE supports MINT:

– true: MINT is supported by the UE;

– false: MINT is not supported.

NOTE: Absence of optional attributes indicates: no modification. Attributes of this type are not marked "nullable: true" in the OpenAPI file as deletion of these attributes is not applicable.

guami

Guami

M

1

Guami of the AMF requesting the modification. If the MCC, MNC, AMF Region ID and AMF Set ID within the guami do not match the stored value, the modification request shall be rejected.

purgeFlag

PurgeFlag

O

0..1

This flag indicates whether or not the AMF has deregistered. It shall be included in the Deregistration service operation with a value of "TRUE".

pei

Pei

O

0..1

Permanent Equipment Identifier.

If the UDR supports the PeiResource feature and the PEI is of type IMEI(SV), the UDM shall in addition to updating the AmfNon3GppAccessRegistration resource also update the PeiInfo resource of the UDR to store the received PEI if it is different from the previously stored PEI.

imsVoPs

ImsVoPs

O

0..1

If present indicates per UE that support of "IMS Voice over PS Sessions" has been modified to supported or not supported".

The value NON_HOMOGENEOUS_OR_UNKNOWN is not applicable.

backupAmfInfo

array(BackupAmfInfo)

C

0..N

This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF for the Modification of the BackupAmfInfo.

The UDM uses this attribute to do an NRF query in order to invoke later services in a backup AMF, e.g. Namf_EventExposure.

An empty array indicates that the complete backupAmfInfo shall be deleted.

NOTE: Absence of optional attributes indicates: no modification. Attributes of this type are not marked "nullable: true" in the OpenAPI file as deletion of these attributes is not applicable.

supi

Supi

M

1

A SUPI that is served by the failed P-CSCF

failedPcscf

PcscfAddress

C

0..1

Information about the failed P-CSCF

name

DiameterIdentity

M

1

realm

DiameterIdentity

M

1

pgwFqdn

Fqdn

M

1

The PGW FQDN of the "PGW-C+SMF"

smfInstanceId

NfInstanceId

M

1

The SMF Instance Id of the "PGW-C+SMF"

plmnId

PlmnId

O

0..1

PLMN where the PGW-C+SMF is located

supi

Supi

M

1

failedPcscf

PcscfAddress

C

0..1

Information about the failed P-CSCF

deregReason

DeregistrationReason

M

1

String; see clause 6.2.6.3.3

epsIwkPgws

map(EpsIwkPgw)

O

0..N

A map (list of key-value pairs where dnn serves as key) of EpsIwkPgws.

An empty map is used in Amf3GppAccessRegistrationModification to delete the epsInterworkingInfo.

supi

Supi

O

0..1

Subscription Permanent Identifier (NOTE 1)

gpsi

Gpsi

O

0..1

Generic Public Subscription Identifier (NOTE 1)

registrationLocationInfoList

array(RegistrationLocationInfo)

M

1..2

Serving AMF, optional VGMLC and access type related informations used by (H)GMLC to send Location Request (NOTE 2)

supportedFeatures

SupportedFeatures

O

0..1

supported-features of the UDM

NOTE 1: One of both shall be included to identify the target UE.

NOTE 2: At least, one of 3GPP and Non-3GPP access types shall be included to describe the location related information of the target UE for the access type.

amfInstanceId

NfInstanceId

M

1

The NF instance identity of the serving.

guami

Guami

O

0..1

The GUAMI served by the serving AMF.

plmnId

PlmnId

C

0..1

Serving node PLMN identity is included if the target UE is in roaming case for the serving AMF.

This attribute shall be present if the VGMLC address was registered by the serving AMF.

Otherwise shall be absent.

(NOTE)

vgmlcAddress

VgmlcAddress

C

0..1

The address(es) of VGMLC. (NOTE)

accessTypeList

array(AccessType)

M

1..2

Access type(s) where the UE is registered

NOTE: The two IEs are only be included if the target UE is registered in VPLMN via the serving AMF.

vgmlcAddressIpv4

Ipv4Addr

O

0..1

When present, indicates VGMLC IPv4 address.

vgmlcAddressIpv6

Ipv6Addr

O

0..1

When present, indicates VGMLC IPv6 address.

vgmlcFqdn

Fqdn

O

0..1

When present, indicates FQDN of the VGMLC IPv6 address.

NOTE: At least, one of VGMLC addresses should be included.

pei

Pei

M

1

amf3Gpp

Amf3GppAccessRegistration

O

0..1

AMF 3GPP Access Registration

amfNon3Gpp

AmfNon3GppAccessRegistration

O

0..1

AMF Non 3GPP Access Registration

smfRegistration

SmfRegistrationInfo

O

0..1

SMF Registration Information

smsf3Gpp

SmsfRegistration

O

0..1

SMSF 3GPP Access Registration

smsfNon3Gpp

SmsfRegistration

O

0..1

SMSF Non 3GPP Access Registration

ipSmGw

IpSmGwRegistration

O

0..1

IP-SM-GW Registration

nwdafRegistration

NwdafRegistrationInfo

O

0..1

NWDAF Registration Information

ipSmGwMapAddress

E164Number

C

0..1

International E.164 number of the IP-SM-GW; it shall be present if the IP-SM-GW supports MAP (see 3GPP TS 29.002 [21])

(NOTE 1)

ipSmGwDiameterAddress

NetworkNodeDiameterAddress

C

0..1

Diameter Identity of the IP-SM-GW; it shall be present if the IP-SM-GW supports Diameter (see 3GPP TS 29.328 [52])

(NOTE 1)

ipsmgwIpv4

Ipv4Addr

C

0..1

This IE shall be present if available.

When present, this IE indicates the IPv4 address of the IP-SM-GW.

(NOTE 1)

ipsmgwIpv6

Ipv6Addr

C

0..1

This IE shall be present if available.

When present, this IE indicates the IPv6 address of the IP-SM-GW.

(NOTE 1)

ipsmgwFqdn

Fqdn

C

0..1

This IE shall be present if available.

When present, this IE indicates the FQDN of the IP-SM-GW.

(NOTE 1)

ipSmGwSbiSupInd

boolean

C

0..1

SBI Support Indication of the IP-SM-GW. it shall be present if provided in IP-SM-GW registration procedure (see clauses 5.3.2.2.7)

Contains the indication on whether or not the IP-SM-GW is expecting to support SBI-based MT SM transmit.

– true: the IP-SM-GW supports SBI for MT SM transmit.

– false, or absence of this attribute: the IP-SM-GW do not support SBI for MT SM transmit.

nfInstanceId

NfInstanceId

C

0..1

NF Instance ID of the SBI-capable IP-SM-GW

unriIndicator

boolean

O

0..1

UE-Not-Reachable-for-IP (UNRI) flag as defined in 3GPP TS 23.040 [53]. This IE indicates whether the address list of MWD contains one or more entries because an attempt to deliver a short message to a UE via an IP-SM-GW has failed with a cause of Absent Subscriber:

– true: the MWD contains one or more list elements due to an SMS delivery failure

– false, or absence of this attribute: the MWD does not contain any list element

resetIds

array(string)

O

1..N

May be present in registration response messages.
The IP-SM-GW may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId.

NOTE 1: At least one of the properties, ipSmGwMapAddress or ipSmGwDiameterAddress or ipsmgwIpv4 or ipsmgwIpv6 or ipsmgwFqdn, shall be present. If the IP-SM-GW supports SBI, the nfInstanceId property shall be present.

NOTE 2: The unriIndicator attribute shall only be exposed over the Nudr SBI.

smfRegistrationList

array(SmfRegistration)

M

1..N

List of SmfRegistration.

nwdafInstanceId

NfInstanceId

M

1

NF Instance Id of the NWDAF.

analyticsIds

array(EventId)

M

1..N

List of analytics Id(s) provided by the consumers of NWDAF.

nwdafSetId

NfSetId

C

0..1

This IE shall be present if the NWDAF belongs to an NWDAF SET.

If present, it indicates the NF Set ID of NWDAF Set.

registrationTime

DateTime

C

0..1

Time of NwdafRegistration. Shall be present when used on Nudr.

contextInfo

ContextInfo

C

0..1

This IE if present may contain e.g. the headers received by the UDM along with the NwdafRegistration.

Shall be absent on Nudm and may be present on Nudr.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.2.8

These are the features supported by the NWDAF.

resetIds

array(string)

O

1..N

May be present in registration response messages.
The NWDAF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId.

nwdafInstanceId

NfInstanceId

M

1

NF Instance Id of the NWDAF

nwdafSetId

NfSetId

C

0..1

This IE shall be present if the NWDAF belongs to an NWDAF SET.

If present, it indicates the NF Set ID of NWDAF Set.

analyticsIds

array(EventId)

O

0..N

List of analytics Id(s) supplied by NWDAF.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.2.8

These are the features supported by the NWDAF.

NOTE: Absence of optional attributes indicates: no modification. Attributes of this type are not marked "nullable: true" in the OpenAPI file as deletion of these attributes is not applicable.

smfInstanceId

NfInstanceId

M

1

NF Instance Id of the SMF requesting the modification. If the NF Set Id is absent and the NF Instance Id does not match the stored NF Instance Id value, the modification request shall be rejected.

smfSetId

NfSetId

O

0..1

NF Set Id of the SMF requesting the modification. If the NF Set Id is present and does not match the stored NF Set Id value, the modification request shall be rejected.

pgwFqdn

FqdnRm

C

0..1

FQDN of the PGW in the "PGW-C+SMF", to be included for interworking with EPS. For deletion of the PGW FQDN, the value of the pgwFqdn shall be set to null.

NOTE: Absence of optional attributes indicates: no modification. Attributes of this type are not marked "nullable: true" in the OpenAPI file as deletion of these attributes is not applicable.

servingPlmn

PlmnId

M

1

the new Serving PLMN

roaming

boolean

C

0..1

This IE shall be included if the roaming status changes (from roaming to non-roaming or vice versa).

True: The new serving PLMN is different from the HPLMN;
False: The new serving PLMN is the HPLMN

lastReplicationTime

DateTime

O

0..1

If present, it contains the timestamp of the most recent instant when the data was assumed to be consistent at UDR (i.e. the potential data loss event at UDR did not occur before this instant).

recoveryTime

DateTime

O

0..1

If present, it contains the timestamp of the instant when the potential data loss event was recovered at UDR (i.e. all data records stored by UDR after this time are assumed to be consistent).

plmnId

PlmnId

C

0..1

If present, it shall contain the PLMN-ID of the UDM/UDR that originated the Data Restoration Notification.

It shall be included in notifications sent by UDM to its NF consumers located in other PLMNs.

supiRanges

array(SupiRange)

O

1..N

If present, it contains the list of SUPIs potentially subject to a data-loss event at the UDR.

gpsiRanges

array(IdentityRange)

O

1..N

If present, it contains the list of GPSIs potentially subject to a data-loss event at the UDR.

resetIds

array(string)

O

1..N

If present, it contains the list of Reset-IDs of those UEs potentially subject to a data-loss event at the UDR.

sNssaiList

array(Snssai)

O

1..N

If present, it contains the list of slices (S-NSSAIs) potentially subject to a data-loss event at the UDR.

dnnList

array(Dnn)

O

1..N

If present, it contains the list of DNNs potentially subject to a data-loss event at the UDR.

udmGroupId

NfGroupId

O

1..N

If present, it contains the ID of the UDM Group whose UEs have been potentially subject to a data loss event at the UDR.

ipv4Addrs

array(Ipv4Addr)

O

1..N

If present, it contains IPv4 address(es) of the P-CSCF (NOTE 2).

ipv6Addrs

array(Ipv6Addr)

O

1..N

If present, it contains IPv6 address(es) of the P-CSCF (NOTE 2).

fqdn

Fqdn

O

0..1

If present, it contains the FQDN of the P-CSCF.

NOTE 1: At least, one of these P-CSCF addressing attributes shall be included.

NOTE 2: Several addresses may be included (in ipv4Addrs or ipv6Addrs) to convey multiple redundant IP endpoints on the Mw interface of the P-CSCF.

nwdafRegistrationList

array(NwdafRegistration)

M

1..N

List of NwdafRegistration.

ipSmGwInd

boolean

C

0..1

This IE indicates whether the SMS-GMSC is prepared to receive IP-SM-GW guidance information in the response:

– true: receiving IP-SM-GW guidance in the response is supported;

– false, or absence: receiving IP-SM-GW guidance in the response is not supported.

supportedFeatures

SupportedFeatures

O

0..1

Features of the Nudm_UECM API supported by the NF Service Consumer.

supi

Supi

O

0..1

Contains the SUPI of the UE

smsf3Gpp

SmsfRegistration

O

0..1

SMSF 3GPP Access Registration

smsfNon3Gpp

SmsfRegistration

O

0..1

SMSF Non 3GPP Access Registration

ipSmGw

IpSmGwInfo

O

0..1

IP-SM-GW Registration

smsRouter

SmsRouterInfo

O

0..1

SMS Router address

ipSmGwRegistration

IpSmGwRegistration

M

1

IP-SM-GW routing information

ipSmGwGuidance

IpSmGwGuidance

C

0..1

Contains the recommended and the minimum timer values for supervision of MT SMS response. It shall be present if the ipSmGwInd attribute in the request is set to true.

minDeliveryTime

integer

M

1

The minimum timer value in units of seconds.

Minimum = 30. Maximum = 600.

recommDeliveryTime

integer

M

1

The recommended timer value in units of seconds.

Minimum = 30. Maximum = 600.

nfInstanceId

NfInstanceId

O

0..1

NF Instance ID of the SMS Router

diameterAddress

NetworkNodeDiameterAddress

O

0..1

Diameter address of the SMS Router

mapAddress

E164Number

O

0..1

MAP address of the SMS Router

routerIpv4

Ipv4Addr

O

0..1

This IE shall be present if available.

When present, this IE indicates the IPv4 address of the SMS Router.

routerIpv6

Ipv6Addr

O

0..1

This IE shall be present if available.

When present, this IE indicates the IPv6 address of the SMS Router.

routerFqdn

Fqdn

O

0..1

This IE shall be present if available.

When present, this IE indicates the FQDN of the SMS Router.

PurgeFlag

boolean