Tech-invite  3GPPspace  IETFspace
◀  ▶  21  22  23  24  25  26  27  28  29  31  32  33  34  35  36  37  38  4‑5x
Top   in Index   Prev   Next

TS 29.222
Common API Framework for 3GPP Northbound APIs

3GPP‑Page   ETSI‑search   fToC↓   Partial Content →
V19.4.0 (PDF)  2025/09  … p.
V18.7.0  2024/12  221 p.
V17.9.0  2024/12  185 p.
V16.12.0  2024/12  163 p.
V15.13.0  2023/03  119 p.
Rapporteur:
Mr. Tangudu, Narendranath Durga
Samsung R&D Institute India

full Table of Contents for  TS 29.222  Word version:  19.4.0

each clause number in 'red' refers to the equivalent title in the Partial Content
Here   Top
1Scope  p. 15
2References  p. 15
3Definitions and abbreviations  p. 16
3.1Definitions  p. 16
3.2Abbreviations  p. 16
4Overview  p. 17
4.1Introduction  p. 17
4.2Service Architecture  p. 17
4.3Functional Entities  p. 17
4.3.1API invoker  p. 17
4.3.2CAPIF core function  p. 17
4.3.3API exposing function  p. 17
4.3.4API publishing function  p. 17
4.3.5API management function  p. 17
5Services offered by the CAPIF Core Function  p. 17
5.1Introduction of Services  p. 17
5.2CAPIF_Discover_Service_API  p. 19
5.2.1Service Description  p. 19
5.2.1.1Overview  p. 19
5.2.2Service Operations  p. 19
5.2.2.1Introduction  p. 19
5.2.2.2Discover_Service_API  p. 19
5.2.2.2.1General  p. 19
5.2.2.2.2Consumer discovering service API using Discover_Service_API service operation  p. 20
5.3CAPIF_Publish_Service_API  p. 20
5.3.1Service Description  p. 20
5.3.1.1Overview  p. 20
5.3.2Service Operations  p. 20
5.3.2.1Introduction  p. 20
5.3.2.2Publish_Service_API  p. 21
5.3.2.2.1General  p. 21
5.3.2.2.2API publishing function publishing service APIs on CAPIF core function using Publish_Service_API service operation  p. 21
5.3.2.2.3CAPIF core function publishing service APIs on other CAPIF core function using Publish_Service_API service operation |R16|  p. 22
5.3.2.3Unpublish_Service_API  p. 23
5.3.2.3.1General  p. 23
5.3.2.3.2Consumer un-publishing service APIs from CAPIF core function using Unpublish_Service_API service operation  p. 23
5.3.2.4Get_Service_API  p. 23
5.3.2.4.1General  p. 23
5.3.2.4.2Consumer retrieving service APIs from CAPIF core function using Get_Service_API service operation  p. 23
5.3.2.5Update_Service_API  p. 24
5.3.2.5.1General  p. 24
5.3.2.5.2Consumer updating published service APIs on CAPIF core function using Update_Service_API service operation  p. 24
5.4CAPIF_Events_API  p. 25
5.4.1Service Description  p. 25
5.4.1.1Overview  p. 25
5.4.2Service Operations  p. 25
5.4.2.1Introduction  p. 25
5.4.2.2Subscribe_Event  p. 25
5.4.2.2.1General  p. 25
5.4.2.2.2Subscribing to CAPIF events using Subscribe_Event service operation  p. 25
5.4.2.3Unsubscribe_Event  p. 26
5.4.2.3.1General  p. 26
5.4.2.3.2Unsubscribing from CAPIF events using Unsubscribe_Event service operation  p. 26
5.4.2.4Notify_Event  p. 27
5.4.2.4.1General  p. 27
5.4.2.4.2Notifying CAPIF events using Notify_Event service operation  p. 27
5.4.2.5Update_Event_Subscription |R18|  p. 27
5.4.2.5.1General  p. 27
5.4.2.5.2Update Subscription to CAPIF events using Update_Event_Subscription service operation  p. 28
5.5CAPIF_API_Invoker_Management_API  p. 28
5.5.1Service Description  p. 28
5.5.1.1Overview  p. 28
5.5.2Service Operations  p. 28
5.5.2.1Introduction  p. 28
5.5.2.2Onboard_API_Invoker  p. 29
5.5.2.2.1General  p. 29
5.5.2.2.2API Invoker on-boarding itself as a recognized user of CAPIF using the Onboard_API_Invoker service operation  p. 29
5.5.2.3Offboard_API_Invoker  p. 30
5.5.2.3.1General  p. 30
5.5.2.3.2API Invoker off-boarding itself from being a recognized user of CAPIF using the Offboard_API_Invoker service operation  p. 30
5.5.2.4Notify_Onboarding_Completion  p. 30
5.5.2.4.1General  p. 30
5.5.2.4.2Notifying API Invoker's onboarding creation/update completion using Notify_Onboarding_Completion service operation  p. 30
5.5.2.5Update_API_Invoker_Details |R16|  p. 30
5.5.2.5.1General  p. 30
5.5.2.5.2API Invoker updating its details on CAPIF using Update_API_Invoker_Details service operation  p. 31
5.5.2.6Notify_Update_Completion |R16|  p. 32
5.5.2.6.1General  p. 32
5.6CAPIF_Security_API  p. 32
5.6.1Service Description  p. 32
5.6.1.1Overview  p. 32
5.6.2Service Operations  p. 32
5.6.2.1Introduction  p. 32
5.6.2.2Obtain_Security_Method  p. 33
5.6.2.2.1General  p. 33
5.6.2.2.2Request service API security method from CAPIF using Obtain_Security_Method service operation  p. 33
5.6.2.3Obtain_Authorization  p. 33
5.6.2.3.1General  p. 33
5.6.2.3.2Obtain authorization using Obtain_Authorization service operation  p. 33
5.6.2.3.3Void  p. …
5.6.2.4Obtain_API_Invoker_Info  p. 34
5.6.2.4.1General  p. 34
5.6.2.4.2Obtain API invoker's security information using Obtain_API_Invoker_Info service operation  p. 34
5.6.2.5Revoke_Authorization  p. 35
5.6.2.5.1General  p. 35
5.6.2.5.2Invalidate authorization using Revoke_Authorization service operation  p. 35
5.7CAPIF_Monitoring_API  p. 35
5.8CAPIF_Logging_API_Invocation_API  p. 35
5.8.1Service Description  p. 35
5.8.1.1Overview  p. 35
5.8.2Service Operations  p. 36
5.8.2.1Introduction  p. 36
5.8.2.2Log_API_Invocation_API  p. 36
5.8.2.2.1General  p. 36
5.8.2.2.2Logging service API invocations using Log_API_Invocation service operation  p. 36
5.9CAPIF_Auditing_API  p. 36
5.9.1Service Description  p. 36
5.9.1.1Overview  p. 36
5.9.2Service Operations  p. 37
5.9.2.1Introduction  p. 37
5.9.2.2Query_Invocation_Logs_API  p. 37
5.9.2.2.1General  p. 37
5.9.2.2.2Query API invocation information logs using Query_Invocation_Logs service operation  p. 37
5.10CAPIF_Access_Control_Policy_API  p. 37
5.10.1Service Description  p. 37
5.10.1.1Overview  p. 37
5.10.2Service Operations  p. 38
5.10.2.1Introduction  p. 38
5.10.2.2Obtain_Access_Control_Policy  p. 38
5.10.2.2.1General  p. 38
5.10.2.2.2API exposing function obtaining access control policy from the CAPIF core function using Obtain_Access_Control_Policy service operation  p. 38
5.10.3Related Events  p. 38
5.11CAPIF_API_Provider_Management_API |R16|  p. 38
5.11.1Service Description  p. 38
5.11.1.1Overview  p. 38
5.11.2Service Operations  p. 39
5.11.2.1Introduction  p. 39
5.11.2.2Register_API_Provider  p. 39
5.11.2.2.1General  p. 39
5.11.2.2.2API provider domain functions registering as a recognized API provider domain function of CAPIF using Register_API_Provider service operation  p. 39
5.11.2.3Update_API_Provider  p. 39
5.11.2.3.1General  p. 39
5.11.2.3.2API management function updating API provider domain function details on CAPIF using Update_API_Provider service operation  p. 40
5.11.2.4Deregister_API_Provider  p. 40
5.11.2.4.1General  p. 40
5.11.2.4.2API provider domain functions deregistering as a recognized API provider domain function of CAPIF using Deregister_API_Provider service operation  p. 40
5.12CAPIF_Routing_Info_API |R16|  p. 41
5.12.1Service Description  p. 41
5.12.1.1Overview  p. 41
5.12.2Service Operations  p. 41
5.12.2.1Introduction  p. 41
5.12.2.2Obtain_Routing_Info  p. 41
5.12.2.2.1General  p. 41
5.12.2.2.2API exposing function obtaining API routing information from the CAPIF core function using Obtain_Routing_Info service operation  p. 41
6Services offered by the API exposing function  p. 42
6.1Introduction of Services  p. 42
6.2AEF_Security_API  p. 42
6.2.1Service Description  p. 42
6.2.1.1Overview  p. 42
6.2.2Service Operations  p. 42
6.2.2.1Introduction  p. 42
6.2.2.2Initiate_Authentication  p. 43
6.2.2.2.1General  p. 43
6.2.2.2.2API invoker initiating authentication using Initiate_Authentication service operation  p. 43
6.2.2.3Revoke_Authorization |R16|  p. 43
6.2.2.3.1General  p. 43
6.2.2.3.2CAPIF core function initiating revocation using Revoke_Authorization service operation  p. 43
7CAPIF Design Aspects Common for All APIs  p. 43
7.1General  p. 43
7.2Data Types  p. 44
7.2.1General  p. 44
7.2.2Void  p. …
7.2.3Void  p. …
7.3Usage of HTTP  p. 44
7.4Content type  p. 44
7.5URI structure  p. 44
7.6Notifications  p. 44
7.7Error handling  p. 45
7.8Feature negotiation  p. 45
7.9HTTP custom headers  p. 45
7.10Conventions for Open API specification files  p. 45
7.11CAPIF vendor-specifc extensions |R18|  p. 45
8CAPIF Core Function API Definition  p. 45
8.1CAPIF_Discover_Service_API  p. 45
8.1.1API URI  p. 45
8.1.2Resources  p. 46
8.1.2.1Overview  p. 46
8.1.2.2Resource: All published service APIs  p. 46
8.1.2.2.1Description  p. 46
8.1.2.2.2Resource Definition  p. 46
8.1.2.2.3Resource Standard Methods  p. 47
8.1.2.2.3.1GET  p. 47
8.1.2.2.4Resource Custom Operations  p. 50
8.1.2ACustom Operations without associated resources |R18|  p. 50
8.1.3Notifications  p. 50
8.1.4Data Model  p. 50
8.1.4.1General  p. 50
8.1.4.2Structured data types  p. 51
8.1.4.2.1Introduction  p. 51
8.1.4.2.2Type: DiscoveredAPIs  p. 51
8.1.4.2.3Void  p. …
8.1.4.2.4Type: IpAddrInfo |R18|  p. 52
8.1.4.2.5Type: ResOperInfo |R19|  p. 52
8.1.4.3Simple data types and enumerations  p. 52
8.1.4.3.1Introduction |R18|  p. 52
8.1.4.3.2Simple data types |R18|  p. 52
8.1.4.4Data types describing alternative data types or combinations of data types |R18|  p. 53
8.1.5Error Handling  p. 53
8.1.5.1General |R18|  p. 53
8.1.5.2Protocol Errors |R18|  p. 53
8.1.5.3Application Errors |R18|  p. 53
8.1.6Feature negotiation  p. 53
8.2CAPIF_Publish_Service_API  p. 54
8.2.1API URI  p. 54
8.2.2Resources  p. 54
8.2.2.1Overview  p. 54
8.2.2.2Resource: APF published APIs  p. 55
8.2.2.2.1Description  p. 55
8.2.2.2.2Resource Definition  p. 55
8.2.2.2.3Resource Standard Methods  p. 56
8.2.2.2.3.1POST  p. 56
8.2.2.2.3.2GET  p. 56
8.2.2.2.4Resource Custom Operations  p. 57
8.2.2.3Resource: Individual APF published API  p. 58
8.2.2.3.1Description  p. 58
8.2.2.3.2Resource Definition  p. 58
8.2.2.3.3Resource Standard Methods  p. 58
8.2.2.3.3.1GET  p. 58
8.2.2.3.3.2PUT  p. 59
8.2.2.3.3.3DELETE  p. 60
8.2.2.3.3.4PATCH   p. 61
8.2.2.3.4Resource Custom Operations  p. 62
8.2.2ACustom Operations without associated resources |R18|  p. 62
8.2.3Notifications  p. 62
8.2.4Data Model  p. 63
8.2.4.1General  p. 63
8.2.4.2Structured data types  p. 64
8.2.4.2.1Introduction  p. 64
8.2.4.2.2Type: ServiceAPIDescription  p. 65
8.2.4.2.3Type: InterfaceDescription  p. 66
8.2.4.2.4Type: AefProfile  p. 67
8.2.4.2.5Type: Version  p. 68
8.2.4.2.6Type: Resource  p. 68
8.2.4.2.7Type: CustomOperation  p. 69
8.2.4.2.8Type: ShareableInformation |R16|  p. 69
8.2.4.2.9Type: PublishedApiPath |R16|  p. 69
8.2.4.2.10Type: AefLocation |R17|  p. 70
8.2.4.2.11Type: ServiceAPIDescriptionPatch |R17|  p. 70
8.2.4.2.12Type: ApiStatus |R18|  p. 71
8.2.4.2.13Type: ServiceKpis |R18|  p. 72
8.2.4.2.14Type: IpAddrRange |R18|  p. 74
8.2.4.3Simple data types and enumerations  p. 74
8.2.4.3.1Introduction  p. 74
8.2.4.3.2Simple data types  p. 74
8.2.4.3.3Enumeration: Protocol  p. 74
8.2.4.3.4Enumeration: DataFormat  p. 75
8.2.4.3.5Enumeration: CommunicationType  p. 75
8.2.4.3.6Enumeration: SecurityMethod  p. 75
8.2.4.3.7Enumeration: Operation  p. 75
8.2.5Error Handling  p. 75
8.2.5.1General |R18|  p. 75
8.2.5.2Protocol Errors |R18|  p. 76
8.2.5.3Application Errors |R18|  p. 76
8.2.6Feature negotiation  p. 76
8.3CAPIF_Events_API  p. 77
8.3.1API URI  p. 77
8.3.2Resources  p. 78
8.3.2.1Overview  p. 78
8.3.2.2Resource: CAPIF Events Subscriptions  p. 78
8.3.2.2.1Description  p. 78
8.3.2.2.2Resource Definition  p. 79
8.3.2.2.3Resource Standard Methods  p. 79
8.3.2.2.3.1POST  p. 79
8.3.2.2.4Resource Custom Operations  p. 79
8.3.2.3Resource: Individual CAPIF Events Subscription  p. 80
8.3.2.3.1Description  p. 80
8.3.2.3.2Resource Definition  p. 80
8.3.2.3.3Resource Standard Methods  p. 80
8.3.2.3.3.1DELETE  p. 80
8.3.2.3.3.2PUT   p. 81
8.3.2.3.3.3PATCH   p. 82
8.3.2.3.4Resource Custom Operations  p. 83
8.3.2ACustom Operations without associated resources |R18|  p. 83
8.3.3Notifications  p. 83
8.3.3.1General  p. 83
8.3.3.2Event Notification  p. 84
8.3.3.2.1Description  p. 84
8.3.3.2.2Notification definition  p. 84
8.3.3.2.2.1Target URI   p. 84
8.3.3.2.2.2Standard Methods   p. 84
8.3.3.2.2.2.1POST  p. 84
8.3.4Data Model  p. 85
8.3.4.1General  p. 85
8.3.4.2Structured data types  p. 86
8.3.4.2.1Introduction  p. 86
8.3.4.2.2Type: EventSubscription  p. 87
8.3.4.2.3Type: EventNotification  p. 87
8.3.4.2.4Type: CAPIFEventFilter |R16|  p. 88
8.3.4.2.5Type: CAPIFEventDetail |R16|  p. 88
8.3.4.2.6Type: AccessControlPolicyListExt |R16|  p. 88
8.3.4.2.7Type: TopologyHiding |R16|  p. 88
8.3.4.2.8Type: EventSubscriptionPatch |R18|  p. 89
8.3.4.2.9Type: ApiInvokerCount |R19|  p. 89
8.3.4.2.10Type: DiscoveryCount |R19|  p. 89
8.3.4.3Simple data types and enumerations  p. 90
8.3.4.3.1Introduction  p. 90
8.3.4.3.2Simple data types  p. 90
8.3.4.3.3Enumeration: CAPIFEvent  p. 90
8.3.4.4Data types describing alternative data types or combinations of data types |R19|  p. 91
8.3.4.5Binary data |R19|  p. 92
8.3.4.5.1Binary Data Types  p. 92
8.3.5Error Handling  p. 92
8.3.5.1General |R18|  p. 92
8.3.5.2Protocol Errors |R18|  p. 92
8.3.5.3Application Errors |R18|  p. 92
8.3.6Feature negotiation  p. 92
8.4CAPIF_API_Invoker_Management_API  p. 93
8.4.1API URI  p. 93
8.4.2Resources  p. 93
8.4.2.1Overview  p. 93
8.4.2.2Resource: On-boarded API Invokers  p. 94
8.4.2.2.1Description  p. 94
8.4.2.2.2Resource Definition  p. 94
8.4.2.2.3Resource Standard Methods  p. 95
8.4.2.2.3.1POST  p. 95
8.4.2.2.4Resource Custom Operations  p. 95
8.4.2.3Resource: Individual On-boarded API Invoker  p. 95
8.4.2.3.1Description  p. 95
8.4.2.3.2Resource Definition  p. 95
8.4.2.3.3Resource Standard Methods  p. 96
8.4.2.3.3.1DELETE  p. 96
8.4.2.3.3.2PUT   p. 97
8.4.2.3.3.3PATCH   p. 98
8.4.2.3.4Resource Custom Operations  p. 99
8.4.2ACustom Operations without associated resources |R18|  p. 99
8.4.3Notifications  p. 99
8.4.3.1General  p. 99
8.4.3.2Notify_Onboarding_Completion  p. 100
8.4.3.2.1Description  p. 100
8.4.3.2.2Notification definition  p. 100
8.4.3.3Void  p. …
8.4.4Data Model  p. 101
8.4.4.1General  p. 101
8.4.4.2Structured data types  p. 102
8.4.4.2.1Introduction  p. 102
8.4.4.2.2Type: APIInvokerEnrolmentDetails  p. 103
8.4.4.2.3Void  p. …
8.4.4.2.4Type: APIList  p. 104
8.4.4.2.5Type: OnboardingInformation  p. 104
8.4.4.2.6Void  p. …
8.4.4.2.7Type: OnboardingNotification  p. 105
8.4.4.2.8Type: APIInvokerEnrolmentDetailsPatch |R17|  p. 105
8.4.4.2.9Type: OnboardingCriteria |R19|  p. 106
8.4.4.2.10Type: RelatedCriteria |R19|  p. 106
8.4.4.2.11Type: ApiInfo |R19|  p. 106
8.4.4.2.12Type: EnrolFailReason |R19|  p. 106
8.4.4.3Simple data types and enumerations  p. 107
8.4.4.3.1Introduction |R19|  p. 107
8.4.4.3.2Simple data types |R19|  p. 107
8.4.4.3.3Enumeration: EnrolFailCause |R19|  p. 107
8.4.4.3.4Enumeration: OnboardingFailReason |R19|  p. 107
8.4.4.4Data types describing alternative data types or combinations of data types |R19|  p. 107
8.4.4.5Binary data |R19|  p. 108
8.4.4.5.1Binary Data Types  p. 108
8.4.5Error Handling  p. 108
8.4.5.1General |R18|  p. 108
8.4.5.2Protocol Errors |R18|  p. 108
8.4.5.3Application Errors |R18|  p. 108
8.4.6Feature negotiation  p. 108
8.5CAPIF_Security_API  p. 109
8.5.1API URI  p. 109
8.5.2Resources  p. 109
8.5.2.1Overview  p. 109
8.5.2.2Resource: Trusted API invokers  p. 110
8.5.2.2.1Description  p. 110
8.5.2.2.2Resource Definition  p. 111
8.5.2.2.3Resource Standard Methods  p. 111
8.5.2.2.3.1Void  p. …
8.5.2.2.4Resource Custom Operations  p. 111
8.5.2.3Resource: Individual trusted API invokers  p. 111
8.5.2.3.1Description  p. 111
8.5.2.3.2Resource Definition  p. 111
8.5.2.3.3Resource Standard Methods  p. 111
8.5.2.3.3.1GET  p. 111
8.5.2.3.3.2DELETE  p. 113
8.5.2.3.3.3PUT  p. 113
8.5.2.3.4Resource Custom Operations  p. 114
8.5.2.3.4.1Overview  p. 114
8.5.2.3.4.2Operation: update  p. 115
8.5.2.3.4.2.1Description  p. 115
8.5.2.3.4.2.2Operation Definition  p. 115
8.5.2.3.4.3Operation: delete  p. 116
8.5.2.3.4.3.1Description  p. 116
8.5.2.3.4.3.2Operation Definition  p. 116
8.5.2.3.4.4Operation: token  p. 117
8.5.2.3.4.4.1Description  p. 117
8.5.2.3.4.4.2Operation Definition  p. 117
8.5.2.3.4.5Void  p. …
8.5.2ACustom Operations without associated resources |R18|  p. 118
8.5.3Notifications  p. 118
8.5.3.1General  p. 118
8.5.3.2Authorization revoked notification  p. 119
8.5.3.2.1Description  p. 119
8.5.3.2.2Notification definition  p. 119
8.5.4Data Model  p. 120
8.5.4.1General  p. 120
8.5.4.2Structured data types  p. 122
8.5.4.2.1Introduction  p. 122
8.5.4.2.2Type: ServiceSecurity  p. 122
8.5.4.2.3Type: SecurityInformation  p. 123
8.5.4.2.4Void  p. …
8.5.4.2.5Type: SecurityNotification  p. 123
8.5.4.2.6Type: AccessTokenReq  p. 124
8.5.4.2.7Type: AccessTokenRsp  p. 128
8.5.4.2.8Type: AccessTokenClaims  p. 132
8.5.4.2.9Type: AccessTokenErr |R17|  p. 135
8.5.4.2.10Void  p. …
8.5.4.2.11Type: ResOwnerId |R18|  p. 136
8.5.4.3Simple data types and enumerations  p. 136
8.5.4.3.1Introduction  p. 136
8.5.4.3.2Simple data types  p. 136
8.5.4.3.3Enumeration: Cause  p. 136
8.5.4.3.4Enumeration: OAuthGrantType |R18|  p. 136
8.5.5Error Handling  p. 137
8.5.5.1General |R17|  p. 137
8.5.5.2Protocol Errors |R17|  p. 137
8.5.5.3Application Errors |R17|  p. 137
8.5.6Feature negotiation  p. 137
8.6CAPIF_Access_Control_Policy_API  p. 138
8.6.1API URI  p. 138
8.6.2Resources  p. 138
8.6.2.1Overview  p. 138
8.6.2.2Resource: Access Control Policy List  p. 139
8.6.2.2.1Description  p. 139
8.6.2.2.2Resource Definition  p. 139
8.6.2.2.3Resource Standard Methods  p. 140
8.6.2.2.3.1GET  p. 140
8.6.2.2.4Resource Custom Operations  p. 141
8.6.2ACustom Operations without associated resources |R18|  p. 141
8.6.3Notifications  p. 141
8.6.4Data Model  p. 141
8.6.4.1General  p. 141
8.6.4.2Structured data types  p. 141
8.6.4.2.1Introduction  p. 141
8.6.4.2.2Type: AccessControlPolicyList  p. 141
8.6.4.2.3Type: ApiInvokerPolicy  p. 142
8.6.4.2.4Type: TimeRangeList  p. 142
8.6.4.3Simple data types and enumerations  p. 142
8.6.5Error Handling  p. 142
8.6.5.1General |R18|  p. 142
8.6.5.2Protocol Errors |R18|  p. 142
8.6.5.3Application Errors |R18|  p. 142
8.6.6Feature negotiation  p. 143
8.7CAPIF_Logging_API_Invocation_API  p. 143
8.7.1API URI  p. 143
8.7.2Resources  p. 143
8.7.2.1Overview  p. 143
8.7.2.2Resource: Logs  p. 144
8.7.2.2.1Description  p. 144
8.7.2.2.2Resource Definition  p. 144
8.7.2.2.3Resource Standard Methods  p. 144
8.7.2.2.3.1POST  p. 144
8.7.2.2.4Resource Custom Operations  p. 145
8.7.2ACustom Operations without associated resources |R18|  p. 145
8.7.3Notifications  p. 145
8.7.4Data Model  p. 145
8.7.4.1General  p. 145
8.7.4.2Structured data types  p. 146
8.7.4.2.1Introduction  p. 146
8.7.4.2.2Type: InvocationLog  p. 146
8.7.4.2.3Type: Log  p. 147
8.7.4.3Simple data types and enumerations  p. 147
8.7.4.3.1Introduction |R16|  p. 147
8.7.4.3.2Simple data types |R16|  p. 148
8.7.5Error Handling  p. 148
8.7.5.1General |R18|  p. 148
8.7.5.2Protocol Errors |R18|  p. 148
8.7.5.3Application Errors |R18|  p. 148
8.7.6Feature negotiation  p. 148
8.8CAPIF_Auditing_API  p. 148
8.8.1API URI  p. 148
8.8.2Resources  p. 149
8.8.2.1Overview  p. 149
8.8.2.2Resource: All service API invocation logs  p. 149
8.8.2.2.1Description  p. 149
8.8.2.2.2Resource Definition  p. 149
8.8.2.2.3Resource Standard Methods  p. 150
8.8.2.2.3.1GET  p. 150
8.8.2.2.4Resource Custom Operations  p. 151
8.8.2ACustom Operations without associated resources |R18|  p. 151
8.8.3Notifications  p. 151
8.8.4Data Model  p. 151
8.8.4.1General  p. 151
8.8.4.2Structured data types  p. 152
8.8.4.2.1Introduction |R18|  p. 152
8.8.4.2.2Type: InvocationLogs |R18|  p. 152
8.8.4.3Simple data types and enumerations  p. 153
8.8.4.4Data types describing alternative data types or combinations of data types |R18|  p. 153
8.8.4.4.1Type: InvocationLogsRetrieveRes  p. 153
8.8.5Error Handling  p. 153
8.8.5.1General |R18|  p. 153
8.8.5.2Protocol Errors |R18|  p. 153
8.8.5.3Application Errors |R18|  p. 153
8.8.6Feature negotiation  p. 153
8.9CAPIF_API_Provider_Management_API |R16|  p. 154
8.9.1API URI  p. 154
8.9.2Resources  p. 154
8.9.2.1Overview  p. 154
8.9.2.2Resource: All API Provider Domains Registrations  p. 155
8.9.2.2.1Description  p. 155
8.9.2.2.2Resource Definition  p. 155
8.9.2.2.3Resource Standard Methods  p. 155
8.9.2.2.3.1POST  p. 155
8.9.2.2.4Resource Custom Operations  p. 156
8.9.2.3Resource: Individual API Provider Domain Registration  p. 156
8.9.2.3.1Description  p. 156
8.9.2.3.2Resource Definition  p. 156
8.9.2.3.3Resource Standard Methods  p. 156
8.9.2.3.3.1PUT  p. 156
8.9.2.3.3.2DELETE  p. 157
8.9.2.3.3.3PATCH   p. 158
8.9.2.3.4Resource Custom Operations  p. 159
8.9.2ACustom Operations without associated resources |R18|  p. 159
8.9.3Notifications  p. 160
8.9.4Data Model  p. 160
8.9.4.1General  p. 160
8.9.4.2Structured data types  p. 161
8.9.4.2.1Introduction  p. 161
8.9.4.2.2Type: APIProviderEnrolmentDetails  p. 161
8.9.4.2.3Type: APIProviderFunctionDetails  p. 162
8.9.4.2.4Type: RegistrationInformation  p. 162
8.9.4.2.5Type: APIProviderEnrolmentDetailsPatch |R17|  p. 163
8.9.4.3Simple data types and enumerations  p. 163
8.9.4.3.1Introduction  p. 163
8.9.4.3.2Simple data types  p. 163
8.9.4.3.3Enumeration: ApiProviderFuncRole  p. 163
8.9.5Error Handling  p. 163
8.9.5.1General |R18|  p. 163
8.9.5.2Protocol Errors |R18|  p. 163
8.9.5.3Application Errors |R18|  p. 164
8.9.6Feature negotiation  p. 164
8.10CAPIF_Routing_Info_API |R16|  p. 164
8.10.1API URI  p. 164
8.10.2Resources  p. 164
8.10.2.1Overview  p. 164
8.10.2.2Resource: Individual Service API routing info  p. 165
8.10.2.2.1Description  p. 165
8.10.2.2.2Resource Definition  p. 165
8.10.2.2.3Resource Standard Methods  p. 165
8.10.2.2.3.1GET  p. 165
8.10.2.2.4Resource Custom Operations  p. 166
8.10.2ACustom Operations without associated resources |R18|  p. 166
8.10.3Notifications  p. 167
8.10.4Data Model  p. 167
8.10.4.1General  p. 167
8.10.4.2Structured data types  p. 167
8.10.4.2.1Introduction  p. 167
8.10.4.2.2Type: RoutingInfo  p. 167
8.10.4.2.3Type: RoutingRule  p. 168
8.10.4.2.4Type: Ipv6AddressRange  p. 168
8.10.4.3Simple data types and enumerations  p. 168
8.10.5Error Handling  p. 168
8.10.5.1General |R18|  p. 168
8.10.5.2Protocol Errors |R18|  p. 168
8.10.5.3Application Errors |R18|  p. 168
8.10.6Feature negotiation  p. 168
8.11CAPIF_Open_Discover_Service_API |R19|  p. 169
8.11.1Introduction  p. 169
8.11.1AUsage of HTTP  p. 169
8.11.2Resources  p. 169
8.11.2.1Overview  p. 169
8.11.2.2Resource: Service APIs  p. 170
8.11.2.2.1Description  p. 170
8.11.2.2.2Resource Definition  p. 170
8.11.2.2.3Resource Standard Methods  p. 170
8.11.2.2.3.1GET  p. 170
8.11.2.2.4Resource Custom Operations  p. 174
8.11.3Custom Operations without associated resources  p. 174
8.11.4Notifications  p. 174
8.11.5Data Model  p. 174
8.14.5.1General  p. 174
8.11.5.2Structured data types  p. 175
8.11.5.2.1Introduction  p. 175
8.11.5.2.2Type: OpenDiscoveryResp  p. 175
8.11.5.2.3Type: OpenAPIDetails  p. 175
8.11.5.2.4Type: OpenAefProfile  p. 176
8.11.5.3Simple data types and enumerations  p. 176
8.11.5.3.1Introduction  p. 176
8.11.5.3.2Simple data types  p. 176
8.11.5.4Data types describing alternative data types or combinations of data types  p. 176
8.11.6Error Handling  p. 176
8.11.6.1General  p. 176
8.11.6.2Protocol Errors  p. 176
8.11.6.3Application Errors  p. 176
8.11.7Feature negotiation  p. 177
8.11.8Security  p. 177
9AEF API Definition  p. 177
9.1AEF_Security_API  p. 177
9.1.1API URI  p. 177
9.1.2Resources  p. 177
9.1.2ACustom Operations without associated resources |R17|  p. 177
9.1.2A.1Overview  p. 177
9.1.2A.2Operation: check-authentication  p. 178
9.1.2A.2.1Description  p. 178
9.1.2A.2.2Operation Definition  p. 178
9.1.2A.3Operation: revoke-authorization  p. 179
9.1.2A.3.1Description  p. 179
9.1.2A.3.2Operation Definition  p. 179
9.1.3Notifications  p. 180
9.1.4Data Model  p. 180
9.1.4.1General  p. 180
9.1.4.2Structured data types  p. 180
9.1.4.2.1Introduction  p. 180
9.1.4.2.2Type: CheckAuthenticationReq  p. 180
9.1.4.2.3Type: CheckAuthenticationRsp  p. 181
9.1.4.2.4Type: RevokeAuthorizationReq  p. 181
9.1.4.2.5Type: RevokeAuthorizationRsp  p. 181
9.1.4.3Simple data types and enumerations  p. 181
9.1.5Error Handling  p. 181
9.1.5.1General |R18|  p. 181
9.1.5.2Protocol Errors |R18|  p. 181
9.1.5.3Application Errors |R18|  p. 181
9.1.6Feature negotiation  p. 182
10Security  p. 182
10.1General  p. 182
10.2CAPIF-1/1e security  p. 182
10.3CAPIF-2/2e security and securely invoking service APIs  p. 182
A(Normative)  OpenAPI specification  p. 182
A.1General  p. 182
A.2CAPIF_Discover_Service_API  p. 183
A.3CAPIF_Publish_Service_API  p. 186
A.4CAPIF_Events_API  p. 196
A.5CAPIF_API_Invoker_Management_API  p. 203
A.6CAPIF_Security_API  p. 210
A.7CAPIF_Access_Control_Policy_API  p. 218
A.8CAPIF_Logging_API_Invocation_API  p. 219
A.9CAPIF_Auditing_API  p. 222
A.10AEF_Security_API  p. 224
A.11CAPIF_API_Provider_Management_API |R16|  p. 226
A.12CAPIF_Routing_Info_API |R16|  p. 231
A.13CAPIF_Open_Discover_Service_API |R19|  p. 232
BIANA registration of 3GPP defined JWT claims |R19|  p. 236
B.1Introduction  p. 236
B.2"resOwnerId" JWT claim  p. 236
$Change history  p. 237

Up   Top