Tech-invite3GPPspaceIETF RFCsSIP
Quick21222324252627282931323334353637384‑5x

Content for  TS 23.222  Word version:  17.6.0

Top   Top   Up   Prev   Next
0…   4…   5   6…   6.3…   7…   8…   8.5…   8.9…   8.13…   8.17…   8.21…   8.25…   9…   10…   11…   A   B…   B.2   B.3   C…   D…

 

10  CAPIF core function APIsp. 88

10.1  Generalp. 88

Table 10.1-1 illustrates the CAPIF core function APIs.
API Name API Operations Known Consumer(s) Communication Type
CAPIF_Discover_Service_APIDiscover_Service_APIAPI Invoker,
CAPIF core function
Request/ Response
Subscribe_EventAPI InvokerRequest/ Response
Notify_EventAPI InvokerNotify
Unsubscribe_EventAPI InvokerRequest/ Response
CAPIF_Publish_Service_APIPublish_Service_APIAPI Publishing Function,
CAPIF core function
Request/ Response
Unpublish_Service_APIAPI Publishing Function,
CAPIF core function
Request/ Response
Update_Service_APIAPI Publishing Function,
CAPIF core function
Request/ Response
Get_Service_APIAPI Publishing Function,
CAPIF core function
Request/ Response
Subscribe_EventAPI Publishing FunctionRequest/ Response
Notify_EventAPI Publishing FunctionNotify
Unsubscribe_EventAPI Publishing FunctionRequest/ Response
CAPIF_Events APISubscribe_EventAPI Invoker,
API Publishing Function,
API Management Function,
API Exposing Function
Request/ Response
Notify_EventAPI Invoker,
API Publishing Function,
API Management Function,
API Exposing Function
Notify
Unsubscribe_EventAPI Invoker,
API Publishing Function, API Management Function, API Exposing Function
Request/ Response
CAPIF_API_Invoker_management APIOnboard_API_InvokerAPI InvokerRequest/ Response
Offboard_API_InvokerAPI InvokerRequest/ Response
Subscribe_EventAPI Management FunctionRequest/ Response
Notify_EventAPI Management FunctionNotify
Unsubscribe_EventAPI Management FunctionRequest/ Response
CAPIF_API_Provider_Management_APIRegister_API_ProviderAPI Management FunctionRequest/Response
Update_API_ProviderAPI Management FunctionRequest/Response
Deregister_API_ProviderAPI Management FunctionRequest/Response
CAPIF_Security APIObtain_Security_MethodAPI InvokerRequest/ Response
Obtain_AuthorizationAPI InvokerRequest/ Response
Obtain_API_Invoker_InfoAPI Exposing FunctionRequest/ Response
Revoke_AuthorizationAPI Exposing FunctionRequest/ Response
CAPIF_Monitoring APISubscribe_EventAPI Management FunctionRequest/ Response
Notify_Monitoring_Service_EventAPI Management FunctionNotify
Unsubscribe_EventAPI Management FunctionRequest/ Response
CAPIF_Logging_API_Invocation APILog_API_InvocationAPI exposing functionRequest/ Response
CAPIF_Auditing APIQuery_API_Invocation_LogAPI management functionRequest/ Response
CAPIF_Access_Control_Policy APIObtain_Access_Control_PolicyAPI exposing functionRequest/Response
CAPIF_Routing_Info APIObtain_Routing_InfoAPI exposing functionRequest/Response
Up

10.2  CAPIF_Discover_Service_API APIp. 90

10.2.1  Generalp. 90

API description:
This API enables the API invoker to communicate with the CAPIF core function to discover the published service API information over CAPIF‑1 or CAPIF‑1e.

10.2.2  Discover_Service_API operationp. 90

API operation name:
Discover_Service_API
Description:
Provides the published service APIs information.
Known Consumers:
API invoker.
Inputs:
Outputs:
See subclause 8.7.3 for the details of usage of this API operation.

10.2.3  Subscribe_Event operationp. 90

