hash stringlengths 32 32 | doc_id stringlengths 5 12 | section stringlengths 5 1.47k | content stringlengths 0 6.67M |
|---|---|---|---|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.6.1 Introduction
| The CAPIF includes monitoring functions. This enables API provider to monitor service API invocations, to determine critical aspects such as system load, API usage information, uncover potential overload and attacks (e.g. DDoS) conditions.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.6.2 Requirements
| [AR-4.6.2-a] The CAPIF shall provide mechanisms to capture service API invocation events and make them available to service API provider.
[AR-4.6.2-b] The CAPIF shall provide mechanisms to notify events related to overload and threat conditions (e.g. system load, resource usage information).
[AR-4.6.2-c] The CAPIF shall provide mechanisms to allow service API provider to apply monitoring filters based on criteria such as API invoker's ID and IP address, service API name and version, invoked operation, input parameters, and invocation result.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.7 Logging
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.7.1 Introduction
| The CAPIF supports the ability to log events and store the corresponding logs. This enables the API providers to use the logs for the purpose of tracing back and statistical analysis.
The following events in CAPIF are supported for logging:
- Service API invocation events;
- API invoker onboarding events; and
- API invoker interactions with the CAPIF (e.g. authentication, authorization, discover service APIs).
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.7.2 Logging events related to service API invocations
| [AR-4.7.2-a] The CAPIF shall provide mechanisms for service API invocation event logging and storage functionality.
[AR-4.7.2-b] The service API invocation log shall be stored for a configurable time period, according to the service API provider's policy.
[AR-4.7.2-c] The service API invocation log shall be stored securely, and shall only be accessed by CAPIF administrators of the service API provider.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.7.3 Logging events related to API invoker onboarding
| [AR-4.7.3-a] The CAPIF shall provide mechanisms for API invoker onboarding event logging and storage functionality.
[AR-4.7.3-b] The API invoker onboarding log shall be stored at least for the duration during which the onboarding is valid.
[AR-4.7.3-c] The API invoker onboarding log shall be stored securely, and shall only be accessed by CAPIF administrators.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.7.4 Logging events related to API invoker interaction with the CAPIF
| [AR-4.7.4-a] The CAPIF shall provide mechanisms for the event logging of API invoker interactions with the CAPIF (e.g. authentication, authorization, discover service APIs).
[AR-4.7.4-b] The API invoker interactions log shall be stored for a configurable time period.
[AR-4.7.4-c] The API invoker interactions log shall be stored securely, accessed only by CAPIF administrators.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.8 Auditing service API invocation
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.8.1 Introduction
| The CAPIF includes auditing capabilities. This enables the service API provider to identify illegal service API invocations e.g. by querying the service API invocation log.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.8.2 Requirements
| [AR-4.8.2-a] The CAPIF shall provide mechanisms to query the service API invocation log, by CAPIF administrators.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.9 Onboarding API invoker
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.9.1 Introduction
| This subclause specifies the requirements related to onboarding API invoker to the CAPIF.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.9.2 Requirements
| [AR-4.9.2-a] The CAPIF shall provide the capability to onboard new API invokers.
[AR-4.9.2-b] The CAPIF shall support granting an API invoker's request to onboard with the CAPIF administrator.
[AR-4.9.2-c] The CAPIF shall support offboarding an API invoker from the CAPIF.
[AR-4.9.2-d] The CAPIF shall support updating an API invoker's API list e.g., subsequent to discovery of new API(s).
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.10 Policy configuration
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.10.1 Introduction
| This subclause specifies the policy configuration related requirements.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.10.2 Requirements
| [AR-4.10.2-a] The CAPIF shall support policy configurations (e.g. related to the protection of platforms and network, specific functionalities exposed, message payload size or throughput).
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.11 Protocol design
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.11.1 Introduction
| In order for the CAPIF to be common across all present and future API invokers for various usages and purposes, a minimum common protocol stack model is necessary so that all API invokers that use the common-framework-based API need to support only one and the same set of protocols, e.g. security layer protocol(s). Extensibility of this model allows evolution and re-use.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.11.2 Requirements
| [AR-4.11.2-a] The CAPIF shall support a minimum common protocol stack model common for all API implementations to be based on.
[AR-4.11.2-b] The CAPIF shall support a common security mechanism for all API implementations to provide confidentiality and integrity protection.
[AR-4.11.2-c] The CAPIF shall be extensible to support different protocol stack models, including related security mechanisms, in addition to the minimum common protocol stack model.
NOTE: Potentially, Stage 3 needs to consider all CAPIF APIs for protocol extensibility.
[AR-4.11.2-d] CAPIF APIs and associated information flows shall be extensible to support vendor-specific functionality.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.12 Interconnection between the CAPIF providers
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.12.1 Introduction
| Two organizations with a business relationship that have each deployed CAPIF may need to interoperate to allow API invokers in each trust domain to utilize service APIs from both CAPIFs as illustrated in figure 4.12.1-1.
Figure 4.12.1-1: Interconnection between the CAPIF providers
NOTE: From each CAPIF provider's perspective the other CAPIF provider is a 3rd party.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.12.2 Requirements
| [AR-4.12.2-a] The CAPIF shall provide mechanisms to enable the API invokers of the CAPIF provider to discover and invoke the service APIs of the 3rd party CAPIF provider.
[AR-4.12.2-b] The CAPIF shall provide mechanisms to enable a CAPIF provider to publish, retrieve unpublish and update service APIs in a 3rd party CAPIF provider.
[AR-4.12.2-c] The CAPIF shall provide mechanisms for authentication, authorization, authorization revocation for access to the service APIs exposed by a 3rd party CAPIF provider.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.13 Identities
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.13.1 Introduction
| This subclause specifies the identities related requirements.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.13.2 Requirements
| [AR-4.13.2-a] The CAPIF shall support uniform addressing (e.g. identity) for communication within the same trust domain or from the 3rd party trust domain.
[AR-4.13.2-b] The CAPIF shall support identities for uniquely identifying each service API.
[AR-4.13.2-c] The CAPIF shall support identities for uniquely identifying each API invoker.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.14 API provider domain interactions
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.14.1 Introduction
| This subclause specifies the API provider domain interactions related requirements.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.14.2 Requirements
| [AR-4.14.2-a] The CAPIF shall enable interactions between multiple API exposing functional entities within the same trust domain.
[AR-4.14.2-b] The CAPIF shall enable interactions of multiple API exposing functional entities between trust domains.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.15 Dynamic routing of service API invocation
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.15.1 Introduction
| This subclause specifies the dynamic routing of service API invocation related requirements.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.15.2 Requirements
| [AR-4.15.2-a] The CAPIF shall provide a mechanism to support the dynamic routing of service API invocation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.16 Registering API provider domain functions
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.16.1 Introduction
| This subclause specifies the requirements related to registration of API provider domain functions on the CAPIF core function.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.16.2 Requirements
| [AR-4.16.2-a] The CAPIF shall provide the capability to register API provider domain functions.
[AR-4.16.2-b] The CAPIF shall support the capability to update the registration information of the API provider domain functions.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.17 Resource owner-aware northbound API invocation
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.17.1 Introduction
| This subclause specifies requirements related to the resource owner-aware northbound API invocation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 4.17.2 Requirements
| [AR-4.17.2-a] The CAPIF shall support applications on the UE acting as an API invoker.
[AR-4.17.2-b] The CAPIF shall support the authentication of the resource owner.
[AR-4.17.2-c] The CAPIF shall provide mechanisms to manage (provide, obtain, revoke) resource owner authorization for API invoker(s) to access (API provider domain hosted) resources owned by resource owners.
[AR-4.17.2-d] The CAPIF shall provide a mechanism to enable API invoker on a UE to access resources of another UE or group of UE(s) with resource owner authorization.
[AR-4.12.2-e] The CAPIF shall enable API invokers to access (API provider domain hosted) resources via the service APIs exposed by a 3rd party CAPIF provider with resource owner authorization.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 5 Involved business relationships
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 5.1 Basic CAPIF business relationships
| Figure 5.1-1 shows the typical business relationships in CAPIF.
Figure 5.1-1: Business relationships in CAPIF
The API invoker has service agreement with a CAPIF provider and consumes the CAPIF APIs and service APIs. There are various API invokers like application management client (used by application developers, application service provider), hosted applications (on cloud, edge or UE), and channel aggregator (who aggregates the CAPIF APIs and/or the service APIs). For more details about these API invoker roles, please refer to Annex F.
The API provider hosts one or more service APIs and has a service API arrangement with CAPIF provider to offer the service APIs to the API invoker.
The CAPIF provider and the API provider can be part of the same organization (e.g. PLMN operator), in which case the business relationship between the two is internal to a single organization. The CAPIF provider and the API provider can be part of different organizations, in which case the business relationship between the two must exist.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 5.2 CAPIF business relationships for RNAA
| Figure 5.2-1 shows the CAPIF business relationships for the resource owner-aware northbound API access (RNAA).
Figure 5.2-1: CAPIF business relationships for RNAA
The business relationships the API invoker, the CAPIF provider, and the API provider follow the description in the clause 5.1. In addition to them, the resource owner is an entity capable of granting access to a protected resource related to the resource exposed by the API provider. The API invoker and the resource owner can be the same entity or separate entities. In the current release, the resource owner is a user of a UE and can provide authorization information using the UE.
The CAPIF provider and the API provider can belong to the same organization (e.g. PLMN operator), in which case the service API arrangement is not required explicitly.
The CAPIF provider and the API provider (e.g. 3rd party CAPIF provider or 3rd party API provider) can belong to different organizations, in which case the service API arrangement is required. The specification of service API arrangement is out of scope of 3GPP.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6 Functional model
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.1 General
| The Common API framework (CAPIF) functional architecture is described in this subclause. The CAPIF architecture is defined as service-based and interactions between the CAPIF functions are represented in two ways:
- A service-based representation, where CAPIF functions enable other authorized CAPIF functions to access their services;
- A reference point representation, where interactions between any two CAPIF functions (e.g. CCF, AEF) is shown by an appropriate point-to-point reference point (e.g. CAPIF-3).
The CAPIF functional architecture can be adopted by any 3GPP functionality providing 3GPP northbound service APIs.
Charging aspects of CAPIF framework are specified in 3GPP TS 32.254 [20].
NOTE 1: The terms “functional architecture” and “functional model” mean the same and have been used interchangeably in this specification.
NOTE 2: The functional model described in this specification applies to both PLMN(s) and to SNPN(s).
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.2 Functional model description
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.2.0 Functional model description for the CAPIF
| Figure 6.2.0-1 shows the reference point based functional model for the CAPIF.
Figure 6.2.0-1: Functional model for the CAPIF
The CAPIF is hosted within the PLMN operator network (or even an SNPN). 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.
In a reference point based model, the API invoker within the PLMN trust domain interacts with the CAPIF via CAPIF-1 and CAPIF-2. The API invoker from outside the PLMN trust domain interacts with the CAPIF via CAPIF-1e and CAPIF-2e. The API exposing function, the API publishing function and the API management function of the API provider domain (together known as API provider domain functions) within the PLMN trust domain interacts with the CAPIF core function via CAPIF-3, CAPIF-4 and CAPIF-5 respectively.
Figure 6.2.0-2: Functional model for interactions between API exposing functions
As illustrated in figure 6.2.0-2, the interactions between the API exposing functions within the PLMN trust domain is via CAPIF-7.
The CAPIF core function provides CAPIF APIs to the API invoker over CAPIF-1 and CAPIF-1e. The API exposing function provides the service APIs to the API invoker over CAPIF-2 and CAPIF-2e.
NOTE 1: The communication between the API exposing function and the CAPIF core function, between the API publishing function and the CAPIF core function and between the API management function and the CAPIF core function over CAPIF-3, CAPIF-4 and CAPIF-5 respectively can be API based.
The detailed information of the APIs provided by the CAPIF core function is specified in clause 10.
The security aspects of CAPIF reference points are specified in 3GPP TS 33.122 [12].
Figure 6.2.0-3 illustrates the CAPIF functional model using service-based interfaces.
Figure 6.2.0-3: CAPIF functional model representation using service-based interfaces
Table 6.2.0-1 specifies the service-based interfaces supported by CAPIF.
Table 6.2.0-1: Service-based interfaces supported by CAPIF
Service-based interface
Entity
APIs offered
Cccf
CAPIF core function
Specified in subclause 10
Caef
API exposing function
Specified in subclause 11
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.2.1 Functional model description to support 3rd party API providers
| Figure 6.2.1-1 shows the functional model for the CAPIF to support 3rd party API providers.
Figure 6.2.1-1: Functional model for the CAPIF to support 3rd party API providers
The CAPIF core function in the PLMN trust domain supports service APIs from both the PLMN trust domain and the 3rd party trust domain having business relationship with PLMN. The API invokers may exist within the PLMN trust domain, or within the 3rd party trust domain or outside of both the PLMN trust domain and the 3rd party trust domain. The API provider domain 1 offers the service APIs from the PLMN operator. The API provider domain 2 offers the service APIs from the 3rd party. When the 3rd party API provider is a trusted 3rd party of the PLMN, the API provider domain 1 also offers the service APIs from the 3rd party.
The API invoker 2 within the PLMN trust domain interacts with the CAPIF core function via CAPIF-1, and invokes the service APIs in the PLMN trust domain via CAPIF-2 and invokes the service APIs in the 3rd party trust domain via CAPIF-2e. The API invoker 3 within the 3rd party trust domain interacts with the CAPIF core function via CAPIF-1e, and invokes the service APIs in the PLMN trust domain via CAPIF-2e and invokes the service APIs in 3rd party trust domain via CAPIF-2. The API invoker 1 from outside the PLMN trust domain and 3rd party trust domain, interacts with the CAPIF core function via CAPIF-1e and invokes the service APIs in the PLMN trust domain and the service APIs in the 3rd party trust domain via CAPIF-2e.
The API exposing function, the API publishing function and the API management function of the API provider domain 1 within the PLMN trust domain interacts with the CAPIF core function via CAPIF-3, CAPIF-4 and CAPIF-5 respectively. The API exposing function, the API publishing function and the API management function of the API provider domain 2 within the 3rd party trust domain interacts with the CAPIF core function in the PLMN trust domain via CAPIF-3e, CAPIF-4e and CAPIF-5e respectively. The API exposing function within the PLMN trust domain and the 3rd party trust domain provides the service APIs to the API invoker, offered by the respective trust domains.
The interactions between the API exposing functions within the PLMN trust domain is via CAPIF-7 (not shown in the figure 6.2.1-1 for simplicity). The API exposing function within the PLMN trust domain interacts with the API exposing function in the 3rd party trust domain via CAPIF-7e.
NOTE 1: The communication between the API exposing function and the CAPIF core function, between the API publishing function and the CAPIF core function and between the API management function and the CAPIF core function over CAPIF-3/3e, CAPIF-4/4e and CAPIF-5/5e respectively can be API based.
The detailed information of the APIs provided by the CAPIF core function is specified in clause 10.
NOTE 2: The security aspects of CAPIF reference points are under SA3 responsibility and out of scope of the present document.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.2.2 Functional model description to support CAPIF interconnection
| Figure 6.2.2-1 shows the architectural model for the CAPIF interconnection which allows API invokers of a CAPIF provider to utilize the service APIs from the 3rd party CAPIF provider.
Figure 6.2.2-1: High level functional architecture for CAPIF interconnection with multiple CAPIF provider domains
Figure 6.2.2-2 shows the architectural model for the CAPIF interconnection within the same CAPIF provider domain, which allows API invokers of CAPIF core function 1 to utilize the service APIs from CAPIF core function 2, where both CAPIF core function 1 and CAPIF core function 2 are hosted within the trust domain of the CAPIF provider A.
Figure 6.2.2-2: High level functional architecture for CAPIF interconnection within a CAPIF provider domain
The CAPIF provider A and CAPIF provider B host the CAPIF in their trust domains. A business relationship exists between the CAPIF providers.
The CAPIF providers in their respective trust domain hosts multiple CAPIF instances where each CAPIF instance consists of the CAPIF core function (local), the API provider domain and the API invokers. All interactions within the CAPIF instance is according to the functional model specified in clause 6.2.0.
When multiple CAPIF instances are deployed by a CAPIF provider there may be a hierarchy associated with the multiple CAPIF core function deployed which allows:
- the designated CAPIF core function of the CAPIF provider A to interconnect with the designated CAPIF core function of the CAPIF provider B; and
- within CAPIF provider A, one or more CAPIF core function interacts with the designated CAPIF core function 1.
The designated CAPIF core function of the CAPIF provider A provides the information about the CAPIF instances and service APIs deployed by the CAPIF provider A to the designated CAPIF core function of the CAPIF provider B and vice versa over CAPIF-6e reference point.
The CAPIF core function 2 of CAPIF provider A provides the information about the service APIs to the CAPIF core function 1 over CAPIF-6 reference point.
NOTE 1: Void
The API invokers may exist within the trust domain of CAPIF provider A, or within the trust domain of CAPIF provider B or outside of the trust domains of both CAPIF provider A and CAPIF provider B. The API invoker of a CAPIF provider is onboarded with the CAPIF core function in the corresponding trust domain of the CAPIF provider.
NOTE 2: For sake of simplicity, the service API interactions of API invokers of the CAPIF provider B are not shown. From each CAPIF provider's perspective the other CAPIF provider is a 3rd party.
One or more CAPIF core function can publish service APIs to the designated CAPIF core function over CAPIF-6 reference point and, also discover the service APIs from the designated CAPIF core function and vice versa over CAPIF-6 reference point.
The API invoker within the trust domain of CAPIF provider A interacts with the CAPIF core function of the CAPIF provider A via CAPIF-1 and discovers the service APIs of both CAPIF providers, and invokes the service APIs in the trust domain of CAPIF provider A via CAPIF-2 and invokes the service APIs in the trust domain of CAPIF provider B via CAPIF-2e. The API invoker from outside the trust domain of CAPIF providers, interacts with the CAPIF core function of th CAPIF provider A via CAPIF-1e and invokes the service APIs in the trust domain of the CAPIF providers via CAPIF-2e.
NOTE 3: The communication between the CAPIF core function of the CAPIF providers over CAPIF-6 or CAPIF-6e can be API based.
The detailed information of the APIs provided by the CAPIF core function is specified in clause 10.
NOTE 4: The security aspects of CAPIF reference points are under SA3 responsibility and out of scope of the present document.
NOTE 5: All interactions among entities within the CAPIF provider domains (regardless if CAPIF is deployed in a PLMN, SNPN or 3rd party network) are ruled by the functional model in clause 6.2.0, the support of 3rd party API providers is as in clause 6.2.1, whereas the interconnection among CCFs is according to this clause.
NOTE 6: RNAA for CAPIF interconnection is not specified in this release of the specification.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.2.3 Functional model description to support RNAA
| Figure 6.2.3-1 shows the architectural model for the RNAA which allows the resource owner to provide authorization to access their resources through Service API invocation.
Figure 6.2.3-1: High level functional architecture for CAPIF supporting RNAA
The authorization function is an internal entity of the CAPIF core function and performs API invoker authorization based on the API invoker authorization policies available in the CCF and the RO authorization information obtained via the ROF.
The resource owner function interacts with the authorization function in the CAPIF core function via CAPIF-8. The authorization function in the CAPIF core function interacts with the resource owner function to obtain the resource owner authorization. The CAPIF core function (authorization function) uses resource owner authorization information obtained via the ROF as part of the processing of the authorization requests received from API invokers.
The API exposing function (e.g. NEF, SCEF) interacts with the authorization function in the CAPIF core function via CAPIF-3. The API exposing function acts as an authorization enforcement point according to the authorization token received from the API invoker.
NOTE 1: RNAA support is not dependant of the access network, i.e., the RNAA support is not restricted to 5G networks.
The API invoker interacts with authorization function in the CAPIF core function via CAPIF-1/CAPIF-1e.
NOTE 2: In the current release, 3rd party API providers (i.e., API providers outside the PLMN trust domain) are not supported for RNAA.
NOTE 3: The interaction between resource owner function and CCF over CAPIF-8 is not specified in the current release of the specification.
NOTE 4: The authorization information from the resource owner used by CCF (described in 3GPP TS 33.122 [12]) is independent from the user consent information used from user subscription data at UDM/UDR (described in Annex V of 3GPP TS 33.501 [16]). In the current release of 3GPP specifications, no synergy between CCF and UDM is specified.
The security aspects of CAPIF supporting RNAA are specified in 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.3 Functional entities description
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.3.1 General
| Each subclause is a description of a functional entity and does not imply a physical entity.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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 may be either an application on a server or an application on a UE.
The API invoker supports the following capabilities:
- Triggering API invoker onboarding/offboarding;
- 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.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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;
- Mutual authentication with the API invoker;
- Publishing, storing, retrieving, unpublishing, updating and discovering 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;
- Reporting Charging based events to the charging function (e.g. events of API invoker onboarding);
- Monitoring the service API invocations;
- Onboarding a new API invoker and offboarding an API invoker;
- Storing policy configurations related to CAPIF and service APIs;
- Accessing the logs for auditing (e.g. detecting abuse);
- Publishing, retrieving, unpublishing, updating,and discovering service APIs information with another CAPIF core function in CAPIF interconnection; and
- Slice related API exposure in, e.g., API publish, API discovery, API invoker authorization, API access control.
NOTE: Charging events reported by the CCF are specified in 3GPP TS 32.254 [20].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.3.4 API exposing function
| 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;
- Requesting the revocation of the API invoker authorization;
- Enforcing the authorization provided by the CAPIF core function;
- Supporting authorization revocation;
- Reporting Charging based events to the charging function (e.g. events of service API invocations);
- Logging the service API invocations at the CAPIF core function; and
- Hiding the topology of the PLMN trust domain from API invokers, depending on configured policy.
NOTE: Charging events reported by the AEF (NEF) are specified in 3GPP TS 32.254 [20].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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; and
- Retrieving service API information from the CAPIF core function.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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 new API invokers and offboarding API invokers; and
- Registering and maintaining registration information of the API provider domain functions on the CAPIF core function.
NOTE: The API invoker onboarding/offboarding in the API management function is out of the scope of the current release.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.3.7 Authorization function
| The authorization function has the following capabilities:
- Acts in an authorization server role as specified in clause 1.1 of IETF RFC 6749 [14],
- Verifies authorization information for service APIs, upon request from AEF (when the AEF does not have information required to authorize the service API invocation),
- Uses the RO authorization information (such as user consent) obtained via ROF, when legally required, as part of the authorization of the API invoker to access the RO resources related to a service API.
NOTE 1: In the current release, the authorization function is an internal entity of the CAPIF core function.
NOTE 2: The persistent storage of the resource owner authorization data is subject to local/regional regulations and is not in scope of this specification.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.3.8 Resource owner function
| The resource owner function is responsible for interactions with the resource owner, when needed for the resource owner network resource consumption during obtain service API authorization procedure, e.g. in a similar way to the resource owner's user agent shown in clause 4.1 of IETF RFC 6749 [14].
The resource owner function enables the following:
- Authorization for resource access; and
- Managing and revoking authorization for resource access.
NOTE: The procedures corresponding to these capabilities of the resource owner function are FFS and out of scope of the current release of the specification.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4 Reference points
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.1 General
| The reference points for CAPIF are described in the following subclauses.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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:
- Onboarding the new API invokers and offboarding API invokers;
- 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;
- Providing authorization for the API invoker based on RNAA; and
- Discovering the service APIs information.
NOTE: The security aspects of CAPIF-1 are specified in subclause 6.2 of 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.3 Reference point CAPIF-1e (between the API invoker and the CAPIF core function)
| 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 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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;
- Providing authorization revocation information;
- Authorization verification for the API invoker upon accessing the service API;
- Authorization verification for the API invoker based on RNAA;
- Controlling the service API access based on PLMN operator configured policies; and
- Logging the service API invocations;
NOTE: The security aspects of CAPIF-3 are specified in subclause 6.6 of 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.7 Reference point CAPIF-4 (between the API publishing function and the CAPIF core function)
| 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 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 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 1: The security aspects of CAPIF-5 are specified in subclause 6.6 of 3GPP TS 33.122 [12].
NOTE 2: The API invoker onboarding/offboarding over CAPIF-5 is out of the scope of the current release.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.9 Reference point CAPIF-3e (between the API exposing function and the CAPIF core function)
| 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 are specified in clause 6.10 of 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.10 Reference point CAPIF-4e (between the API publishing function and the CAPIF core function)
| 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 are specified in clause 6.10 of 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.11 Reference point CAPIF-5e (between the API management function and the CAPIF core function)
| 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 are specified in clause 6.10 of 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.12 Reference point CAPIF-7 (between the API exposing functions)
| 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.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.13 Reference point CAPIF-7e (between the API exposing functions)
| 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.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.14 Reference point CAPIF-6 (between the CAPIF core functions of the same CAPIF provider)
| 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;
- Discovering the service APIs information;
- Obtaining security information for the API invoker upon accessing the service API; and
- Providing authorization for the API invoker prior to accessing the service API.
NOTE: The security aspects of CAPIF-6 are specified in clauses 6.6, 6.10 and 6.13 of 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.15 Reference point CAPIF-6e (between the CAPIF core functions of different CAPIF providers)
| 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 are specified in 3GPP TS 33.122 [12], clauses 6.6, 6.10 and 6.13.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.4.16 Reference point CAPIF-8 (between the CAPIF core function and the resource owner function)
| The CAPIF-8 reference point exists between the CAPIF core function and the resource owner function.
The CAPIF-8 reference point supports:
- Providing authorization for resource access; and
- Managing and revoking the provided authorization.
NOTE: The functionalities over CAPIF-8 is FFS and out of scope of the current release of the specification.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 6.5 Service-based interfaces
| The CAPIF architecture contains the following service-based interfaces:
- Cccf: Service-based interface exhibited by CAPIF core function.
- Caef: Service-based interface exhibited by API exposing function.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 7 Application of functional model to deployments
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 7.1 General
| The CAPIF deployments in centralized and distributed models are described in clause 7.2 and clause 7.3. The multiple CCFs deployment is described in clause 7.4.
The RNAA deployments are described in clause 7.5.
The CAPIF deployment models shown are not exhaustive.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 7.2 Centralized deployment
| The CAPIF can be deployed centrally as illustrated in the figure 7.2-1.
Figure 7.2-1: Centralized deployment of CAPIF
In one centralized deployment, the CAPIF core function and the API provider domain functions are co-located. The API invoker can interact independently with the CAPIF core function and the API exposing function including the service APIs. The CAPIF appears as a gateway for all API invoker interactions. The API invoker obtains the service API information and its entry point details from the CAPIF core function via CAPIF-1. The service communication point of entry for the service API is the API exposing function which also applies any access control or policy control to the internal interactions between the API invoker and the service API in coordination with the CAPIF core function.
NOTE: The API invoker can be outside the PLMN trust domain and will access the CAPIF via CAPIF-1e and CAPIF-2e instead of CAPIF-1 and CAPIF-2.
Another variation of the centralized deployment is where the CAPIF core function and the API exposing function is co-located where as other API provider domain functions (API publishing function and API management function) are not co-located with the API exposing function. In such deployment scenario, the CAPIF core function interacts with the API publishing function and the API management function via CAPIF-4 and CAPIF-5 reference points respectively.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 7.3 Distributed deployment
| The CAPIF can be deployed in a distributed manner illustrated in the figure 7.3-1.
Figure 7.3-1: Distributed deployment of the CAPIF within PLMN trust domain
In distributed deployment, the CAPIF core function and the API provider domain functions are not co-located. The CAPIF core function interacts with the API exposing function, the API publishing function and the API management function via CAPIF-3, CAPIF-4 and CAPIF-5 reference points respectively. The API invoker can interact independently with the CAPIF core function and the API exposing function including the service APIs. In this deployment, the API exposing function appears as an agent for all service API invocations from the API invoker. The API invoker obtains the service API information and its entry point details from the CAPIF core function via CAPIF-1 interface. The first point of entry for the service API is the API exposing function during API invocation. The API exposing function acts as agent for service API applying any access control or policy control to the interactions between the API invoker and the service API in coordination with the CAPIF core function via CAPIF-3 interface.
The CAPIF can be deployed by splitting the functionality of the API exposing function among multiple API exposing function entities, of which one acts as the entry point. However there will be single API publishing function and single API management function in the API provider domain although there could be multiple API exposing function entities. The CAPIF deployment with cascading API exposing functions is as illustrated in the figure 7.3-2.
Figure 7.3-2: Distributed deployment of the CAPIF with cascading API exposing functions
In this deployment option, the API exposing function can have several instances like AEF-1, AEF-2 and AEF-3 which can be assigned with different roles. The roles for each API exposing function are decided by the operator. In this illustration, the API exposing functions AEF-2 and AEF-3 provide service APIs for service X and service Y respectively. The API exposing function AEF-1 provides the service communication entry point to the service APIs for service X APIs and service Y APIs. The API exposing function AEF-1 for instance can hide the topology of service X APIs and service Y APIs from the API invoker. The API exposing function AEF-1 also applies any access control or policy control to the interactions between the API invoker and service X APIs and between the API invoker and service Y APIs, in coordination with the CAPIF core function using CAPIF-3.
The API invoker interacts with the CAPIF core function via CAPIF-1. The API invoker interacts with service (X&Y) APIs on the API exposing function AEF-1 via CAPIF-2. The API exposing function AEF-1 forwards the invocation of the service X API or service Y API from the API invoker to the API exposing functions AEF-2 or AEF-3 respectively via CAPIF-2. The API messages are forwarded via CAPIF-7 (in compliance with CAPIF-2 interaction between the API invoker and the AEF-1) in the interactions between API exposing functions. The API invoker cannot directly interact with service X APIs and service Y APIs provided by API exposing functions AEF-2 and AEF-3 respectively.
Different splits of responsibility are possible. In another example illustrated in figure 7.3-3, the API exposing function AEF-1 could provide topology hiding for API exposing functions AEF-2 and AEF-3, plus access control for AEF-3. The API exposing function AEF-2 would provide its own access control, interacting with the CAPIF core function via CAPIF-3.
Figure 7.3-3: Another example of distributed deployment of the CAPIF with cascading API exposing functions
NOTE 1: The API invoker can be outside the PLMN trust domain and will access the CAPIF via CAPIF-1e and CAPIF-2e instead of CAPIF-1 and CAPIF-2.
When considering the 3rd party trust domain deployment, the API provider domain belongs to a 3rd party trust domain, the CAPIF core function belongs to PLMN trust domain and the API invoker belongs to PLMN trust domain as illustrated in figure 7.3-4.
Figure 7.3-4: Distributed deployment of CAPIF considering PLMN trust domain and 3rd party trust domain
The interactions between the AEF and the CAPIF core function is based on CAPIF-3e. The interactions between the API publisher function and the CAPIF core function is based on CAPIF-4e. The interactions between the API management function and the CAPIF core functions are based on CAPIF-5e. The interactions between the API invoker and the AEF are based on CAPIF-2e. The API provider domain functions may be deployed in the PLMN trust domain and the interactions of the API provider domain functions within CAPIF of the PLMN trust domain is not shown in the figure 7.3-4 and is as illustrated in figure 7.3-1.
NOTE 2: For deployments illustrated in figure 7.3-2 and figure 7.3-3, when the API provider domain belongs to the 3rd party trust domain, the interactions between the AEF of the API provider domain and API invoker belonging to the PLMN trust domain are carried over CAPIF-2e reference point and the interactions between the entities of the API provider domain and the CAPIF core function belonging to the PLMN trust domain are carried over CAPIF-3e, CAPIF-4e and CAPIF-5e as illustrated in figure 7.3-4.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 7.4 Multiple CCFs deployment
| Multiple CAPIF core functions may be deployed within the PLMN trust domain as illustrated in the figure 7.4-1. For simplicity, the API invoker is not shown.
Figure 7.4-1: Multiple CCFs deployment within the PLMN trust domain
In the distributed deployment, the CAPIF core function 1 and the CAPIF core function 2 interact with CAPIF core function 3 via CAPIF-6 reference point. The CAPIF core function 3 assumes the role of a centralized repository of service APIs in the PLMN trust domain.
NOTE: The CAPIF core function 3 can be connected with the API exposing function(s) and API invokers.
The CAPIF core function 1 and the CAPIF core function 2 publishes the service API provided by its connected API exposing function(s) to the CAPIF core function 3, and obtains the service API information provided by other CAPIF core function(s).
An API invoker (not shown in the figure for simplicity) connected to the CAPIF core function 1 is able to discover and invoke the service APIs provided by the API exposing function connected to the CAPIF core function 2.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 7.5 RNAA deployments
| CAPIF supports RNAA and has enabled API invoker(s) to have authorized access to resources of a resource owner provided by service APIs offered by the AEF. The CCF acts as the Authorization Function and supports the authentication and authorization of API invoker(s). After checking the resource owner authorization information (e.g., user consent) via the ROF, the CCF (Authorization function) provides the access token for a service API access to the API invoker. The API invoker performs service API invocations on the AEF by utilizing the access token.
The API invoker may be deployed in the following ways:
a. API invoker may be deployed as AF on the UE (i.e. 3rd party application).
b. API invoker may be deployed as AF on the UE supporting several other 3rd party applications deployed on the UE.
c. API invoker may be deployed on the network as AF.
The resource owner is connected via a UE and can use a Resource Owner Function on the UE to interact with the CCF acting as the Authorization Function to grant RO permission to the API invoker to access resource(s) of the resource owner provided by the service API. The CCF (Authorization Function) uses the RO authorization information, as part of API invoker authorization process.
NOTE: The details of the protocol for CAPIF supporting RNAA is specified in 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8 Procedures and information flows
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.1 Onboarding the API invoker to the CAPIF
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.1.1 General
| The procedure in this subclause corresponds to the architectural requirements for onboarding the API invoker to the CAPIF. The CAPIF enables a one time onboarding process that enrolls the API invoker as a recognized user of the CAPIF, which may be triggered by the API invoker via CAPIF-1 or CAPIF-1e, or may be based on provisioning.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.1.2 Information flows
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.1.2.1 Onboard API invoker request
| Table 8.1.2.1-1 describes the information flow onboard API invoker request from the API invoker to the CAPIF core function.
Table 8.1.2.1-1: Onboard API invoker request
Information element
Status
Description
Onboarding information
M
The information of the API invoker including enrolment details, required for onboarding
> Onboarding criteria
O
Indicates that the API Invoker wishes to on board itself to the CCF only if the CCF supports the features mentioned in criteria information.
>> Criteria information
M
This information includes at least one of the criteria listed (supported security methods, supported security methods for given AEFs / service APIs/ Service API categories) for the CCF to onboard the API invoker.
APIs for enrollment
O
List of APIs being enrolled for.
Proposed expiration time
O
Proposed expiration time for the onboarding.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.1.2.2 Onboard API invoker response
| Table 8.1.2.2-1 describes the information flow onboard API invoker response from the CAPIF core function to the API invoker.
Table 8.1.2.2-1: Onboard API invoker response
Information element
Status
Description
Onboarding status
M
The result of onboarding request i.e., success indication is included if the API invoker is granted permission otherwise failure.
Enrolled information
O
(see NOTE 1)
Information from the provisioned API invoker profile which includes information to allow the API invoker to be authenticated and to obtain authorization for service APIs, containing the unique API invoker identity associated to the onboarded API invoker profile.
Service API information
O
(see NOTE 2)
The service API information as specified in Table 8.7.2.2-1.
Reason
O
(see NOTE 3)
This element indicates the reason when onboarding status is failure.
Expiration time
O
Indicates the expiration time of the onboarding. At expiration, CCF cancels the enrollment of the API invoker from CAPIF. If omitted, it indicates the onboarding does not expire.
NOTE 1: Information element shall be present when onboarding status is successful.
NOTE 2: Information element may be present when onboarding status is successful.
NOTE 3: Information element shall be present when onboarding status is failure.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.1.3 Procedure
| Figure 8.1.3-1 illustrates the procedure for onboarding the API invoker to the CAPIF. The security aspects of this procedure are specified in subclause 6.1 of 3GPP TS 33.122 [12].
Pre-conditions:
1. The API invoker is not a recognized user of the CAPIF.
2. The API invoker has visibility to APIs information (e.g., API catalogue or dashboard - central place for the API provider to manage which APIs are displayed, giving API invokers the ability to enroll for).
Figure 8.1.3-1: Procedure for onboarding the API invoker to the CAPIF
1. For enrolment of the API invoker to be a recognized user of the CAPIF, the API invoker triggers onboard API invoker request towards the CAPIF core function, providing the information as required for the API management and criteria information as required to onboard the API invoker.
2. The CAPIF core function begins the onboarding process by verifying whether all the necessary information has been provided to onboard the API invoker, and further initiates a grant process. If the onboard API invoker request message includes onboard criteria information, then the CCF verifies whether the CCF can support the onboard criteria information. The CCF further proceeds with API invoker onboarding procedure, only if the CCF supports the onboard criteria information from the API Invoker. Successful onboarding results in provisioning API invoker profile which includes identity for the API invoker. The authorization information and the list of APIs and the categories of APIs that the API invoker can access subsequent to successful onboarding may also be created, considering the network slice information, if applicable. The CAPIF core function may create access control policy (see Table E-1) for the onboarded API invoker considering the network slice information.
NOTE 1: Completion of onboarding 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.
NOTE 2: The API invoker profile consists of at least the identity information for the API invoker, information required for the authentication and authorization by the CAPIF (e.g., application service information such as application service provider and application identifier) and the CAPIF identity information.
3. If the API invoker has triggered the onboard API invoker request and is granted permission, the onboard API invoker response provides success indication including information from the provisioned API invoker profile which may include information to allow the API invoker to be authenticated and to obtain authorization for service APIs.
4. As a result of successful onboarding process, the CAPIF core function is able to authenticate and authorize the API invoker.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.2 Offboarding the API invoker from the CAPIF
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.2.1 General
| This subclause defines the procedure for offboarding the API invoker from the CAPIF. The offboarding process makes the API invoker no longer a recognized user of the CAPIF. The procedure is triggered by the API invoker over CAPIF-1 or CAPIF-1e.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.2.2 Information flows
| This subclause describes the information flows for the API invoker offboarding.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.2.2.1 Offboard API invoker request
| Table 8.2.2.1-1 describes the information flow offboard API invoker request from the API invoker to the CAPIF core function.
Table 8.2.2.1-1: Offboard API invoker request
Information element
Status
Description
API invoker identity information
M
Identity information of the API invoker requesting offboarding
Reason
O
Indicate the reason of offboarding
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.2.2.2 Offboard API invoker response
| Table 8.2.2.2-1 describes the information flow offboard API invoker response from the CAPIF core function to the API invoker.
Table 8.2.2.2-1: Offboard API invoker response
Information element
Status
Description
Result
M
Indicates the success or failure of the offboarding operation
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.2.3 Procedure
| Figure 8.2.3-1 illustrates the procedure for offboarding the API invoker from the CAPIF, triggered by the API invoker. The security aspects of this procedure are specified in subclause 6.8 of 3GPP TS 33.122 [12].
Pre-conditions:
1. The API invoker has been onboarded as a recognized user of the CAPIF.
Figure 8.2.3-1: Procedure for offboarding the API invoker from the CAPIF
1. The API invoker triggers offboard API invoker request to the CAPIF core function, providing the information as required for the API management.
2. The CAPIF core function cancels the enrollment of the API invoker from CAPIF. The API invoker ceases to be a recognized user of the CAPIF. All the authorizations corresponding to the API invoker are revoked from CAPIF. Optionally, the information of the API invoker may be retained at the CAPIF core function as per the operator policy.
NOTE: Completion of offboarding process can require explicit notification to the CAPIF administrator or the API management, which is left out-of-scope of this solution. CAPIF can handle the de-provisioning process internally without the need of explicit grant by the CAPIF administrator.
3. The CAPIF core function returns the offboard API invoker response providing successful offboarding indication.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.3 Publish service APIs
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.3.1 General
| The CAPIF supports publishing service APIs by the API provider. The API publishing function can be within PLMN trust domain or within 3rd party trust domain.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.3.2 Information flows
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.3.2.1 Service API publish request
| Table 8.3.2.1-1 describes the information flow service API publish request from the API publishing function to the CAPIF core function.
Table 8.3.2.1-1: Service API publish request
Information element
Status
Description
API publisher information
M
The information of the API publisher may include identity, authentication and authorization information
Service API information
M
(see NOTE 2)
The service API information includes the service API name, API provider name (optional), List of public IP ranges of UEs (optional), service API category (e.g. V2X, IoT), service API status (e.g. active, inactive), communication type, description, Serving Area Information (optional), AEF location (optional), interface details (e.g. IP address, port number, URI), protocols, version numbers, data format, Service KPIs (optional), service API operation(s) and resource(s) (optional), and Network Slice Info (optional), security methods.
Shareable information
O
(see NOTE 1)
Indicates whether the service API information or the service API category can be published to other CCFs. And if sharing, a list of CAPIF provider domain information where the service API information or the service API category can be published is contained.
NOTE 1: If the shareable information is not present, the service API information is not allowed to be shared.
NOTE 2: The active and inactive states of the service APIs of 3GPP AEFs are based on the respective combinations of the management states (administrative, operational) specified in the management domain in TS 28.541 [17], TS 28.532 [18] and TS 28.538 [19].
The Service KPIs is defined as below:
Table 8.3.2.1-2: Service KPIs
Information element
Status
Description
Maximum Request rate
O
Maximum request rate from the API Invoker supported by the server.
Maximum Response time
O
The maximum response time advertised for the API Invoker's service requests.
Availability
O
Advertised percentage of time the server is available for the API Invoker's use.
Available Compute
O
The maximum compute resource available for the API Invoker.
Available Graphical Compute
O
The maximum graphical compute resource available for the API Invoker.
Available Memory
O
The maximum memory resource available for the API Invoker.
Available Storage
O
The maximum storage resource available for the API Invoker.
Connection Bandwidth
O
The connection bandwidth in Kbit/s advertised for the API Invoker's use.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.3.2.2 Service API publish response
| Table 8.3.2.2-1 describes the information flow service API publish response from the CAPIF core function to the API publishing function.
Table 8.3.2.2-1: Service API publish response
Information element
Status
Description
Result
M
Indicates the success or failure of publishing the service API information
Service API published information reference
O
(see NOTE)
The information which can be used for referencing the information (set) about the published service API by the API publishing function.
Service API information
O
(see NOTE)
The authorized service API information, which may be a subset or the full set, of the Service API information as specified in Table 8.3.2.1-1.
NOTE: This information element is included when the Result indicates success.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.3.3 Procedure
| Figure 8.3.3-1 illustrates the procedure for publishing the service APIs. The service API publish mechanism is supported by the CAPIF core function.
Pre-conditions:
1. Authorization details of the APF are available with the CAPIF core function.
2. API invokers may have subscribed with the CAPIF core function to obtain new service API information.
Figure 8.3.3-1: Publish service APIs
1. The API publishing function sends a service API publish request to the CAPIF core function, with the details of the service API. If the service API is to be shared to other CAPIF core functions, the shareable information and the CAPIF provider domain information are included.
2. Upon receiving the service API publish request, the CAPIF core function checks whether the API publishing function is authorized to publish service APIs. If the check is successful, the service API information provided by the API publishing function is stored at the CAPIF core function (API registry).
3. The CAPIF core function provides a service API publish response to the API publishing function indicating success or failure result and triggers notifications to subscribed API invokers as described in subclause 8.8.4.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.4 Unpublish service APIs
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.