5.2.1 Overview

29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data

Figure 5.2.1-1: Resource URI sub-level structure for subscription data

Figure 5.2.1-2: Resource URI sub-level structure for subscription data (cont.)

Figure 5.2.1-3: Resource URI sub-level structure for subscription data (cont.)

Table 5.2.1-1 provides an overview of the resources, applicable HTTP methods and whether subscribe (implicit and explicit) to be notified about data change applies.

Table 5.2.1-1: Resources and methods overview

Resource name

Resource URI

Subscribe to be notified about data change supported

HTTP method

Description

AuthenticationSubscription

(Document)

/subscription-data/{ueId}/authentication-data/authentication-subscription

N

GET

Retrieve a UE’s authentication subscription data

PATCH

Update a UE’s authentication subscription data

Updates shall be limited to the sequenceNumber attribute. Attempts to patch any other attribute shall be rejected by the UDR.

AuthenticationSoR

(Document)

/subscription-data/{ueId}/ue-update-confirmation-data/sor-data

Y

PUT

Store UE’s SOR acknowledgement information (SoR-XMAC-IUE) and "ME support of SOR-CMCI"

GET

Retrieve UE’s SoR acknowledgement information, "ME support of SOR-CMCI"

PATCH

Update "ME support of SOR-CMCI"

AuthenticationUPU

(Document)

/subscription-data/{ueId}/ue-update-confirmation-data/upu-data

Y

PUT

Store UE Parameter Update acknowledgement information (UPU-XMAC-IUE)

GET

Retrieve UE Parameter Update acknowledgement information

SubscribedSNSSAIs

(Document)

/subscription-data/{ueId}/ue-update-confirmation-data/subscribed-snssais

Y

PUT

Store UE-acknowledgement info for change of subscribed S-NSSAIs

GET

Retrieve UE-acknowledgement info for change of subscribed S-NSSAIs

SubscribedCAG

(Document)

/subscription-data/{ueId}/ue-update-confirmation-data/subscribed-cag

Y

PUT

Store UE-acknowledgement info for change of subscribed CAG

GET

Retrieve UE-acknowledgement info for change of subscribed CAG

AuthenticationStatus

(Document)

/subscription-data/{ueId}/authentication-data/authentication-status

N

PUT

Store a UE’s authentication status

GET

Retrieve a UE’s authentication status

DELETE

Delete a UE’s authentication status

IndividualAuthenticationStatus

(Document)

/subscription-data/{ueId}/authentication-data/authentication-status/{servingNetworkName}

Y

PUT

When the feature "PerUePerSnAuthStatus" is supported, store a UE’s Individual authentication status

GET

When the feature "PerUePerSnAuthStatus" is supported, retrieve a UE’s Individual authentication status

DELETE

When the feature "PerUePerSnAuthStatus" is supported, delete a UE’s Individual authentication status

ProvisionedData

(Document)

/subscription-data/{ueId}/{servingPlmnId}/provisioned-data

N

GET

Retrieve the UE’s subscribed Provisioned Data

AccessAndMobilitySubscriptionData

(Document)

/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/am-data

Y

GET

Retrieve the UE’s subscribed Access and Mobility Data

SmfSelectionSubscriptionData

(Document)

/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/smf-selection-subscription-data

Y

GET

Retrieve the UE’s subscribed SMF Selection Data

SessionManagementSubscriptionData

(Document)

/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sm-data

Y

GET

Retrieve the UE’s subscribed SM Subscription Data

ContextData

(Document)

/subscription-data/{ueId}/context-data

N

GET

Retrieve the UE’s context Data

Amf3GppAccessRegistration

(Document)

/subscription-data/{ueId}/context-data/amf-3gpp-access

Y

PUT

Create and Update the AMF registration for 3GPP access

PATCH

Modify the AMF registration for 3GPP access

GET

Retrieve the AMF registration information for 3GPP access

AmfNon3GppAccessRegistration

(Document)

/subscription-data/{ueId}/context-data/amf-non-3gpp-access

Y

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)

/subscription-data/{ueId}/context-data/smf-registrations