API operation name:
Subscribe_Event
Description:
Provides subscription to the CAPIF related event information.
Known Consumers:
API invoker.
Inputs:
Outputs:
See subclause 8.8.3 for the details of usage of this API operation.

10.2.4  Notify_Event operationp. 90

API operation name:
Notify_Event
Description:
Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers:
API invoker.
Inputs:
Outputs:
See subclause 8.8.4 for the details of usage of this API operation.

10.2.5  Unsubscribe_Event operationp. 90

API operation name:
Unsubscribe_Event
Description:
Unsubscription to the CAPIF event information.
Known Consumers:
API invoker.
Inputs:
Outputs:
See subclause 8.8.5 for the details of usage of this API operation.

10.3  CAPIF_Publish_Service_API APIp. 91

10.3.1  Generalp. 91

API description:
This API enables the API publishing function to communicate with the CAPIF core function to publish the service API information and manage the published service API information over CAPIF‑4.

10.3.2  Publish_Service_API operationp. 91

API operation name:
Publish_Service_API
Description:
Publish the service API information.
Known Consumers:
API publishing function.
Inputs:
Outputs:
See subclause 8.3.3 for the details of usage of this API operation.

10.3.3  Unpublish_Service_API operationp. 91

API operation name:
Unpublish_Service_API
Description:
Remove the published service API information.
Known Consumers:
API publishing function.
Inputs:
Outputs:
See subclause 8.4.3 for the details of usage of this API operation.

10.3.4  Update_Service_API operationp. 91

API operation name:
Update_Service_API
Description:
Update the published service API information.
Known Consumers:
API publishing function.
Inputs:
Outputs:
See subclause 8.6.3 for the details of usage of this API operation.

10.3.5  Get_Service_API operationp. 91

API operation name:
Get_Service_API
Description:
Retrieve the published service API information.
Known Consumers:
API publishing function.
Inputs:
Outputs:
See subclause 8.12.3 for the details of usage of this API operation.

10.3.6  Subscribe_Event operationp. 92

API operation name:
Subscribe_Event
Description:
Provides subscription to the CAPIF related event information.
Known Consumers:
API publishing function.
Inputs:
Outputs:
See subclause 8.8.3 for the details of usage of this API operation.

10.3.7  Notify_Event operationp. 92

API operation name:
Notify_Event
Description:
Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers:
API publishing function.
Inputs:
Outputs:
See subclause 8.8.4 for the details of usage of this API operation.

10.3.8  Unsubscribe_Event operationp. 92

API operation name:
Unsubscribe_Event
Description:
Unsubscription to the CAPIF event information.
Known Consumers:
API publishing function.
Inputs:
Outputs:
See subclause 8.8.5 for the details of usage of this API operation.

10.4  CAPIF_Events APIp. 92

10.4.1  Generalp. 92

API description: This API enables the API subscribing entity to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events and receive subsequent notification of CAPIF events. This API is used for the subscription to and notifications of those CAPIF events that are not bound to any of the other CAPIF core function APIs. The following are the key functionalities:
  • API invoker subscribes to CAPIF events over CAPIF‑1 or CAPIF‑1e.
  • API invoker receives notifications for subscribed CAPIF events over CAPIF‑1 or CAPIF‑1e.
  • API invoker unsubscribes from CAPIF events over CAPIF‑1 or CAPIF‑1e.
  • API exposing function subscribes to CAPIF events over CAPIF‑3.
  • API exposing function receives notifications for subscribed CAPIF events over CAPIF‑3.
  • API exposing function unsubscribes from CAPIF events over CAPIF‑3.
  • API publishing function subscribes to CAPIF events over CAPIF‑4.
  • API publishing function receives notifications for subscribed CAPIF events over CAPIF‑4.
  • API publishing function unsubscribes from CAPIF events over CAPIF‑4.
  • API management function subscribes to CAPIF events over CAPIF‑5.
  • API management function receives notifications for subscribed CAPIF events over CAPIF‑5.
  • API management function unsubscribes from CAPIF events over CAPIF‑5.
Up

10.4.2  Subscribe_Event operationp. 93

