Tech-
invite
3GPP
space
IETF
space
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TS 29.559
Word version: 18.3.0
1…
5…
5
Services offered by the 5G PKMF
5.1
Introduction
5.2
Npkmf_PKMFKeyRequest Service
5.3
Npkmf_ResolveRemoteUserId Service
5.4
Npkmf_ Discovery Service
6
API Definitions
6.1
Npkmf_PKMFKeyRequest Service API
6.2
Npkmf_ResolveRemoteUserId Service API
6.3
Npkmf_Discovery Service API
A
OpenAPI specification
A.1
General
A.2
Npkmf_PKMFKeyRequest API
A.3
Npkmf_ResolveRemoteUserId API
A.4
Npkmf_Discovery API
$
Change history
5
Services offered by the 5G PKMF
p. 8
5.1
Introduction
p. 8
5.2
Npkmf_PKMFKeyRequest Service
p. 9
5.2.1
Service Description
p. 9
5.2.2
Service Operations
p. 9
5.2.2.1
Introduction
p. 9
5.2.2.2
ProseKey
p. 9
5.2.2.2.1
General
p. 9
5.3
Npkmf_ResolveRemoteUserId Service
p. 10
5.3.1
Service Description
p. 10
5.3.2
Service Operations
p. 11
5.3.2.1
Introduction
p. 11
5.3.2.2
Retrieve
p. 11
5.3.2.2.1
General
p. 11
5.4
Npkmf_ Discovery Service
p. 11
5.4.1
Service Description
p. 11
5.4.2
Service Operations
p. 12
5.4.2.1
Introduction
p. 12
5.4.2.2
AnnounceAuthorize
p. 12
5.4.2.2.1
General
p. 12
5.4.2.3
MonitorKey
p. 12
5.4.2.3.1
General
p. 12
5.4.2.4
DiscoverKey
p. 13
5.4.2.4.1
General
p. 13
6
API Definitions
p. 14
6.1
Npkmf_PKMFKeyRequest Service API
p. 14
6.1.1
Introduction
p. 14
6.1.2
Usage of HTTP
p. 14
6.1.2.1
General
p. 14
6.1.2.2
HTTP standard headers
p. 14
6.1.2.2.1
General
p. 14
6.1.2.2.2
Content type
p. 14
6.1.2.3
HTTP custom headers
p. 15
6.1.3
Resources
p. 15
6.1.3.1
Overview
p. 15
6.1.3.2
Resource: ProSe Keys Collection
p. 15
6.1.3.2.1
Description
p. 15
6.1.3.2.2
Resource Definition
p. 15
6.1.3.2.3
Resource Standard Methods
p. 16
6.1.3.2.4
Resource Custom Operations
p. 16
6.1.3.2.4.1
Overview
p. 16
6.1.3.2.4.2
Operation: request
p. 16
6.1.3.2.4.2.1
Description
p. 16
6.1.3.2.4.2.2
Operation Definition
p. 16
6.1.4
Custom Operations without associated resources
p. 17
6.1.5
Notifications
p. 17
6.1.6
Data Model
p. 17
6.1.6.1
General
p. 17
6.1.6.2
Structured data types
p. 18
6.1.6.2.1
Introduction
p. 18
6.1.6.2.2
Type: ProseKeyReqData
p. 18
6.1.6.2.3
Type: ProseKeyRspData
p. 19
6.1.6.3
Simple data types and enumerations
p. 19
6.1.6.3.1
Introduction
p. 19
6.1.6.3.2
Simple data types
p. 19
6.1.6.4
Data types describing alternative data types or combinations of data types
p. 20
6.1.6.5
Binary data
p. 20
6.1.7
Error Handling
p. 20
6.1.7.1
General
p. 20
6.1.7.2
Protocol Errors
p. 21
6.1.7.3
Application Errors
p. 21
6.1.8
Feature negotiation
p. 21
6.1.9
Security
p. 21
6.1.10
HTTP redirection
p. 21
6.2
Npkmf_ResolveRemoteUserId Service API
p. 22
6.2.1
Introduction
p. 22
6.2.2
Usage of HTTP
p. 22
6.2.2.1
General
p. 22
6.2.2.2
HTTP standard headers
p. 22
6.2.2.2.1
General
p. 22
6.2.2.2.2
Content type
p. 22
6.2.2.3
HTTP custom headers
p. 22
6.2.3
Resources
p. 23
6.2.3.1
Overview
p. 23
6.2.4
Custom Operations without associated resources
p. 23
6.2.4.1
Overview
p. 23
6.2.4.2
Operation: resolve-id
p. 23
6.2.4.2.1
Description
p. 23
6.2.4.2.2
Operation Definition
p. 23
6.2.5
Notifications
p. 24
6.2.6
Data Model
p. 24
6.2.6.1
General
p. 24
6.2.6.2
Structured data types
p. 25
6.2.6.2.1
Introduction
p. 25
6.2.6.2.2
Type: ResolveRequest
p. 25
6.2.6.2.3
Type: ResolveResponse
p. 25
6.2.6.3
Simple data types and enumerations
p. 25
6.2.6.4
Data types describing alternative data types or combinations of data types
p. 25
6.2.6.5
Binary data
p. 25
6.2.7
Error Handling
p. 26
6.2.7.1
General
p. 26
6.2.7.2
Protocol Errors
p. 26
6.2.7.3
Application Errors
p. 26
6.2.8
Feature negotiation
p. 26
6.2.9
Security
p. 26
6.2.10
HTTP redirection
p. 26
6.3
Npkmf_Discovery Service API
p. 27
6.3.1
Introduction
p. 27
6.3.2
Usage of HTTP
p. 27
6.3.2.1
General
p. 27
6.3.2.2
HTTP standard headers
p. 27
6.3.2.2.1
General
p. 27
6.3.2.2.2
Content type
p. 27
6.3.2.3
HTTP custom headers
p. 28
6.3.3
Resources
p. 28
6.3.3.1
Overview
p. 28
6.3.3.2
Resource: AnnounceAuthorize
p. 29
6.3.3.2.1
Description
p. 29
6.3.3.2.2
Resource Definition
p. 29
6.3.3.2.3
Resource Standard Methods
p. 29
6.3.3.3
Resource: MonitorKey
p. 31
6.3.3.3.1
Description
p. 31
6.3.3.3.2
Resource Definition
p. 31
6.3.3.3.3
Resource Standard Methods
p. 31
6.3.3.4
Resource: DiscoveryKey
p. 33
6.3.3.4.1
Description
p. 33
6.3.3.4.2
Resource Definition
p. 33
6.3.3.4.3
Resource Standard Methods
p. 33
6.3.4
Custom Operations without associated resources
p. 35
6.3.5
Notifications
p. 35
6.3.6
Data Model
p. 35
6.3.6.1
General
p. 35
6.3.6.2
Structured data types
p. 36
6.3.6.2.1
Introduction
p. 36
6.3.6.2.2
Type: AnnounceAuthData
p. 36
6.3.6.2.3
Type: MonitorKeyReqData
p. 36
6.3.6.2.4
Type: MonitorKeyRespData
p. 36
6.3.6.2.5
Type: DiscoveryKeyReqData
p. 36
6.3.6.2.6
Type: DiscoveryKeyRespData
p. 36
6.3.6.2.7
Type: DiscSecMaterials
p. 37
6.3.6.3
Simple data types and enumerations
p. 37
6.3.6.3.1
Introduction
p. 37
6.3.6.3.2
Simple data types
p. 37
6.3.6.4
Data types describing alternative data types or combinations of data types
p. 37
6.3.6.5
Binary data
p. 38
6.3.7
Error Handling
p. 38
6.3.7.1
General
p. 38
6.3.7.2
Protocol Errors
p. 38
6.3.7.3
Application Errors
p. 38
6.3.8
Feature negotiation
p. 38
6.3.9
Security
p. 38
6.3.10
HTTP redirection
p. 39
A
(Normative) OpenAPI specification
p. 39
A.1
General
p. 39
A.2
Npkmf_PKMFKeyRequest API
p. 39
A.3
Npkmf_ResolveRemoteUserId API
p. 41
A.4
Npkmf_Discovery API
p. 43
$
Change history
p. 49