Tech-invite  3GPPspecsRELsGlossariesSIP
Info21222324252627282931323334353637384‑5x

full Contents for  TS 23.222  Word version:   17.0.0

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…

 

6.3  Functional entities descriptionWord-p. 26
6.3.1  General
Each subclause is a description of a functional entity and does not imply a physical entity.
6.3.2  API invoker
The API invoker is typically provided by a 3rd party application provider who has service agreement with PLMN operator. The API invoker may reside within the same trust domain as the PLMN operator network.
The API invoker supports the following capabilities:
  • Supporting the authentication by providing the API invoker identity and other information required for authentication of the API invoker;
  • Supporting mutual authentication with CAPIF;
  • Obtaining the authorization prior to accessing the service API;
  • Discovering service APIs information; and
  • Invoking the service APIs.
NOTE:
The details of the specific service APIs are out of scope of the present document.
Up
6.3.3  CAPIF core function
The CAPIF core function consists of the following capabilities:
  • Authenticating the API invoker based on the identity and other information required for authentication of the API invoker;
  • Supporting mutual authentication with the API invoker;
  • Providing authorization for the API invoker prior to accessing the service API;
  • Publishing, storing and supporting the discovery of service APIs information;
  • Controlling the service API access based on PLMN operator configured policies;
  • Storing the logs for the service API invocations and providing the service API invocation logs to authorized entities;
  • Charging based on the logs of the service API invocations;
  • Monitoring the service API invocations;
  • Onboarding a new API invoker and offboarding an API invoker;
  • Storing policy configurations related to CAPIF and service APIs;
  • Support accessing the logs for auditing (e.g. detecting abuse); and
  • Supports publishing, discovery of service APIs information with another CAPIF core function in CAPIF interconnection.
Up
6.3.4  API exposing functionWord-p. 27
The API exposing function is the provider of the service APIs and is also the service communication entry point of the service API to the API invokers. The API exposing function consists of the following capabilities:
  • Authenticating the API invoker based on the identity and other information required for authentication of the API invoker provided by the CAPIF core function;
  • Validating the authorization provided by the CAPIF core function; and
  • Logging the service API invocations at the CAPIF core function.
Up
6.3.5  API publishing function
The API publishing function enables the API provider to publish the service APIs information in order to enable the discovery of service APIs by the API invoker. The API publishing function consists of the following capability:
  • Publishing the service API information of the API provider to the CAPIF core function.
6.3.6  API management function
The API management function enables the API provider to perform administration of the service APIs. The API management function consists of the following capabilities:
  • Auditing the service API invocation logs received from the CAPIF core function;
  • Monitoring the events reported by the CAPIF core function;
  • Configuring the API provider policies to the CAPIF core function;
  • Monitoring the status of the service APIs;
  • Onboarding the new API invokers and offboarding API invokers; and
  • Registering and maintaining registration information of the API provider domain functions on the CAPIF core function.
Up
6.4  Reference points
6.4.1  General
The reference points for CAPIF are described in the following subclauses.
6.4.2  Reference point CAPIF-1 (between the API invoker and the CAPIF core function)
The CAPIF‑1 reference point, which exists between the API invoker and the CAPIF core function, is used for the API invoker within the PLMN trust domain to discover service APIs, to authenticate and to get authorization.
The CAPIF‑1 reference point supports:
  • Authenticating the API invoker based on the identity and credentials of the API invoker;
  • Mutual authentication between the API invoker and the CAPIF core function;
  • Providing authorization for the API invoker prior to accessing the service API; and
  • Discovering the service APIs information.
NOTE:
The security aspects of CAPIF‑1 are specified in subclause 6.2 of TS 33.122.
Up
6.4.3  Reference point CAPIF-1e (between the API invoker and the CAPIF core function)Word-p. 28
The CAPIF‑1e reference point, which exists between the API invoker and the CAPIF core function, is used for the API invoker outside the PLMN trust domain to discover service APIs, to authenticate and to get authorization.
The CAPIF‑1e reference point supports all the functions of CAPIF‑1.
NOTE:
The security aspects of CAPIF‑1e are specified in subclause 6.3 of TS 33.122.
6.4.4  Reference point CAPIF-2 (between the API invoker and the API exposing function)
The CAPIF‑2 reference point, which exists between the API invoker and the API exposing function belonging to the same trust domain, is used for the API invoker to communicate with the service APIs.
The CAPIF‑2 reference point supports:
  • Authenticating the API invoker based on the identity and credentials of the API invoker;
  • Authorization verification for the API invoker upon accessing the service API; and
  • Invocation of service APIs.
NOTE 1:
The aspects related to the specific service API invocation in reference point CAPIF‑2 are out of scope of the present document.
NOTE 2:
The security aspects of CAPIF‑2 are specified in subclause 6.4 of TS 33.122.
Up
6.4.5  Reference point CAPIF-2e (between the API invoker and the API exposing function)
The CAPIF‑2e reference point, which exists between the API invoker and the API exposing function belonging to a different trust domain, is used for the API invoker to communicate with the service APIs.
The CAPIF‑2e reference point supports all the functions of CAPIF‑2.
NOTE:
The security aspects of CAPIF‑2e are specified in subclause 6.5 of TS 33.122.
6.4.6  Reference point CAPIF-3 (between the API exposing function and the CAPIF core function)
The CAPIF‑3 reference point, which exists between the API exposing function and the CAPIF core function, is used for exercising access and policy related control for service API communications initiated by the API invoker.
The CAPIF‑3 reference point supports:
  • Authenticating the API invoker based on the identity and credentials of the API invoker;
  • Providing authorization for the API invoker prior to accessing the service API;
  • Authorization verification for the API invoker upon accessing the service API;
  • Controlling the service API access based on PLMN operator configured policies;
  • Logging the service API invocations; and
  • Charging the service API invocations.