API operation name:
Subscribe_Event
Description:
Provides subscription to the CAPIF related event information.
Known Consumers:
API invoker, API publishing function, API management function, API exposing function.
Inputs:
Outputs:
See subclause 8.8.3 for the details of usage of this API operation.

10.4.3  Notify_Event operationp. 93

API operation name:
Notify_Event
Description:
Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers:
API invoker, API publishing function, API management function, API exposing function.
Inputs:
Outputs:
See subclause 8.8.4 for the details of usage of this API operation.

10.4.4  Unsubscribe_Event operationp. 93

API operation name:
Unsubscribe_Event
Description:
Unsubscription to the CAPIF event information.
Known Consumers:
API invoker, API publishing function, API management function, API exposing function.
Inputs:
Outputs:
See subclause 8.8.5 for the details of usage of this API operation.

10.5  CAPIF_API_invoker_management APIp. 94

10.5.1  Generalp. 94

API description:
This API enables the API invoker to communicate with the CAPIF core function to enroll as a registered user of CAPIF and manage the enrollment information over CAPIF‑1 or CAPIF‑1e.

10.5.2  Onboard_API_Invoker operationp. 94

API operation name:
Onboard_API_Invoker
Description:
Enrolls the API invoker as a recognized user of the CAPIF.
Known Consumers:
API invoker.
Inputs:
Outputs:
See subclause 8.1.3 for the details of usage of this API operation.

10.5.3  Offboard_API_Invoker operationp. 94

API operation name:
Offboard_API_Invoker
Description:
Cancels enrollment of the API invoker as a recognized user of the CAPIF.
Known Consumers:
API invoker.
Inputs:
Outputs:
See subclause 8.2.3 for the details of usage of this API operation.

10.5.4  Subscribe_Event operationp. 94

API operation name:
Subscribe_Event
Description:
Provides subscription to the CAPIF related event information.
Known Consumers:
API management function.
Inputs:
Outputs:
See subclause 8.8.3 for the details of usage of this API operation.

10.5.5  Notify_Event operationp. 94

API operation name:
Notify_Event
Description:
Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers:
API management function.
Inputs:
Outputs:
See subclause 8.8.4 for the details of usage of this API operation.

10.5.6  Unsubscribe_Event operationp. 95

API operation name:
Unsubscribe_Event
Description:
Unsubscription to the CAPIF event information.
Known Consumers:
API management function.
Inputs:
Outputs:
See subclause 8.8.5 for the details of usage of this API operation.

10.6  CAPIF_Security APIp. 95

10.6.1  Generalp. 95

API description:
This API enables the API invoker to communicate with the CAPIF core function to authenticate and obtain authorization to access service APIs over CAPIF‑1 or CAPIF‑1e.

10.6.2  Obtain_Security_Method operationp. 95

API operation name:
Obtain_Security_Method
Description:
Obtain information about service API security method with CAPIF core function for service API invocations.
Known Consumers:
API invoker.
Inputs:
Outputs:
See subclause 8.10.3 for the details of usage of this API operation.

10.6.3  Obtain_Authorization operationp. 95

API operation name:
Obtain_Authorization
Description:
Provides the authorization information to access relevant service API.
Known Consumers:
API invoker.
Inputs:
Outputs:
See subclause 8.16.3 for the details of usage of this API operation.

10.6.4  Obtain_API_Invoker_Info operationp. 95

API operation name:
Obtain_API_Invoker_Info
Description:
Obtains the API invoker information.
Known Consumers:
API exposing function.
Inputs:
Outputs:
See subclause 8.16.3 for the details of usage of this API operation.

10.6.5  Revoke_Authorization operationp. 96

API operation name:
Revoke_Authorization
Description:
Revokes API invoker authorization to access service API.
Known Consumers:
API exposing function.
Inputs:
Outputs:
See subclause 8.23.3 for the details of usage of this API operation.

10.7  CAPIF_Monitoring APIp. 96

10.7.1  Generalp. 96

API description:
This API enables the API management function to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events related to monitoring and receive subsequent notification of CAPIF monitoring events over CAPIF‑5.

