7.6 Key management APIs
29.5493GPPApplication Programming Interface (API) specificationRelease 18Service Enabler Architecture Layer for Verticals (SEAL)Stage 3TS
7.6.1 SS_KeyInfoRetrieval API
7.6.1.1 API URI
The request URI used in each HTTP request from the VAL server towards the Key management server shall have the structure as defined in clause 6.5 with the following clarifications:
– The <apiName> shall be "ss-kir".
– The <apiVersion> shall be "v1".
– The <apiSpecificSuffixes> shall be set as described in clause 7.6.1.2.
7.6.1.2 Resources
7.6.1.2.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 7.6.1.2.1-1 depicts the resource URIs structure for the SS_KeyInfoRetrieval API.
Figure 7.6.1.2.1-1: Resource URI structure of the SS_KeyInfoRetrieval API
Table 7.6.1.2.1-1 provides an overview of the resources and applicable HTTP methods.
Table 7.6.1.2.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
Key records |
/key-records |
GET |
Retrieve key management information uniquely applicable to VAL service, VAL user or VAL UE. |
7.6.1.2.2 Resource: Key Records
7.6.1.2.2.1 Description
The Key Records resource represents the key management information of all VAL services that are created at a given key management server.
7.6.1.2.2.2 Resource Definition
Resource URI: {apiRoot}/ss-kir/<apiVersion>/key-records
This resource shall support the resource URI variables defined in the table 7.6.1.2.2.2-1.
Table 7.6.1.2.2.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause 6.5 |
7.6.1.2.2.3 Resource Standard Methods
7.6.1.2.2.3.1 GET
This operation retrieves VAL service key management information satisfying the filter criteria. This method shall support the URI query parameters specified in table 7.6.1.2.2.3.1-1.
Table 7.6.1.2.2.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
val-tgt-ue |
ValTargetUe |
O |
0..1 |
Identifying a VAL user or a VAL UE. |
|
val-service-id |
string |
M |
1 |
String identifying a VAL service. |
This method shall support the request data structures specified in table 7.6.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.6.1.2.2.3.1 -3.
Table 7.6.1.2.2.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 7.6.1.2.2.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
ValKeyInfo |
M |
1 |
200 OK |
Key management information specific to VAL service, VAL user or VAL UE. This response shall include key management information matching the query parameters provided in the request. |
|
n/a |
307 Temporary Redirect |
Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative key management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative key management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. |
||
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. |
||||
Table 7.6.1.2.2.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative key management server. |
Table 7.6.1.2.2.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative key management server. |
7.6.1.2.2.4 Resource Custom Operations
None.
7.6.1.3 Notifications
None.
7.6.1.4 Data Model
7.6.1.4.1 General
This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API.
Table 7.6.1.4.1-1 specifies the data types defined specifically for the SS_KeyInfoRetrieval API service.
Table 7.6.1.4.1-1: SS_KeyInfoRetrieval API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
ValKeyInfo |
7.6.1.4.2.3 |
Key management information associated with VAL server, VAL user or VAL UE. |
Table 7.6.1.4.1-2 specifies data types re-used by the SS_KeyInfoRetrieval API service.
Table 7.6.1.4.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
ValTargetUe |
Clause 7.3.1.4.2.3 |
Used to identify a VAL User ID or VAL UE ID applicable to key management information. |
7.6.1.4.2 Structured Data Types
7.6.1.4.2.1 Introduction
7.6.1.4.2.2 ValKeyInfo
Table 7.6.1.4.2.3-1: Definition of type ValKeyInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
userUri |
Uri |
M |
1 |
URI of the user for which the response is intended. |
|
|
skmsId |
string |
O |
0..1 |
String identifying the SEAL key management server, sending the response. |
|
|
valService |
string |
M |
1 |
String identifying the VAL service. This attribute shall be same as in the HTTP GET request. |
|
|
valTgtUe |
ValTargetUe |
O |
0..1 |
String identifying a VAL user or VAL UE. This value depends on the value that was in the HTTP GET request. |
|
|
keyInfo |
string |
M |
1 |
Key management information uniquely applicable to the requested VAL service, VAL user or VAL UE or VAL client. |
7.6.1.4.3 Simple data types and enumerations
None.
7.6.1.5 Error Handling
7.6.1.5.1 General
HTTP error handling shall be supported as specified in clause 6.7.
In addition, the requirements in the following clauses shall apply.
7.6.1.5.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the SS_KeyInfoRetrieval API.
7.6.1.5.3 Application Errors
The application errors defined for SS_KeyInfoRetrieval API are listed in table 7.6.1.5.3-1.
Table 7.6.1.5.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
Applicability |
7.6.1.6 Feature Negotiation
General feature negotiation procedures are defined in clause 6.8.
Table 7.6.1.6-1: Supported Features
|
Feature number |
Feature Name |
Description |