8.26 Update API invoker’s API list

23.2223GPPCommon API Framework for 3GPP Northbound APIsRelease 18TS

8.26.1 General

The procedure in this subclause corresponds to the architectural requirements for updating the API invoker’s API list on the CAPIF core function. The CAPIF enables API invoker to update its own API list e.g. subsequent to discovering new API(s).

8.26.2 Information flows

8.26.2.1 Update API invoker API list request

Table 8.26.2.1-1 describes the information flow update API invoker API list request from the API invoker to the CAPIF core function.

Table 8.26.2.1-1: Update API invoker API list request

Information element	Status	Description
API invoker identity information	M	Identity information of the API invoker requesting update
APIs for update	M	List of APIs that need update (e.g. enroll new API(s), disenroll API(s)).

8.26.2.2 Update API invoker API list response

Table 8.26.2.2-1 describes the information flow update API invoker API list response from the CAPIF core function to the API invoker.

Table 8.26.2.2-1: Update API invoker API list response

Information element	Status	Description
Result	M	Indicates the completely successful or partially successful or failure of the update operation
API information	O (see NOTE 1)	List of APIs and the types of APIs that the API invoker can access
Reason	O (see NOTE 2)	This element indicates the reason when update status is failure and for which API(s)
NOTE 1: Information element shall be present when update API invoker API list status is partial or completely successful. NOTE 2: Information element shall be present when update API invoker API list status is partial successful or failure.

8.26.3 Procedure

Figure 8.26.3-1 illustrates the procedure for updating the API invoker API list on the CAPIF.

Pre-conditions:

1. The API invoker has been onboarded as a recognized user of the CAPIF and associated API invoker profile is provisioned.

2. The API invoker has visibility to new APIs information (e.g. updates on API catalogue or dashboard, API discovery).

Figure 8.26.3-1: Procedure for updating the API invoker profile on the CAPIF

1. For updating of the API invoker API list on the CAPIF, the API invoker triggers update API invoker API list request towards the CAPIF core function, providing the information to be updated (e.g. enroll new APIs, disenroll APIs).

2. The CAPIF core function updates the API invoker API list of the requesting API invoker, according to the grant from the CAPIF administrator or the API management.

NOTE: Completion of updating process can require explicit grant by the CAPIF administrator or the API management, which is left out-of-scope of this solution. CAPIF can handle the grant process internally without the need of explicit grant by the CAPIF administrator.

3. The update API invoker API list response provides partial success or complete success or failure indication. Partial success and complete success result will include APIs information that the API invoker can access. When the update status is failure, the reason for failure and information for which API(s) the update operation has failed is included.