Y

GET

Retrieve the list of the SMF registrations

IndividualSmfRegistration

(Document)

/subscription-data/{ueId}/context-data /smf-registrations/{pduSessionId}

Y

PUT

Store an individual SMF registration identified by PDU Session Id

DELETE

Delete an individual SMF registration

GET

Retrieve individual SMF registration

PATCH

Modify the individual SMF registration

OperatorSpecificData

(Document)

/subscription-data/{ueId}/operator-specific-data

Y

GET

retrieve the operator specific subscription data of a UE

PATCH

modify the operator specific subscription data of a UE

PUT

create/update the operator specific subscription data of a UE

DELETE

delete the operator specific subscription data of a UE

OperatorDeterminedBarringData

(Document)

/subscription-data/{ueId}/operator-determined-barring-data

Y

GET

Retrieve the UE’s Operator Determined Barring

SMSManagementSubscriptionData

(Document)

/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-mng-data

Y

GET

Retrieve the UE’s subscribed SMS management subscription data.

Smsf3GppAccessRegistration

(Document)

/subscription-data/{ueId}/context-data /smsf-3gpp-access

Y

PUT

Create or Update the SMSF registration

DELETE

Delete the SMSF registration for 3GPP access

GET

Retrieve the SMSF registration information

SmsfNon3GppAccessRegistration

(Document)

/subscription-data/{ueId}/context-data /smsf-non-3gpp-access

Y

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

IpSmGwRegistration

(Document)

/subscription-data/{ueId}/context-data/ip-sm-gw

Y

PUT

Create or Update the IP-SM-GW registration

DELETE

Delete the IP-SM-GW registration

PATCH

Modify the IP-SM-GW registration

GET

Retrieve the IP-SM-GW registration information

MessageWaitingData

(Document)

/subscription-data/{ueId}/context-data/mwd

Y

PUT

Create or Update the SMS Message Waiting Data

DELETE

Delete the SMS Message Waiting Data

PATCH

Modify the SMS Message Waiting Data

GET

Retrieve the SMS Message Waiting Data

SdmSubscriptions

(Collection)

/subscription-data/{ueId}/context-data/sdm-subscriptions

N

GET

Retrieve SDM subscriptions

POST

Create an individual SDM subscription

IndividualSdmSubscription

(Document)

/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}

N

PUT

Update an individual SDM subscription

DELETE

Delete an individual SDM subscription

PATCH

Update an individual SDM Subscription

GET

Retrieve an individual SDM subscription

HssSdmSubscriptionInfo

(Document)

/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}/hss-sdm-subscriptions

N

PUT

Store information related to the Hss-SDM-Subscriptions

DELETE

Delete the Hss-SDM-subscriptions

GET

Retrieve Hss-SDM-subscriptions

PATCH

Update Hss-SDM-subscriptions

EeSubscriptions

(Collection)

/subscription-data/{ueId}/context-data/ee-subscriptions

N

GET

Retrieve EE subscriptions

POST

Create an EE subscription

IndividualEeSubscription

(Document)

/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}

N

PUT

Update an individual EE subscription

DELETE

Delete an individual EE subscription

PATCH

Update an individual EE subscription

GET

Retrieve an individual EE subscription

AmfSubscriptionInfo

(Document)

/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/amf-subscriptions

N

PUT

Store information related to the Amf-EE-Subscription response

DELETE

Delete the Amf-EE-subscriptions

GET

Retrieve AMF-subscriptions

PATCH

Update AMF-subscriptions

SmfSubscriptionInfo

(Document)

/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/smf-subscriptions

N

PUT

Store information related to the received Smf-EE-Subscription response

DELETE

Delete the Smf-EE-subscriptions

GET

Retrieve SMF-subscriptions

PATCH

Update SMF-subscriptions

HssSubscriptionInfo

(Document)

/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/hss-subscriptions

N

PUT

Store information related to the Hss-EE-Subscriptions

DELETE

Delete the Hss-EE-subscriptions

GET

Retrieve Hss-EE-subscriptions

PATCH

