AuthenticationSubscription

5.4.2.2

A UE’s authentication data

OperatorSpecificDataContainer

5.4.2.3

Container for operator specific data

SmfRegList

5.4.2.4

The list of all the SMF registrations of a UE

SubscriptionDataSubscriptions

5.4.2.5

A subscription to notifications.

DataChangeNotify

5.4.2.6

Container for data which have changed and notification was requested when changed.

IdentityData

5.4.2.7

Identity data corresponds to the provided ueId

ProvisionedDataSets

5.4.2.8

Contains the provisioned data sets

SorData

5.4.2.9

Used to store the status of the latest SOR data update

UpuData

5.4.2.9A

Used to store the status of the latest UPU data update

NssaiAckData

5.4.2.9B

Used to store the status of the latest NSSAI data update

CagAckData

5.4.2.9C

Used to store the status of the latest CAG data update

AmfSubscriptionInfo

5.4.2.19

Information the UDR stores and retrieves related to active subscriptions at the AMF(s)

EeProfileData

5.4.2.20

Event Exposure Profile Data

ContextDataSets

5.4.2.22

Contains the context data sets

SequenceNumber

5.4.2.23

Contains the SQN

MessageWaitingData

5.4.2.24

Message Waiting Data list

SmscData

5.4.2.25

Addresses of SM-Service Center entities with SMS waiting to be delivered to the UE

SmfSubscriptionInfo

5.4.2.26

Information the UDR stores and retrieves related to active subscriptions at the SMF(s)

SmfSubscriptionItem

5.4.2.27

Contains info about a single SMF event subscription

MtcProvider

5.4.2.28

MTC provider information

HssSubscriptionInfo

5.4.2.29

Information the UDR stores related to active subscriptions at the HSS(s)

HssSubscriptionItem

5.4.2.30

Contains info about a single HSS event subscription

EeGroupProfileData

5.4.2.31

The Event Exposure Profile Data for a group of UEs

Pp5gVnGroupProfileData

5.4.2.32

The Parameter Provision Profile Data for 5G VN groups

PpProfileData

5.4.2.33

The Parameter Provision Profile Data

AllowedMtcProviderInfo

5.4.2.34

Allowed MTC Providers or AFs Information to provision parameters for UE.

GroupIdentifiers

5.4.2.35

External or Internal Group Identifier with a list of group members

AuthorizationData

5.4.2.36

Authorization Information

NiddAuthorizationInfo

5.4.2.37

Information the UDR stores and retrieves related to active NIDD authorizations

PpDataEntryList

5.4.2.38

A list of the Provisioned Parameters entries.

UeSubscribedDataSets

5.4.2.39

Contains the subscribed data sets of a UE

ServiceSpecificAuthorizationInfo

5.4.2.40

Information the UDR stores and retrieves related to active Service Specific authorizations

NfIdentifier

5.4.2.41

Network Function Identifier

EeSubscriptionExt

5.4.2.42

Extended Event Exposure Subscription

AdditionalEeSubsInfo

5.4.2.43

Additional EE-Subscription Information

ImmediateReport

5.4.2.44

Immediate Report

VarPlmnId

5.4.3.2

String identifying a PLMN ID or an SNPN ID.

AuthMethod

5.4.3.3

Contains the Authentication Method

DataSetName

5.4.3.4

The name of data set

ContextDataSetName

5.4.3.6

The name of context data set

SqnScheme

5.4.3.7

Scheme for generation of Sequence Numbers

Sign

5.4.3.8

Sign of the DIF value

UeUpdateStatus

5.4.3.9

Status of the procedure

PpDataType

5.4.3.10

The data type of the Provisioned Parameters

AccessAndMobilitySubscriptionData

3GPP TS 29.503 [6]

Access and Mobility Subscription Data

SmfSelectionSubscriptionData

3GPP TS 29.503 [6]

SMF Selection Subscription Data

SmSubsData

3GPP TS 29.503 [6]

Session Management Subscription Data

Amf3GppAccessRegistration

3GPP TS 29.503 [6]

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

AmfNon3GppAccessRegistration

3GPP TS 29.503 [6]

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

SmfRegistration

3GPP TS 29.503 [6]

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

SmsfRegistration

3GPP TS 29.503 [6]

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

SmsManagementSubscriptionData

3GPP TS 29.503 [6]

SMS Management Subscription Data

SupportedFeatures

3GPP TS 29.571 [3]

Used to negotiate the applicability of the optional features

ProblemDetails

3GPP TS 29.571 [3]

Detailed information about the status code.

PpData

3GPP TS 29.503 [6]

Parameter Provision Data

PpDataEntry

3GPP TS 29.503 [6]

Provisioned Parameter Data Entry

SmsSubscriptionData

3GPP TS 29.503 [6]

SMS Subscription Data

PatchItem

3GPP TS 29.571 [3]

