8.29 Update registration information of the API provider domain functions on the CAPIF

23.2223GPPCommon API Framework for 3GPP Northbound APIsRelease 18TS

8.29.1 General

The procedure in this subclause corresponds to the architectural requirements for update of the registration information of the API provider domain functions on the CAPIF.

Editor’s Note: The security aspects of this procedure are FFS in SA3.

8.29.2 Information flows

8.29.2.1 Registration request

Table 8.29.2.1-1 describes the information flow, registration update request, from the API management function to the CAPIF core function.

Table 8.29.2.1-1: Registration update request

Information element	Status	Description
List of API provider domain functions requiring update	M	List of API provider domain functions requiring updates, including role (e.g. AEF, APF, AMF) and, if required, specific security information.
Security information	M	Information for CAPIF core function to validate the registration request

8.29.2.2 Registration update response

Table 8.29.2.2-1 describes the information flow, registration update response, from the CAPIF core function to the API management function.

Table 8.29.2.2-1: Registration response

Information element	Status	Description
List of identities	M (see NOTE 1)	List of identities, for each successfully updated API provider domain function and any specific security information.
Security information	O	Information to be used by the API provider domain function in subsequent CAPIF API invocations. Provided when registration update is successful.
Reason	O (see NOTE 2)	Information related to registration update result specific to individual API provider domain functions. Provided when the registration fails.
NOTE 1: Information element shall be present when at least one registration update request is successful. NOTE 2: Information element may be present when at least one registration update requests fail.

8.29.3 Procedure

Figure 8.29.3-1 illustrates the procedure for updating the registration information of the API provider domain functions on the CAPIF core function.

Figure 8.29.3-1: Procedure for update of registration information of API provider domain functions on CAPIF

1. For updating the registration information of API provider domain functions on the CAPIF core function, the API management function sends a registration update request to the CAPIF core function. The registration update request contains a list of information about all the API provider domain functions, which require registration update on the CAPIF core function.

2. The CAPIF core function validates the received request and updates the identity and other security related information for all the API provider domain functions listed in the registration request.

3. The CAPIF core function sends the updated information in the registration update response message to the API management function.

4. The API management function configures the received information to the individual API provider domain functions.