Update Hss-EE-subscriptions

EeProfileData

(Document)

/subscription-data/{ueId}/ee-profile-data

Y

GET

Retrieve the UE’s subscribed EE profile data.

ProvisionedParamenterData

(Document)

/subscription-data/{ueId}/pp-data

y

PATCH

Update of provisioned parameters.

GET

Retrieves the UE’s provisioned parameters.

PpProfileData

(Document)

/subscription-data/{ueId}/pp-profile-data

Y

GET

Retrieve the UE’s subscribed PP profile data.

ProvisionedParameterDataEntries

(Store)

/subscription-data/{ueId}/pp-data-store

Y

GET

Retrieve a Provisioned Parameter Data of multiple Entries

ProvisionedParameterDataEntry

(Document)

/subscription-data/{ueId}/pp-data-store/{afInstanceId}

Y

PUT

Create a Provisioned Parameter Data Entry

DELETE

Delete a Provisioned Parameter Data Entry

GET

Retrieve a Provisioned Parameter Data Entry

SMSSubscriptionData

(Document)

/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-data

Y

GET

Retrieve the UE’s subscribed SMS subscription data.

SubscriptionDataSubscriptions

(Collection)

/subscription-data/subs-to-notify

N

GET

Retrieve existing subscriptions

POST

Create a subscription, i.e. subscribe a node to receive notification for change of data

DELETE

Deletes multiple subscriptions for a given UE.

IndividualSubscriptionDataSubscription

(Document)

/subscription-data/subs-to-notify/{subsId}

N

DELETE

Delete the subscription identified by {subsId}, i.e. unsubscribe a node to receive notification for change of data

PATCH

Update an individual Subscription to notification

GET

Retrieve an individual Subscription to notification

EeGroupSubscriptions

(Collection)

/subscription-data/group-data/{ueGroupId}/ee-subscriptions

N

GET

Retrieve EE subscriptions for groups of UEs

POST

Create an EE subscription for groups of UEs

IndividualEeGroupSubscription

(Document)

/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}

N

PUT

Update an individual EE subscription for a group of UEs

DELETE

Delete an individual EE subscription for a group of UEs

PATCH

Update an individual EE subscription for a group of UEs

GET

Retrieve an individual EE subscription for a group of UEs

AmfGroupSubscriptionInfo

(Document)

/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/amf-subscriptions

N

PUT

Store information related to the Amf-EE-Subscription response for a group of UEs

DELETE

Delete the Amf-EE-subscriptions for a group of UEs

GET

Retrieve AMF-subscriptions for a group of UEs

PATCH

Update AMF-subscriptions for a group of UEs

SmfGroupSubscriptionInfo

(Document)

/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/smf-subscriptions

N

PUT

Store information related to the received Smf-EE-Subscription response for a group of UEs

DELETE

Delete the Smf-EE-subscriptions for a group of UEs

GET

Retrieve SMF-subscriptions for a group of UEs

PATCH

Update SMF-subscriptions for a group of UEs

HssGroupSubscriptionInfo

(Document)

/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/hss-subscriptions

N

PUT

Store information related to the Hss-EE-Subscriptions for a group of UEs

DELETE

Delete the Hss-EE-subscriptions for a group of UEs

GET

Retrieve Hss-EE-subscriptions for a group of UEs

PATCH

Update Hss-EE-subscriptions for a group of UEs

EeGroupProfileData

(Document)

/subscription-data/group-data/{ueGroupId}/ee-profile-data

Y

GET

Retrieve the subscribed EE profile data for a group of UEs.

TraceData

(Document)

/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/trace-data

Y

GET

Retrieve the UE’s trace configuration data

IdentityData

(Document)

/subscription-data/{ueId}/identity-data

Y

GET

Retrieve identity data that corresponds to the provided ueId

SharedData
(Collection)

/subscription-data/shared-data

N

GET

Retrieve shared data

IndividualSharedData
(Document)

/subscription-data/shared-data/{sharedDataId}

Y

GET

Retrieve the individual Shared Data

GroupIdentifiers

(Document)

/subscription-data/group-data/group-identifiers