NOTE:
The security aspects of CAPIF‑3 are specified in subclause 6.6 of TS 33.122.
Up
6.4.7  Reference point CAPIF-4 (between the API publishing function and the CAPIF core function)Word-p. 29
The CAPIF‑4 reference point, which exists between the API publishing function and the CAPIF core function, is used for publishing the service API information.
The CAPIF‑4 reference point supports:
  • Publishing the service APIs information by the API publishing function.
NOTE:
The security aspects of CAPIF‑4 are specified in subclause 6.6 of TS 33.122.
6.4.8  Reference point CAPIF-5 (between the API management function and the CAPIF core function)
The CAPIF‑5 reference point, which exists between the API management function and the CAPIF core function, is used for management of service API, API invoker and API provider domain function information.
The CAPIF‑5 reference point supports:
  • Accessing the service API invocation logs by the API management function;
  • Enabling the API management function to monitor the events reported due to the service APIs invocations;
  • Onboarding new API invokers by provisioning the API invoker information at the CAPIF core function, requesting explicit grant of new API invokers onboarding and confirming onboarding success;
  • Offboarding API invokers;
  • Enabling the API management function to configure policies at the CAPIF core function e.g. service API invocation throttling, blocking API invocation for certain duration;
  • Enabling the API provider to monitor the status of service APIs (e.g. pilot or live status, start or stop status of service API);
  • Registering API provider domain functions on the CAPIF core function; and
  • Update of the registration information of API provider domain functions on the CAPIF core function.
NOTE:
The security aspects of CAPIF‑5 are specified in subclause 6.6 of TS 33.122.
Up
6.4.9  Reference point CAPIF-3e (between the API exposing function and the CAPIF core function) [R16]
The CAPIF‑3e reference point, which exists between the API exposing function within the 3rd party trust domain and the CAPIF core function within the PLMN trust domain, is used for exercising access and policy related control for service API communications initiated by the API invoker.
The CAPIF‑3e supports all the functions of CAPIF‑3.
NOTE:
The security aspects of CAPIF‑3e will be specified by SA3.
Editor's note: Reference to the appropriate SA3 specification is needed.
6.4.10  Reference point CAPIF-4e (between the API publishing function and the CAPIF core function) [R16]Word-p. 30
The CAPIF‑4e reference point, which exists between the API publishing function within the 3rd party trust domain and the CAPIF core function within the PLMN trust domain, is used for publishing the service API information.
The CAPIF‑4e reference point supports all the functions of CAPIF‑4.
NOTE:
The security aspects of CAPIF‑4e will be specified by SA3.
Editor's note: Reference to the appropriate SA3 specification is needed.
6.4.11  Reference point CAPIF-5e (between the API management function and the CAPIF core function) [R16]
The CAPIF‑5e reference point, which exists between the API management function within the 3rd party trust domain and the CAPIF core function within the PLMN trust domain, is used for management of service API, API invoker and API provider domain function information.
The CAPIF‑5e reference point supports all the functions of CAPIF‑5.
NOTE:
The security aspects of CAPIF‑5e will be specified by SA3.
Editor's note: Reference to the appropriate SA3 specification is needed.
6.4.12  Reference point CAPIF-7 (between the API exposing functions) [R16]
The CAPIF‑7 reference point, which exists between the API exposing functions belonging to the same trust domain, is used for the forwarding or routing of the API invoker's service API invocation from one API exposing function to the other API exposing function deployed in the PLMN trust domain.
The CAPIF‑7 reference point supports all the functions of CAPIF‑2.
The CAPIF‑7 reference point supports invocation of service APIs originated by the API invoker using CAPIF‑2.
NOTE 1:
The aspects related to the specific service API invocation in reference point CAPIF‑7 are out of scope of the present document.
NOTE 2:
The security aspects of CAPIF‑7 are the responsibility of SA3.
Up
6.4.13  Reference point CAPIF-7e (between the API exposing functions) [R16]
The CAPIF‑7e reference point, which exists between the API exposing functions belonging to different trust domains, is used for the forwarding or routing of the API invoker's service API invocation from one API exposing function to the other API exposing function between different trust domains.
The CAPIF‑7e reference point supports all the functions of CAPIF‑2e.
NOTE:
The security aspects of CAPIF‑7e are the responsibility of SA3.
6.4.14  Reference point CAPIF-6 (between the CAPIF core functions of the same CAPIF provider) [R16]
The CAPIF‑6 reference point exists between the CAPIF core functions within the same trust domain of CAPIF provider.
The CAPIF‑6 reference point supports:
  • Publishing the service APIs information; and
  • Discovering the service APIs information.
6.4.15  Reference point CAPIF-6e (between the CAPIF core functions of different CAPIF providers) [R16]Word-p. 31
The CAPIF‑6e reference point exists between the CAPIF core function within the 3rd party trust domain and the CAPIF core function within the PLMN trust domain.
The CAPIF‑6e reference point supports all the functions of CAPIF‑6.
NOTE:
The security aspects of CAPIF‑6e will be specified by SA3.
Editor's note: Reference to the appropriate SA3 specification is needed.

Up   Top   ToC