5.2.2 Resource: AuthenticationSubscription

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

5.2.2.1 Description

This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]).

NOTE 1: This resource contains security-sensitive attributes, such as the long-term key of the UE (see "encPermanentKey" attribute of the AuthenticationSubscription data type in clause 5.4.2.2). Read/write access can be authorized by means of OAuth2.

NOTE 2: Although these security-sensitive attributes are stored in an encrypted form in the UDR, operators can consider its storage separately from other types of subscription data. How to achieve this in a secure way is implementation-specific; a description of a typical mechanism can be found in the informative Annex X in 3GPP TS 29.500 [8].

5.2.2.2 Resource Definition

Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/authentication-data/authentication-subscription

This resource shall support the resource URI variables defined in table 5.2.2.2-1.

Table 5.2.2.2-1: Resource URI variables for this resource

Name	Definition
apiRoot	See 3GPP TS 29.504 [2] clause 6.1.1
ueId	Represents the Subscription Identifier of the UE. It may be the SUPI (see 3GPP TS 23.501 [4], clause 5.9.2) of the UE or a pseudonym in SUPI format (e.g. the GLI or GCI of the UE; see 3GPP TS 23.316 [18], clauses 4.7.3 and 4.7.4). Pattern: See pattern of type Supi in 3GPP TS 29.571 [3].

5.2.2.3 Resource Standard Methods

5.2.2.3.1 GET

This method shall support the URI query parameters specified in table 5.2.2.3.1-1.

Table 5.2.2.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [8] clause 6.6

This method shall support the request data structures specified in table 5.2.2.3.1-2 and the response data structures and response codes specified in table 5.2.2.3.1-3.

Table 5.2.2.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.2.2.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
AuthenticationSubscription	M	1	200 OK	Upon success, a response body containing the AuthenticationSubscription shall be returned.
NOTE: In addition common data structures as listed in table 5.5-1 are supported.

5.2.2.3.2 PATCH

This method is used to modify the authentication data of UE in the UDR.

This method shall support the URI query parameters specified in table 5.2.2.3.2-1.

Table 5.2.2.3.2-1: URI query parameters supported by the PATCH method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [8] clause 6.6

This method shall support the request data structures specified in table 5.2.2.3.2-2 and the response data structures and response codes specified in table 5.2.2.3.2-3.

Table 5.2.2.3.2-2: Data structures supported by the PATCH Request Body on this resource

Data type	P	Cardinality	Description
array(PatchItem)	M	1..N	Contains the delta data to the authentication subscription of a UE

Table 5.2.2.3.2-3: Data structures supported by the PATCH Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Upon successful modification there is no body in the response message. (NOTE 2)
PatchResult	M	1	200 OK	Upon success, the execution report is returned. (NOTE 2)
ProblemDetails	O	0..1	403 Forbidden	If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modifiedand the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1.
NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR 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 UDR shall respond with PatchResult.