Data structure used for JSON patch.

SdmSubscription

3GPP TS 29.503 [6]

A subscription to notifications

EeSubscription

3GPP TS 29.503 [6]

A subscription to Notifications of event exposure

Uri

3GPP TS 29.571 [3]

URI

TraceData

3GPP TS 29.571 [3]

Trace Data

Dnn

3GPP TS 29.571 [3]

Data Network Name

Snssai

3GPP TS 29.571 [3]

Single NSSAI

VarUeId

3GPP TS 29.571 [3]

String represents the SUPI or GPSI.

NfInstanceId

3GPP TS 29.571 [3]

NF Instance Identifier

NotifyItem

3GPP TS 29.571 [3]

Common data type used for data change notification.

OdbData

3GPP TS 29.571 [3]

Operator Determined Barring Data

EventType

3GPP TS 29.503 [6]

Event Type

ExtGroupId

3GPP TS 29.503 [6]

External Group Identifier

PduSessionId

3GPP TS 29.571 [3]

PDU Session ID which identifies a PDU session

DateTime

3GPP TS 29.571 [3]

Date Time

UpuMac

3GPP TS 29.509 [15]

MAC value for protecting UPU procedure (UPU-MAC-I_AUSF and UPU-MAC-I_UE)

5GVnGroupConfiguration

3GPP TS 29.503 [6]

5G VN Group Configuration data

PatchResult

3GPP TS 29.571 [3]

Patch Result

SupportedFeatures

3GPP TS 29.571 [3]

Supported Features

AppPortId

3GPP TS 29.503 [6]

Application Port Identifier

LcsPrivacyData

3GPP TS 29.503 [6]

LCS Privacy Subscription Data

LcsMoData

3GPP TS 29.503 [6]

LCS Mobile Originated Subscription Data

MtcProviderInformation

3GPP TS 29.571 [3]

An ID uniquely identifying MTC provider information

EnhancedCoverageRestrictionData

3GPP TS 29.503 [6]

Enhanced Coverage Restriction Data

LocationInfo

3GPP TS 29.503 [6]

Location Information

V2xSubscriptionData

3GPP TS 29.503 [6]

V2X Subscription Data

E164Number

3GPP TS 29.503 [6]

E164Number

NetworkNodeDiameterAddress

3GPP TS 29.503 [6]

Diameter Address of an Network Node

IpSmGwRegistration

3GPP TS 29.503 [6]

The complete set of information relevant to the IP-SM-GW where the UE has registered.

LcsBroadcastAssistanceTypesData

3GPP TS 29.503 [6]

LCS Broadcast Assistance Data Types

ContextInfo

3GPP TS 29.503 [6]

Contains the headers received by an NF.

NfGroupId

3GPP TS 29.571 [3]

NF Group ID

ProseSubscriptionData

3GPP TS 29.503 [6]

ProSe Service Subscription Data

PlmnId

3GPP TS 29.571 [3]

PLMN ID

AppPortId

3GPP TS 29.503 [6]

Application Port Id

AuthorizationInfo

3GPP TS 29.503 [6]

Contains Authorization Information

MbsSubscriptionData

3GPP TS 29.503 [6]

Contains 5MBS Subscription Data

ServiceType

3GPP TS 29.503 [6]

Service Type

RoamingInfoUpdate

3GPP TS 29.503 [6]

Roaming Information in EPC domain

UcSubscriptionData

3GPP TS 29.503 [6]

User Consent Data

UcPurpose

3GPP TS 29.503 [6]

User Consent Purpose

PeiUpdateInfo

3GPP TS 29.503 [6]

PEI Update Information

SharedData

3GPP TS 29.503 [6]

Shared Data

authenticationMethod

AuthMethod

M

1

String containing the Authentication Method ("5G_AKA", "EAP_AKA_PRIME", "EAP_TLS"…) that shall be used when the UE’s device is 5G capable.

If AV generation for HSS is required in UDM, this attribute shall take any 5G AKA-based value (i.e. "5G_AKA" or "EAP_AKA_PRIME").

encPermanentKey

string

C

0..1

The encrypted value (hexstring) of the permanent authentication key (K) (see 3GPP TS 33.501 [9]).

It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS.

protectionParameterId

string

C

0..1

Identifies a parameter set securely stored in the UDM (ARPF) that can be used to decrypt the encPermanentKey (and encOpcKey or encTopcKey if present). Values and their meaning are HPLMN-operator specific.

It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS.

sequenceNumber

SequenceNumber

C

0..1

String containing the SQN as defined in 3GPP TS 33.102 [10].

It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS.

authenticationManagementField

string

C

0..1

Hexstring containing the Authentication management field as defined in 3GPP TS 33.501 [9].

It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS.

Pattern: ‘^[A-Fa-f0-9]{4}$’

algorithmId

string

C

0..1

