11 API exposing function APIs

23.2223GPPCommon API Framework for 3GPP Northbound APIsRelease 18TS

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

11.1 General

Table 11.1-1 illustrates the API exposing function APIs.

Table 11.1-1: List of API exposing function APIs

API Name	API Operations	Known Consumer(s)	Communication Type
AEF_Security API	Revoke_Authorization	CAPIF Core Function	Request/ Response
AEF_Security API	Initiate_Authentication	API Invoker	Request/ Response

11.2 AEF_Security API

11.2.1 General

API description: This API allows CAPIF core function to revoke access to service APIs and API invokers to request the authentication parameters necessary for authentication of the API invoker available with the API exposing function.

11.2.2 Revoke_Authorization operation

API operation name: Revoke_Authorization

Description: Revokes API invoker authorization to access service API.

Known Consumers: CAPIF core function.

Inputs: Refer subclause 8.23.2.

Outputs: Refer subclause 8.23.2.

See subclause 8.23.4 for the details of usage of this API operation.

11.2.3 Initiate_Authentication operation

API operation name: Initiate_Authentication

Description: Revokes API invoker authorization to access service API.

Known Consumers: API Invoker.

Inputs: Refer subclause 8.14.2.

Outputs: Refer subclause 8.14.2.

See subclause 8.14.3 for the details of usage of this API operation.

Annex A (informative):
Overview of CAPIF operations

Depicted in figure A-1 is the overview of CAPIF operations. CAPIF operations occur between different actors involving the API invoker, the CAPIF core function, the API exposing function, the API publishing function and the API management function. High level CAPIF interactions between the actors are shown in figure A-1. This figure is only provided for illustration purposes, and does not represent the order of operations.

Figure A-1: Overview of CAPIF operations

The CAPIF defines the functional entities in subclause 6.3.

The CAPIF defines the reference points between the functional entities in subclause 6.4.

The following operations require the communication between the CAPIF entities:

1. Publishing service APIs: the API provider utilizes the API publishing function over CAPIF-4 reference point to publish the service APIs on the CAPIF core function, as specified in subclause 8.3 of this specification;

2. Discovering service APIs: the API invoker discovers the service APIs over CAPIF-1/CAPIF-1e reference points, as specified in subclause 8.7 of this specification;

3. API event subscription and notification: the API invoker subscribes to and receive service API event notifications over CAPIF-1/CAPIF-1e reference points, as specified in subclause 8.8 of this specification;

4. Authenticating with CAPIF: the API invoker authenticates itself over CAPIF-1/CAPIF-1e reference points, as specified in subclause 8.10 of this specification;

5. Authorizing with CAPIF: the API invoker obtains service API authorization over CAPIF-1/CAPIF-1e reference points, as specified in subclause 8.11 of this specification;

6. Topology hiding: the API provider, to hide the topology, utilizes the API exposing function over CAPIF-3 reference point, as specified in subclause 8.13 of this specification;

7. Authenticating the API invoker prior to service API invocation: the API provider, to authenticate the API invoker prior to the service API invocation, utilizes the API exposing function over CAPIF-2/CAPIF-2e and CAPIF-3, as specified in subclause 8.14 of this specification;

8. Authenticating the API invoker upon the service API invocation: the API provider, to authenticate the API invoker upon invocation of the service APIs, utilizes the API exposing function over CAPIF-2/CAPIF-2e and CAPIF-3, as specified in subclause 8.15 of this specification;

9. Authorizing API invoker: the API provider, to authorize the API invoker to access the service APIs, utilizes the API exposing function over CAPIF-2/CAPIF-2e and CAPIF-3, as specified in subclause 8.16 of this specification;

10. Access control: the API provider, to control the access of the service API by the API invoker based on policy or usage limits,

– utilizes the API exposing function over CAPIF-2/CAPIF-2e and CAPIF-3, as specified in subclause 8.17 of this specification; or

– in a cascaded deployment, utilizes API exposing functions over CAPIF-2/CAPIF-2e, as specified in subclause 8.18 of this specification;

11. Logging service: the API provider, to maintain the log of the API invocations at the CAPIF core function for services such as charging, invocation history, utilizes the API exposing function over CAPIF-3, as specified in subclause 8.19 of this specification;

12. Charging service: the API provider, to facilitate charging of the API invocations, utilizes the API exposing function over CAPIF-3, as specified in subclause 8.20 of this specification;

13. Service monitoring: the API provider, to facilitate monitoring such as API invoker’s ID and IP address, utilizes the API management function over CAPIF-5, as specified in subclause 8.21 of this specification; and

14. Auditing: the API provider, for auditing, utilizes the API management function over CAPIF-5, as specified in subclause 8.22 of this specification.

Annex B (informative):
CAPIF relationship with network exposure aspects of 3GPP systems

This annex provides the relationship of CAPIF with network exposure aspects of 3GPP systems. Any system exposing capabilities as service APIs can implement CAPIF. Generic model for CAPIF utilization by service API provider is included. Network exposure aspects of EPS and 5GS are considered for illustration.

NOTE: As there are no impacts on CAPIF’s relationship with network exposure aspects of 3GPP systems due to deployment of 3^rd party trust domain, it is not illustrated in the figures.