LTE; 5G; Common API Framework for 3GPP Northbound APIs (3GPP TS 29.222 version 15.13.0 Release 15)

RTS/TSGC-0329222vfd0

General Information

Status
Not Published
Current Stage
12 - Citation in the OJ (auto-insert)
Completion Date
05-Apr-2023
Ref Project

Buy Standard

Standard
ETSI TS 129 222 V15.13.0 (2023-04) - LTE; 5G; Common API Framework for 3GPP Northbound APIs (3GPP TS 29.222 version 15.13.0 Release 15)
English language
119 pages
sale 15% off
Preview
sale 15% off
Preview

Standards Content (Sample)

ETSI TS 129 222 V15.13.0 (2023-04)






TECHNICAL SPECIFICATION
LTE;
5G;
Common API Framework for 3GPP Northbound APIs
(3GPP TS 29.222 version 15.13.0 Release 15)



---------------------- Page: 1 ----------------------
3GPP TS 29.222 version 15.13.0 Release 15 1 ETSI TS 129 222 V15.13.0 (2023-04)

Reference
RTS/TSGC-0329222vfd0
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 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871

Important notice
The present document can be downloaded from:
https://www.etsi.org/standards-search
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
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
If you find a security vulnerability in the present document, please report it through our
Coordinated Vulnerability Disclosure Program:
https://www.etsi.org/standards/coordinated-vulnerability-disclosure
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
and/or governmental
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.

Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
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 2023.
All rights reserved.

ETSI

---------------------- Page: 2 ----------------------
3GPP TS 29.222 version 15.13.0 Release 15 2 ETSI TS 129 222 V15.13.0 (2023-04)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations
pertaining to these essential IPRs, if any, are 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 Directives including the ETSI IPR Policy, no investigation regarding the essentiality of IPRs,
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.
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.
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 https://webapp.etsi.org/key/queryform.asp.
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 15.13.0 Release 15 3 ETSI TS 129 222 V15.13.0 (2023-04)
Contents
Intellectual Property Rights . 2
Legal Notice . 2
Modal verbs terminology . 2
Foreword . 11
1 Scope . 12
2 References . 12
3 Definitions and abbreviations . 13
3.1 Definitions . 13
3.2 Abbreviations . 13
4 Overview . 13
4.1 Introduction . 13
4.2 Service Architecture . 14
4.3 Functional Entities . 14
4.3.1 API invoker . 14
4.3.2 CAPIF core function . 15
4.3.3 API exposing function . 15
4.3.4 API publishing function . 15
4.3.5 API management function . 16
5 Services offered by the CAPIF Core Function . 16
5.1 Introduction of Services . 16
5.2 CAPIF_Discover_Service_API . 17
5.2.1 Service Description . 17
5.2.1.1 Overview . 17
5.2.2 Service Operations . 17
5.2.2.1 Introduction . 17
5.2.2.2 Discover_Service_API . 17
5.2.2.2.1 General . 17
5.2.2.2.2 API invoker discovering service API using Discover_Service_API service operation . 17
5.3 CAPIF_Publish_Service_API . 17
5.3.1 Service Description . 17
5.3.1.1 Overview . 17
5.3.2 Service Operations . 18
5.3.2.1 Introduction . 18
5.3.2.2 Publish_Service_API . 18
5.3.2.2.1 General . 18
5.3.2.2.2 API publishing function publishing service APIs on CAPIF core function using
Publish_Service_API service operation . 18
5.3.2.3 Unpublish_Service_API . 18
5.3.2.3.1 General . 18
5.3.2.3.2 API publishing function un-publishing service APIs from CAPIF core function using
Unpublish_Service_API service operation . 19
5.3.2.4 Get_Service_API . 19
5.3.2.4.1 General . 19
5.3.2.4.2 API publishing function retrieving service APIs from CAPIF core function using
Get_Service_API service operation . 19
5.3.2.5 Update_Service_API . 19
5.3.2.5.1 General . 19
5.3.2.5.2 API publishing function updating published service APIs on CAPIF core function using
Update_Service_API service operation . 19
5.4 CAPIF_Events_API . 20
5.4.1 Service Description . 20
5.4.1.1 Overview . 20
5.4.2 Service Operations . 20
ETSI

