5.2.23 Resource: IdentityData
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
5.2.23.1 Description
This resource represents the identity data. It is queried by the UDM by GPSI or SUPI.
5.2.23.2 Resource Definition
Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/identity-data
This resource shall support the resource URI variables defined in table 5.2.23.2-1.
Table 5.2.23.2-1: Resource URI variables for this resource
|
Name |
Definition |
|
apiRoot |
See clause 6.1.1 |
|
ueId |
Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) |
5.2.23.3 Resource Standard Methods
5.2.23.3.1 GET
This method shall support the URI query parameters specified in table 5.2.23.3.1-1.
Table 5.2.23.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
app-port-id |
AppPortId |
O |
0..1 |
Application port identity, see 3GPP TS 23.501 [4] clause 4.4.7 |
This method shall support the request data structures specified in table 5.2.23.3.1-2 and the response data structures and response codes specified in table 5.2.23.3.1-3.
Table 5.2.23.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.2.23.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
IdentityData |
M |
1 |
200 OK |
Upon success, a response body containing the identity data that corresponds to the provided ueId |
|
ProblemDetails |
O |
0..1 |
404 Not Found |
If the ueId does not exist, a response code of 404 Not Found shall be returned. The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND |
|
NOTE: In addition, common data structures as listed in table 5.5-1 are supported. |
||||