hash
stringlengths 32
32
| doc_id
stringlengths 5
12
| section
stringlengths 4
595
| content
stringlengths 0
6.67M
|
|---|---|---|---|
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
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].
When API invoker is deployed on a UE (cases a and b), with suitable authorization, the API invoker is allowed to access the resources (via service API) of the resource owner corresponding to the UE.
When API invoker is deployed on a UE (cases a and b), with suitable authorization, the API invoker is allowed to access the resources (via service API) of the resource owner of other UEs.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8 Procedures and information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.1 Onboarding the API invoker to the CAPIF
| |
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.1.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
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 / AEF types/ 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.
|
654592d6e30fb2596cb6e134b557471f
|
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 may include information to allow the API invoker to be authenticated and to obtain authorization for service APIs.
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.
|
654592d6e30fb2596cb6e134b557471f
|
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 enrollment 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. 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 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.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.2 Offboarding the API invoker from the CAPIF
| |
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.2.2 Information flows
|
This subclause describes the information flows for the API invoker offboarding.
|
654592d6e30fb2596cb6e134b557471f
|
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
|
654592d6e30fb2596cb6e134b557471f
|
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
|
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.3 Publish service APIs
| |
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.3.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
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.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.4 Unpublish service APIs
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.4.1 General
|
The CAPIF supports unpublishing service APIs by the API provider. Once the service API information is unpublished, it is no more available to be discovered by API invokers. The API publishing function can be within PLMN trust domain or within 3rd party trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.4.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.4.2.1 Service API unpublish request
|
Table 8.4.2.1-1 describes the information flow service API unpublish request from the API publishing function to the CAPIF core function.
Table 8.4.2.1-1: Service API unpublish request
Information element
Status
Description
API publisher information
M
The information of the API publisher may include identity, authentication and authorization information
Service API published information reference
M
The information provided by the CAPIF core function which can be for referencing the information (set) about the published service API by the API publishing function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.4.2.2 Service API unpublish response
|
Table 8.4.2.2-1 describes the information flow service API unpublish response from the CAPIF core function to the API publishing function.
Table 8.4.2.2-1: Service API unpublish response
Information element
Status
Description
Result
M
Indicates the success or failure of unpublishing the service API information
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.4.3 Procedure
|
Figure 8.4.3-1 illustrates the procedure for unpublishing the service APIs. The service API unpublish 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 notification regarding service API unpublish.
Figure 8.4.3-1: Unpublish service APIs
1. The API publishing function sends a service API unpublish request to the CAPIF core function, with service API published information reference provided by the CAPIF core function when the service API was published.
2. Upon receiving the service API unpublish request, the CAPIF core function checks whether the API publishing function is authorized to unpublish service APIs. If the check is successful, the service API information provided by the API publishing function is removed at the CAPIF core function (API registry).
3. The CAPIF core function provides a service API unpublish response to the API publishing function and triggers notifications to subscribed API invokers as described in subclause 8.8.4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.5 Retrieve service APIs
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.5.1 General
|
The CAPIF supports retrieving the published service APIs information by the API provider. The API publishing function can be within PLMN trust domain or within 3rd party trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.5.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.5.2.1 Service API get request
|
Table 8.5.2.1-1 describes the information flow service API get request from the API publishing function to the CAPIF core function.
Table 8.5.2.1-1: Service API get request
Information element
Status
Description
API publisher information
M
The information of the API publisher may include identity, authentication and authorization information
Service API published information reference
M
The information provided by the CAPIF core function which can be for referencing the information (set) about the published service API by the API publishing function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.5.2.2 Service API get response
|
Table 8.5.2.2-1 describes the information flow service API get response from the CAPIF core function to the API publishing function.
Table 8.5.2.2-1: Service API get response
Information element
Status
Description
Result
M
Indicates the success or failure of retrieving the service API information
Cause
O
The cause for the request failure.
Service API information
O (see NOTE)
The service API information as specified in Table 8.3.2.1-1.
NOTE: Shall be present if the Result information element indicates that the service API get request is successful. Otherwise service API information shall not be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.5.3 Procedure
|
Figure 8.5.3-1 illustrates the procedure for retrieving the service APIs. The service API retrieval mechanism is supported by the CAPIF core function.
Pre-condition:
1. Authorization details of the APF are available with the CAPIF core function.
Figure 8.5.3-1: Retrieve service APIs
1. The API publishing function sends a service API get request to the CAPIF core function, with service API published information reference provided by the CAPIF core function when the service API was published.
2. Upon receiving the service API get request, the CAPIF core function checks whether the API publishing function is authorized to get published service APIs information. If the check is successful, the corresponding service API information is retrieved from the CAPIF core function (API registry).
3. The CAPIF core function provides a service API get response to the API publishing function which includes the service API information.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.6 Update service APIs
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.6.1 General
|
The CAPIF core function allows the service API provider to update the information related to the published service API, e.g. a change in the characteristics of the service API. This procedure is initiated by the API publishing function to the CAPIF core function. The API publishing function can be within PLMN trust domain or within 3rd party trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.6.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.6.2.1 Service API update request
|
Table 8.6.2.1-1 describes the information flow service API update request from the API publishing function to the CAPIF core function.
Table 8.6.2.1-1: Service API update request
Information element
Status
Description
API publisher information
M
The information of the API publisher may include identity, authentication and authorization information
Service API published information reference
M
The information (set) provided by the CAPIF core function about the published service API which can be used for reference by the API publishing function.
Service API information
M
The service API information as specified in Table 8.3.2.1-1, as required to replace the existing service API information.
Reason
O
The reason of the update (e.g. change log).
NOTE: How to monitor service API status when the APF is unable to update service API status is not specified in this release.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.6.2.2 Service API update response
|
Table 8.6.2.2-1 describes the information flow service API update response from the CAPIF core function to the API publishing function.
Table 8.6.2.2-1: Service API update response
Information element
Status
Description
Result
M
Indicates the success or failure of updating the service API information
Cause
O
The cause for the request failure.
Service API information
O
The authorized service API information during update, applicable when the update result is success. This can be a subset or the full set, of the Service API information as specified in Table 8.3.2.1-1.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.6.3 Procedure
|
Figure 8.6.3-1 illustrates the procedure for updating the published service APIs information. The service API update 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 notification regarding update to service API information.
Figure 8.6.3-1: Update service APIs
1. The API publishing function sends a service API update request to the CAPIF core function, which includes the service API published information reference provided by the CAPIF core function when the service API was published and the new service API information which is to be updated.
2. Upon receiving the service API update request, the CAPIF core function checks whether the API publishing function is authorized to update the published service APIs information. If the check is successful, the service API information provided by the API publishing function is updated at the CAPIF core function (API registry).
3. The CAPIF core function provides a service API update response to the API publishing function and triggers notifications to subscribed API invokers as described in subclause 8.8.4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.7 Discover service APIs
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.7.1 General
|
The following procedure in this subclause corresponds to the architectural requirements on discover service APIs. This procedure may be invoked by different types of API invokers (i.e., application management client, hosted application) at different phases (i.e., hosted application development, test phase and hosted application running phase). Different API invokers utlize this procedure for different purpose:
- service API discovery for interested service APIs with service API informaiton including e.g., API name, API provider name, API category.
- service API discovery for the interface information (e.g. IP address, port number, URI) of a particular service API in case of the interface information is not provided in the service API information during hosted application running phase.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.7.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.7.2.1 Service API discover request
|
Table 8.7.2.1-1 describes the information flow service API discover request from the API invoker to the CAPIF core function.
Table 8.7.2.1-1: Service API discover request
Information element
Status
Description
API invoker identity information
M
Identity information of the API invoker discovering service APIs
Query information
O (NOTE 2)
Criteria for discovering matching service APIs (e.g. service API category, Serving Area Information (optional), preferred AEF location (optional), required API provider name (optional), UE IP address (optional), interfaces, protocols, Service KPIs (optional), security methods, service API operation(s) and resource(s) (optional), and Network Slice Info (optional)).
(see NOTE 1)
Service API identification
O (NOTE 2)
The identification information of the service API(s) for which the request is targeting
NOTE 1: It should be possible to discover all the service APIs.
NOTE 2: Either "Query information" IE or " Service API identification" IE shall be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.7.2.2 Service API discover response
|
Table 8.7.2.2-1 describes the information flow service API discover response from the CAPIF core function to the API invoker.
Table 8.7.2.2-1: Service API discover response
Information element
Status
Description
Result
M
Indicates the success or failure of the discovery of the service API information
Service API information
(see NOTE 2)
O
(see NOTE 1, NOTE 3)
The service API information as specified in Table 8.3.2.1-1, except for the service API status (e.g. active, inactive).
Interface information
O
(NOTE 3)
The interface details (e.g. IP address, port number, URI) of the requested service API(s)
CAPIF core function identity information
O
(see NOTE 1, NOTE 3)
Indicates the CAPIF core function serving the service API category provided in the query criteria
NOTE 1: The service API information or the CAPIF core function identity information or both shall be present if the Result information element indicates that the service API discover operation is successful. Otherwise, both shall not be present.
NOTE 2: If topology hiding is enabled for the service API, the interface details shall be the interface details of AEF acting as service communication entry point for the service API.
NOTE 3: "Interface information" IE shall not be present when "Service API information" or "CAPIF core function identity information" is present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.7.3 Procedure
|
Figure 8.7.3-1 illustrates the procedure for discover service APIs.
The service API discovery mechanism is supported by the CAPIF core function.
Pre-conditions:
1. The API invoker is onboarded and has received an API invoker identity.
2. The CAPIF core function is configured with a discovery policy information (e.g. to restrict discovery to category of APIs) for API invoker(s).
Figure 8.7.3-1: Discover service APIs
1. The API invoker sends a service API discover request to the CAPIF core function. It includes the API invoker identity, either query information or the service API identification.
For service API discovery for interested service APIs, the query information is included.
For service API discovery for interface information, service API identification is included.
2. Upon receiving the service API discover request, the CAPIF core function verifies the identity of the API invoker (via authentication).
If the query information is included, the CAPIF core function retrieves the stored service API(s) information from the CAPIF core function (API registry) as per the query information in the service API discover request. Further, the CAPIF core function applies the discovery policy and performs filtering of service APIs information retrieved from the CAPIF core function.
If the service API identification is included, the CAPIF core function retrieves the interface information of the requested service API(s).
3. The CAPIF core function sends a service API discover response to the API invoker.
If the query information is included, the list of service API information is returned.
If the service API identification is included, the interface information is returned.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8 Subscription, unsubscription and notifications for the CAPIF events
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.1 General
|
The CAPIF core function enables the subscribing entity (i.e. the API invoker, the API exposing function, the API publishing function, the API management function) to subscribe to and unsubscribe from the CAPIF events such as availability events of service APIs, change in service API information, monitoring service API invocations, API invoker onboarding events, etc. The subscription, unsubscription and notification for the CAPIF events are enabled on the following CAPIF reference points:
- CAPIF-1 or CAPIF-1e: the API invoker can subscribe to and unsubscribe from CAPIF events and receive notifications from the CAPIF core function;
- CAPIF-3 or CAPIF-3e: the AEF can subscribe to and unsubscribe from CAPIF events and receive notifications from the CAPIF core function;
- CAPIF-4 or CAPIF-4e: the API publishing function can subscribe to and unsubscribe from CAPIF events and receive notifications from the CAPIF core function; and
- CAPIF-5 or CAPIF-5e: the API management function can subscribe to and unsubscribe from CAPIF events and receive notifications from the CAPIF core function.
NOTE: Support for subscriptions and notifications can also be part of the actual service APIs. That type of subscriptions and notifications is not covered by the provisions in this clause.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2.1 Event subscription request
|
Table 8.8.2.1-1 describes the information flow for event subscription request from the subscribing entity to the CAPIF core function.
Table 8.8.2.1-1: Event subscription request
Information element
Status
Description
Identity information
M
The information to determine the identity of the subscribing entity
Event criteria
M
The event criteria include event type information like failure API invocation event, new API available event, API version change event, API location change event, API invoker status etc and other query information like service API identifier, service API name, onboarding criteria etc.
Notification reception information
O
The information of the subscribing entity for receiving the notifications for the event.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2.2 Event subscription response
|
Table 8.8.2.2-1 describes the information flow for event subscription response from the CAPIF core function to the subscribing entity.
Table 8.8.2.2-1: Event subscription response
Information element
Status
Description
Result
M
Indicates the success or failure of the event subscription operation
Cause
O
The cause for the request failure.
Subscription identifier
O
(see NOTE)
The unique identifier for the event subscription.
NOTE: Shall be present if the Result information element indicates that the event subscription operation is successful. Otherwise subscription identifier shall not be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2.3 Event notification
|
Table 8.8.2.3-1 describes the information flow for event notification from the CAPIF core function to the subscribing entity. A notification about an event is sent to a subscribing entity if the event criteria in the related subscription match the corresponding attributes of the event content.
Table 8.8.2.3-1: Event notification
Information element
Status
Description
Subscription identifier
M
The unique identifier of the event subscription
Event identifier
M
The unique identifier for the event. For the list of events, refer subclause 8.8.6
Event related information
M
The event related information (e.g. time at which the event originated, location of event)
Event content
M
The content of the event information.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2.4 Event notification acknowledgement
|
Table 8.8.2.4-1 describes the information flow event notification acknowledgement from the subscribing entity to the CAPIF core function.
Table 8.8.2.4-1: Event notification acknowledgement
Information element
Status
Description
Acknowledgement
M
Acknowledgement for the event notification received.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2.5 Event unsubscription request
|
Table 8.8.2.5-1 describes the information flow for event unsubscription request from the subscribing entity to the CAPIF core function.
Table 8.8.2.5-1: Event unsubscription request
Information element
Status
Description
Identity information
M
The information to determine the identity of the subscribing entity
Subscription identifier
M
The unique identifier for the event subscription that was provided to the subscribing entity during the CAPIF event subscription operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2.6 Event unsubscription response
|
Table 8.8.2.6-1 describes the information flow for event unsubscription response from the CAPIF core function to the subscribing entity.
Table 8.8.2.6-1: Event unsubscription response
Information element
Status
Description
Result
M
Indicates the success or failure of the event unsubscription operation
Cause
O
The cause for the request failure.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2.7 Event subscription update request
|
Table 8.8.2.7-1 describes the information flow for event subscription update request from the subscribing entity to the CAPIF core function.
Table 8.8.2.7-1: Event subscription update request
Information element
Status
Description
Identity information
M
The information to determine the identity of the subscribing entity
Subscription identifier
M
The unique identifier for the event subscription that was provided to the subscribing entity during the CAPIF event subscription operation.
Event criteria changes
O (NOTE)
Updates to the event criteria which are defined in clause 8.8.2.1
Notification reception information changes
O (NOTE)
Updates to the information of the subscribing entity for receiving the notifications for the event
NOTE: At least one of these information elements shall be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.2.8 Event subscription update response
|
Table 8.8.2.8-1 describes the information flow for event subscription update response from the CAPIF core function to the subscribing entity.
Table 8.8.2.2-1: Event subscription update response
Information element
Status
Description
Result
M
Indicates the success or failure of the event subscription update operation
Cause
O
The cause for the request failure.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.3 Procedure for CAPIF event subscription
|
Figure 8.8.3-1 illustrates the procedure for CAPIF events subscription.
Pre-conditions:
1. The subscribing entity has the authorization to subscribe for the CAPIF events.
Figure 8.8.3-1: Procedure for CAPIF event subscription
1. The subscribing entity sends an event subscription request to the CAPIF core function in order to receive notification of events.
2. Upon receiving the event subscription request from the subscribing entity, the CAPIF core function checks for the relevant authorization for the event subscription.
3. If the authorization is successful, the CAPIF core function stores the subscription information.
4. The CAPIF core function sends an event subscription response indicating successful operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.4 Procedure for CAPIF event notifications
|
Figure 8.8.4-1 illustrates the procedure for CAPIF event notifications.
Pre-conditions:
1. The subscription procedure as illustrated in figure 8.8.3-1 is performed by the subscribing entity.
Figure 8.8.4-1: Procedure for CAPIF event notifications
1. The CAPIF core function generates events to be consumed by the subscribing entity(s).
2. For the generated event, the CAPIF core function retrieves the list of corresponding subscriptions.
3. The CAPIF core function sends event notifications to all the subscribing entity(s) that have subscribed for the event matching the criteria. If a notification reception information is available as part of the subscribing entity event subscription, then the notification reception information is used by the CAPIF core function to send event notifications to the subscribing entity.
4. The subscribing entity sends an event notification acknowledgement to the CAPIF core function for the event notification received.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.5 Procedure for CAPIF event unsubscription
|
Figure 8.8.5-1 illustrates the procedure for CAPIF event unsubscription.
Pre-condition:
1. The subscribing entity has subscribed to the CAPIF events.
Figure 8.8.5-1: Procedure for CAPIF event unsubscription
1. The subscribing entity sends an event unsubscription request to the CAPIF core function with the information of the subscribed CAPIF event.
2. Upon receiving the event unsubscription request from the subscribing entity, the CAPIF core function checks for the event subscription corresponding to the subscribing entity and further checks if the subscribing entity is authorized to unsubscribe from the CAPIF event.
3. If the event subscription information corresponding to the subscribing entity is available and the subscribing entity is authorized to unsubscribe for the CAPIF event, the CAPIF core function removes the subscription information.
4. The CAPIF core function sends an event unsubscription response indicating successful operation.
8.8.5a Procedure for CAPIF event subscription update
Figure 8.8.5a-1 illustrates the procedure for CAPIF events subscription update.
Pre-conditions:
1. The subscribing entity has the authorization to update subscriptions for CAPIF events.
2. The subscribing entity has created subscriptions for CAPIF events.
Figure 8.8.5a-1: Procedure for CAPIF event subscription
1. The subscribing entity sends an event subscription update request to the CAPIF core function in order update a previous subscription to receive notification of events.
2. Upon receiving the event subscription update request from the subscribing entity, the CAPIF core function checks for the relevant authorization for the event subscription update.
3. If the authorization is successful, the CAPIF core function updates the subscription information.
4. The CAPIF core function sends an event subscription update response indicating successful operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.8.6 List of CAPIF events
|
Table 8.8.6-1 provides a non-exhaustive list of CAPIF events.
Table 8.8.6-1: List of CAPIF events
Events
Events Description
Availability of service APIs
Availability events of service APIs (e.g. active, inactive)
Service API updated
Events related to change in service API information
Monitoring service API invocations
Events corresponding to service API invocations
API invoker status
Events related to API invoker status in CAPIF (onboarded, offboarded, onboarding criteria not met status along with the criteria information that is not met.)
API topology hiding status
Events related to API topology hiding status in CAPIF (created, revoked)
System related events
Alarm events providing fault information
Performance related events
Events related to system load conditions
CAPIF-1/1e interaction events
Events related to CAPIF-1/1e interactions for a service API (e.g. onboarded API invokers)
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.9 Revoking subscription of the CAPIF events
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.9.1 General
|
The CAPIF core function allows to revoke subscription of CAPIF events for the subscribing entity related to the service API changes, such as availability events of service APIs, change in service API information, monitoring service API invocations, API invoker onboarding events, etc. This procedure is initiated by the CAPIF core function.
NOTE: It is optional to trigger notification by the CAPIF core function for revocation of subscription for CAPIF event(s).
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.9.2 Information flows
|
This subclause describes the information flows for CAPIF event subscription revocation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.9.2.1 Subscription revoke notification
|
Table 8.9.2.1-1 describes the information flow for subscription revoke notification from the CAPIF core function to the subscribing entity.
Table 8.9.2.1-1: Subscription revoke notification
Information element
Status
Description
Identity information
M
The information to determine the identity of the subscribing entity
Subscription identifier
M
The unique identifier for the event subscription that was provided to the subscribing entity during the CAPIF event subscription operation.
Reason
O
Indicate the reason of subscription revocation
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.9.2.2 Subscription revoke notification acknowledgement
|
Table 8.9.2.2-1 describes the information flow for subscription revoke notification acknowledgement from the subscribing entity to the CAPIF core function.
Table 8.9.2.2-1: Subscription revoke notification acknowledgement
Information element
Status
Description
Acknowledgement
M
The acknowledgement for the received notification.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.9.3 Procedure
|
Figure 8.9.3-1 illustrates the procedure for subscription revocation, triggered by the CAPIF core function.
Pre-conditions:
1. The subscribing entity has previously subscribed to CAPIF event(s) to the CAPIF core function.
Figure 8.9.3-1: Procedure for revoking subscription of the CAPIF events
1. The CAPIF core function decides to revoke subscription of CAPIF event(s) for the subscribing entity.
2. The CAPIF core function sends subscription revoke notification to the subscribing entity.
3. The subscribing entity provides a subscription revoke notification acknowledgement to the CAPIF core function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.10 Authentication between the API invoker and the CAPIF core function
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.10.1 General
|
The procedure in this subclause corresponds to the architectural requirements for authentication between the API invoker and the CAPIF core function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.10.2 Information flows
|
NOTE: The security aspects of this procedure are specified in subclause 6.2 and subclause 6.3.1 of 3GPP TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.10.3 Procedure
|
Figure 8.10.3-1 illustrates the procedure for authentication between the API invoker and the CAPIF core function.
Pre-conditions:
1. The API invoker is onboarded with the CAPIF core function and the API invoker profile is created.
Figure 8.10.3-1: Procedure for authentication between the API invoker and the CAPIF core function
1. The API invoker triggers authentication to the CAPIF core function, including the identity confirmed after successful onboarding.
2. Upon receiving the authentication request, the CAPIF core function verifies the identity with the API invoker profile and authenticates the API invoker.
NOTE 1: The authentication process is specified in subclause 6.2 and subclause 6.3.1 of 3GPP TS 33.122 [12].
3. The CAPIF core function returns the result of the API invoker identity verification in the authentication response.
NOTE 2: The CAPIF core function can share the information required for authentication of the API invoker at the AEF.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.11 API invoker obtaining authorization to access service API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.11.1 General
|
The API invoker requires to execute this procedure when it needs to obtain or re-obtain (e.g. upon expiry of the authorization information) the authorization to access the service API. Once the API invoker receives the authorization to access the service API, the API invoker can perform one or multiple service API invocations as per the permission limit. This procedure may be performed during the API invoker onboarding process.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.11.2 Information flows
|
NOTE: The security aspects of this procedure are specified in subclause 6.4 and subclause 6.5.2 of 3GPP TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.11.3 Procedure
|
Figure 8.11.3-1 illustrates the procedure for obtaining authorization to access the service API.
Pre-condition:
1. The API invoker is onboarded and has received an API invoker identity.
Figure 8.11.3-1: Procedure for the API invoker obtaining authorization for service API access
1. The API invoker sends an obtain service API authorization request to the CAPIF core function for obtaining permission to access the service API by including the API invoker information (including its own identity and optionally application service information such as application service provider and application identifier), optionally service API operation(s) and resource(s), and any information required for authentication of the API invoker. The request may include desired Network Slice Info of the service API. In addition to the information identifying the service API, the request may include finer level service API access requirements (e.g., access per service API operation or access per API service resource).
2. The CAPIF core function validates the authentication of the API invoker (using authentication information) and checks whether the API invoker is permitted to access the requested service API considering service API operation(s) and resource(s), if available. The CAPIF core function may additionally verify the Network Slice Info, e.g., check that the desired Network Slice Info by the API invoker is included in the supported Network Slice Info for the indicated service API.
Editor's Note: Authorization related to network slice are to be detailed by SA3.
NOTE 1: The authorization of Network Slice Info is performed by the CAPIF core function within the PLMN trust domain.
NOTE 2: The authentication process is specified in subclause 6.5.2 of 3GPP TS 33.122 [12].
3. Based on the API invoker's subscription information the authorization information to access the service APIs, optionally including access authorization per service operation and, optionally, resource, is sent to the API invoker in the obtain service API authorization response.
NOTE 3: API invoker authorization granularity mechanisms are specified in 3GPP TS 33.122 [12].
NOTE 4: The mechanism for distribution of the authorization information for the API invoker to the API exposing function over CAPIF-3 reference point is specified in subclause 6.5.2 of 3GPP TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.12 AEF obtaining service API access control policy
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.12.1 General
|
The CAPIF core function is the central repository of all the policies related to service APIs. The AEF executes this procedure when it needs to obtain the policy to perform access control on the service API invocations (e.g. when policy for performing access control on service API is unavailable at the AEF). The AEF can be within PLMN trust domain or within 3rd party trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.12.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.12.2.1 Obtain access control policy request
|
Table 8.12.2.1-1 describes the information flow obtain access control policy request from the AEF to the CAPIF core function.
Table 8.12.2.1-1: Obtain access control policy request
Information element
Status
Description
Identity information
M
Identity information of the entity requesting the access control policy
Service API identification
M
The identification information of the service API for which the access control policy is being requested.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.12.2.2 Obtain access control policy response
|
Table 8.12.2.2-1 describes the information flow obtain access control policy response from the CAPIF core function to the AEF.
Table 8.12.2.2-1: Obtain access control policy response
Information element
Status
Description
Result
M
Indicates the success or failure of the obtain access control policy operation
Access control policy information
O (see NOTE)
The access control policy information corresponding to the requested service API. (See Table E-1)
NOTE: Shall be present if the Result information element indicates that the obtain access control policy operation is successful. Otherwise access control policy information shall not be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.12.3 Procedure
|
Figure 8.12.3-1 illustrates the procedure for obtaining policy to perform access control on the service API invocations.
Pre-conditions:
1. The AEF is hosting the service API but the policy to perform access control is not available with AEF.
2. The CAPIF core function is configured with the access control policies corresponding to one or more service APIs.
3. Authorization details of the AEF are available with the CAPIF core function.
Figure 8.12.3-1: Procedure for the AEF obtaining service API access control policy
1. The AEF sends an obtain access control policy request to the CAPIF core function for obtaining the policy to perform the access control on service API invocations by including the details of the hosted service API.
2. The CAPIF core function checks whether the AEF is authorized to receive the access control policy corresponding to the service APIs requested.
3. If authorization check is successful, the AEF is provided the access control policy for the service API via an obtain access control policy response. If authorization check is not successful, the AEF is provided with a failure indication via a obtain access control policy response.
NOTE: To maintain synchronization between the AEF and the CAPIF core function for the policy cached at AEF, the AEF can subscribe to the policy update event at CAPIF core function according to the procedure in subclause 8.8.3 and receive notifications about any updated policy at CAPIF core function according to the procedure in subclause 8.8.4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.13 Topology hiding
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.13.1 General
|
The procedure in this subclause corresponds to the architectural requirements for hiding the topology of the PLMN trust domain from the API invokers accessing the service APIs from outside the PLMN trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.13.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.13.2.1 Service API invocation request (API invoker – AEF-1)
|
The information flow service API invocation request from the API invoker to AEF-1 (AEF acting as service communication entry point) is service API specific and the complete detail of the service API invocation request is out of scope of the present document. Table 8.17.2.1-1 describes the CAPIF related information elements which are included in the service API invocation request.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.13.2.2 Service API invocation request (AEF-1 – AEF-2)
|
The information flow service API invocation request from AEF-1 (AEF acting as service communication entry point) to AEF-2 (destination AEF for handling service API) is service API specific and the complete detail of the service API invocation request is out of scope of the present document. Table 8.17.2.1-1 describes the CAPIF related information elements which are included in the service API invocation request.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.13.2.3 Service API invocation response (AEF-2 – AEF-1)
|
The information flow service API invocation response from AEF-2 (destination AEF for handling service API) to AEF-1 (AEF acting as service communication entry point) is service API specific and the complete detail of the service API invocation response is out of scope of the present document. Table 8.17.2.2-1 describes the CAPIF related information elements which are included in the service API invocation response.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.13.2.4 Service API invocation response (AEF-1 – API invoker)
|
The information flow service API invocation response from AEF-1 (AEF acting as service communication entry point) to the API invoker is service API specific and the complete detail of the service API invocation response is out of scope of the present document. Table 8.17.2.2-1 describes the CAPIF related information elements which are included in the service API invocation response.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.13.3 Procedure
|
Figure 8.13.3-1 illustrates the procedure for CAPIF topology hiding.
Pre-conditions:
1. The API invoker has performed the service discovery and received the details of the service API which includes the information about the service communication entry point of the AEF-1 in the CAPIF.
2. The API invoker is authenticated and authorized to use the service API.
3. The AEF-1 in the CAPIF is configured with a policy for topology hiding including the entry point address of the service API (provided via AEF-2).
Figure 8.13.3-1: Procedure for CAPIF topology hiding
1. The API invoker performs service API invocation according to the interface of the service API by sending a service API invocation request towards the AEF-1 which exposes the service API towards the API invoker, and acts as topology hiding entity.
NOTE: Steps 2 and 3 are not necessary when the AEF-1 is capable to serve the service API invocation request.
2. The AEF-1 further resolves the actual destination service API address information according to the topology hiding policy and forwards the incoming service API invocation request to the service API of the related AEF-2.
3. The AEF-1 receives a response request for service API invocation from service API provided by AEF-2.
4. The AEF-1 resolves the destination API invoker address and also modifies the source address information of the AEF-2 within the response request as per topology hiding policy and forwards the response request to the API invoker.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.14 Authentication between the API invoker and the AEF prior to service API invocation
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.14.1 General
|
The procedure in this subclause corresponds to the architectural requirements for authentication of the API invoker by the AEF.
To reduce latency during API invocation, the API invoker associated authentication information can be made available at the AEF after authentication between the API invoker and the CAPIF core function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.14.2 Information flows
|
NOTE: The security aspects of this procedure are specified in subclause 6.4 and subclause 6.5.2 of 3GPP TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.14.3 Procedure
|
Figure 8.14.3-1 illustrates the procedure for authentication between the API invoker and the AEF.
Pre-conditions:
1. Optionally, the CAPIF core function has shared the information required for authentication of the API invoker with the AEF.
Figure 8.14.3-1: Procedure for authentication between the API invoker and the AEF prior to service API invocation
1. The API invoker triggers authentication initiation to the AEF, including the API invoker identity.
2. The AEF obtains the API invoker information required for authentication by the AEF, if not available.
3. The AEF returns the result of authentication initiation in the authentication initiation response.
4. The AEF verifies the identity of the API invoker and authenticates the API invoker.
NOTE 1: The authentication process is specified in subclause 6.4 and subclause 6.5.2 of 3GPP TS 33.122 [12].
NOTE 2: The authentication is terminated at the AEF acting as the service communication entry point when topology hiding is enabled for the service API.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.15 Authentication between the API invoker and the AEF upon the service API invocation
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.15.1 General
|
The procedure in this subclause corresponds to the architectural requirements for authentication of the API invoker by the AEF upon the service API invocation.
To reduce latency during API invocation, the API invoker associated authentication information can be made available at the AEF after authentication between the API invoker and the CAPIF core function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.15.2 Information flows
|
NOTE: The security aspects of this procedure are specified in subclause 6.4 and subclause 6.5.2 of 3GPP TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.15.2.1 Service API invocation request with authentication information
|
The information flow service API invocation request with authentication information from the API invoker to the AEF is service API specific and the complete detail of the service API invocation request is out of scope of the present document. Table 8.15.2.1-1 describes only the CAPIF related information elements which are included in the service API invocation request.
Table 8.15.2.1-1: Service API invocation request with authentication information
Information element
Status
Description
API invoker identity information
M
The information that determines the identity of the API invoker
Authentication information
M
(see NOTE)
The authentication information obtained before initiating the service API invocation request
Service API identification
M
The identification information of the service API for which invocation is requested. The service API identification is part of the specific service API invocation request.
NOTE: The specific security information of this information element is specified in subclause 6.5.2 of 3GPP TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.15.2.2 Service API invocation response
|
The information flow service API invocation response from the AEF to the API invoker is service API specific and the complete detail of the service API invocation response is out of scope of the present document. Table 8.15.2.2-1 describes only the CAPIF related information elements which are included in the service API invocation response.
Table 8.15.2.2-1: Service API invocation response
Information element
Status
Description
Result
M
Indicates the success or failure of service API invocation.
Cause
O
The cause for the request failure.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.