5.2.24A Resource: IndividualAuthenticationStatus
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
5.2.24A.1 Description
This resource is used to represent individual Authentication Status to be stored in the UDR.
This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]).
5.2.24A.2 Resource Definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/authentication-data/authentication-status/{servingNetworkName}
This resource shall support the resource URI variables defined in table 5.2.24A.2-1.
Table 5.2.24A.2-1: Resource URI variables for this resource
Name |
Definition |
apiRoot |
See clause 6.4.1 |
ueId |
Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2) |
servingNetworkName |
Represents the Serving Network Name. pattern: See pattern of type ServingNetworkName in 3GPP TS 29.503 [6] |
5.2.24A.3 Resource Standard Methods
5.2.24A.3.1 PUT
This method shall support the URI query parameters specified in table 5.2.24A.3.1-1.
Table 5.2.24A.3.1-1: URI query parameters supported by the PUT method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 5.2.24A.3.1-2 and the response data structures and response codes specified in table 5.2.24A.3.1-3.
Table 5.2.24A.3.1-2: Data structures supported by the PUT Request Body on this resource
Data type |
P |
Cardinality |
Description |
AuthEvent |
M |
1 |
To store the authentication status of the UE. |
Table 5.2.24A.3.1-3: Data structures supported by the PUT Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
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.5-1 are supported. |
5.2.24A.3.2 GET
This method shall support the URI query parameters specified in table 5.2.24A.3.2-1.
Table 5.2.24A.3.2-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
P |
Cardinality |
Description |
fields |
array(string) |
C |
1..N |
When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. |
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.24A.3.2-2 and the response data structures and response codes specified in table 5.2.24A.3.2-3.
Table 5.2.24A.3.2-2: Data structures supported by the GET Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.2.24A.3.2-3: Data structures supported by the GET Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
AuthEvent |
M |
1 |
200 OK |
Upon success, a response body containing the AuthEvent shall be returned. |
NOTE: In addition common data structures as listed in table 5.5-1 are supported. |
5.2.24A.3.3 DELETE
This method shall support the URI query parameters specified in table 5.2.24A.3.3-1.
Table 5.2.24A.3.3-1: URI query parameters supported by the DELETE method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 5.2.24A.3.3-2 and the response data structures and response codes specified in table 5.2.24A.3.3-3.
Table 5.2.24A.3.3-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.2.24A.3.3-3: Data structures supported by the DELETE Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
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.5-1 are supported. |