Tech-invite 3GPPspace IETFspace

21 22 23 24 25 26 27 28 29 31 32 33 34 35 36 37 38 4‑5x

Content for TS 29.222 Word version: 18.4.0

1… 4… 5… 8… 9…

5.1 Introduction of Services 5.2 CAPIF_Discover_Service_API 5.3 CAPIF_Publish_Service_API 5.4 CAPIF_Events_API 5.5 CAPIF_API_Invoker_Management_API 5.6 CAPIF_Security_API 5.7 CAPIF_Monitoring_API 5.8 CAPIF_Logging_API_Invocation_API 5.9 CAPIF_Auditing_API 5.10 CAPIF_Access_Control_Policy_API 5.11 CAPIF_API_Provider_Management_API 5.12 CAPIF_Routing_Info_API 6.1 Introduction of Services 6.2 AEF_Security_API 7.1 General 7.2 Data Types 7.3 Usage of HTTP 7.4 Content type 7.5 URI structure 7.6 Notifications 7.7 Error handling 7.8 Feature negotiation 7.9 HTTP headers 7.10 Conventions for Open API specification files 7.11 CAPIF vendor-specifc extensions
...

5 Services offered by the CAPIF Core Function p. 17

5.1 Introduction of Services p. 17

5.2 CAPIF_Discover_Service_API p. 19

5.2.1 Service Description p. 19

5.2.1.1 Overview p. 19

5.2.2 Service Operations p. 19

5.2.2.1 Introduction p. 19

5.2.2.2 Discover_Service_API p. 20

5.2.2.2.1 General p. 20

5.2.2.2.2 Consumer discovering service API using Discover_Service_API service operation p. 20

5.3 CAPIF_Publish_Service_API p. 20

5.3.1 Service Description p. 20

5.3.1.1 Overview p. 20

5.3.2 Service Operations p. 21

5.3.2.1 Introduction p. 21

5.3.2.2 Publish_Service_API p. 21

5.3.2.2.1 General p. 21

5.3.2.2.2 API publishing function publishing service APIs on CAPIF core function using Publish_Service_API service operation p. 21

5.3.2.2.3 CAPIF core function publishing service APIs on other CAPIF core function using Publish_Service_API service operation |R16| p. 22

5.3.2.3 Unpublish_Service_API p. 23

5.3.2.3.1 General p. 23

5.3.2.3.2 Consumer un-publishing service APIs from CAPIF core function using Unpublish_Service_API service operation p. 23

5.3.2.4 Get_Service_API p. 23

5.3.2.4.1 General p. 23

5.3.2.4.2 Consumer retrieving service APIs from CAPIF core function using Get_Service_API service operation p. 23

5.3.2.5 Update_Service_API p. 24

5.3.2.5.1 General p. 24

5.3.2.5.2 Consumer updating published service APIs on CAPIF core function using Update_Service_API service operation p. 24

5.4 CAPIF_Events_API p. 25

5.4.1 Service Description p. 25

5.4.1.1 Overview p. 25

5.4.2 Service Operations p. 25

5.4.2.1 Introduction p. 25

5.4.2.2 Subscribe_Event p. 25

5.4.2.2.1 General p. 25

5.4.2.2.2 Subscribing to CAPIF events using Subscribe_Event service operation p. 25

5.4.2.3 Unsubscribe_Event p. 26

5.4.2.3.1 General p. 26

5.4.2.3.2 Unsubscribing from CAPIF events using Unsubscribe_Event service operation p. 26

5.4.2.4 Notify_Event p. 27

5.4.2.4.1 General p. 27

5.4.2.4.2 Notifying CAPIF events using Notify_Event service operation p. 27

5.4.2.5 Update_Event_Subscription |R18| p. 27

5.4.2.5.1 General p. 27

5.4.2.5.2 Update Subscription to CAPIF events using Update_Event_Subscription service operation p. 27

5.5 CAPIF_API_Invoker_Management_API p. 28

5.5.1 Service Description p. 28

5.5.1.1 Overview p. 28

5.5.2 Service Operations p. 28

5.5.2.1 Introduction p. 28

5.5.2.2 Onboard_API_Invoker p. 28

5.5.2.2.1 General p. 28

5.5.2.2.2 API invoker on-boarding itself as a recognized user of CAPIF using Onboard_API_Invoker service operation p. 28

5.5.2.3 Offboard_API_Invoker p. 29

5.5.2.3.1 General p. 29

5.5.2.3.2 API invoker off-boarding itself as a recognized user of CAPIF using Offboard_API_Invoker service operation p. 29

5.5.2.4 Notify_Onboarding_Completion p. 30

5.5.2.4.1 General p. 30

5.5.2.4.2 Notifying Onboarding completion using Notify_Onboarding_Completion service operation p. 30

5.5.2.5 Update_API_Invoker_Details |R16| p. 30

5.5.2.5.1 General p. 30

5.5.2.5.2 API invoker updating its details on CAPIF using Update_API_Invoker_Details service operation p. 30

5.5.2.6 Notify_Update_Completion |R16| p. 31

5.5.2.6.1 General p. 31

5.5.2.6.2 Notifying API invoker update completion using Notify_Update_Completion service operation p. 31