Identifies a parameter set securely stored in the UDM (ARPF) that provides details on the algorithm and parameters used to generate authentication vectors. Values and their meaning are HPLMN-operator specific.

It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS.

encOpcKey

string

O

0..1

Hexstring of the encrypted OPC Key.

Presence indicates that the provided value (decrypted) shall be used instead of the value derived from OP and K.

encTopcKey

string

O

0..1

Hexstring of the encrypted TOPC Key.

Presence indicates that the provided value (decrypted) shall be used instead of the value derived from TOP and K.

hssGroupId

NfGroupId

O

0..1

Identity of the HSS group associated with the subscription that might be used by the UDM to discover the HSS; see 3GPP TS 29.510 [19].

This attribute may be present if the vectorGenerationInHss attribute is present and set to True.

vectorGenerationInHss

boolean

O

0..1

True indicates that the UDM needs to retrieve an Authentication Vector from the HSS;

False and absence indicates that vector generation shall be performed in the UDM.

n5gcDeviceAuthMethod

AuthMethod

O

0..1

String containing the Authentication Method that shall be used when the UE’s device is Non-5G-Capable behind Cable RGs in private networks or in isolated deployment scenarios with wireline access.

See NOTE.

rgAuthenticationInd

boolean

O

0..1

true: indicates that authentication by the home network is not required if authentication has been completed by the W-5GAN. See 3GPP TS 33.501 [9] clause 7b.
false (default): otherwise.

supi

Supi

C

0..1

If present, this IE shall contain the UE’s SUPI which shall contain an IMSI.

It shall be present if the subscription is allowed to be identified by a pseudonym of the SUPI e.g. by a GCI or GLI that is not the SUPI.

akmaAllowed

boolean

O

0..1

This IE indicates whether or not the subscriber is allowed to use AKMA:

– true: subscriber is allowed to use AKMA

– absent or false: subscriber is not allowed to use AKMA

routingId

string

C

0..1

This IE shall be present if the akmaAllowed is set to "true".

When present, this IE shall include the Routing Indicator contained in the SUCI (see 3GPP TS 23.003 [5], clause 2.2B).

NOTE: The attribute n5gcDeviceAuthMethod is used for EAP-TLS, which is described in the informative annex O of 3GPP TS 33.501 [9] and is not mandatory to support.

dataType

string

M

1

This attribute value must be a string equals to the name of the actual data type of the "Value" attribute.

value

any type

M

1

dataTypeDefinition

string

O

0..1

If present, this attribute is applicable when "dataType" takes value "object" or "array" and it shall contain a JSON Pointer expression referencing a JSON Schema data type definition (same as how the attribute "$ref" is used in JSON Schema specifications), which the "value" attribute must conform to.

supportedFeatures

SupportedFeatures

C

0..1

Indicates the list of negotiated supported features.

This parameter shall be supplied by the UDR in the response to the GET request when the GET request includes the "supported-features" query parameter and the UDR supports feature negotiation for the OperatorSpecificData resource defined in this specification and in 3GPP TS 29.519 [17].

resetIds

array(string)

O

1..N

This IE uniquely identifies a part of temporary data in UDR that contains the created resource.

This attribute may be provided in the response of successful resource creation.

N/A

array(SmfRegistration)

M

0..N

Each member of the array (if any) is an individual SMF registration of the UE.

An empty array indicates absence of any SmfRegistration.

callbackReference

Uri

M

1

Identifies the UDM/NF pool or an individual UDM/NF which should be used by the UDR to send notification to UDM/NF.

originalCallbackReference

Uri

O

0..1

URI provided by the NF service consumer to the UDM to receive notifications from the UDR.

If "sdmSubscription" is present, this attribute may be absent (and, if it is also present, it shall take the same value as the attribute "callbackReference" of "sdmSubscription").

ueId

VarUeId

O

0..1

User identity if subscription to notifications is related to a user.

monitoredResourceUris

array(Uri)

M

1..N

A set of URIs that identify the resources for which a modification of the representation 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 [16].

The URI shall not contain query parameters.

See NOTE 1.

expiry

DateTime

C

0..1

This IE shall be included in a subscription response, if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.

This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.

The absence of this attribute in the subscription response means the subscription to be valid without an expiry time.

sdmSubscription

SdmSubscription

O

0..1

Data related to the subscription to changes on SDM data, created by the NF Service Consumer of the UDM (see 3GPP TS 29.503 [6], clause 6.1.6.2.3).

hssSubscriptionInfo

HssSubscriptionInfo

O

0..1

HSS Subscription Info associated with the sdmSubscription.

subscriptionId

string

C

0..1

This attribute shall be present if the SubscriptionDataSubscriptions is sent in a GET response message or in a Notification. It identifies the individual SubscriptionDataSubscriptions stored in the UDR and may be used by the UDM to e.g. delete or update a SubscriptionDataSubscriptions.