10.7.2  Subscribe_Event operationp. 96

API operation name:
Subscribe_Event
Description:
Provides subscription to the CAPIF related event information.
Known Consumers:
API management function.
Inputs:
Outputs:
See subclause 8.8.3 for the details of usage of this API operation.

10.7.3  Notify_Monitoring_Service_Event operationp. 96

API operation name:
Notify_Monitoring_Service_Event
Description:
Provides the notification of the events related to monitoring service API invocations to the subscribed API management function.
Known Consumers:
API management function.
Inputs:
Outputs:
See subclause 8.21.3 for the details of usage of this API operation.

10.7.4  Unsubscribe_Event operationp. 96

API operation name:
Unsubscribe_Event
Description:
Unsubscription to the CAPIF event information.
Known Consumers:
API management function.
Inputs:
Outputs:
See subclause 8.8.5 for the details of usage of this API operation.

10.8  CAPIF_Logging_API_Invocation APIp. 97

10.8.1  Generalp. 97

API description:
This API enables the API exposing function to communicate with the CAPIF core function to log the information related to service API invocation over CAPIF‑3.

10.8.2  Log_API_Invocation operationp. 97

API operation name:
Log_API_Invocation
Description:
Enables to log API invocation information.
Known Consumers:
API exposing function.
Inputs:
Outputs:
See subclause 8.19.3 for the details of usage of this API operation.

10.9  CAPIF_Auditing APIp. 97

10.9.1  Generalp. 97

API description:
This API enables the API management function to communicate with the CAPIF core function to retrieve the log information related to service API invocation over CAPIF‑5.

10.9.2  Query_ API_Invocation_Log operationp. 97

API operation name:
Query_API_Invocation_Log
Description:
Query the API invocation log information.
Known Consumers:
API management function.
Inputs:
Outputs:
See subclause 8.22.3 for the details of usage of this API operation.

10.10  CAPIF_Access_Control_Policy APIp. 97

10.10.1  Generalp. 97

API description:
This API enables the API exposing function to obtain the policy to perform access control on the service API invocations.

10.10.2  Obtain_Access_Control_Policy operationp. 98

API operation name:
Obtain_Access_Control_Policy
Description:
Allows obtaining the policy to perform access control on the service API invocations.
Known Consumers:
API exposing function.
Inputs:
Outputs:
See subclause 8.12.3 for the details of usage of this API operation.

10.11  CAPIF_Routing_Info API |R16|p. 98

10.11.1  Generalp. 98

API description:
This API enables the API exposing function to obtain the routing information to forward the API invocation to another API exposing function.

10.11.2  Obtain_Routing_Info operationp. 98

API operation name:
Obtain_Routing_Info
Description:
Allows obtaining the API routing information.
Known Consumers:
API exposing function.
Inputs:
Outputs:
See subclause 8.27.3 for the details of usage of this API operation.

10.12  CAPIF_API_provider_management API |R16|p. 98

10.12.1  Generalp. 98

API description:
This API enables the API Management Function to communicate with the CAPIF core function to register the API provider domain functions as authorized users of the CAPIF functionalities.

10.12.2  Register_API_Provider operationp. 98

API operation name:
Register_API_Provider
Description:
Registers the API provider domain functions as authorized users of the CAPIF.
Known Consumers:
API Management Function.
Inputs:
Outputs:
See subclause 8.28.3 for the details of usage of this API operation.

10.12.3  Update_API_Provider operationp. 98

API operation name:
Update_API_Provider
Description:
Updates registration information of the API provider domain functions.
Known Consumers:
API Management Function.
Inputs:
Outputs:
See subclause 8.29.3 for the details of usage of this API operation.

10.12.4  Deregister_API_Provider operationp. 99

API operation name:
Deregister_API_Provider
Description:
Registers the API provider domain functions as authorized users of the CAPIF.
Known Consumers:
API Management Function.
Inputs:
Outputs:
See subclause 8.30.3 for the details of usage of this API operation.

Up   Top   ToC