5.6 CAPIF_Security_API p. 32

5.6.1 Service Description p. 32

5.6.1.1 Overview p. 32

5.6.2 Service Operations p. 32

5.6.2.1 Introduction p. 32

5.6.2.2 Obtain_Security_Method p. 32

5.6.2.2.1 General p. 32

5.6.2.2.2 Request service API security method from CAPIF using Obtain_Security_Method service operation p. 33

5.6.2.3 Obtain_Authorization p. 33

5.6.2.3.1 General p. 33

5.6.2.3.2 Obtain authorization using Obtain_Authorization service operation p. 33

5.6.2.3.3 Obtain authorization code using Obtain_Authorization service operation |R18| p. 34

5.6.2.4 Obtain_API_Invoker_Info p. 34

5.6.2.4.1 General p. 34

5.6.2.4.2 Obtain API invoker's security information using Obtain_API_Invoker_Info service operation p. 34

5.6.2.5 Revoke_Authentication p. 35

5.6.2.5.1 General p. 35

5.6.2.5.2 Invalidate authorization using Revoke_Authorization service operation p. 35

5.7 CAPIF_Monitoring_API p. 35

5.8 CAPIF_Logging_API_Invocation_API p. 35

5.8.1 Service Description p. 35

5.8.1.1 Overview p. 35

5.8.2 Service Operations p. 36

5.8.2.1 Introduction p. 36

5.8.2.2 Log_API_Invocation_API p. 36

5.8.2.2.1 General p. 36

5.8.2.2.2 Logging service API invocations using Log_API_Invocation service operation p. 36

5.9 CAPIF_Auditing_API p. 36

5.9.1 Service Description p. 36

5.9.1.1 Overview p. 36

5.9.2 Service Operations p. 37

5.9.2.1 Introduction p. 37

5.9.2.2 Query_Invocation_Logs_API p. 37

5.9.2.2.1 General p. 37

5.9.2.2.2 Query API invocation information logs using Query_Invocation_Logs service operation p. 37

5.10 CAPIF_Access_Control_Policy_API p. 37

5.10.1 Service Description p. 37

5.10.1.1 Overview p. 37

5.10.2 Service Operations p. 38

5.10.2.1 Introduction p. 38

5.10.2.2 Obtain_Access_Control_Policy p. 38

5.10.2.2.1 General p. 38

5.10.2.2.2 API exposing function obtaining access control policy from the CAPIF core function using Obtain_Access_Control_Policy service operation p. 38

5.10.3 Related Events p. 38

5.11 CAPIF_API_Provider_Management_API |R16| p. 38

5.11.1 Service Description p. 38

5.11.1.1 Overview p. 38

5.11.2 Service Operations p. 39

5.11.2.1 Introduction p. 39

5.11.2.2 Register_API_Provider p. 39

5.11.2.2.1 General p. 39

5.11.2.2.2 API provider domain functions registering as a recognized API provider domain function of CAPIF using Register_API_Provider service operation p. 39

5.11.2.3 Update_API_Provider p. 39

5.11.2.3.1 General p. 39

5.11.2.3.2 API management function updating API provider domain function details on CAPIF using Update_API_Provider service operation p. 40

5.11.2.4 Deregister_API_Provider p. 40

5.11.2.4.1 General p. 40

5.11.2.4.2 API provider domain functions deregistering as a recognized API provider domain function of CAPIF using Deregister_API_Provider service operation p. 40

5.12 CAPIF_Routing_Info_API |R16| p. 41

5.12.1 Service Description p. 41

5.12.1.1 Overview p. 41

5.12.2 Service Operations p. 41

5.12.2.1 Introduction p. 41

5.12.2.2 Obtain_Routing_Info p. 41

5.12.2.2.1 General p. 41

5.12.2.2.2 API exposing function obtaining API routing information from the CAPIF core function using Obtain_Routing_Info service operation p. 41

6 Services offered by the API exposing function p. 42

6.1 Introduction of Services p. 42

6.2 AEF_Security_API p. 42

6.2.1 Service Description p. 42

6.2.1.1 Overview p. 42

6.2.2 Service Operations p. 42

6.2.2.1 Introduction p. 42

6.2.2.2 Initiate_Authentication p. 43

6.2.2.2.1 General p. 43

6.2.2.2.2 API invoker initiating authentication using Initiate_Authentication service operation p. 43

6.2.2.3 Revoke_Authorization |R16| p. 43

6.2.2.3.1 General p. 43

6.2.2.3.2 CAPIF core function initiating revocation using Revoke_Authorization service operation p. 43

7 CAPIF Design Aspects Common for All APIs p. 43

7.1 General p. 43

7.2 Data Types p. 44

7.2.1 General p. 44

7.2.2 Referenced structured data types p. 44

7.2.3 Referenced Simple data types and enumerations p. 44

7.3 Usage of HTTP p. 45

7.4 Content type p. 45

7.5 URI structure p. 45

7.6 Notifications p. 46

7.7 Error handling p. 46

7.8 Feature negotiation p. 46

7.9 HTTP headers p. 46

7.10 Conventions for Open API specification files p. 46

7.11 CAPIF vendor-specifc extensions |R18| p. 46