Read Only: true

uniqueSubscription

boolean

C

0..1

This attribute shall be present and set to true if the UDM requests the UDR to maintain a single UDM subscription per UE.

The attribute shall not be set to true if the sdmSubscription attribute is present.

The attribute shall not be set to true if the sdmSubscription and UeId attributes are not present.

See clause 5.2.20.3.1.

supportedFeatures

SupportedFeatures

O

0..1

Used to negotiate the applicability of optional features

immediateReport

boolean

O

0..1

This IE indicates whether immediate report is requested or not.

When present, this IE shall be set as following:

– true: immediate report is required

– false (default) immediate report is not required

ImmediateReport

report

ImmediateReport

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 need to be monitored, i.e. listed in monitoredResourceUris attribute.

ImmediateReport

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

originalCallbackReference

array(Uri)

C

1..N

Original Callback Reference shall be present if a UDM has subscribed to notification due to an request from an NF. If present it is Identifying the NF to which the UDM has to provide the notification of data change.

ueId

VarUeId

C

0..1

User identity if subscription to notifications is related to a user that may be provided e.g. in case OriginalCallback URI is not included.

notifyItems

array(NotifyItem)

O

1..N

This attribute contains the changes which have been applied on the resources.

sdmSubscription

SdmSubscription

O

0..1

Data related to the subscription to changes on SDM data created by the NF Service Consumer of the UDM (see 3GPP TS 29.503 [6], clause 6.1.6.2.3).

This attribute should be omitted if the SubscriptionsDataSubscriptions array is included.

additionalSdmSubscriptions

array(SdmSubscription)

C

1..N

Shall be present if more than one subscription to changes on SDM data created by different NF service consumers of the UDM exist. This attribute if present shall convey sdm subscriptions in addition to and different from the sdm subscription present in the sdmSubscription attribute.

subscriptionDataSubscriptions

array(SubscriptionDataSubscriptions)

O

1..N

This attribute contain the Subscription Data Subscriptions (subs-to-notify) associated with the Notification.

supiList

array(Supi)

C

1..N

Supi list corresponding to the provided gpsi ueId.

gpsiList

array(Gpsi)

C

1..N

Gpsi list corresponding to the provided supi ueId.

Zero or one MSISDN and/or zero or more external Identifiers may be included.

allowedAfIds

array(string)

O

1..N

A list of Application Function Identifiers authorized to retrieve this Identities lists. The absence of this IE indicates that any AF is allowed to retrieve them.

applicationPortIds

map(Gpsi)

O

1..N

A map (list of key-value pairs where AppPortId serves as key) of GPSIs.

amData

AccessAndMobilitySubscriptionData

O

0..1

Access and Mobility Subscription Data

smfSelData

SmfSelectionSubscriptionData

O

0..1

SMF Selection Subscription Data

smsSubsData

SmsSubscriptionData

O

0..1

SMS Subscription Data

smData

SmSubsData

O

0..1

Session Management Subscription Data

traceData

TraceData

O

0..1

Trace Data. The Null value indicates that trace is not active.

smsMngData

SmsManagementSubscriptionData

O

0..1

SMS Management Subscription Data

lcsPrivacyData

LcsPrivacyData

O

0..1

LCS Privacy Subscription Data

lcsMoData

LcsMoData

O

0..1

LCS Mobile Originated Subscription Data

lcsBcaData

LcsBroadcastAssistanceTypesData

O

0..1

LCS Broadcast Assistance Subscription Data

v2xData

V2xSubscriptionData

O

0..1

V2X Subscription Data

proseData

ProseSubscriptionData

O

0..1

ProSe service Subscription Data

odbData

OdbData

O

0..1

Operator Determined Barring Subscription Data

eeProfileData

EeProfileData

O

0..1

Event Exposure Profile Data

ppProfileData

PpProfileData

O

0..1

Parameter Provisioning Profile Data

niddAuthData

AuthorizationData

O

0..1

NIDD Authorization Data

mbsSubscriptionData

MbsSubscriptionData

O

0..1

5MBS Subscription Data

provisioningTime

DateTime

M

1

Point in time of provisioning

ueUpdateStatus

UeUpdateStatus

M

1

status of the SOR data update procedure

sorXmacIue

SorMac

C

0..1

String containing SoR-XMAC-IUE as specified in 3GPP TS 33.501 [9]. Shall be present if UeUpdateStatus is "WAITING_FOR_ACK" or "ACK_RECEIVED".

sorMacIue

SorMac

C

0..1

String containing SoR-MAC-IUE as specified in 3GPP TS 33.501 [9]. Shall be preset if UeUpdateStatus is "ACK_RECEIVED".

meSupportOfSorCmci

Boolean

C

0..1

When present, indicates "ME support of SOR-CMCI" sent from UE as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [27].

