Tech-invite3GPPspaceIETFspace
21222324252627282931323334353637384‑5x
Top   in Index   Prev   Next

TS 23.222
Common API Framework for 3GPP Northbound APIs

V19.5.0 (Wzip)2025/03  155 p.
V18.7.0 (PDF)  2024/12  133 p.
V17.8.0  2023/12  122 p.
V16.13.0  2023/12  121 p.
V15.7.0  2023/12  90 p.
Rapporteur:
Mr. Pattan, Basavaraj (Basu)
Samsung R&D Institute UK

essential Table of Contents for  TS 23.222  Word version:  19.5.0

each title, in the "available" or "not available yet" area, links to the equivalent title in the CONTENT
Here   Top

Up   Top

List of Figures and Tables

Figure 4.12.1-1Interconnection between the CAPIF providers
Figure 5.1-1Business relationships in CAPIF
Figure 5.2-1CAPIF business relationships for RNAA
Figure 6.2.0-1Functional model for the CAPIF
Figure 6.2.0-2Functional model for interactions between API exposing functions
Figure 6.2.0-3CAPIF functional model representation using service-based interfaces
Table 6.2.0-1Service-based interfaces supported by CAPIF
Figure 6.2.1-1Functional model for the CAPIF to support 3rd party API providers
Figure 6.2.2-1High level functional architecture for CAPIF interconnection with multiple CAPIF provider domains
Figure 6.2.2-2High level functional architecture for CAPIF interconnection within a CAPIF provider domain
Figure 6.2.3-1High level functional architecture for CAPIF supporting RNAA
Figure 7.2-1Centralized deployment of CAPIF
Figure 7.3-1Distributed deployment of the CAPIF within PLMN trust domain
Figure 7.3-2Distributed deployment of the CAPIF with cascading API exposing functions
Figure 7.3-3Another example of distributed deployment of the CAPIF with cascading API exposing functions
Figure 7.3-4Distributed deployment of CAPIF considering PLMN trust domain and 3rd party trust domain
Figure 7.4-1Multiple CCFs deployment within the PLMN trust domain
Table 8.1.2.1-1Onboard API invoker request
Table 8.1.2.2-1Onboard API invoker response
Figure 8.1.3-1Procedure for onboarding the API invoker to the CAPIF
Table 8.2.2.1-1Offboard API invoker request
Table 8.2.2.2-1Offboard API invoker response
Figure 8.2.3-1Procedure for offboarding the API invoker from the CAPIF
Table 8.3.2.1-1Service API publish request
Table 8.3.2.1-2Service KPIs
Table 8.3.2.2-1Service API publish response
Figure 8.3.3-1Publish service APIs
Table 8.4.2.1-1Service API unpublish request
Table 8.4.2.2-1Service API unpublish response
Figure 8.4.3-1Unpublish service APIs
Table 8.5.2.1-1Service API get request
Table 8.5.2.2-1Service API get response
Figure 8.5.3-1Retrieve service APIs
Table 8.6.2.1-1Service API update request
Table 8.6.2.2-1Service API update response
Figure 8.6.3-1Update service APIs
Table 8.7.2.1-1Service API discover request
Table 8.7.2.2-1Service API discover response
Figure 8.7.3-1Discover service APIs
Table 8.8.2.1-1Event subscription request
Table 8.8.2.2-1Event subscription response
Table 8.8.2.3-1Event notification
Table 8.8.2.4-1Event notification acknowledgement
Table 8.8.2.5-1Event unsubscription request
Table 8.8.2.6-1Event unsubscription response
Table 8.8.2.7-1Event subscription update request
Table 8.8.2.8-1Event subscription update response
Figure 8.8.3-1Procedure for CAPIF event subscription
Figure 8.8.4-1Procedure for CAPIF event notifications
Figure 8.8.5-1Procedure for CAPIF event unsubscription
Figure 8.8.5a-1Procedure for CAPIF event subscription
Table 8.8.6-1List of CAPIF events
Table 8.9.2.1-1Subscription revoke notification
Table 8.9.2.2-1Subscription revoke notification acknowledgement
Figure 8.9.3-1Procedure for revoking subscription of the CAPIF events
Figure 8.10.3-1Procedure for authentication between the API invoker and the CAPIF core function
Figure 8.11.3-1Procedure for the API invoker obtaining authorization for service API access
Table 8.12.2.1-1Obtain access control policy request
Table 8.12.2.2-1Obtain access control policy response
Figure 8.12.3-1Procedure for the AEF obtaining service API access control policy
Figure 8.13.3-1Procedure for CAPIF topology hiding
Figure 8.14.3-1Procedure for authentication between the API invoker and the AEF prior to service API invocation
Table 8.15.2.1-1Service API invocation request with authentication information
Table 8.15.2.2-1Service API invocation response
Figure 8.15.3-1Procedure for authentication between the API invoker and the AEF upon the service API invocation
Table 8.16.2.1-1Service API invocation request
Table 8.16.2.2-1Service API invocation response
Figure 8.16.3-1Procedure for API invoker authorization to access service APIs
Table 8.17.2.1-1Service API invocation request
Table 8.17.2.2-1Service API invocation response
Figure 8.17.3-1Procedure for service API access control
Figure 8.18.3-1Procedure for CAPIF access control with cascaded AEFs
Table 8.19.2.1-1API invocation log request
Table 8.19.2.2-1API invocation log response
Figure 8.19.3-1Procedure for logging service API invocations
Figure 8.20.3-1Procedure for charging the invocation of service APIs
Figure 8.21.3-1Procedure for monitoring service API invocation
Table 8.22.2.1-1Query service API log request
Table 8.22.2.2-1Query service API log response
Figure 8.22.3-1Procedure for auditing service API invocation
Table 8.23.2.1-1Revoke API invoker authorization request
Table 8.23.2.2-1Revoke API invoker authorization response
Table 8.23.2.3-1Revoke API invoker authorization notify
Figure 8.23.3-1Procedure for revoking API invoker authorization initiated by AEF
Figure 8.23.4-1Procedure for revoking API invoker authorization initiated by CAPIF core function
Table 8.24.2.1-1API topology hiding notify
Figure 8.24.3-1API topology hiding via API (un)publish
Table 8.25.2.1-1Interconnection API publish request
Table 8.25.2.2-1Interconnection API publish response
Table 8.25.2.3-1Interconnection service API discover request
Table 8.25.2.4-1Interconnection service API discover response
Table 8.25.2.5-1Interconnection API unpublish request
Table 8.25.2.6-1Interconnection API unpublish response
Table 8.25.2.7-1Interconnection get service API request
Table 8.25.2.8-1Interconnection get service API response
Table 8.25.2.9-1Interconnection update service API request
Table 8.25.2.10-1Interconnection update service API response
Figure 8.25.3.1-1Interconnection API publish
Figure 8.25.3.2-1Service API discovery involving multiple CCFs
Figure 8.25.3.3-1Service API discovery for CAPIF interconnection
Figure 8.25.3.4-1Interconnection API unpublish
Figure 8.25.3.5-1Retrieve service APIs for CAPIF interconnection
Figure 8.25.3.6-1Update service APIs for CAPIF interconnection
Table 8.26.2.1-1Update API invoker API list request
Table 8.26.2.2-1Update API invoker API list response
Figure 8.26.3-1Procedure for updating the API invoker profile on the CAPIF
Table 8.27.2.1-1Obtain routing information request
Table 8.27.2.2-1Obtain routing information response
Figure 8.27.3-1Procedure for dynamic routing of service API invocation
Table 8.28.2.1-1Registration request
Table 8.28.2.2-1Registration response
Figure 8.28.3-1Procedure for registration of API provider domain functions on CAPIF
Table 8.29.2.1-1Registration update request
Table 8.29.2.2-1Registration update response
Figure 8.29.3-1Procedure for update of registration information of API provider domain functions on CAPIF
Table 8.30.2.1-1Deregistration request
Table 8.30.2.2-1Deregistration response
Figure 8.30.3-1Procedure for deregistration of API provider domain functions on CAPIF
Figure 8.31.3-1Procedure for API invoker obtaining authorization from resource owner
Figure 8.32.3-1Procedure for obtaining authorization information in a nested API invocation
Table 10.1-1List of CAPIF core function APIs
Table 11.1-1List of API exposing function APIs
Figure A-1Overview of CAPIF operations
Figure B.0-1CAPIF utilization by service API provider
Table B.1.1-1CAPIF relationship with 3GPP EPS network exposure
Figure B.1.2.2-1SCEF implements the CAPIF architecture
Figure B.1.2.3-1SCEF implements the service specific aspect compliant with the CAPIF architecture
Figure B.1.2.4-1Distributed deployment of SCEF compliant with the CAPIF architecture
Table B.2.1-1CAPIF relationship with 3GPP 5GS network exposure
Figure B.2.2.2-1NEF implements the CAPIF architecture
Figure B.2.2.3-1NEF implements the service specific aspect compliant with the CAPIF architecture
Figure B.2.2.4-1Distributed deployment of NEF compliant with the CAPIF architecture
Figure B.3.2.2-1Integrated deployment of the SCEF and the NEF with the CAPIF
Figure C.1-1CAPIF role in charging
Table D-1CAPIF relationship with external API frameworks
Table E-1Configuration data for CAPIF
Figure F-1Examples of API invoker roles in CAPIF

Top