Tech-invite  3GPPspace  IETFspace
21  22  23  24  25  26  27  28  29  31  32  33  34  35  36  37  38  4‑5x

Content for  TS 23.222  Word version:  18.2.0

Top   Top   Up   Prev   Next
0…   4…   5…   6…   6.3…   6.4…   7…   8…   8.5…   8.8…   8.9…   8.13…   8.17…   8.21…   8.25…   8.28…   9…   10…   10.4…   10.7…   11…   A   B…   B.2…   B.3…   C…   D… 
10.4 CAPIF_Events API  10.4.1 General  10.4.2 Subscribe_Event operation  10.4.3 Notify_Event operation  10.4.4 Unsubscribe_Event operation  10.4.5 Update_Event_Subscription operation  10.5 CAPIF_API_invoker_management API  10.5.1 General  10.5.2 Onboard_API_Invoker operation  10.5.3 Offboard_API_Invoker operation  10.5.4 Subscribe_Event operation  10.5.5 Notify_Event operation  10.5.6 Unsubscribe_Event operation  10.5.7 Update_Event_Subscription operation  10.6 CAPIF_Security API  10.6.1 General  10.6.2 Obtain_Security_Method operation  10.6.3 Obtain_Authorization operation  10.6.4 Obtain_API_Invoker_Info operation  10.6.5 Revoke_Authorization operation 
...

 

10.4  CAPIF_Events API  p. 100

10.4.1  General  p. 100

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 invoker updates subscriptions for 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 exposing function updates subscriptions for 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 publishing function updates subscriptions for 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.
  • API management function updates subscriptions for CAPIF events over CAPIF-5.
Up

10.4.2  Subscribe_Event operation  p. 100

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:
Refer subclause 8.8.2.1.
Outputs:
Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.

10.4.3  Notify_Event operation  p. 101

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:
Refer subclause 8.8.2.3.
Outputs:
Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.

10.4.4  Unsubscribe_Event operation  p. 101

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:
Refer subclause 8.8.2.5.
Outputs:
Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.

10.4.5  Update_Event_Subscription operation |R18|  p. 101

API operation name:
Update_Event_Subscription
Description:
Updates a subscription to CAPIF related event information.
Known Consumers:
API invoker, API publishing function, API management function, API exposing function.
Inputs:
Refer subclause 8.8.2.7.
Outputs:
Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.

10.5  CAPIF_API_invoker_management API  p. 101

10.5.1  General  p. 101

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 operation  p. 101

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

10.5.3  Offboard_API_Invoker operation  p. 102

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:
Refer subclause 8.2.2.1.
Outputs:
Refer subclause 8.2.2.2.
See subclause 8.2.3 for the details of usage of this API operation.

10.5.4  Subscribe_Event operation  p. 102

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

10.5.5  Notify_Event operation  p. 102

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

10.5.6  Unsubscribe_Event operation  p. 102

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

10.5.7  Update_Event_Subscription operation |R18|  p. 103

API operation name:
Update_Event_Subscription
Description:
Updates a subscription to CAPIF related event information.
Known Consumers:
API management function.
Inputs:
Refer subclause 8.8.2.7.
Outputs:
Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.

10.6  CAPIF_Security API  p. 103

10.6.1  General  p. 103

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 operation  p. 103

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:
Refer subclause 8.10.2.
Outputs:
Refer subclause 8.10.2.
See subclause 8.10.3 for the details of usage of this API operation.

10.6.3  Obtain_Authorization operation  p. 103

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

10.6.4  Obtain_API_Invoker_Info operation  p. 103

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

10.6.5  Revoke_Authorization operation  p. 104

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

Up   Top   ToC