Y

GET

Retrieve group identifiers and the UE identifiers belong to the group identifiers.

5GvnGroups

(Store)

/subscription-data/group-data/5g-vn-groups

Y

GET

Retrieve 5G VN Groups

Individual5GvnGroup

(Document)

/subscription-data/group-data/5g-vn-groups/{externalGroupId}

Y

PUT

Create a 5G VN Group

PATCH

Update a 5G VN Group

DELETE

Delete a 5G VN Group

GET

Retrieve a 5G VN Group

5GVnGroupsInternal

(Document)

/subscription-data/group-data/5g-vn-groups/internal

Y

GET

Retrieve 5G VN Group Data based on Internal Group Identifier(s)

Pp5gVnGroupProfileData

(Document)

/subscription-data/group-data/5g-vn-groups/pp-profile-data

Y

GET

Retrieve the UE’s subscribed PP profile data for accessing 5G VN Groups service operations.

LcsPrivacySubscriptionData

(Document)

/subscription-data/{ueId}/lcs-privacy-data

Y

GET

Retrieve the UE’s subscribed LCS privacy Subscription Data

LcsMobileOriginatedSubscriptionData

(Document)

/subscription-data/{ueId}/lcs-mo-data

Y

GET

Retrieve the UE’s subscribed LCS Mobile Originated Subscription Data

NiddAuthorizationData

(Document)

/subscription-data/{ueId}/nidd-authorization-data

Y

GET

Retrieve the UE’s NIDD Authorization Data

ServiceSpecificAuthorizationData

(Document)

/subscription-data/{ueId}/service-specific-authorization-data/{serviceType}

Y

GET

Retrieve the UE’s Authorization Data for a specific service

CoverageRestrictionData

(Document)

/subscription-data/{ueId}/coverage-restriction-data

Y

GET

Retrieve the UE’s subscribed enhanced Coverage Restriction Data

Location

(Document)

/subscription-data/{ueId}/context-data/location

Y

GET

Retrieve the UE’s Location Information

V2xSubscriptionData

(Document)

/subscription-data/{ueId}/v2x-data

Y

GET

Retrieve the UE’s subscribed V2X Data

ProseSubscriptionData

(Document)

/subscription-data/{ueId}/prose-data

Y

GET

Retrieve the UE’s subscribed ProSe Service Data

5MBSSubscriptionData

(Document)

/subscription-data/{ueId}/5mbs-data

Y

GET

Retrieve the UE’s 5MBS Subscription Data

UcSubscriptionData

(Document)

/subscription-data/{ueId}/uc-data

Y

GET

Retrieve the UE’s User Consent Data

LcsBroadcastAssistanceSubscriptionData

(Document)

/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/lcs-bca-data

Y

GET

Retrieve the UE’s subscribed LCS Broadcast Assistance subscription data

NiddAuthorizations

(Document)

/subscription-data/{ueId}/context-data/nidd-authorizations

Y

PUT

Store information related to the NIDD Authorization

DELETE

Delete the NIDD Authorizations

GET

Retrieve NIDD Authorizations

PATCH

Update a specific NIDD Authorization

UeSubscriptionData

(Document)

/subscription-data/{ueId}

N

GET

Retrieve data set(s) from the UE’s subscription data

SpecificServiceAuthorizations

(Document)

/subscription-data/{ueId}/context-data/service-specific-authorizations/{serviceType}

Y

PUT

Store information related to the service specific Authorization

DELETE

Delete the service specific Authorization

GET

Retrieve service specific Authorizations

PATCH

Update a service specific Authorization

RoamingInfo

(Document)

/subscription-data/{ueId}/context-data/roaming-information

Y

GET

Retrieve the last 5GC/EPC common Roaming Information in the 3GPP access

PUT

Update or create the last 5GC/EPC common Roaming Information in the 3GPP access

PeiInfo

(Document)

/subscription-data/{ueId}/context-data/ pei-info

Y

GET

Retrieve the PEI of the 5GC/EPC domains

PUT

Update or create the PEI of the 5GC/EPC domains