---------------------- Page: 4 ----------------------
3GPP TS 29.222 version 15.13.0 Release 15 4 ETSI TS 129 222 V15.13.0 (2023-04)
5.4.2.1 Introduction . 20
5.4.2.2 Subscribe_Event . 20
5.4.2.2.1 General . 20
5.4.2.2.2 Subscribing to CAPIF events using Subscribe_Event service operation . 20
5.4.2.3 Unsubscribe_Event . 21
5.4.2.3.1 General . 21
5.4.2.3.2 Unsubscribing from CAPIF events using Unsubscribe_Event service operation . 21
5.4.2.4 Notify_Event . 21
5.4.2.4.1 General . 21
5.4.2.4.2 Notifying CAPIF events using Notify_Event service operation . 21
5.5 CAPIF_API_Invoker_Management_API . 21
5.5.1 Service Description . 21
5.5.1.1 Overview . 21
5.5.2 Service Operations . 21
5.5.2.1 Introduction . 21
5.5.2.2 Onboard_API_Invoker . 22
5.5.2.2.1 General . 22
5.5.2.2.2 API invoker on-boarding itself as a recognized user of CAPIF using Onboard_API_Invoker
service operation . 22
5.5.2.3 Offboard_API_Invoker . 23
5.5.2.3.1 General . 23
5.5.2.3.2 API invoker off-boarding itself as a recognized user of CAPIF using Offboard_API_Invoker
service operation . 23
5.5.2.4 Notify_Onboarding_Completion . 23
5.5.2.4.1 General . 23
5.5.2.4.2 Notifying Onboarding completion using Notify_Onboarding_Completion service operation . 23
5.6 CAPIF_Security_API . 24
5.6.1 Service Description . 24
5.6.1.1 Overview . 24
5.6.2 Service Operations . 24
5.6.2.1 Introduction . 24
5.6.2.2 Obtain_Security_Method . 24
5.6.2.2.1 General . 24
5.6.2.2.2 Request service API security method from CAPIF using Obtain_Security_Method service
operation . 24
5.6.2.3 Obtain_Authorization . 25
5.6.2.3.1 General . 25
5.6.2.3.2 Obtain authorization using Obtain_Authorization service operation. 25
5.6.2.4 Obtain_API_Invoker_Info . 25
5.6.2.4.1 General . 25
5.6.2.4.2 Obtain API invoker's security information using Obtain_API_Invoker_Info service operation . 26
5.6.2.5 Revoke_Authentication . 26
5.6.2.5.1 General . 26
5.6.2.5.2 Invalidate authorization using Revoke_Authorization service operation . 26
5.7 CAPIF_Monitoring_API . 26
5.8 CAPIF_Logging_API_Invocation_API . 27
5.8.1 Service Description . 27
5.8.1.1 Overview . 27
5.8.2 Service Operations . 27
5.8.2.1 Introduction . 27
5.8.2.2 Log_API_Invocation_API . 27
5.8.2.2.1 General . 27
5.8.2.2.2 Logging service API invocations using Log_API_Invocation service operation . 27
5.9 CAPIF_Auditing_API . 27
5.9.1 Service Description . 27
5.9.1.1 Overview . 27
5.9.2 Service Operations . 28
5.9.2.1 Introduction . 28
5.9.2.2 Query_Invocation_Logs_API . 28
5.9.2.2.1 General . 28
5.9.2.2.2 Query API invocation information logs using Query_Invocation_Logs service operation . 28
5.10 CAPIF_Access_Control_Policy_API . 28
ETSI

---------------------- Page: 5 ----------------------
3GPP TS 29.222 version 15.13.0 Release 15 5 ETSI TS 129 222 V15.13.0 (2023-04)
5.10.1 Service Description . 28
5.10.1.1 Overview . 28
5.10.2 Service Operations . 28
5.10.2.1 Introduction . 28
5.10.2.2 Obtain_Access_Control_Policy . 29
5.10.2.2.1 General . 29
5.10.2.2.2 API exposing function obtaining access control policy from the CAPIF core function using
Obtain_Access_Control_Policy service operation . 29
5.10.3 Related Events . 29
6 Services offered by the API exposing function . 29
6.1 Introduction of Services . 29
6.2 AEF_Security_API . 29
6.2.1 Service Description . 29
6.2.1.1 Overview . 29
6.2.2 Service Operations . 30
6.2.2.1 Introduction . 30
6.2.2.2 Initiate_Authentication . 30
6.2.2.2.1 General . 30
6.2.2.2.2 API invoker initiating authentication using Initiate_Authentication service operation . 30
7 CAPIF Design Aspects Common for All APIs . 31
7.1 General . 31
7.2 Data Types. 31
7.2.1 General . 31
7.2.2 Referenced structured data types . 31
7.2.3 Referenced Simple data types and enumerations . 31
7.3 Usage of HTTP . 32
7.4 Content type . 32
7.5 URI structure . 32
7.6 Notifications . 33
7.7 Error handling . 33
7.8 Feature negotiation . 33
7.9 HTTP headers . 33
7.10 Conventions for Open API specification files . 33
8 CAPIF API Definition . 34
8.1 CAPIF_Discover_Service_API . 34
8.1.1 API URI .
...

Questions, Comments and Discussion

Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.