As described in 3GPP TS 23.122 [14] Annex C.2 step 3a, this attribute will be deleted (set to False) during UE initiates initial registration or emergency registration.

– True: ME supports SOR-CMCI

– False or absent: ME does not support SOR-CMCI

provisioningTime

DateTime

M

1

Point in time of provisioning

ueUpdateStatus

UeUpdateStatus

M

1

status of the UPU data update procedure

upuXmacIue

UpuMac

C

0..1

String containing UPU-XMAC-IUE as specified in 3GPP TS 33.501 [9]. Shall be present if UeUpdateStatus is "WAITING_FOR_ACK" or "ACK_RECEIVED".

upuMacIue

UpuMac

C

0..1

String containing UPU-MAC-IUE as specified in 3GPP TS 33.501 [9]. Shall be preset if UeUpdateStatus is "ACK_RECEIVED".

provisioningTime

DateTime

M

1

Point in time of provisioning

ueUpdateStatus

UeUpdateStatus

M

1

status of the Nssai update procedure

provisioningTime

DateTime

M

1

Point in time of provisioning

ueUpdateStatus

UeUpdateStatus

M

1

status of the Cag update procedure

amfInstanceId

NfInstanceId

M

1

InstanceId of the AMF to which the subscription was sent

subscriptionId

Uri

M

1

The Subscription Id allocated by the AMF as received by the UDM in the HTTP "Location" header of the Namf_EventExposure_Subscribe response

subsChangeNotifyCorrelationId

string

O

1

The Correlation Id allocated by the UDM and sent to the AMF for correlation of subscriptionId-change-notifications

contextInfo

ContextInfo

O

0..1

This IE if present may contain e.g. the headers sent/received by the UDM during AMF Event Exposure subscription.

restrictedEventTypes

array(EventType)

O

1..N

List of the event types that are restricted (if any) for the UE.

The absence of this IE indicates that all event types are authorized for the UE.

supportedFeatures

SupportedFeatures

O

0..1

allowedMtcProvider

map(array(MtcProvider))

O

1..N(1..M)

