|
TECHNICAL SPECIFICATION
5G;
LTE;
Common API Framework for 3GPP Northbound APIs
(3GPP TS 29.222 version 16.5.0 Release 16)
---------------------- Page: 1 ----------------------
3GPP TS 29.222 version 16.5.0 Release 16 1 ETSI TS 129 222 V16.5.0 (2021-01)
Reference
RTS/TSGC-0329222vg50
Keywords
5G,LTE
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
If you find errors in the present document, please send your comment to one of the following services:
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2021.
All rights reserved.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners.
®
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 29.222 version 16.5.0 Release 16 2 ETSI TS 129 222 V16.5.0 (2021-01)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Legal Notice
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities. These shall be
interpreted as being references to the corresponding ETSI deliverables.
The cross reference between 3GPP and ETSI identities can be found under .
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
---------------------- Page: 3 ----------------------
3GPP TS 29.222 version 16.5.0 Release 16 3 ETSI TS 129 222 V16.5.0 (2021-01)
Contents
Intellectual Property Rights . 2
Legal Notice . 2
Modal verbs terminology . 2
Foreword . 12
1 Scope . 13
2 References . 13
3 Definitions and abbreviations . 14
3.1 Definitions . 14
3.2 Abbreviations . 14
4 Overview . 15
4.1 Introduction . 15
4.2 Service Architecture . 15
4.3 Functional Entities . 17
4.3.1 API invoker . 17
4.3.2 CAPIF core function . 17
4.3.3 API exposing function . 18
4.3.4 API publishing function . 18
4.3.5 API management function . 18
5 Services offered by the CAPIF Core Function . 19
5.1 Introduction of Services . 19
5.2 CAPIF_Discover_Service_API . 20
5.2.1 Service Description . 20
5.2.1.1 Overview . 20
5.2.2 Service Operations . 20
5.2.2.1 Introduction . 20
5.2.2.2 Discover_Service_API . 21
5.2.2.2.1 General . 21
5.2.2.2.2 Consumer discovering service API using Discover_Service_API service operation . 21
5.3 CAPIF_Publish_Service_API . 21
5.3.1 Service Description . 21
5.3.1.1 Overview . 21
5.3.2 Service Operations . 21
5.3.2.1 Introduction . 21
5.3.2.2 Publish_Service_API . 22
5.3.2.2.1 General . 22
5.3.2.2.2 API publishing function publishing service APIs on CAPIF core function using
Publish_Service_API service operation . 22
5.3.2.2.3 CAPIF core function publishing service APIs on other CAPIF core function using
Publish_Service_API service operation . 23
5.3.2.3 Unpublish_Service_API . 23
5.3.2.3.1 General . 23
5.3.2.3.2 Consumer un-publishing service APIs from CAPIF core function using
Unpublish_Service_API service operation . 24
5.3.2.4 Get_Service_API . 24
5.3.2.4.1 General . 24
5.3.2.4.2 Consumer retrieving service APIs from CAPIF core function using Get_Service_API service
operation . 24
5.3.2.5 Update_Service_API . 25
5.3.2.5.1 General . 25
5.3.2.5.2 Consumer updating published service APIs on CAPIF core function using
Update_Service_API service operation . 25
5.4 CAPIF_Events_API . 25
5.4.1 Service Description . 25
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 29.222 version 16.5.0 Release 16 4 ETSI TS 129 222 V16.5.0 (2021-01)
5.4.1.1 Overview . 25
5.4.2 Service Operations . 26
5.4.2.1 Introduction . 26
5.4.2.2 Subscribe_Event . 26
5.4.2.2.1 General . 26
5.4.2.2.2 Subscribing to CAPIF events using Subscribe_Event service operation . 26
5.4.2.3 Unsubscribe_Event . 27
5.4.2.3.1 General . 27
5.4.2.3.2 Unsubscribing from CAPIF events using Unsubscribe_Event service operation . 27
5.4.2.4 Notify_Event . 27
5.4.2.4.1 General . 27
5.4.2.4.2 Notifying CAPIF events using Notify_Event service operation . 27
5.5 CAPIF_API_Invoker_Management_API . 28
5.5.1 Service Description . 28
5.5.1.1 Overview . 28
5.5.2 Service Operations . 28
5.5.2.1 Introduction . 28
5.5.2.2 Onboard_API_Invoker . 28
5.5.2.2.1 General . 28
5.5.2.2.2 API invoker on-boarding itself as a recognized user of CAPIF using Onboard_API_Invoker
service operation . 28
5.5.2.3 Offboard_API_Invoker . 29
5.5.2.3.1 General . 29
5.5.2.3.2 API invoker off-boarding itself as a recognized user of CAPIF using Offboard_API_Invoker
service operation . 29
5.5.2.4 Notify_Onboarding_Completion . 30
5.5.2.4.1 General . 30
5.5.2.4.2 Notifying Onboarding completion using Notify_Onboarding_Completion service operation . 30
5.5.2.5 Update_API_Invoker_Details . 30
5.5.2.5.1 General . 30
5.5.2.5.2 API invoker updating its details on CAPIF using Update_API_Invoker_Details service
operation . 30
5.5.2.6 Notify_Update_Completion . 31
5.5.2.6.1 General . 31
5.5.2.6.2 Notifying API invoker update completion using Notify_Update_Completion service
operation . 31
5.6 CAPIF_Security_API . 31
5.6.1 Service Description . 31
5.6.1.1 Overview . 31
5.6.2 Service Operations . 32
5.6.2.1 Introduction . 32
5.6.2.2 Obtain_Security_Method . 32
5.6.2.2.1 General . 32
5.6.2.2.2 Request service API security method from CAPIF using Obtain_Security_Method service
operation . 32
5.6.2.3 Obtain_Authorization . 33
5.6.2.3.1 General . 33
5.6.2.3.2 Obtain authorization using Obtain_Authorization service operation. 33
5.6.2.4 Obtain_API_Invoker_Info . 33
5.6.2.4.1 General . 33
5.6.2.4.2 Obtain API invoker's security information using Obtain_API_Invoker_Info service operation . 33
5.6.2.5 Revoke_Authentication . 34
5.6.2.5.1 General . 34
5.6.2.5.2 Invalidate authorization using Revoke_Authorization service operation . 34
5.7 CAPIF_Monitoring_API . 34
5.8 CAPIF_Logging_API_Invocation_API . 34
5.8.1 Service Description . 34
5.8.1.1 Overview . 34
5.8.2 Service Operations . 35
5.8.2.1 Introduction . 35
5.8.2.2 Log_API_Invocation_API . 35
5.8.2.2.1 General . 35
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 29.222 version 16.5.0 Release 16 5 ETSI TS 129 222 V16.5.0 (2021-01)
5.8.2.2.2 Logging service API invocations using Log_API_Invocation service operation . 35
5.9 CAPIF_Auditing_API . 35
5.9.1 Service Description . 35
5.9.1.1 Overview . 35
5.9.2 Service Operations . 36
5.9.2.1 Introduction . 36
5.9.2.2 Query_Invocation_Logs_API . 36
5.9.2.2.1 General . 36
5.9.2.2.2 Query API invocation information logs using Query_Invocation_Logs service operation . 36
5.10 CAPIF_Access_Control_Policy_API . 36
5.10.1 Service Description . 36
5.10.1.1 Overview . 36
5.10.2 Service Operations . 37
5.10.2.1 Introduction . 37
5.10.2.2 Obtain_Access_Control_Policy . 37
5.10.2.2.1 General . 37
5.10.2.2.2 API exposing function obtaining access control policy from the CAPIF core function using
Obtain_Access_Control_Policy service operation . 37
5.10.3 Related Events . 37
5.11 CAPIF_API_Provider_Management_API . 37
5.11.1 Service Description . 37
5.11.1.1 Overview . 37
5.11.2 Service Operations . 37
5.11.2.1 Introduction . 37
5.11.2.2 Register_API_Provider . 38
5.11.2.2.1 General . 38
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 . 38
5.11.2.3 Update_API_Provider . 38
5.11.2.3.1 General . 38
5.11.2.3.2 API management function updating API provider domain function details on CAPIF using
Update_API_Provider service operation . 38
5.11.2.4 Deregister_API_Provider . 39
5.11.2.4.1 General . 39
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 . 39
5.12 CAPIF_Routing_Info_API . 39
5.12.1 Service Description . 39
5.12.1.1 Overview . 39
5.12.2 Service Operations . 40
5.12.2.1 Introduction . 40
5.12.2.2 Obtain_Routing_Info . 40
5.12.2.2.1 General . 40
5.12.2.2.2 API exposing function obtaining API routing information from the CAPIF core function
using Obtain_Routing_Info service operation . 40
6 Services offered by the API exposing function . 40
6.1 Introduction of Services . 40
6.2 AEF_Security_API . 41
6.2.1 Service Description . 41
6.2.1.1 Overview .
...