Content for TS 29.222 Word version: 18.4.0
8 CAPIF API Definition
8.1 CAPIF_Discover_Service_API
8.2 CAPIF_Publish_Service_API
8.3 CAPIF_Events_API
8.4 CAPIF_API_Invoker_Management_API
8.5 CAPIF_Security_API
8.6 CAPIF_Access_Control_Policy_API
8.7 CAPIF_Logging_API_Invocation_API
8.8 CAPIF_Auditing_API
8.9 CAPIF_API_Provider_Management_API
8.10 CAPIF_Routing_Info_API
8 CAPIF API Definition p. 47
8.1 CAPIF_Discover_Service_API p. 47
8.1.1 API URI p. 47
8.1.2 Resources p. 47
8.1.2.1 Overview p. 47
8.1.2.2 Resource: All published service APIs p. 48
8.1.2.2.1 Description p. 48
8.1.2.2.2 Resource Definition p. 48
8.1.2.2.3 Resource Standard Methods p. 48
8.1.2.2.3.1 GET p. 48
8.1.2.2.4 Resource Custom Operations p. 50
8.1.2A Custom Operations without associated resources |R18| p. 50
8.1.3 Notifications p. 50
8.1.4 Data Model p. 50
8.1.4.1 General p. 50
8.1.4.2 Structured data types p. 51
8.1.4.2.1 Introduction p. 51
8.1.4.2.2 Type: DiscoveredAPIs p. 51
8.1.4.2.3 Void
8.1.4.2.4 Type: IpAddrInfo |R18| p. 51
8.1.4.3 Simple data types and enumerations p. 52
8.1.5 Error Handling p. 52
8.1.5.1 General |R18| p. 52
8.1.5.2 Protocol Errors |R18| p. 52
8.1.5.3 Application Errors |R18| p. 52
8.1.6 Feature negotiation p. 52
8.2 CAPIF_Publish_Service_API p. 52
8.2.1 API URI p. 52
8.2.2 Resources p. 53
8.2.2.1 Overview p. 53
8.2.2.2 Resource: APF published APIs p. 53
8.2.2.2.1 Description p. 53
8.2.2.2.2 Resource Definition p. 54
8.2.2.2.3 Resource Standard Methods p. 54
8.2.2.2.3.1 POST p. 54
8.2.2.2.3.2 GET p. 54
8.2.2.2.4 Resource Custom Operations p. 55
8.2.2.3 Resource: Individual APF published API p. 55
8.2.2A Custom Operations without associated resources |R18| p. 59
8.2.3 Notifications p. 59
8.2.4 Data Model p. 60
8.2.4.1 General p. 60
8.2.4.2 Structured data types p. 62
8.2.4.2.1 Introduction p. 62
8.2.4.2.2 Type: ServiceAPIDescription p. 62
8.2.4.2.3 Type: InterfaceDescription p. 63
8.2.4.2.4 Type: AefProfile p. 63
8.2.4.2.5 Type: Version p. 64
8.2.4.2.6 Type: Resource p. 64
8.2.4.2.7 Type: CustomOperation p. 65
8.2.4.2.8 Type: ShareableInformation |R16| p. 65
8.2.4.2.9 Type: PublishedApiPath |R16| p. 65
8.2.4.2.10 Type: AefLocation |R17| p. 65
8.2.4.2.11 Type: ServiceAPIDescriptionPatch |R17| p. 66
8.2.4.2.12 Type: ApiStatus |R18| p. 66
8.2.4.2.13 Type: ServiceKpi |R18| p. 67
8.2.4.2.14 Type: IpAddrRange |R18| p. 68
8.2.4.3 Simple data types and enumerations p. 68
8.2.5 Error Handling p. 69
8.2.5.1 General |R18| p. 69
8.2.5.2 Protocol Errors |R18| p. 70
8.2.5.3 Application Errors |R18| p. 70
8.2.6 Feature negotiation p. 70
8.3 CAPIF_Events_API p. 70
8.3.1 API URI p. 70
8.3.2 Resources p. 71
8.3.2.1 Overview p. 71
8.3.2.2 Resource: CAPIF Events Subscriptions p. 72
8.3.2.2.1 Description p. 72
8.3.2.2.2 Resource Definition p. 72
8.3.2.2.3 Resource Standard Methods p. 72
8.3.2.2.3.1 POST p. 72
8.3.2.2.4 Resource Custom Operations p. 73
8.3.2.3 Resource: Individual CAPIF Events Subscription p. 73
8.3.2A Custom Operations without associated resources |R18| p. 76
8.3.3 Notifications p. 76
8.3.3.1 General p. 76
8.3.3.2 Event Notification p. 76
8.3.4 Data Model p. 77
8.3.4.1 General p. 77
8.3.4.2 Structured data types p. 78
8.3.4.2.1 Introduction p. 78
8.3.4.2.2 Type: EventSubscription p. 79
8.3.4.2.3 Type: EventNotification p. 79
8.3.4.2.4 Type: CAPIFEventFilter |R16| p. 80
8.3.4.2.5 Type: CAPIFEventDetail |R16| p. 80
8.3.4.2.6 Type: AccessControlPolicyListExt |R16| p. 80
8.3.4.2.7 Type: TopologyHiding |R16| p. 80
8.3.4.2.8 Type: EventSubscriptionPatch |R18| p. 81
8.3.4.3 Simple data types and enumerations p. 81
8.3.5 Error Handling p. 82
8.3.5.1 General |R18| p. 82
8.3.5.2 Protocol Errors |R18| p. 82
8.3.5.3 Application Errors |R18| p. 82
8.3.6 Feature negotiation p. 83
8.4 CAPIF_API_Invoker_Management_API p. 83
8.4.1 API URI p. 83
8.4.2 Resources p. 83
8.4.2.1 Overview p. 83
8.4.2.2 Resource: On-boarded API invokers p. 84
8.4.2.2.1 Description p. 84
8.4.2.2.2 Resource Definition p. 84
8.4.2.2.3 Resource Standard Methods p. 85
8.4.2.2.3.1 POST p. 85
8.4.2.2.4 Resource Custom Operations p. 85
8.4.2.3 Resource: Individual On-boarded API Invoker p. 86
8.4.2A Custom Operations without associated resources |R18| p. 89
8.4.3 Notifications p. 89
8.4.3.1 General p. 89
8.4.3.2 Notify_Onboarding_Completion p. 90
8.4.3.3 Notify_Update_Completion |R16| p. 91
8.4.4 Data Model p. 92
8.4.4.1 General p. 92
8.4.4.2 Structured data types p. 94
8.4.4.2.1 Introduction p. 94
8.4.4.2.2 Type: APIInvokerEnrolmentDetails p. 94
8.4.4.2.3 Void
8.4.4.2.4 Type: APIList p. 94
8.4.4.2.5 Type: OnboardingInformation p. 95
8.4.4.2.6 Void
8.4.4.2.7 Type: OnboardingNotification p. 95
8.4.4.2.8 Type: APIInvokerEnrolmentDetailsPatch |R17| p. 96
8.4.4.3 Simple data types and enumerations p. 96
8.4.5 Error Handling p. 96
8.4.5.1 General |R18| p. 96
8.4.5.2 Protocol Errors |R18| p. 96
8.4.5.3 Application Errors |R18| p. 96
8.4.6 Feature negotiation p. 96
8.5 CAPIF_Security_API p. 97
8.5.1 API URI p. 97
8.5.2 Resources p. 97
8.5.2.1 Overview p. 97
8.5.2.2 Resource: Trusted API invokers p. 98
8.5.2.2.1 Description p. 98
8.5.2.2.2 Resource Definition p. 98
8.5.2.2.3 Resource Standard Methods p. 98
8.5.2.2.4 Resource Custom Operations p. 98
8.5.2.3 Resource: Individual trusted API invokers p. 99
8.5.2.3.1 Description p. 99
8.5.2.3.2 Resource Definition p. 99
8.5.2.3.3 Resource Standard Methods p. 99
8.5.2.3.4 Resource Custom Operations p. 102
8.5.2.3.4.1 Overview p. 102
8.5.2.3.4.2 Operation: update p. 102
8.5.2.3.4.3 Operation: delete p. 103
8.5.2.3.4.4 Operation: token p. 104
8.5.2.3.4.5 Operation: code p. 106
8.5.2A Custom Operations without associated resources |R18| p. 107
8.5.3 Notifications p. 107
8.5.3.1 General p. 107
8.5.3.2 Authorization revoked notification p. 107
8.5.3.2.1 Description p. 107
8.5.3.2.2 Notification definition p. 107
8.5.4 Data Model p. 108
8.5.4.1 General p. 108
8.5.4.2 Structured data types p. 110
8.5.4.2.1 Introduction p. 110
8.5.4.2.2 Type: ServiceSecurity p. 110
8.5.4.2.3 Type: SecurityInformation p. 110
8.5.4.2.4 Void
8.5.4.2.5 Type: SecurityNotification p. 111
8.5.4.2.6 Type: AccessTokenReq p. 112
8.5.4.2.7 Type: AccessTokenRsp p. 113
8.5.4.2.8 Type: AccessTokenClaims p. 114
8.5.4.2.9 Type: AccessTokenErr |R17| p. 115
8.5.4.2.10 Type: AuthorizationCodeRsp |R18| p. 115
8.5.4.3 Simple data types and enumerations p. 115
8.5.4.3.1 Introduction p. 115
8.5.4.3.2 Simple data types p. 115
8.5.4.3.3 Enumeration: Cause p. 116
8.5.4.3.4 Enumeration: AuthorizationFlow |R18| p. 116
8.5.5 Error Handling p. 116
8.5.5.1 General |R17| p. 116
8.5.5.2 Protocol Errors |R17| p. 116
8.5.5.3 Application Errors |R17| p. 116
8.5.6 Feature negotiation p. 117
8.6 CAPIF_Access_Control_Policy_API p. 117
8.6.1 API URI p. 117
8.6.2 Resources p. 117
8.6.2.1 Overview p. 117
8.6.2.2 Resource: Access Control Policy List p. 118
8.6.2.2.1 Description p. 118
8.6.2.2.2 Resource Definition p. 118
8.6.2.2.3 Resource Standard Methods p. 119
8.6.2.2.3.1 GET p. 119
8.6.2.2.4 Resource Custom Operations p. 119
8.6.2A Custom Operations without associated resources |R18| p. 120
8.6.3 Notifications p. 120
8.6.4 Data Model p. 120
8.6.4.1 General p. 120
8.6.4.2 Structured data types p. 120
8.6.4.2.1 Introduction p. 120
8.6.4.2.2 Type: AccessControlPolicyList p. 120
8.6.4.2.3 Type: ApiInvokerPolicy p. 121
8.6.4.2.4 Type: TimeRangeList p. 121
8.6.4.3 Simple data types and enumerations p. 121
8.6.5 Error Handling p. 121
8.6.5.1 General |R18| p. 121
8.6.5.2 Protocol Errors |R18| p. 121
8.6.5.3 Application Errors |R18| p. 121
8.6.6 Feature negotiation p. 122
8.7 CAPIF_Logging_API_Invocation_API p. 122
8.7.1 API URI p. 122
8.7.2 Resources p. 122
8.7.2.1 Overview p. 122
8.7.2.2 Resource: Logs p. 123
8.7.2.2.1 Description p. 123
8.7.2.2.2 Resource Definition p. 123
8.7.2.2.3 Resource Standard Methods p. 123
8.7.2.2.3.1 POST p. 123
8.7.2.2.4 Resource Custom Operations p. 124
8.7.2A Custom Operations without associated resources |R18| p. 124
8.7.3 Notifications p. 124
8.7.4 Data Model p. 124
8.7.4.1 General p. 124
8.7.4.2 Structured data types p. 125
8.7.4.3 Simple data types and enumerations p. 126
8.7.5 Error Handling p. 127
8.7.5.1 General |R18| p. 127
8.7.5.2 Protocol Errors |R18| p. 127
8.7.5.3 Application Errors |R18| p. 127
8.7.6 Feature negotiation p. 127
8.8 CAPIF_Auditing_API p. 127
8.8.1 API URI p. 127
8.8.2 Resources p. 128
8.8.2.1 Overview p. 128
8.8.2.2 Resource: All service API invocation logs p. 128
8.8.2.2.1 Description p. 128
8.8.2.2.2 Resource Definition p. 128
8.8.2.2.3 Resource Standard Methods p. 129
8.8.2.2.3.1 GET p. 129
8.8.2.2.4 Resource Custom Operations p. 130
8.8.2A Custom Operations without associated resources |R18| p. 130
8.8.3 Notifications p. 130
8.8.4 Data Model p. 130
8.8.4.1 General p. 130
8.8.4.2 Structured data types p. 131
8.8.4.3 Simple data types and enumerations p. 131
8.8.4.4 Data types describing alternative data types or combinations of data types |R18| p. 131
8.8.5 Error Handling p. 131
8.8.5.1 General |R18| p. 131
8.8.5.2 Protocol Errors |R18| p. 132
8.8.5.3 Application Errors |R18| p. 132
8.8.6 Feature negotiation p. 132
8.9 CAPIF_API_Provider_Management_API |R16| p. 132
8.9.1 API URI p. 132
8.9.2 Resources p. 132
8.9.2.1 Overview p. 132
8.9.2.2 Resource: All API Provider Domains Registrations p. 133
8.9.2.2.1 Description p. 133
8.9.2.2.2 Resource Definition p. 133
8.9.2.2.3 Resource Standard Methods p. 134
8.9.2.2.3.1 POST p. 134
8.9.2.2.4 Resource Custom Operations p. 134
8.9.2.3 Resource: Individual API Provider Domain Registration p. 134
8.9.2.3.1 Description p. 134
8.9.2.3.2 Resource Definition p. 134
8.9.2.3.3 Resource Standard Methods p. 135
8.9.2.3.4 Resource Custom Operations p. 138
8.9.2A Custom Operations without associated resources |R18| p. 138
8.9.3 Notifications p. 138
8.9.4 Data Model p. 138
8.9.4.1 General p. 138
8.9.4.2 Structured data types p. 139
8.9.4.2.1 Introduction p. 139
8.9.4.2.2 Type: APIProviderEnrolmentDetails p. 139
8.9.4.2.3 Type: APIProviderFunctionDetails p. 140
8.9.4.2.4 Type: RegistrationInformation p. 140
8.9.4.2.5 Type: APIProviderEnrolmentDetailsPatch |R17| p. 141
8.9.4.3 Simple data types and enumerations p. 141
8.9.4.3.1 Introduction p. 141
8.9.4.3.2 Simple data types p. 141
8.9.4.3.3 Enumeration: ApiProviderFuncRole p. 141
8.9.5 Error Handling p. 141
8.9.5.1 General |R18| p. 141
8.9.5.2 Protocol Errors |R18| p. 141
8.9.5.3 Application Errors |R18| p. 142
8.9.6 Feature negotiation p. 142
8.10 CAPIF_Routing_Info_API |R16| p. 142
8.10.1 API URI p. 142
8.10.2 Resources p. 142
8.10.2.1 Overview p. 142
8.10.2.2 Resource: Individual Service API routing info p. 143
8.10.2.2.1 Description p. 143
8.10.2.2.2 Resource Definition p. 143
8.10.2.2.3 Resource Standard Methods p. 143
8.10.2.2.3.1 GET p. 143
8.10.2.2.4 Resource Custom Operations p. 144
8.10.2A Custom Operations without associated resources |R18| p. 144
8.10.3 Notifications p. 145
8.10.4 Data Model p. 145
8.10.4.1 General p. 145
8.10.4.2 Structured data types p. 145
8.10.4.2.1 Introduction p. 145
8.10.4.2.2 Type: RoutingInfo p. 145
8.10.4.2.3 Type: RoutingRule p. 146
8.10.4.2.4 Type: Ipv6AddressRange p. 146
8.10.4.3 Simple data types and enumerations p. 146
8.10.5 Error Handling p. 146
8.10.5.1 General |R18| p. 146
8.10.5.2 Protocol Errors |R18| p. 146
8.10.5.3 Application Errors |R18| p. 146
8.10.6 Feature negotiation p. 146