A map (list of key-value pairs where EventType (see 3GPP TS 29.503 [6] serves as key) of MTC Provider.
In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry which contains a list of MtcProviders that are allowed monitoring all Event Types.

The absence of this IE indicates that monitoring by any MTC provider is allowed for any non restricted event type.

iwkEpcRestricted

boolean

O

0..1

If set to True, indicates that interworking with EPC is restricted. Set to False or not present means that the UE is not restriceted in the EPC.

imsi

string

O

0..1

This IE contains the IMSI of the UE and should be present if the iwkEpcRestricted attribute is not set to True.

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

hssGroupId

NfGroupId

O

0..1

Identity of the HSS group associated with the subscription that might be used by the UDM to discover the HSS; see 3GPP TS 29.510 [19]. This attribute may be present if the iwkEpcRestricted attribute is not present or present and set to False.

amf3Gpp

Amf3GppAccessRegistration

O

0..1

AMF 3GPP Access registration

amfNon3Gpp

AmfNon3GppAccessRegistration

O

0..1

AMF Non 3GPP Access registration

sdmSubscriptions

array(SdmSubscription)

O

1..N

SDM-Subscriptions

eeSubscriptions

array(EeSubscription)

O

1..N

Event Exposure Subscriptions

smsf3GppAccess

SmsfRegistration

O

0..1

SMSF 3GPP Access registration

smsfNon3GppAccess

SmsfRegistration

O

0..1

SMSF Non 3GPP Access registration

subscriptionDataSubscriptions

array(SubscriptionDataSubscriptions)

O

1..N

This attribute contain the Subscription Data Subscriptions (subs-to-notify) associated with the Notification.

smfRegistrations

SmfRegList

O

0..1

SMF Registrations

ipSmGw

IpSmGwRegistration

O

0..1

IP-SM-GW Registration

roamingInfo

RoamingInfoUpdate

O

0..1

Roaming Information

peiInfo

PeiUpdateInfo

O

0..1

PEI Information

sqnScheme

SqnScheme

M

1

The scheme used to generate the sequence numbers, as described in 3GPP TS 33.102 [10], clause C.1.1.

sqn

string

C

0..1

A 48-bit hex string containing the SEQ part of SQN (most significant bits), as specified in 3GPP TS 33.102 [10], and where the IND part (least significant bits) is filled with 0’s.

When the sqnScheme is "TIME_BASED", the SEQ part (most significant bits) of this attribute contains the DIF value.

This IE may be absent, if it does not exist in UDR (e.g. right after the subscriber is provisioned); otherwise, it shall be present.

Pattern: ‘^[A-Fa-f0-9]{12}$’

lastIndexes

map(integer)

C

1..N

A map of integer values, where the key of the map is the type of node that is requesting the generation of an authentication vector in UDM, and the integer is the last used value of IND for the corresponding type of node.

The types of nodes currently defined are:

– "ausf"

– "vlr"

– "sgsn"

– "s-cscf"

– "bsf",

– "gan-aaa-server"

– "wlan-aaa-server"

– "mme"

This IE may be absent, if it does not exist in UDR (e.g. right after the subscriber is provisioned); otherwise, it shall be present.

indLength

integer

O

1

Number of bits of the IND part of SQN. The length of the SEQ part is, therefore, (48 – indLength) bits.

If not present, the default value is 5.

difSign

Sign

O

1

Sign of the DIF value. It is applicable when the sqnScheme is "TIME_BASED".

If not present, the default value is "NEGATIVE".

mwdList

array(SmscData)

O

1..N

List of addresses of SM-Service Center entities with SMS wating to be delivered to the UE.

smscMapAddress

E164Number

C

0..1

International E.164 number of the SM-SC; it shall be present if the SM-SC supports the MAP protocol.

smscDiameterAddress

NetworkNodeDiameterAddress

C

0..1

Diameter Identity of the SM-SC; it shall be present if the SM-SC supports the Diameter protocol.

NOTE: At least one of the properties, smscMapAddress or smscDiameterAddress, shall be present.

smfSubscriptionList

array(SmfSubscriptionItem)

M

1..N

List of SmfSubscriptionItem objects

smfInstanceId

NfInstanceId

M

1

InstanceId of the SMF to which the subscription was sent

subscriptionId

Uri

M

1

The Subscription Id allocated by the SMF as received by the UDM in the HTTP "Location" header of the Nsmf_EventExposure_Subscribe response

contextInfo

ContextInfo

O

0..1

This IE if present may contain e.g. the headers received by the UDM along with consuming Nsmf_EventExposure_Subscribe service operation.

mtcProviderInformation

MtcProviderInformation

O

0..1

Indicates MTC provider information for Monitoring Configuration authorization.

afId

string

O

0..1

ID of the AF. The string identifying the originating AF, formatted as described in the definition of type MonitoringConfiguration in 3GPP TS 29.503 [6].

hssSubscriptionList

array(HssSubscriptionItem)

M

1..N

List of hssSubscriptionItem objects

hssInstanceId

NfInstanceId

M

1

InstanceId of the HSS to which the subscription was sent.

subscriptionId

Uri

M

1

The Subscription Id allocated by the HSS as received by the UDM in the HTTP "Location" header of the Nhss_EventExposure_Subscribe response or the Nhss_SDM_Subscribe response.

contextInfo

ContextInfo

O

0..1

This IE if present may contain e.g. the headers received by the UDM along with consuming Nhss_EventExposure_Subscribe service operation or the Nhss_SDM_Subscribe response.

restrictedEventTypes

array(EventType)

O

1..N

List of the event types that are restricted (if any) for the group.

The absence of this IE indicates that all event types are authorized for the group.

allowedMtcProvider

map(array(MtcProvider))

O

1..N

A map (list of key-value pairs where EventType (see 3GPP TS 29.503 [6] serves as key) of MTC Provider.

In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry which contains a list of MtcProviders that are allowed monitoring all Event Types.

The absence of this IE indicates that monitoring by any MTC provider is allowed for any non restricted event type.

supportedFeatures

SupportedFeatures

O

0..1

iwkEpcRestricted

boolean

O

0..1

If set to True, indicates that interworking with EPC is restricted. Set to False or not present means that the UE is not restricted in the EPC.

extGroupId

string

O

0..1

This IE contains the External Group Identifier and should be present if the iwkEpcRestricted attribute is not set to True.

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

hssGroupId

NfGroupId

O

0..1

Identity of the HSS group associated with the subscription that might be used by the UDM to discover the HSS; see 3GPP TS 29.510 [19]. This attribute may be present if the iwkEpcRestricted attribute is not present or present and set to False.

allowedMtcProviders

map(array(AllowedMtcProviderInfo))

O

1..N

A map (list of key-value pairs where ExtGroupId (see 3GPP TS 29.503 [6]) serves as key of a list of AllowedMtcProviderInfos which include MTC provider informations or AF IDs that are allowed to create, update and delete a 5G VN Group for the user using UDM ParameterProvision service.

In addition to defined external group identifier, the key value "ALL" may be used to identify a map entry which contains a list of AllowedMtcProviderInfos that are allowed operating all the external group identifiers.

The absence of this IE indicates that all the MTC Providers and AFs are authorized to create, update and delete any 5G VN Group.

supportedFeatures

SupportedFeatures

O

0..1

allowedMtcProviders

map(array(AllowedMtcProviderInfo))

O

1..N

A map (list of key-value pairs where PpDataType (see 5.4.3.10) serves as key of a list of AllowedMtcProviderInfos which include MTC provider informations or AF IDs that are allowed to provision the parameters for the user using UDM ParameterProvision service.

In addition to defined external group identifier, the key value "ALL" may be used to identify a map entry which contains a list of AllowedMtcProviderInfos that are allowed provisioning all types of PP data.

The absence of this IE indicates that all the MTC Providers and AFs are authorized to provision all types of PP data for the UE

supportedFeatures

SupportedFeatures

O

0..1

mtcProviderInformation

MtcProviderInformation

C

0..1

Indicates MTC provider information for Parameters Provision authorization.

afId

string

C

0..1

Indicates ID of the AF for Parameters Provision authorization.

The string identifying the originating AF, formatted as described in the definition of type MonitoringConfiguration in 3GPP TS 29.503 [6].

extGroupId

ExtGroupId

C

0..1

This IE shall contain the External Group ID associated to the provided Internal Group ID.

intGroupId

GroupId

C

0..1

This IE shall contain the Internal Group ID associated to the provided External Group ID..

ueIdList

array(UeId)

C

1..N

This IE shall contain a list of the UE identifiers that belong to the provided Internal/External Group ID if they are required.

allowedAfIds

array(string)

O

1..N

A list of Application Function Identifiers authorized to retrieve this Identities lists. The absence of this IE indicates that any AF is allowed to retrieve them.

authorizationData

array(UserIdentifier)

M

1..N

May contain a single value or list of (SUPI and GPSI). Contains unique items.

allowedDnnList

array(Dnn)

O

0..N

List of the allowed DNNs that this user can use for NIDD or other specific service

allowedSnssaiList

array(Snssai)

O

0..N

List of the allowed SNSSAIs that this user can use for NIDD or other specific service

allowedMtcProviders

array(AllowedMtcProviderInfo)

O

0..N

List of AllowedMtcProviderInfos which include MTC provider informations or AF IDs that are allowed for NIDD or other specific service

validityTime

DateTime

O

0..1

Indicates the granted validity time of the AuthorizationData. Absence indicates permanent validity.

niddAuthorizationList

array(AuthorizationInfo)

M

1..N

List of NiddAuthorizationInfo items

ppDataEntryList

array(PpDataEntry)

O

0..N

List of the Entries under the Provisioned Parameter Data store for a UE.

supportedFeatures

SupportedFeatures

O

0..1

Contains SupportedFeatures.

amData

AccessAndMobilitySubscriptionData

O

0..1

Access and Mobility Subscription Data for the serving PLMN

smfSelData

SmfSelectionSubscriptionData

O

0..1

SMF Selection Subscription Data for the serving PLMN

smsSubsData

SmsSubscriptionData

O

0..1

SMS Subscription Data for the serving PLMN

smData

SmSubsData

O

0..1

Session Management Subscription Data

traceData

TraceData

O

0..1

Trace Data for the serving PLMN. The Null value indicates that trace is not active.

smsMngData

SmsManagementSubscriptionData

O

0..1

SMS Management Subscription Data for the serving PLMN

lcsPrivacyData

LcsPrivacyData

O

0..1

LCS Privacy Subscription Data

lcsMoData

LcsMoData

O

0..1

LCS Mobile Originated Subscription Data

lcsBcaData

LcsBroadcastAssistanceTypesData

O

0..1

LCS Broadcast Assistance Subscription Data for the serving PLMN

v2xData

V2xSubscriptionData

O

0..1

V2X Subscription Data

proseData

ProseSubscriptionData

O

0..1

ProSe service Subscription Data

odbData

OdbData

O

0..1

Operator Determined Barring Subscription Data

eeProfileData

EeProfileData

O

0..1

Event Exposure Profile Data

ppProfileData

PpProfileData

O

0..1

Parameter Provisioning Profile Data

niddAuthData

AuthorizationData

O

0..1

NIDD Authorization Data

ucData

UcSubscriptionData

O

0..1

User Consent Data

mbsSubscriptionData

MbsSubscriptionData

O

0..1

5MBS Subscription Data

serviceSpecificAuthorizationList

array(AuthorizationInfo)

M

1..N

List of ServiceSpecificAuthorizationInfo items

nfType

NFType

M

1

NF Type as defined in 3gpp TS 29.510.

nfInstanceId

NfInstanceId

O

0..1

Instance ID of the NF as defined in 3GPP TS 29.571.

EeSubscription

1

see 3GPP TS 29.503 [6]

AdditionalEeSubsInfo

0..1

EeSubscriptionExt

amfSubscriptionInfoList

array(AmfSubscriptionInfo)

O

1..2

List AMF subscription info
May be present on Nudr in GET response messages

EeSubscriptionExt

smfSubscriptionInfo

SmfSubscriptionInfo

O

0..1

SMF subscription info
May be present on Nudr in GET response messages

EeSubscriptionExt

hssSubscriptionInfo

HssSubscriptionInfo

O

0..1

HSS subscription info
May be present on Nudr in GET response messages

EeSubscriptionExt

ProvisionedDataSets

1

UE based provisioned data sets.

array(SharedData)

1..N

Shared subscription data sets that need to be monitored in SubscriptionDataSubscription.

VarUeGroupId

string

String identifying an external Group of UEs or any UE.

Pattern: ‘^(extgroupid-[^@]+@[^@]+|anyUE)$’

VarPlmnId

string

String identifying a PLMN ID or an SNPN ID.

Pattern: ‘^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$’

"5G_AKA"

5G AKA

"EAP_AKA_PRIME"

EAP AKA’

"EAP-TLS"

EAP TLS

"EAP_TTLS"

EAP TTLS

"NONE"

No specific EAP method type is signalled.

"AM"

Access and Mobility Subscription Data

"SMF_SEL"

SMF Selection Subscription Data

"SMS_SUB"

SMS Subscription Data

"SM"

Session Management Subscription Data

"TRACE"

Trace Data

"SMS_MNG"

SMS Management Subscription Data

"LCS_PRIVACY"

LCS Privacy Subscription Data

"LCS_MO"

LCS Mobile Originated Subscription Data

"LCS_BCA"

LCS Broadcast Assistance Subscription Data

"V2X"

V2X Subscription Data

"PROSE"

ProSe service Subscription Data

"ODB"

Operator Determined Barring Subscription Data

"EE_PROF"

Event Exposure Profile Data

"PP_PROF"

Parameter Provisioning Profile Data

"NIDD_AUTH"

NIDD Authorization Data

"USER_CONSENT"

User Consent Data

"MBS"

5MBS Subscription Data

"AMF_3GPP"

AMF 3GPP Access Registration

"AMF_NON_3GPP"

SMF Non 3GPP Access Registration

"SDM SUBSCRIPTIONS"

SDM Subscriptions

"EE_SUBSCRIPTIONS"

EE Subscriptions

"SMSF_3GPP"

SMSF 3GPP Access Registration

"SMSF_NON_3GPP"

SMSF Non 3GPP Access Registration

"SUBS_TO_NOTIFY"

UDR Subscriptions

"SMF_REG"

SMF Registrations

"IP_SM_GW"

IP-SM-GW Registration

“ROAMING_INFO”

Roaming Information

“PEI_INFO”

PEI information

"GENERAL"

Scheme for generation of Sequence Numbers (partially time-based), as described in 3GPP TS 33.102 [10], clause C.1.1.1

"NON_TIME_BASED"

Scheme for generation of Sequence Numbers (non-time-based), as described in 3GPP TS 33.102 [10], clause C.1.1.2

"TIME_BASED"

Scheme for generation of Sequence Numbers (entirely time-based), as described in 3GPP TS 33.102 [10], clause C.1.1.3

NOTE: These schemes for Sequence Number generation are documented in an informative Annex in 3GPP TS 33.102 [10]; having these different schemes listed in this Enumeration type does not imply that UDM implementations are required to support all of them; the Sequence Number generation schemes that need to be supported by UDM is deployment-specific.

"POSITIVE"

"NEGATIVE"

"NOT_SENT"

SOR data update / UPU data update / NSSAI update / CAG update has not been sent to the AMF e.g. because no AMF was registered at provisioning time

"SENT_NO_ACK_REQUIRED"

SOR data update / UPU data update has been sent to the AMF; Acknowledgement was not requested

This state is not applicable for NSSAI update / CAG update

"WAITING_FOR_ACK"

SOR data update has been sent to the AMF; Acknowledgement has been requested. In this state sorXmacIue shall be present;
or
UPU data update has been sent to the AMF; Acknowledgement has been requested. In this state upuXmacIue shall be present;
or
NSSAI has been sent to the AMF
or
CAG has been sent to the AMF.

"ACK_RECEIVED"

SOR data update has been acknowledged by the UE. In this state sorXmacIue and sorMacIue shall be present;
or
UPU data update has been acknowledged by the UE. In this state upuXmacIue and upuMacIue shall be present;
or
NSSAI data update has been acknowledged by the UE
or
CAG data update has been acknowledged by the UE.

"NEGATIVE_ACK_RECEIVED"

SOR data update / UPU data update has been sent to the AMF, but could not be forwarded to the UE due to the UE not being reachable.

"COMMUNICATION_CHARACTERISTICS"

Communication Characteristics Parameters

"EXPECTED_UE_BEHAVIOUR"

Expected UE Behaviour Parameters

"EC_RESTRICTION"

Enhanced Coverage Restriction Parameters

"ACS_INFO"

ACS Information

"TRACE"

Trace Data

"STN_SR"

Session Transfer Number for SRVCC

"LCS_PRIVACY"

LCS Privacy Parameters

"SOR_INFO"

Steering of Roaming information to be conveyed to a UE