hash stringlengths 32 32 | doc_id stringlengths 5 12 | section stringlengths 5 1.47k | content stringlengths 0 6.67M |
|---|---|---|---|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.33.2 Information flows
| NOTE: The security aspects of this procedure are specified in clause 6.4 and 6.5.3 of 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.33.3 Procedure
| Figure 8.33.3-1 illustrates the procedure for obtaining collective authorization from resource owner.
The mechanism to obtain collective authorization from a resource owner is supported by the CAPIF core function.
Pre-conditions:
1. The resource owner function can communicate with the CCF (Authorization function).
2. Access to an API exposing function offered service API requires obtaining authorization from a resource owner.
3. The API invoker is successfully onboarded as described in clause 8.1.
4. The CCF is configured for handling collective authorization, see table 8.33.3-1.
Figure 8.33.3-1: Procedure for obtaining collective authorization from resource owner
1. An API invoker sends obtain service API authorization request to the CAPIF core function for obtaining permission to access a service API by including its API invoker identity information and any information required for authentication of the API invoker. The API invoker includes in the request information about the purpose and the targeted resources and operations to be performed on those resources.
2. The CCF performs the authentication of the API invoker (using authentication information) and checks whether it is permitted to access the requested service API by checking whether a resource owner authorization information is already available for that API invoker. If the authorization for accessing the requested resources for the signalled purpose is already granted, the procedure continues with step 4.
3. If authorization information is not available regarding whether the API invoker is permitted to access the requested service API (i.e., there is no applicable resource owner authorization information available) the collective resource owner authorization configuration (table 8.33.3-1) is assessed.
If authorization trigger criteria have been specified as part of the collective resource owner authorization configuration, interactions with the resource owner are only initiated once the trigger conditions are met.
If trigger criteria have not been set or once the trigger conditions are met, the authorization function determines the authorization by interacting with the resource owner via the ROF deployed on a UE. Based on the configured collective resource owner authorization configuration at the CCF and any cached “obtain service API authorization requests”, the scope of the request towards the ROF can be expanded to include additional API invokers and or service APIs based on the assumption that there is an association between the requesting API invoker and the API exposing functions and API invokers listed in the CCF configuration.
NOTE 2: The details of the interaction between RO and ROF for capturing the resource owner authorization are considered out-of-scope of the present specification.
NOTE 3: The detailed procedure to obtain the resource owner's authorization information for multiple API invokers in a single request, including whether such authorization can be limited to the API invoker initiating the request and only for the specific service being requested, is out of scope of this release of the specification.
4. Based on the RO authorization information obtained via the ROF for each API invoker and corresponding service API(s), the CCF sends an API invoker specific service API authorization response (as described in clause 8.31) to the API invoker that initially triggered the collective resource owner authorization information requested and to each API invoker for which a obtain service API authorization request was received (for the same service API) whilst the collective resource owner authorization configuration duration timer was running, i.e., the cached requests.
5. An API invoker that receives the service API authorization response can send service API invocation requests to the API exposing function with their API invoker specific resource owner authorization information as described in clause 8.31.
6. The API exposing function will send a service API invocation response once it has successfully checked that the API invoker is authorized to invoke that service API based on the authorization information.
Table 8.33.3-1: Collective resource owner authorization configuration
Information element
Status
Description
List of API invoker associations (NOTE 1)
O
Lists of API invokers with their associated service APIs
> API invoker identity information list
M
List of API invoker identities
> Service API identification list
M
List of AEF service API identities.
List of trigger criteria (NOTE 1)
O
Criteria for triggering requesting of resource owner authorization
> Duration (NOTE 2)
O
Initiate request towards RO via ROF after the given duration (in seconds) after receiving a obtain service authorization request from an API invoker
> Timeperiod (NOTE 2)
O
Time period during which notifications may be sent towards RO via ROF.
> Resource owner identifier
O
Can only be included if a duration or timeslot is included. Indicates that the resource owner authorization trigger criteria is to be applied to the specific resource owner identified by their GPSI, i.e., no other resource owner authorization trigger criteria shall be applied for that resource owner.
NOTE 1: At least one of these attributes shall be present
NOTE 2: Only one of these attributes shall be present
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.34 UE-deployed API invoker accessing other UEs’ resources of a group
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.34.1 General
| This clause specifies the procedures for API invoker on a UE to be able to access the services exposing resources of other UEs of a group. The UEs belong to the same group and the same VAL service provider (IoT case) or the same user and all of them belong to the same CAPIF provider domain.
The authorization relationship between UE2 (the API invoker is in UE2) and UE1, given by the membership to the same group, is within the CAPIF provider domain. The difference of this scenario compared with the procedure of an API invoker obtaining authorization from resource owner described in clause 8.31 is that:
a. the API invoker is not deployed in the UE whose resources are being accessed,
b. the API invoker needs to provide in the request, in addition to the identity of the UE whose resources are being accessed, the Group Identifier and the identity of the UE2; and
c. the group membership needs to be managed by the CAPIF provider as described in Annex E.
NOTE: Other possible scenarios, e.g. where the authorization relationship given by the membership to the same group is within the Application Service Provider, are not specified in this release of the specification.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.34.2 Information flows
| NOTE: The security aspects of this procedure are specified in 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.34.3 Procedure
| Figure 8.34.3-1 presents the procedure for enabling a UE-hosted API invoker accessing network-hosted resources owned by other UEs that belong to the same group.
Pre-condition:
1. The network hosts individual resources for a group of UEs which can be accessed via AEF provided the necessary security conditions are met.
2. UE1 and UE2 belong to the same group and the same VAL service provider (IoT case) or the same user.
3. CCF is provisioned with the information of a Group Resource Owner (GRO) which indicates UE 1 as the authorized RO (e.g. by business relationship between the group of UEs) to provide resource owner authorization for the resources belonging to the UEs in this group.
NOTE: In this release of the specification group context information is provisioned by the CAPIF administrator as specified in Annex E and the other mechanisms are out of scope of this release.
Figure 8.34.3-1: UE-deployed API invoker accessing other UEs’ resources of a group
1. The API invoker (e.g., in UE 2) sends an Obtain service API authorization request to the CCF for obtaining permission to access the service API for other UE's resources hosted in the network (e.g., location) by including the API invoker identity information and any information required for authentication of the API invoker. The request includes API invoker information, the group identifier, and the UE in a group whose resources are to be accessed, and the identity of UE2. Additionally, the API invoker may include in the request information about the purpose and operations (scope) to be performed on the targeted resources.
2. CCF performs authentication of the API invoker (using authentication information) as specified in 3GPP TS 33.122 [12].
3. The CCF, based on the group identifier determines that RO authorization is provided by a GRO. The CCF then resolves the identity of the GRO responsible for the group of UEs based on the provisioned group context information related to the GRO, as specified in Annex E. The CCF shall additionally check whether UE2 belongs to the group.
4. If step 3 is successful, the CCF performs the resource owner authorization check using the GRO as the RO for the requested resources of other UE(s) belonging to the group.
NOTE: The details of the procedure to obtain resource owner’s authorization information from GRO are out the scope of this release of the specification.
5. Based on the group resource owner authorization received in step 4, the CCF sends an Obtain service API authorization response to the API invoker. The authorization response indicates that the access to UE (resource owner) network resource(s) is authorized for an indicated scope.
6. The API invoker sends service API invocation request to the API exposing function with the RO authorization information received in step 5.
7. The API invoker receives the service API invocation response resulting from the service API invocation once the API exposing function has checked whether the API invoker is authorized to invoke that service API based on the RO authorization information.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.35 Revoking resource owner authorization
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.35.1 General
| The procedure in this subclause corresponds to the architectural requirements for revoking resource owner authorization.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.35.2 Information flows
| The information flows for the interactions between the CAPIF core function, the API Invoker and the AEF are described in clause 8.23.2.
Editor's Note: The security aspects of this procedure are to be detailed by SA3.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.35.3 Procedure
| Figure 8.35.3-1 illustrates the procedure for revoking resource owner authorization to access service API initiated by the resource owner function.
Pre-conditions:
1. The API invoker is authenticated and authorized to use the service API.
Figure 8.35.3-1: Procedure for revoking resource owner authorization
1. The RO triggers the revocation of the resource authorization via ROF.
2. The ROF requests resource authorization revocation to the CAPIF core function.
NOTE: The detailed procedure of resource authorization revocation is to be specified in TS 33.122 [12].
3. The CAPIF core function determines the revoked authorization information for the API Invoker and Service API as specified in clause 6.5.3.4 of TS 33.122 [12].
4. The CAPIF core function sends a revoke resource authorization notification to the API invoker according to the procedure in clause 8.23.4.
5. The CAPIF core function sends a revoke resource authorization notification to the API exposing function according to the procedure in clause 8.23.4.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.36 CCF Obtaining Resource Owner Authorization
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.36.1 General
| The procedure in this subclause corresponds to the architectural requirements for CCF obtaining resource owner authorization.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.36.2 Information flows
| The information flows for the interactions to obtain RO authorization information from the RO function are part of the Obtain service API authorization procedure described in clause 8.31.2.
NOTE: The security aspects of this procedure are specified in clause 6.5.3.B of 3GPP TS 33.122 [12].
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.36.3 Procedure
| Figure 8.36.3-1 illustrates the procedure for CCF obtaining resource owner authorization.
Pre-condition:
1. ROF and CCF have successfully completed mutual authentication.
Figure 8.36.3-1: Procedure for obtaining resource owner authorization
1. The CAPIF core function sends the resource owner authorization information request along with the API invoker information received in the obtaining service API authorization procedure as described in clause 8.31.3.
2. Authentication of the resource owner is performed as specified in clause 6.5.3.1 of 3GPP TS 33.122 [12].
3. The resource owner sends the resource owner authorization information response via ROF to the CAPIF core function along with the resource authorization information as specified in clause 8.31.3.
4. The CAPIF core function stores the resource owner authorization information.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.37 UE-deployed API invoker accessing other UEs’ resources
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.37.1 General
| This clause specifies the procedures for API invoker on a UE to be able to access the services exposing resources of other UEs.
The authorization relationship between UE2 (the API invoker is in UE2) and UE1 (the resource owner of the accessed network resources is at UE1) is within the Application Service Provider. The difference of this scenario compared with the procedure of an API invoker obtaining authorization from resource owner described in clause 8.31 is that the API invoker is not deployed in the resource owner’s UE.
NOTE: Other possible scenarios, e.g. where the authorization relationship between UE(s) is in the CAPIF domain, are not specified in this release of the specification.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.37.2 Information flows
| NOTE: The security aspects of this procedure are specified in 3GPP TS 33.122 [12].
8.37.3 Procedure
Figure 8.37.3-1 presents the procedure for enabling a UE-hosted API invoker accessing network-hosted resources owned by other UEs for the scenarios introduced in clause 8.37.1.
Pre-condition:
1. The network hosts individual resource(s) for a UE which can be accessed via AEF provided the necessary security conditions are met.
2. UE 1 and UE 2 belong to the same CAPIF provider domain. The API invoker knows the RO identifier for UE1.
Figure 8.37.3-1: UE-deployed API invoker accessing other UEs’ resources
1. The API invoker in UE2 sends an Obtain service API authorization request to the CCF for obtaining permission to access the service API for other UE’s (UE1) resources hosted in the network by including the API invoker identity information and any information required for authentication of the API invoker.
The request shall include the RO identity for UE1, whose resources are trying to be accessed, the API invoker information that is requesting the access, and the information about the purpose and scope to be performed on the targeted resources.
2. The CCF validates and authorizes the API invoker in UE2 as specified in 3GPP TS 33.122 [3]. If the API invoker validation is successful, the CCF checks the Resource Owner authorization information of UE1. The CCF obtains whether the RO (UE1) authorized to the API invoker the access to the network resource(s) for the specified purpose and scope. If the RO authorization information is not available, the CCF may interact with UE1 via ROF to obtain it.
3. Based on the UE1 resource owner authorization obtained in step 2, the CCF sends an Obtain service API authorization response to the API invoker. The response indicates that UE1, as resource owner, authorizes the service API access for an indicated scope.
4. The API invoker sends service API invocation request to the API exposing function with the RO authorization information received in step 2.
5. The API invoker receives the service API invocation response resulting from the service API invocation once the API exposing function has checked whether the API invoker is authorized to invoke that service API based on the RO authorization information.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.38 Open Discover service APIs
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.38.1 General
| The following procedure in this subclause corresponds to supporting open discover service APIs. Such open discovery operation allows requestor to discover service API information about the available set of APIs offered by CCF before onboarding.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.38.2 Information flows
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.38.2.1 Open Service API discover request
| Table 8.38.2.1-1 describes the information flow open service API discover request from the requestor to the CAPIF core function.
Table 8.38.2.1-1: Open Service API discover request
Information element
Status
Description
Query information
O
(see NOTE)
Criteria for discovering matching service APIs. It may contain Service API information described in table 8.3.2.1-1, except service API interface details.
NOTE: It should be possible to discover all the service APIs.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.38.2.2 Open Service API discover response
| Table 8.38.2.2-1 describes the information flow open service API discover response from the CAPIF core function to the requestor.
Table 8.38.2.2-1: Open Service API discover response
Information element
Status
Description
Result
M
Indicates the success or failure of the open discovery of the service API information
Service API information
O
(see NOTE)
Filtered service APIs information that can be shared to the requestor not a recognized user of the CAPIF. It may contain Service API information described in table 8.3.2.1-1, except service API interface details.
NOTE: The service API information shall be present if the Result information element indicates that the open service API discover operation is successful. Otherwise, it shall not be present.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 8.38.3 Procedure
| Figure 8.38.3-1 illustrates the procedure for open discover service APIs.
The open service API discovery mechanism is supported by the CAPIF core function.
Pre-conditions:
1. The requestor is not a recognized user of the CAPIF.
2. The CAPIF core function is aware of the Service API information that can be disseminated according to the requestor who is not a recognized user of the CAPIF.
Figure 8.38.3-1: Open Discover service APIs
1. The requestor sends an open service API discover request to the CAPIF core function. It may include the query information from the requestor.
NOTE: The security aspects of this procedure are unspecified in this release of the specification.
2. Upon receiving the open service API discover request, if query information is included, the CAPIF core function retrieves the stored service API(s) information as per the query information in the open service API discover request, otherwise all stored service API(s) information is retrieved. Further, since the requestor is not a recognized user of CAPIF, the CAPIF core function performs filtering of service APIs information.
3. The CAPIF core function sends an open service API discover response to the requestor with the filtered list of service API information.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 9 API consistency guidelines
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 9.1 General
| This clause specifies the API consistency guidelines for all northbound APIs utilizing CAPIF architecture. The guidelines are categorized as follows:
- fundamental API guidelines, applicable to all northbound APIs utilizing CAPIF; and
- architecture design considerations, applicable to all northbound APIs utilizing CAPIF.
The API guidelines are also applicable for CAPIF APIs specified in the current specification.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 9.2 Fundamental API Guidelines
| The specification of each northbound API utilizing the common API framework should define:
1. the function of the API;
2. the resource(s) or endpoints involved;
3. the list of supported operations and their usage;
4. the list of input and output parameters along with applicable schemas, as required;
5. the list of supported response codes;
6. the behaviour of the network entity exposing the APIs (e.g. the CAPIF core function or the API exposing function) for each supported operation;
7. the list of applicable data types; and
8. the list of applicable protocols and data serialization formats.
In order to facilitate the consistency of the northbound APIs utilizing the common API framework it is recommended to adopt the guidelines which define the following:
1. consistent nomenclature for the operations, data structures and resources/endpoints;
2. design principles for the use of operations for common tasks; and
3. a template for the consistent documentation of APIs.
The northbound APIs utilizing the common API framework should support the following properties:
1. be extensible, such that it is possible to accommodate future requirements, including vendor-specific needs;
NOTE: The extension does not replace any existing function in Northbound APIs.
2. support access control mechanisms;
3. support charging, if applicable; and
4. be backward and forward compatible with different versions of the same API.
The guidelines above are generic with regard to the API architecture. They are valid for network APIs that follow the RESTful architectural style and that expose resources towards the API invoker, as well as for network APIs of other architectures that expose general network endpoints towards the API invoker. A network endpoint represents one end of a communication channel through which the API consumer communicates with the API producer, using messages of a protocol defined by the API architecture. A resource is identified, and the corresponding endpoint is addressed, by a resource identifier (such as a URI).
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 9.3 Architecture design considerations
| Northbound APIs utilizing common API framework should adhere to RESTful architecture, whenever possible. Service operations can use custom API operations (RPC-style interaction), when it is seen a better fit for the style of interaction to model, e.g. non-CRUD service operations.
NOTE: The selection of a particular API style is specific to each API implementation, and subject to Stage 3 scope.
The API design:
1. should have a uniform interface that conveys the resource/data model of the API to its client developers and:
a. the implementation of the resource(s)/operations involved in the APIs should be hidden from the client, and adequate operations should be designed to operate on the resource(s)/data;
b. any single API should be atomic;
c. all resources/operations involved in APIs should be accessible through a common approach, and resources/data should be similarly modified using a consistent approach;
2. should allow the client (such as the API invoker) and the server (such as the CAPIF core function or the API exposing function) to evolve independently, i.e. the client should not have to be aware of the execution aspects of the APIs on the server;
3. should be stateless such that each request from the client (such as the API invoker) to the server (such as the CAPIF core function or the API exposing function) contains all of the information necessary for the server to understand the request;
4. should define the usage of standard operations, such as Create, Read, Update and Delete, consistently along with the applicable response codes;
5. should allow to label responses as cacheable or non-cacheable, to improve network efficiency by supporting caching in the client (such as the API invoker), if applicable in the API architecture;
6. should prevent unwanted modification of the resources/data during invocation of APIs; and
7. should support version control.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10 CAPIF core function APIs
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.1 General
| Table 10.1-1 illustrates the CAPIF core function APIs.
Table 10.1-1: List of CAPIF core function APIs
API Name
API Operations
Known Consumer(s)
Communication Type
CAPIF_Open_Discover_Service_API
Open_Discover_Service_API
Open
Request/Response
CAPIF_Discover_Service_API
Discover_Service_API
API Invoker, CAPIF core function
Request/ Response
Subscribe_Event
API Invoker
Request/ Response
Update_Event_Subscription
API Invoker
Request/ Response
Notify_Event
API Invoker
Notify
Unsubscribe_Event
API Invoker
Request/ Response
CAPIF_Publish_Service_API
Publish_Service_API
API Publishing Function, CAPIF core function
Request/ Response
Unpublish_Service_API
API Publishing Function, CAPIF core function
Request/ Response
Update_Service_API
API Publishing Function, CAPIF core function
Request/ Response
Get_Service_API
API Publishing Function, CAPIF core function
Request/ Response
Subscribe_Event
API Publishing Function
Request/ Response
Update_Event_Subscription
API Publishing Functionr
Request/ Response
Notify_Event
API Publishing Function
Notify
Unsubscribe_Event
API Publishing Function
Request/ Response
CAPIF_Events API
Subscribe_Event
API Invoker, API Publishing Function, API Management Function, API Exposing Function
Request/ Response
Update_Event_Subscription
API Invoker, API Publishing Function, API Management Function, API Exposing Function
Request/ Response
Notify_Event
API Invoker, API Publishing Function, API Management Function, API Exposing Function
Notify
Unsubscribe_Event
API Invoker, API Publishing Function, API Management Function, API Exposing Function
Request/ Response
CAPIF_API_Invoker_management API
Onboard_API_Invoker
API Invoker
Request/ Response
Offboard_API_Invoker
API Invoker
Request/ Response
Subscribe_Event
API Management Function
Request/ Response
Update_Event_Subscription
API Management Function
Request/ Response
Notify_Event
API Management Function
Notify
Unsubscribe_Event
API Management Function
Request/ Response
CAPIF_API_Provider_Management_API
Register_API_Provider
API Management Function
Request/Response
Update_API_Provider
API Management Function
Request/Response
Deregister_API_Provider
API Management Function
Request/Response
CAPIF_Security API
Obtain_Security_Method
API Invoker
Request/ Response
Obtain_Authorization
API Invoker
Request/ Response
Obtain_API_Invoker_Info
API Exposing Function
Request/ Response
Revoke_Authorization
API Exposing Function
Request/ Response
Revoke_Authorization_Notify
API Invoker
Notify
CAPIF_Monitoring API
Subscribe_Event
API Management Function
Request/ Response
Update_Event_Subscription
API Management Function
Request/ Response
Notify_Monitoring_Service_Event
API Management Function
Notify
Unsubscribe_Event
API Management Function
Request/ Response
CAPIF_Logging_API_Invocation API
Log_API_Invocation
API exposing function
Request/ Response
CAPIF_Auditing API
Query_API_Invocation_Log
API management function
Request/ Response
CAPIF_Access_Control_Policy API
Obtain_Access_Control_Policy
API exposing function
Request/Response
CAPIF_Routing_Info API
Obtain_Routing_Info
API exposing function
Request/Response
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.2 CAPIF_Discover_Service_API API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.2.1 General
| API description: This API enables the API invoker to communicate with the CAPIF core function to discover the published service API information over CAPIF-1 or CAPIF-1e.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.2.2 Discover_Service_API operation
| API operation name: Discover_Service_API
Description: Provides the published service APIs information.
Known Consumers: API invoker.
Inputs: Refer subclause 8.7.2.1.
Outputs: Refer subclause 8.7.2.2.
See subclause 8.7.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.2.3 Subscribe_Event operation
| API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API invoker.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.2.4 Notify_Event operation
| API operation name: Notify_Event
Description: Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers: API invoker.
Inputs: Refer subclause 8.8.2.3.
Outputs: Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.2.5 Unsubscribe_Event operation
| API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API invoker.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.2.6 Update_Event_Subscription operation
| API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API invoker.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3 CAPIF_Publish_Service_API API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.1 General
| API description: This API enables the API publishing function to communicate with the CAPIF core function to publish the service API information and manage the published service API information over CAPIF-4.
NOTE: Stage 3 can decide whether the API for CAPIF_Publish_Service_API can be enabled over CAPIF-4.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.2 Publish_Service_API operation
| API operation name: Publish_Service_API
Description: Publish the service API information.
Known Consumers: API publishing function, CAPIF core function.
Inputs: Refer subclause 8.3.2.1, 8.25.2.1.
Outputs: Refer subclause 8.3.2.2, 8.25.2.2.
See subclause 8.3.3 and 8.25.3.1 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.3 Unpublish_Service_API operation
| API operation name: Unpublish_Service_API
Description: Remove the published service API information.
Known Consumers: API publishing function, CAPIF core function.
Inputs: Refer subclause 8.4.2.1, 8.25.2.5.
Outputs: Refer subclause 8.4.2.2, 8.25.2.6.
See subclause 8.4.3 and 8.25.3.4 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.4 Update_Service_API operation
| API operation name: Update_Service_API
Description: Update the published service API information.
Known Consumers: API publishing function, CAPIF core function.
Inputs: Refer subclause 8.6.2.1, 8.25.2.9.
Outputs: Refer subclause 8.6.2.2, 8.25.2.10.
See subclause 8.6.3 and 8.25.3.6 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.5 Get_Service_API operation
| API operation name: Get_Service_API
Description: Retrieve the published service API information.
Known Consumers: API publishing function, CAPIF core function.
Inputs: Refer subclause 8.5.2.1, 8.25.2.7.
Outputs: Refer subclause 8.5.2.2, 8.25.2.8.
See subclause 8.5.3 and 8.25.3.5 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.6 Subscribe_Event operation
| API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API publishing function.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.7 Notify_Event operation
| API operation name: Notify_Event
Description: Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers: API publishing function.
Inputs: Refer subclause 8.8.2.3.
Outputs: Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.8 Unsubscribe_Event operation
| API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API publishing function.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.3.9 Update_Event_Subscription operation
| API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API publishing function.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.4 CAPIF_Events API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.4.1 General
| API description: This API enables the API subscribing entity to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events and receive subsequent notification of CAPIF events. This API is used for the subscription to and notifications of those CAPIF events that are not bound to any of the other CAPIF core function APIs. The following are the key functionalities:
- API invoker subscribes to CAPIF events over CAPIF-1 or CAPIF-1e.
- API invoker receives notifications for subscribed CAPIF events over CAPIF-1 or CAPIF-1e.
- API invoker unsubscribes from CAPIF events over CAPIF-1 or CAPIF-1e.
- API invoker updates subscriptions for CAPIF events over CAPIF-1 or CAPIF-1e.
- API exposing function subscribes to CAPIF events over CAPIF-3.
- API exposing function receives notifications for subscribed CAPIF events over CAPIF-3.
- API exposing function unsubscribes from CAPIF events over CAPIF-3.
- API exposing function updates subscriptions for CAPIF events over CAPIF-3.
- API publishing function subscribes to CAPIF events over CAPIF-4.
- API publishing function receives notifications for subscribed CAPIF events over CAPIF-4.
- API publishing function unsubscribes from CAPIF events over CAPIF-4.
- API publishing function updates subscriptions for CAPIF events over CAPIF-4.
- API management function subscribes to CAPIF events over CAPIF-5.
- API management function receives notifications for subscribed CAPIF events over CAPIF-5.
- API management function unsubscribes from CAPIF events over CAPIF-5.
- API management function updates subscriptions for CAPIF events over CAPIF-5.
NOTE: Stage 3 can further decide if CAPIF_Events API can be further fine grained into more APIs.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.4.2 Subscribe_Event operation
| API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API invoker, API publishing function, API management function, API exposing function.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.4.3 Notify_Event operation
| API operation name: Notify_Event
Description: Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers: API invoker, API publishing function, API management function, API exposing function.
Inputs: Refer subclause 8.8.2.3.
Outputs: Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.4.4 Unsubscribe_Event operation
| API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API invoker, API publishing function, API management function, API exposing function.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.4.5 Update_Event_Subscription operation
| API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API invoker, API publishing function, API management function, API exposing function.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.5 CAPIF_API_invoker_management API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.5.1 General
| API description: This API enables the API invoker to communicate with the CAPIF core function to enroll as a registered user of CAPIF and manage the enrollment information over CAPIF-1 or CAPIF-1e.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.5.2 Onboard_API_Invoker operation
| API operation name: Onboard_API_Invoker
Description: Enrolls the API invoker as a recognized user of the CAPIF.
Known Consumers: API invoker.
Inputs: Refer subclause 8.1.2.1.
Outputs: Refer subclause 8.1.2.2.
See subclause 8.1.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.5.3 Offboard_API_Invoker operation
| API operation name: Offboard_API_Invoker
Description: Cancels enrollment of the API invoker as a recognized user of the CAPIF.
Known Consumers: API invoker.
Inputs: Refer subclause 8.2.2.1.
Outputs: Refer subclause 8.2.2.2.
See subclause 8.2.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.5.4 Subscribe_Event operation
| API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.5.5 Notify_Event operation
| API operation name: Notify_Event
Description: Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.3.
Outputs: Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.5.6 Unsubscribe_Event operation
| API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.5.7 Update_Event_Subscription operation
| API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.6 CAPIF_Security API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.6.1 General
| API description: This API enables the API invoker to communicate with the CAPIF core function to authenticate and obtain authorization to access service APIs over CAPIF-1 or CAPIF-1e. This API also enables the API exposing function (AEF) to obtain API invoker information and revoke API invoker authorization over CAPIF-3.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.6.2 Obtain_Security_Method operation
| API operation name: Obtain_Security_Method
Description: Obtain information about service API security method with CAPIF core function for service API invocations.
Known Consumers: API invoker.
Inputs: Refer subclause 8.10A.2.
Outputs: Refer subclause 8.10A.2.
See subclause 8.10A.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.6.3 Obtain_Authorization operation
| API operation name: Obtain_Authorization
Description: Provides the authorization information to access relevant service API.
Known Consumers: API invoker.
Inputs: Refer subclause 8.11.2.
Outputs: Refer subclause 8.11.2.
See subclause 8.11.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.6.4 Obtain_API_Invoker_Info operation
| API operation name: Obtain_API_Invoker_Info
Description: Obtains the API invoker information.
Known Consumers: API exposing function.
Inputs: Refer subclause 8.16.2.1.
Outputs: Refer subclause 8.16.2.2.
See subclause 8.16.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.6.5 Revoke_Authorization operation
| API operation name: Revoke_Authorization
Description: Revokes API invoker authorization to access service API.
Known Consumers: API exposing function.
Inputs: Refer subclause 8.23.2.
Outputs: Refer subclause 8.23.2.
See subclause 8.23.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.6.6 Revoke_Authorization_Notify operation
| API operation name: Revoke_Authorization_Notify
Description: Provides to the API invoker authorization revocation information to access service API.
Known Consumers: API invoker.
Inputs: Refer subclause 8.23.2.3.
Outputs: Refer subclause 8.23.2.4.
See clauses 8.23.3 and 8.23.4 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.7 CAPIF_Monitoring API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.7.1 General
| API description: This API enables the API management function to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events related to monitoring and receive subsequent notification of CAPIF monitoring events over CAPIF-5.
NOTE: Stage 3 can decide whether the API for CAPIF_Monitoring can be enabled over CAPIF-5.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.7.2 Subscribe_Event operation
| API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.7.3 Notify_Monitoring_Service_Event operation
| API operation name: Notify_Monitoring_Service_Event
Description: Provides the notification of the events related to monitoring service API invocations to the subscribed API management function.
Known Consumers: API management function.
Inputs: Refer subclause 8.21.2.1.
Outputs: Refer subclause 8.21.2.2.
See subclause 8.21.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.7.4 Unsubscribe_Event operation
| API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.7.5 Update_Event_Subscription operation
| API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.8 CAPIF_Logging_API_Invocation API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.8.1 General
| API description: This API enables the API exposing function to communicate with the CAPIF core function to log the information related to service API invocation over CAPIF-3.
NOTE: Stage 3 can decide whether the API for CAPIF_Logging_API_Invocation can be enabled over CAPIF‑3.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.8.2 Log_API_Invocation operation
| API operation name: Log_API_Invocation
Description: Enables to log API invocation information.
Known Consumers: API exposing function.
Inputs: Refer subclause 8.19.2.1.
Outputs: Refer subclause 8.19.2.2.
See subclause 8.19.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.9 CAPIF_Auditing API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.9.1 General
| API description: This API enables the API management function to communicate with the CAPIF core function to retrieve the log information related to service API invocation over CAPIF-5.
NOTE: Stage 3 can decide whether the API for CAPIF_Auditing can be enabled over CAPIF‑5.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.9.2 Query_ API_Invocation_Log operation
| API operation name: Query_API_Invocation_Log
Description: Query the API invocation log information.
Known Consumers: API management function.
Inputs: Refer subclause 8.22.2.1.
Outputs: Refer subclause 8.22.2.2.
See subclause 8.22.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.10 CAPIF_Access_Control_Policy API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.10.1 General
| API description: This API enables the API exposing function to obtain the policy to perform access control on the service API invocations.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.10.2 Obtain_Access_Control_Policy operation
| API operation name: Obtain_Access_Control_Policy
Description: Allows obtaining the policy to perform access control on the service API invocations.
Known Consumers: API exposing function.
Inputs: Refer subclause 8.12.2.1.
Outputs: Refer subclause 8.12.2.2.
See subclause 8.12.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.11 CAPIF_Routing_Info API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.11.1 General
| API description: This API enables the API exposing function to obtain the routing information to forward the API invocation to another API exposing function.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.11.2 Obtain_Routing_Info operation
| API operation name: Obtain_Routing_Info
Description: Allows obtaining the API routing information.
Known Consumers: API exposing function.
Inputs: Refer subclause 8.27.2.1.
Outputs: Refer subclause 8.27.2.2.
See subclause 8.27.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.12 CAPIF_API_provider_management API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.12.1 General
| API description: This API enables the API Management Function to communicate with the CAPIF core function to register the API provider domain functions as authorized users of the CAPIF functionalities.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.12.2 Register_API_Provider operation
| API operation name: Register_API_Provider
Description: Registers the API provider domain functions as authorized users of the CAPIF.
Known Consumers: API Management Function.
Inputs: Refer subclause 8.28.2.1.
Outputs: Refer subclause 8.28.2.2.
See subclause 8.28.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.12.3 Update_API_Provider operation
| API operation name: Update_API_Provider
Description: Updates registration information of the API provider domain functions.
Known Consumers: API Management Function.
Inputs: Refer subclause 8.29.2.1.
Outputs: Refer subclause 8.29.2.2.
See subclause 8.29.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.12.4 Deregister_API_Provider operation
| API operation name: Deregister_API_Provider
Description: De-registers the API provider domain functions on the CAPIF core function.
Known Consumers: API Management Function.
Inputs: Refer subclause 8.30.2.1.
Outputs: Refer subclause 8.30.2.2.
See subclause 8.30.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.13 CAPIF_Open_Discover_Service_API API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.13.1 General
| API description: This API enables the API invoker to discover service API information about the available set of APIs offered by CCF before onboarding
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 10.13.2 Open_Discover_Service_API operation
| API operation name: Open_Discover_Service_API
Description: Provides the published service APIs information before onboarding.
Known Consumers: Open.
Inputs: Refer subclause 8.38.2.1.
Outputs: Refer subclause 8.38.2.2.
See subclause 8.38.3 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 11 API exposing function APIs
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 11.1 General
| Table 11.1-1 illustrates the API exposing function APIs.
Table 11.1-1: List of API exposing function APIs
API Name
API Operations
Known Consumer(s)
Communication Type
AEF_Security API
Revoke_Authorization
CAPIF Core Function
Request/ Response
Initiate_Authentication
API Invoker
Request/ Response
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 11.2 AEF_Security API
| |
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 11.2.1 General
| API description: This API allows CAPIF core function to revoke access to service APIs and API invokers to request the authentication parameters necessary for authentication of the API invoker available with the API exposing function.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 11.2.2 Revoke_Authorization operation
| API operation name: Revoke_Authorization
Description: Revokes API invoker authorization to access service API.
Known Consumers: CAPIF core function.
Inputs: Refer subclause 8.23.2.
Outputs: Refer subclause 8.23.2.
See subclause 8.23.4 for the details of usage of this API operation.
|
855f363e5db8a2e5fe152fc2c046fb12 | 23.222 | 11.2.3 Initiate_Authentication operation
| API operation name: Initiate_Authentication
Description: Authentication between the API invoker and the AEF prior to service API invocation.
Known Consumers: API Invoker.
Inputs: Refer subclause 8.14.2.
Outputs: Refer subclause 8.14.2.
See subclause 8.14.3 for the details of usage of this API operation.
Annex A (informative):
Overview of CAPIF operations
Depicted in figure A-1 is the overview of CAPIF operations. CAPIF operations occur between different actors involving the API invoker, the CAPIF core function, the API exposing function, the API publishing function and the API management function, and optionally the resource owner function for RNAA. High level CAPIF interactions between the actors are shown in figure A-1. This figure is only provided for illustration purposes, and does not represent the order of operations.
Figure A-1: Overview of CAPIF operations
The CAPIF defines the functional entities in subclause 6.3.
The CAPIF defines the reference points between the functional entities in subclause 6.4.
The following operations require the communication between the CAPIF entities:
1. Publishing service APIs: the API provider utilizes the API publishing function over CAPIF-4 reference point to publish the service APIs on the CAPIF core function, as specified in subclause 8.3 of this specification;
2. Discovering service APIs: the API invoker discovers the service APIs over CAPIF-1/CAPIF-1e reference points, as specified in subclause 8.7 of this specification;
3. API event subscription and notification: the API invoker subscribes to and receive service API event notifications over CAPIF-1/CAPIF-1e reference points, as specified in subclause 8.8 of this specification;
4. Authenticating with CAPIF: the API invoker authenticates itself over CAPIF-1/CAPIF-1e reference points, as specified in subclause 8.10 of this specification;
5. Authorizing with CAPIF: the API invoker obtains service API authorization over CAPIF-1/CAPIF-1e reference points, as specified in subclause 8.11 of this specification. In RNAA scenarios, API authorization is based on the authorization information obtained from the resource owner, as specified in clause 8.31;
6. Topology hiding: the API provider, to hide the topology, utilizes the API exposing function over CAPIF-3 reference point, as specified in subclause 8.13 of this specification;
7. Authenticating the API invoker prior to service API invocation: the API provider, to authenticate the API invoker prior to the service API invocation, utilizes the API exposing function over CAPIF-2/CAPIF-2e and CAPIF-3, as specified in subclause 8.14 of this specification;
8. Authenticating the API invoker upon the service API invocation: the API provider, to authenticate the API invoker upon invocation of the service APIs, utilizes the API exposing function over CAPIF-2/CAPIF-2e and CAPIF-3, as specified in subclause 8.15 of this specification;
9. Authorizing API invoker: the API provider, to authorize the API invoker to access the service APIs, utilizes the API exposing function over CAPIF-2/CAPIF-2e and CAPIF-3, as specified in subclause 8.16 of this specification;
10. Access control: the API provider, to control the access of the service API by the API invoker based on policy or usage limits,
- utilizes the API exposing function over CAPIF-2/CAPIF-2e and CAPIF-3, as specified in subclause 8.17 of this specification; or
- in a cascaded deployment, utilizes API exposing functions over CAPIF-2/CAPIF-2e, as specified in subclause 8.18 of this specification;
11. Logging service: the API provider, to maintain the log of the API invocations at the CAPIF core function for services such as invocation history, utilizes the API exposing function over CAPIF-3, as specified in subclause 8.19 of this specification;
12. Service monitoring: the API provider, to facilitate monitoring such as API invoker's ID and IP address, utilizes the API management function over CAPIF-5, as specified in subclause 8.21 of this specification; and
13. Auditing: the API provider, for auditing, utilizes the API management function over CAPIF-5, as specified in subclause 8.22 of this specification.
NOTE: Charging aspects of CAPIF framework, i.e., charging architecture and information flows, are specified in 3GPP TS 32.254 [20].
Annex B (informative):
CAPIF relationship with network exposure aspects of 3GPP systems
This annex provides the relationship of CAPIF with network exposure aspects of 3GPP systems. Any system exposing capabilities as service APIs can implement CAPIF. Generic model for CAPIF utilization by service API provider is included. Network exposure aspects of EPS and 5GS are considered for illustration.
NOTE: As there are no impacts on CAPIF's relationship with network exposure aspects of 3GPP systems due to deployment of 3rd party trust domain, it is not illustrated in the figures.
B.0 CAPIF utilization by service API provider
Figure B.0-1 illustrates the service API interaction with the CAPIF for utilizing framework aspects provided by the CAPIF.
Figure B.0-1: CAPIF utilization by service API provider
The service API aspects of the 3GPP network services and capabilities such as subscriber management, mobility management, transport and other communication services can be exposed for consumption by external 3rd party applications (e.g. API invoker).
Framework aspects typically horizontal in nature caters to common functionality such as onboarding, offboarding, publishing, unpublishing, update service API, discovery, authentication, registration, authorization, logging, monitoring, configuration, topology hiding, that are required to provide service APIs to API invokers. Service APIs can utilize the functions of the API provider domain (i.e. API exposing function, API publishing function, API management function) and interfaces CAPIF-3, CAPIF-4 and CAPIF-5 as specified in this specification.
The service API exposure function is connected to 3GPP network entity(s) via 3GPP internal interface(s). The API publishing function provides the service API information for publishing to the CAPIF core function.
For consuming service API, the API invoker interacts with the service API exposure function via service API interface and CAPIF-2/2e. While the service API interface is responsible for providing service aspects, CAPIF-2/2e supports service API by providing framework aspects such as authentication of the API invoker, authorization verification for the API invoker upon accessing the service API.
B.1 CAPIF relationship with 3GPP EPS network exposure
B.1.1 General
The table B.1.1-1 shows the relationship between CAPIF and EPS network exposure aspects. The details of SCEF and its role in exposing network capabilities of EPS to 3rd party applications are specified in 3GPP TS 23.682 [2]
Table B.1.1-1: CAPIF relationship with 3GPP EPS network exposure
Aspects
CAPIF
EPS network exposure
Entity providing the APIs to external or 3rd party applications
AEF
SCEF
Entity providing framework related services to the applications (discovery, authentication, authorization, etc)
CAPIF core function
SCEF
Entity representing the external or 3rd party applications
API invoker
SCS/AS
Entity providing framework related services to support the APIs operation and management (publish, policy enforcements)
CAPIF core function
SCEF
Interface/Reference point for exposing network capabilities as APIs
CAPIF-2 and CAPIF-2e (Do not include the service specific aspects)
T8
Interface/Reference point for exposing framework services as APIs to the applications
CAPIF-1 and CAPIF-1e
Not specified. (May be via T8)
Interface/Reference point for framework services to support the APIs operation and management
CAPIF-3, CAPIF-4 and CAPIF-5
Internal to SCEF
B.1.2 Deployment models
B.1.2.1 General
Based on the relationship captured in table B.1.1-1, the following deployment models for CAPIF are possible to enable EPS network exposure.
NOTE: The deployment models captured in subclause 7 are possible for the SCEF deployment compliant with CAPIF. Not all deployment models are illustrated in this subclause.
B.1.2.2 SCEF implements the CAPIF architecture
Figure B.1.2.2-1 illustrates the deployment model where SCEF implements the CAPIF architecture.
Figure B.1.2.2-1: SCEF implements the CAPIF architecture
The SCEF can implement the functionalities of the CAPIF core function, the API exposing function, the API publishing function and the API management function.
According to the CAPIF architecture, CAPIF-2 and CAPIF-2e consist of framework aspects and service specific aspects. The service specific aspects are out of scope of CAPIF. T8 can implement the service specific aspects of CAPIF-2 and CAPIF-2e, and can provide the service APIs exposed by SCEF (AEF) to the SCS/AS (API invoker).
The SCEF can additionally provide CAPIF-1 and CAPIF-1e (CAPIF APIs) to the SCS/AS (API invokers).
B.1.2.3 SCEF implements the service specific aspect compliant with the CAPIF architecture
Figure B.1.2.3-1 illustrates the deployment model where SCEF implements the service specific aspect compliant with the CAPIF architecture.
Figure B.1.2.3-1: SCEF implements the service specific aspect compliant with the CAPIF architecture
3GPP EPS can deploy the CAPIF core function along with the SCEF.
The SCEF can implement the functionalities of the API provider domain functions.
According to the CAPIF architecture, CAPIF-2 and CAPIF-2e consist of framework aspects and service specific aspects. The service specific aspects are out of scope of CAPIF. T8 can implement the service specific aspects of CAPIF-2 and CAPIF-2e, and can provide the service APIs exposed by SCEF (AEF) to the SCS/AS (API invoker).
The SCEF can implement the CAPIF-3 reference point/interface to the CAPIF core function.
B.1.2.4 Distributed deployment of the SCEF compliant with the CAPIF architecture
Figure B.1.2.4-1 illustrates the distributed deployment model where the SCEF implements the service specific aspect compliant with the CAPIF architecture.
Figure B.1.2.4-1: Distributed deployment of SCEF compliant with the CAPIF architecture
The 3GPP EPS can deploy the CAPIF core function, the SCEF-2 (API exposing function as a gateway) along with the SCEF-1 as illustrated in subclause 7.3.
The SCEF can implement the functionalities of API provider domain functions.
According to the CAPIF architecture, CAPIF-2 or CAPIF-2e consists of framework aspects and service specific aspects. The service specific aspects are out of scope of the CAPIF. T8 can implement the service specific aspects of CAPIF-2 or CAPIF-2e and can provide the service APIs exposed by the SCEF-2 (AEF as a gateway) to the SCS/AS (API invoker).
The SCEF-2 can implement the CAPIF-3 reference point to the CAPIF core function and the SCEF-1 can implement the CAPIF-4 and CAPIF-5 reference points to the CAPIF core function.
B.2 CAPIF relationship with 3GPP 5GS network exposure
B.2.1 General
The table B.2.1-1 shows the relationship between CAPIF and 5GS network exposure aspects. The details of NEF and its role in exposing network capabilities of 5GS to 3rd party applications are specified in 3GPP TS 23.501 [3] and the details of NEF service operations are specified in 3GPP TS 23.502 [4].
Table B.2.1-1: CAPIF relationship with 3GPP 5GS network exposure
Aspects
CAPIF
5GS network exposure
Entity providing the APIs to external or 3rd partyapplications
AEF
NEF
Entity providing framework related services to the applications (discovery, authentication, authorization, etc)
CAPIF core function
NEF (Not specified yet)
Entity representing the external or 3rd party applications
API invoker
AF
Entity providing framework related services to support the APIs operation and management (publish, policy enforcements)
CAPIF core function
NEF (Not specified yet)
Interface/Reference point for exposing network capabilities as APIs
CAPIF-2 and CAPIF-2e (Do not include the service specific aspects)
Nnef
Interface/Reference point for exposing framework services as APIs to the applications
CAPIF-1 and CAPIF-1e
Nnef (Not specified yet)
Interface/Reference point for framework services to support the APIs operation and management
CAPIF-3, CAPIF-4 and CAPIF-5
Internal to NEF
B.2.2 Deployment models
B.2.2.1 General
Based on the relationship captured in table B.2.1-1, the following deployment models for CAPIF are possible to enable 5GS network exposure.
NOTE: The deployment models captured in subclause 7 are possible for the NEF deployment compliant with CAPIF. Not all deployment models are illustrated in this subclause.
B.2.2.2 NEF implements the CAPIF architecture
Figure B.2.2.2-1 illustrates the deployment model where the NEF implements the CAPIF architecture.
Figure B.2.2.2-1: NEF implements the CAPIF architecture
The NEF can implement the functionalities of the CAPIF core function, the API exposing function, the API publishing function and the API management function.
According to the CAPIF architecture, CAPIF-2 and CAPIF-2e consist of framework aspects and service specific aspects. The service specific aspects are out of scope of CAPIF. Nnef can implement the service specific aspects of CAPIF-2 and CAPIF-2e, and can provide the service APIs exposed by the NEF (AEF) to the AF (API invoker).
The NEF can additionally provide CAPIF-1 and CAPIF-1e (CAPIF APIs) to the AF (API invokers).
B.2.2.3 NEF implements the service specific aspect compliant with the CAPIF architecture
Figure B.2.2.3-1 illustrates the deployment model where the NEF implements the service specific aspect compliant with the CAPIF architecture.
Figure B.2.2.3-1: NEF implements the service specific aspect compliant with the CAPIF architecture
3GPP 5GS can deploy the CAPIF core function along with the NEF.
The NEF can implement the functionalities of the API provider domain functions.
According to the CAPIF architecture, CAPIF-2 and CAPIF-2e consist of framework aspects and service specific aspects. The service specific aspects are out of scope of CAPIF. Nnef can implement the service specific aspects of CAPIF-2 and CAPIF-2e, and can provide the service APIs exposed by NEF (AEF) to the AF (API invoker).
The NEF can implement the CAPIF-3 reference point/interface to the CAPIF core function.
B.2.2.4 Distributed deployment of the NEF compliant with the CAPIF architecture
Figure B.2.2.4-1 illustrates the distributed deployment model where the NEF implements the service specific aspect compliant with the CAPIF architecture.
Figure B.2.2.4-1: Distributed deployment of NEF compliant with the CAPIF architecture
The 3GPP 5GS can deploy the CAPIF core function, the NEF-2 (API exposing function as a gateway) along with the NEF-1 as illustrated in subclause 7.3.
The NEF can implement the functionalities of API provider domain functions.
According to the CAPIF architecture, CAPIF-2 or CAPIF-2e consists of framework aspects and service specific aspects. The service specific aspects are out of scope of the CAPIF. Nnef can implement the service specific aspects of CAPIF-2 and CAPIF-2 or CAPIF-2e can provide the service APIs exposed by the NEF-2 (AEF as a gateway) to the AF (API invoker).
The NEF-2 (AEF) can implement the CAPIF-3 reference point to the CAPIF core function and the NEF-1 can implement the CAPIF-4 and CAPIF-5 reference points to the CAPIF core function.
B.3 Integrated deployment of 3GPP network exposure systems with the CAPIF
B.3.1 General
According to 3GPP TS 23.682 [2], when the CAPIF is supported, the SCEF supports the API provider domain functions. According to 3GPP TS 23.501 [3], when the CAPIF is supported,the NEF supports the API provider domain functions.
B.3.2 Deployment model
B.3.2.1 General
The SCEF and the NEF may be integrated with a single CAPIF core function to offer their respective service APIs to the API invokers. The following deployment model is possible for integrated deployment of the SCEF and the NEF with the CAPIF core function.
B.3.2.2 Integrated deployment of the SCEF and the NEF with the CAPIF
Figure B.3.2.2-1 illustrates integrated deployment of the SCEF and the NEF with the CAPIF.
Figure B.3.2.2-1: Integrated deployment of the SCEF and the NEF with the CAPIF
The CAPIF core function, the SCEF and the NEF are deployed in the PLMN trust domain, where the CAPIF core function takes the role of a unified gateway and provides services to different API invokers. The API invokers obtains the T8 and N33 service API information and the corresponding entry point details from the CAPIF core function via CAPIF-1 or CAPIF-1e reference points.
The API invokers can interact independently with the SCEF, the NEF and the 3rd party API exposing functions via CAPIF-2 or CAPIF-2e reference points. In this case, T8 and N33 can be reused to implement the service specific aspects of CAPIF-2 or CAPIF-2e reference points for the corresponding service API interactions of the SCEF and the NEF respectively.
The SCEF and the NEF applies any service API access policy control to the interactions between the API invokers and the T8 and N33 service APIs respectively by communicating with the same CAPIF core function via the CAPIF-3 reference point.
Annex C (informative):
CAPIF role in charging
C.1 General
This annex provides the information about the role of CAPIF in charging service API invocations. The common architecture for charging is illustrated in clause 4 of 3GPP TS 32.240 [6]. There are two charging mechanisms - offline charging and online charging. The role of CAPIF in both these charging mechanims is illustrated for informational purpose in this subclause. The charging management for the exposure of northbound APIs when the AEF is within the PLMN is specified in 3GPP TS 32.254 [20].
The API invocations are subjected to charging (online, offline) as described in clause 4.4 of 3GPP TS 32.254 [20].
C.2 CAPIF role in online charging
The API invocations are subjected to online charging as described in clause 5.3 of 3GPP TS 32.254 [20].
C.3 CAPIF role in offline charging
The API invocations are subjected to offline charging as described in clause 5.2 of 3GPP TS 32.254 [20].
Annex D (informative):
CAPIF relationship with external API frameworks
This annex provides the relationship of CAPIF with the OMA Network APIs and the ETSI MEC API framework. The relationship of CAPIF with these external API frameworks is illustrated in the table D-1. "Yes" means that the external API framework supports the CAPIF functionality, "No" means that the API framework does not support the CAPIF functionality, and "Partial" means that it provides a mechanism that partially supports the CAPIF functionality.
Table D-1: CAPIF relationship with external API frameworks
CAPIF functionalities
OMA Network APIs
ETSI MEC API framework
Supported
Reference
Supported
Reference
Publish and discover service API information
Partial
(see NOTE)
OMA-TS-NGSI_Registration_and_Discovery [11]
Yes
ETSI GS MEC 011 [7]
Topology hiding of the service
Yes
Individual API exposing function
Yes
Individual API exposing function
API invoker authentication to access service APIs
Partial
OMA-ER_Autho4API [9]
Partial
ETSI GS MEC 009 [8]
API invoker authorization to access service APIs
Partial
OMA-ER_Autho4API [9]
Partial
ETSI GS MEC 009 [8]
Lifecycle management of service APIs
No
No
Monitoring service API invocations
No
No
Logging API invoker onboarding and service API invocations
No
No
Auditing service API invocations
No
No
Onboarding API invoker to CAPIF
No
No
CAPIF authentication of API invokers
No
No
Service API access control
Partial
OMA-ER_Autho4API [9]
Partial
ETSI GS MEC 009 [8]
Secure API communication
Yes
OMA-ER_Autho4API [9]
Yes
ETSI GS MEC 009 [8]
Policy configuration
No
No
API protocol stack model
Partial
for REST: OMA-TS_REST_NetAPI_Common [10]
Partial
for REST:
ETSI GS MEC 009 [8]
API security protocol
Partial
OMA-ER_Autho4API [9]
Partial
ETSI GS MEC 009 [8]
CAPIF support for service APIs from multiple providers
No
No
NOTE: OMA-TS-NGSI_Registration_and_Discovery [11] is only applicable to a specific type of web services (OWSER using UDDI and WSDL).
Annex E (normative):
Configuration data for CAPIF
The configuration data is stored in the CAPIF core function and provided by the CAPIF administrator.
The configuration data for CAPIF is specified in table E-1.
Table E-1: Configuration data for CAPIF
Reference
Parameter description
Subclause 4.2.2
List of published service API discovery restrictions
> Service API identification
> API invoker identity information
> Service API category
Subclause 4.3.2
List of service API authorization restrictions per API invoker
> API Invoker identity information
> Service API identification
> Per resource, operation authorization information.
(see NOTE 2)
> Network slice identification
Subclause 4.7.2
List of service API log storage durations
> Service API identification
> Service API log storage duration (in hours) (see NOTE 1)
Subclause 4.7.4
List of API invoker interactions log storage durations
> Service API identification
API invoker interactions log storage duration (in hours) (see NOTE 1)
Subclause 4.10
List of access control policy (for an API provider domain) per API invoker and optionally per network slice
> Volume limit on service API invocations (total number of invocations allowed)
> Time limit on service API invocations (The time range of the day during which the service API invocations are allowed)
> Rate limit on service API invocations (allowed service API invocations per second)
> Service API identification
> API invoker identity information
> Network Slice Info
Subclause 8.34.3
Group context information
> Group identifier
> List of UE IDs (group members)
> UE identifier of the Group Resource Owner
> Authorization information related to the list of supported applications
>> Application identifier
>> Purpose
>> Scope
NOTE 1: If no value is set for the duration, the duration is assumed to be unlimited.
NOTE 2: The API invoker request for access authorization to specific resources or operations of a Service API is specified in 3GPP TS 33.122 [12].
Annex F (informative):
Examples of API invoker roles in CAPIF
The figure F-1 provides examples of API invoker roles in CAPIF and illustrates the usage of CAPIF capabilities.
Application Management Client: As specified in clause 3.1, the application developers utilize the CAPIF APIs using an application management client as an API invoker to obtain the service APIs information to implement the application program. Such application programs are hosted on cloud, edge or on a UE.
BSS/OSS System: The BSS/OSS system of MNO enables the business relationship with the Application Service Providers (the consumers of the service APIs exposed by the MNO's exposure platform). The BSS/OSS system as an API invoker invoke the CAPIF APIs as per its business logic.
Channel Aggregator Platform: As specified in clause 3.1, the Channel Aggregator aggregates the APIs from one or more southbound CAPIF providers with the intention to re-expose such APIs or expose value-added APIs developed using the APIs from the southbound CAPIF providers to the northbound side Application management client or Hosted applications. The Channel Aggregator Platform as API invoker invokes the CAPIF APIs and service APIs as per its business logic.
Hosted Applications: As specified in clause 3.1, the hosted applications (which are programmed to utilize the service APIs) as an API invoker invoke the CAPIF APIs and service APIs as per the application business logic.
Figure F-1: Examples of API invoker roles in CAPIF
Annex G (informative):
API invoker with a frontend and backend component
In clause 6.3.2 it is highlighted that the API invoker can be either an application on a server or an application on a UE. When considering the UE, the application can comprise of a frontend component on a UE plus a server-side backend component. The motivation for such an arrangement is to address security vulnerabilities associated with issuing access tokens to client-side entities (i.e., an API invoker as an application on a UE), e.g., persistent token theft.
When the API invoker is deployed with a backend component in the network, the backend component is responsible for authentication and authorization procedures towards the CCF Authorization Function. The backend component can proxy service API discovery and invocation requests initiated by the API invoker frontend. This arrangement is depicted in Figure G-1.
Figure G-1: High level functional RNAA architecture for CAPIF supporting an application with a frontend / backend component
NOTE: The information exchanged and the security aspects between the application frontend component and application backend component is not specified in this release of the specification.
Annex H (informative):
AEF instantiation
As illustrated in figure H-1, CAPIF architecture supports AEFs from multiple API providers (e.g. MNO, 3rd party). The instances of such AEFs are managed by the respective management systems of the API provider (e.g. PLMN management system, 3rd party management system).
The AMF monitors the events reported by the CAPIF core function. These events can be utilized to trigger AEF instantiation by the PLMN management system or 3rd party management system. The AMF can utilize the services of PLMN or 3rd party management systems (e.g. trigger instantiation of corresponding AEFs) via the APIs exposed by the PLMN or 3rd party management systems. It is upto implementation of CAPIF to utilize the services of the PLMN and/or 3rd party management systems for AEF instantiation.
Figure H-1: AEF instantiation
Annex I (informative):
Change history
Change history
Date
Meeting
TDoc
CR
Rev
Cat
Subject/Comment
New version
2017-10
SA6#19
S6-171274
TS skeleton
0.0.0
2017-10
SA6#19
Implementation of the following p-CRs approved by SA6:
S6-171444; S6-171343; S6-171445; S6-171446; S6-171466; S6-171448; S6-171348; S6-171449; S6-171359; S6-171467; S6-171451; S6-171452; S6-171362; S6-171463; S6-171356; S6-171355; S6-171453; S6-171454; S6-171455; S6-171464; S6-171468; S6-171350; S6-171349; S6-171407.
0.1.0
2017-12
SA6#20
Implementation of the following p-CRs approved by SA6:
S6-171630; S6-171631; S6-171633; S6-171648; S6-171650; S6-171658; S6-171659; S6-171692; S6-171693; S6-171694; S6-171695; S6-171698; S6-171699; S6-171700; S6-171702; S6-171704; S6-171705; S6-171706; S6-171711; S6-171712; S6-171713; S6-171819; S6-171820; S6-171821; S6-171822; S6-171823; S6-171848; S6-171855; S6-171865; S6-171876.
0.2.0
2017-12
SA#78
SP-170901
Submitted to SA#78 for approval
1.0.0
2018-01
SA#78
SP-170901
MCC Editorial update for publication after TSG SA approval (SA#78)
15.0.0
2018-04
SA#79
SP-180156
0001
1
F
Use of specific ETSI and OMA references
15.1.0
2018-04
SA#79
SP-180156
0002
F
Corrections for CAPIF-1e and CAPIF-2e
15.1.0
2018-04
SA#79
SP-180156
0003
F
Miscellaneous corrections to procedures and information flows
15.1.0
2018-04
SA#79
SP-180156
0004
1
F
Addition of offboarding to functional entities and reference points description
15.1.0
2018-04
SA#79
SP-180156
0005
1
D
Editorial corrections
15.1.0
2018-04
SA#79
SP-180156
0006
2
B
Solution to EN on revoking authorization based on access control
15.1.0
2018-04
SA#79
SP-180156
0007
3
F
Configuration items for CAPIF
15.1.0
2018-04
SA#79
SP-180156
0008
3
F
Update to CAPIF relationship with 3GPP EPS and 5GS
15.1.0
2018-04
SA#79
SP-180156
0009
1
F
Solution to EN on policy synchronization
15.1.0
2018-04
SA#79
SP-180156
0010
2
F
CAPIF utilization by service APIs
15.1.0
2018-04
SA#79
SP-180156
0011
1
F
Proposal for definition for PLMN trust domain
15.1.0
2018-06
SA#80
SP-180374
0013
1
F
Correction for the details of service API information
15.2.0
2018-06
SA#80
SP-180374
0014
1
F
Correction for usage of service API identification information
15.2.0
2018-06
SA#80
SP-180374
0019
2
D
Editorial correction of TS 23.222 (CAPIF stage2)
15.2.0
2018-06
SA#80
SP-180375
0012
2
B
Architecture functional model to support multiple API providers
16.0.0
2018-06
SA#80
SP-180375
0015
1
B
Service API publish and discovery requirements for 3rd party API providers
16.0.0
2018-06
SA#80
SP-180375
0016
1
B
Charging requirements for 3rd party API providers
16.0.0
2018-06
SA#80
SP-180375
0017
1
B
OAM requirements for 3rd party API providers
16.0.0
2018-06
SA#80
SP-180375
0018
2
B
CAPIF interconnection requirements
16.0.0
2018-06
SA#80
SP-180375
0020
2
F
Updating representation of deployment models
16.0.0
2018-09
SA#81
SP-180675
0021
2
B
Integrated CAPIF with 3GPP EPS and 5GS network exposure
16.1.0
2018-09
SA#81
SP-180675
0022
1
C
Enhancement to the functional model deployments
16.1.0
2018-09
SA#81
SP-180675
0023
2
B
Enhancement to reference points for eCAPIF
16.1.0
2018-09
SA#81
SP-180674
0029
1
A
Update API naming convention
16.1.0
2018-09
SA#81
SP-180674
0030
2
A
Alignment of APIs
16.1.0
2018-09
SA#81
SP-180674
0031
1
A
Alignment to SA3 CAPIF TS
16.1.0
2018-09
SA#81
SP-180674
0032
1
Alignment to SA3 authentication procedure
16.1.0
2018-09
SA#81
SP-180675
0033
3
B
Functional architecture for CAPIF interconnection
16.1.0
2018-12
SA#82
SP-181176
0034
3
B
Topology hiding enhancement
16.2.0
2018-12
SA#82
SP-181176
0035
2
B
API publish and API discover for CAPIF interconnection
16.2.0
2018-12
SA#82
SP-181176
0036
1
C
Architectural requirements for identities
16.2.0
2018-12
SA#82
SP-181176
0038
2
B
Architectural requirements for provider domain entities interaction
16.2.0
2018-12
SA#82
SP-181176
0039
2
B
Update API invoker API list
16.2.0
2018-12
SA#82
SP-181175
0043
2
A
API invoker's onboarding response rel16
16.2.0
2019-03
SA#83
SP-190072
0044
2
F
Update procedures with topology hidding
16.3.0
2019-03
SA#83
SP-190072
0045
2
B
API sharing for CCF interconnection
16.3.0
2019-03
SA#83
SP-190072
0046
2
B
API invocation request routing with topology hiding
16.3.0
2019-03
SA#83
SP-190072
0048
1
C
Interactions between API exposing functions
16.3.0
2019-03
SA#83
SP-190072
0049
1
B
Service API discovery involving multiple CCFs
16.3.0
2019-03
SA#83
SP-190072
0050
2
B
Multiple CCFs deployment in a PLMN trust domain
16.3.0
2019-03
SA#83
SP-190072
0051
2
B
Service API discover for CAPIF interconnection
16.3.0
2019-03
SA#83
SP-190072
0052
1
B
Architectural requirements for registration of API provider domain functions
16.3.0
2019-03
SA#83
SP-190072
0053
2
B
Procedures for registration of API provider domain functions
16.3.0
2019-03
SA#83
SP-190072
0054
1
B
Updates to AEF procedures for 3rd party trust domain
16.3.0
2019-03
SA#83
SP-190072
0055
1
B
Updates to APF procedures for 3rd party trust domain
16.3.0
2019-03
SA#83
SP-190072
0056
1
B
Updates to AMF procedures for 3rd party trust domain
16.3.0
2019-03
SA#83
SP-190072
0057
-
B
Updates to CAPIF events procedures for 3rd party trust domain
16.3.0
2019-06
SA#84
SP-190483
0058
1
F
Clarification to routing rule of service API invocation
16.4.0
2019-06
SA#84
SP-190483
0059
3
F
Functional model update with reference points
16.4.0
2019-06
SA#84
SP-190483
0060
2
B
Update to service API publish for CAPIF interconnection
16.4.0
2019-06
SA#84
SP-190483
0061
2
B
Serving area and domain of service API for CAPIF interconnection
16.4.0
2019-06
SA#84
SP-190483
0062
1
B
3rd party trust domain with network exposure and charging aspects of 3GPP systems
16.4.0
2019-06
SA#84
SP-190483
0063
1
B
Interface based representation of CAPIF architecture
16.4.0
2019-09
SA#85
SP-190828
0064
1
F
Clarification and alignment with publish request information flows
16.5.0
2019-12
SA#86
SP-191107
0065
F
Correction on usage of service API information in access control message
16.6.0
2020-03
SA#87-E
SP-200112
0066
1
F
Shared CAPIF provider domain info in interconnection
16.7.0
2020-03
SA#87-E
SP-200116
0067
2
B
Serving area information for service APIs to support edge applications
17.0.0
2020-07
SA#88-E
SP-200337
0069
A
Add consumer for discover and publish service APIs
17.1.0
2020-07
SA#88-E
SP-200337
0071
A
Add obtaining routing info service API
17.1.0
2020-07
SA#88-E
SP-200337
0073
1
A
Correct API topology hiding
17.1.0
2020-07
SA#88-E
SP-200337
0075
1
A
Correction for CAPIF interconnection IEs
17.1.0
2020-09
SA#89-E
SP-200840
0077
3
F
Correction for API routing information
17.2.0
2020-12
SA#90-E
SP-200997
0078
2
B
Support AEF location and API invoker interface for edge application
17.3.0
2021-04
SA#91-E
SP-210183
0079
4
F
Clarification of Service-based interfaces interaction within CAPIF
17.4.0
2021-06
SA#92-E
SP-210482
0082
A
API provider management API
17.5.0
2022-06
SA#96
SP-220471
0084
1
A
Corrections to API invoker onboarding/offboarding in TS 23.222
17.6.0
2022-09
SA#97
SP-220918
0089
A
Corrections to API invoker onboarding/offboarding in TS 23.222
17.7.0
2022-12
SA#98-e
SP-221250
0090
1
B
Additional CAPIF architectural requirements for SNA
18.0.0
2022-12
SA#98-e
SP-221250
0091
2
B
CAPIF business relationship updates for SNA
18.0.0
2022-12
SA#98-e
SP-221250
0092
2
B
CAPIF functional model updates for SNA
18.0.0
2022-12
SA#98-e
SP-221250
0093
2
B
API invoker obtaining authorization from resource owner
18.0.0
2022-12
SA#98-e
SP-221250
0094
1
B
Discover a proper AEF with owner information
18.0.0
2022-12
SA#98-e
SP-221250
0095
2
B
Reducing resource owner consent inquiry in a nested API invocation
18.0.0
2022-12
SA#98-e
SP-221239
0096
2
B
CAPIF extensibility as requested by ETSI ISG MEC
18.0.0
2023-03
SA#99
SP-230295
0098
B
Discover proper AEF in interconnection
18.1.0
2023-03
SA#99
SP-230296
0099
1
B
Solve CAPIF extensibility EN
18.1.0
2023-03
SA#99
SP-230295
0100
1
B
API invoker clarification
18.1.0
2023-03
SA#99
SP-230295
0101
1
D
Modify a terminology for SNA
18.1.0
2023-03
SA#99
SP-230286
0102
2
B
New IE(Service KPI) in Service API publish request
18.1.0
2023-03
SA#99
SP-230295
0103
2
B
Discover proper AEF with IP information
18.1.0
2023-03
SA#99
SP-230292
0104
B
Support onboarding expiration
18.1.0
2023-03
SA#99
SP-230296
0105
2
F
Resolving editor’s notes about TS reference
18.1.0
2023-03
SA#99
SP-230295
0106
2
B
Adding descriptions of new functional entities and reference points
18.1.0
2023-06
SA#100
SP-230714
0109
2
B
Support CAPIF in SNPN
18.2.0
2023-06
SA#100
SP-230712
0111
4
B
Service API status monitoring
18.2.0
2023-06
SA#100
SP-230713
0112
B
Clarification that RNAA is for both 4G and 5G
18.2.0
2023-06
SA#100
SP-230713
0113
2
B
SNAAPP alignment with SA3
18.2.0
2023-06
SA#100
SP-230713
0114
2
B
Overview of CAPIF operations for RNAA scenarios
18.2.0
2023-06
SA#100
SP-230714
0115
3
B
CAPIF add service procedure for update of subscriptions
18.2.0
2023-06
SA#100
SP-230714
0116
5
B
Alignment among CAPIF provider (trust) domains
18.2.0
2023-12
SA#102
SP-231547
0122
2
A
Editorial corrections
18.3.0
2023-12
SA#102
SP-231569
0125
1
F
Solve EN related to SA3
18.3.0
2023-12
SA#102
SP-231569
0126
2
F
Add response to RNAA procedural flows and correct cross-references
18.3.0
2023-12
SA#102
SP-231569
0128
2
F
Clarify how to monitor service API status when the APF is unable to update service API status
18.3.0
2023-12
SA#102
SP-231569
0129
2
F
Add CAPIF words to Abbreviations
18.3.0
2023-12
SA#102
SP-231569
0133
6
F
CAPIF Architecture alignment with SA3 RNAA aspects
18.3.0
2023-12
SA#102
SP-231546
0136
A
API Description Correction
18.3.0
2023-12
SA#102
SP-231569
0137
1
F
API invoker authorization corrections
18.3.0
2023-12
SA#102
SP-231545
0141
A
Security API corrections
18.3.0
2023-12
SA#102
SP-231569
0147
2
F
Editorial corrections regarding RNAA
18.3.0
2023-12
SA#102
SP-231569
0149
2
F
Corrections for CAPIF revocation of API Invoker's authorization based on RNAA
18.3.0
2023-12
SA#102
SP-231569
0150
1
F
Corrections for CAPIF deployment models supporting RNAA
18.3.0
2023-12
SA#102
SP-231570
0131
2
B
Slice-based service API exposure
19.0.0
2023-12
SA#102
SP-231570
0144
1
F
Service API unpublish for CAPIF interconnection
19.0.0
2023-12
SA#102
SP-231570
0145
1
F
Service API retrieval for CAPIF interconnection
19.0.0
2023-12
SA#102
SP-231570
0146
3
F
Service API update for CAPIF interconnection
19.0.0
2024-03
SA#103
SP-240317
0151
1
D
Align cross-references to the appropriate subclauses of TS 33.122
19.1.0
2024-03
SA#103
SP-240317
0152
1
F
Responsibilities of CAPIF API provider domain functions
19.1.0
2024-03
SA#103
SP-240310
0154
2
A
Consistent use of term "resource owner"
19.1.0
2024-03
SA#103
SP-240317
0157
2
D
Editorial correction for topology hiding
19.1.0
2024-03
SA#103
SP-240317
0158
1
F
Correction cardinality IE service API unpublish for CAPIF interconnection
19.1.0
2024-06
SA#104
SP-240755
0162
1
A
Corrections to Deregister_API_Provider operation
19.2.0
2024-06
SA#104
SP-240755
0167
2
A
Correction for Discover service APIs
19.2.0
2024-06
SA#104
SP-240764
0169
1
A
Add missing function to resource owner function
19.2.0
2024-06
SA#104
SP-240756
0174
3
A
Alignment of "API type" with "API category" terminology
19.2.0
2024-06
SA#104
SP-240755
0180
2
A
Correction for Service API discovery involving multiple CCFs
19.2.0
2024-06
SA#104
SP-240764
0181
1
A
Reducing authorization information inquiry in a nested API invocation
19.2.0
2024-06
SA#104
SP-240764
0185
3
A
Correction to clause 6.2.3
19.2.0
2024-09
SA#105
SP-241213
0188
2
A
Correction to clause 8.3.2.1
19.3.0
2024-09
SA#105
SP-241213
0190
2
A
Correction to Interconnection API publish
19.3.0
2024-09
SA#105
SP-241213
0192
2
A
Correction to Interconnection service API discover
19.3.0
2024-09
SA#105
SP-241217
0194
2
A
Rel-19 Add to Definitions and Abbreviations
19.3.0
2024-09
SA#105
SP-241217
0196
1
A
Rel-19 Correction on Resource owner
19.3.0
2024-09
SA#105
SP-241228
0197
3
F
Update the CAPIF business relationships
19.3.0
2024-12
SA#106
SP-241714
0198
1
F
Rel-19 Correction on Getting Service APIs for CAPIF Interconnection
19.4.0
2024-12
SA#106
SP-241712
0200
3
A
Correction for service API information
19.4.0
2024-12
SA#106
SP-241714
0201
1
B
CAPIF interconnection
19.4.0
2024-12
SA#106
SP-241714
0202
1
B
Update to API invoker Roles in CAPIF
19.4.0
2024-12
SA#106
SP-241714
0203
1
C
Update business relationship for Rel-19
19.4.0
2024-12
SA#106
SP-241714
0205
4
B
Requesting of collective resource owner authorization
19.4.0
2024-12
SA#106
SP-241714
0206
2
B
Finer granularity of access control for service API
19.4.0
2024-12
SA#106
SP-241730
0207
1
F
API discovery update and clarification
19.4.0
2024-12
SA#106
SP-241731
0208
2
F
Align CAPIF API publish and discover with SA3 SNAAPP enhancement
19.4.0
2024-12
SA#106
SP-241714
0209
2
F
Correction of the service API category
19.4.0
2024-12
SA#106
SP-241712
0211
2
A
Resolving ENs without action
19.4.0
2024-12
SA#106
SP-241712
0213
2
A
Resolving ENs adding SA3 references
19.4.0
2024-12
SA#106
SP-241714
0214
2
B
API invoker onboarding
19.4.0
2024-12
SA#106
SP-241712
0216
2
A
Adding invocation latency
19.4.0
2024-12
SA#106
SP-241712
0218
1
A
API invoker obtaining authorization from resource owner
19.4.0
2024-12
SA#106
SP-241712
0220
1
A
Terminology alignment: authorization vs consent
19.4.0
2024-12
SA#106
SP-241714
0221
2
B
API invoker split into frontend and backend components
19.4.0
2024-12
SA#106
SP-241712
0225
1
A
R19_Correction of Update API invoker’s API list
19.4.0
2024-12
SA#106
SP-241714
0226
2
B
Enhancement to API invoker Authorization with the Purpose of Data Processing
19.4.0
2024-12
SA#106
SP-241714
0227
2
B
Enhancement to API invoker Authorization with the Purpose of Data Processing
19.4.0
2024-12
SA#106
SP-241714
0228
2
B
Exposure of User Sensitive Information
19.4.0
2024-12
SA#106
SP-241714
0230
4
B
UE-deployed API invoker accessing other UEs’ resources of a group
19.4.0
2024-12
SA#106
SP-241714
0231
2
B
Additional CAPIF Interconnection-related requirements
19.4.0
2024-12
SA#106
SP-241714
0232
2
B
Additional RNAA-related requirements
19.4.0
2024-12
SA#106
SP-241714
0233
2
B
Resource owner consent upon service API invocation
19.4.0
2024-12
SA#106
SP-241712
0235
2
A
Clarify user consent storage
19.4.0
2025-03
SA#107
SP-250208
0236
1
B
Updates to RNAA deployments
19.5.0
2025-03
SA#107
SP-250208
0241
1
C
Addition of response elements in the CAPIF procedure in TS23.222
19.5.0
2025-03
SA#107
SP-250208
0243
2
B
Procedure for Revoking Resource Owner Authorization
19.5.0
2025-03
SA#107
SP-250208
0244
3
B
Procedure for CCF Obtaining Resource Owner Authorization
19.5.0
2025-03
SA#107
SP-250208
0248
1
B
Solving ENs on CAPIF interconnection
19.5.0
2025-03
SA#107
SP-250208
0249
3
F
UE accessing resources not owned by that UE
19.5.0
2025-03
SA#107
SP-250208
0251
1
F
Correction to Procedure for API invoker obtaining authorization from resource owner
19.5.0
2025-03
SA#107
SP-250208
0252
3
F
Corrections to UE-access of other UEs’ resources of a group
19.5.0
2025-03
SA#107
SP-250209
0253
1
F
Service API category as discovery policy information
19.5.0
2025-03
SA#107
SP-250208
0254
B
Solving ENs on finer granularity of access control for service API
19.5.0
2025-03
SA#107
SP-250208
0255
2
B
Correction on Revocation on CAPIF interconnection
19.5.0
2025-03
SA#107
SP-250207
0256
2
F
Clarification of the ROF and Authorization Function responsibilities
19.5.0
2025-03
SA#107
SP-250208
0257
3
B
Clarification on resource owner consent upon service API invocation
19.5.0
2025-03
SA#107
SP-250208
0259
2
B
Discover service APIs without onboarding
19.5.0
2025-03
SA#107
SP-250207
0260
2
F
Clarification of the ROF and Authorization Function responsibilities
19.5.0
2025-03
SA#107
SP-250208
0261
2
B
Proposal for AEF instantiation support in CAPIF
19.5.0
2025-03
SA#107
SP-250208
0264
1
F
On mapping of active-inactive API states to SA5 solutions and aligning Service API Information descriptions
19.5.0
2025-03
SA#107
SP-250208
0265
2
B
Group Information Provisioning in CAPIF to support RNAA
19.5.0
2025-06
SA#108
SP-250596
0266
F
23.222 CAPIF_ph3 Correction on AEF type
19.6.0
2025-06
SA#108
SP-250596
0267
1
F
Enhanced AEF Capabilities Description
19.6.0
2025-06
SA#108
SP-250596
0269
1
F
Enhanced the CCF's functional description for service API information
19.6.0
2025-06
SA#108
SP-250596
0271
1
F
Remove the Note in Functional model description to support RNAA
19.6.0
2025-06
SA#108
SP-250596
0272
1
F
Remove the limitation in the introduction section of the RNAA architectural requirements
19.6.0
2025-06
SA#108
SP-250596
0277
3
F
Correction to update API invoker’s API list
19.6.0
2025-06
SA#108
SP-250596
0278
1
F
Corrections to RNAA deployments
19.6.0
2025-06
SA#108
SP-250617
0280
1
A
Correction to Preconditions of nested API authorization
19.6.0
2025-06
SA#108
SP-250594
0281
1
F
Correction to access control policy
19.6.0
2025-06
SA#108
SP-250596
0282
2
F
CCF obtaining RO authorization information
19.6.0
2025-06
SA#108
SP-250596
0283
3
F
Correction on Revocation on CAPIF interconnection
19.6.0
2025-06
SA#108
SP-250596
0284
3
F
AEF1 interaction with CCF for token exchange
19.6.0
2025-06
SA#108
SP-250596
0285
2
F
Solving ENs on UE accessing resources not owned by that UE
19.6.0
2025-06
SA#108
SP-250596
0286
2
F
Solving ENs on UE-accessing other UEs’ resources of a group
19.6.0
2025-06
SA#108
SP-250596
0287
1
F
Correction on Obtain service API authorization for RNAA
19.6.0
2025-06
SA#108
SP-250596
0288
4
F
Correction on Obtain service API authorization (without RNAA)
19.6.0
2025-06
SA#108
SP-250596
0290
2
F
Group context information
19.6.0
2025-06
SA#108
SP-250596
0291
1
F
Open Discover API name and service operation
19.6.0
2025-06
SA#108
SP-250596
0292
3
F
Onboarding procedure clarifications
19.6.0
2025-06
SA#108
SP-250596
0294
1
F
Correction to clause 8.35
19.6.0
2025-06
SA#108
SP-250596
0303
1
F
Enhanced API invoker obtaining authorization for service API access in CAPIF interconnection
19.6.0
2025-06
SA#108
SP-250596
0304
F
Enhanced obtaining security information in CAPIF interconnection
19.6.0
2025-06
SA#108
SP-250596
0305
1
F
Enhanced Open Service API discover Procedure
19.6.0
2025-06
SA#108
SP-250596
0306
F
Enhanced retrieve service APIs for CAPIF interconnection
19.6.0
2025-06
SA#108
SP-250596
0307
2
F
Revocation of authorization
19.6.0
2025-06
SA#108
SP-250596
0308
2
F
API invoker identity
19.6.0
2025-06
SA#108
SP-250596
0309
1
F
Completion of RNAA functional model
19.6.0
2025-06
SA#108
SP-250596
0310
1
F
Obtaining collective authorization
19.6.0
2025-09
SA#109
SP-251052
0314
1
F
Proposal for AEF instantiation support in CAPIF
19.7.0
2025-09
SA#109
SP-251066
0315
2
F
Corrections to Revocation of authorization
19.7.0
2025-09
SA#109
SP-251052
0316
1
F
Solving ENs on granularity of service authorization
19.7.0
2025-09
SA#109
SP-251052
0317
1
F
Charging the invocation of service APIs
19.7.0
2025-09
SA#109
SP-251052
0318
1
F
Solving Editor’s Note on Open Discovery
19.7.0
2025-09
SA#109
SP-251052
0319
1
F
Solving Editor’s Notes on CAPIF interconnection
19.7.0
2025-09
SA#109
SP-251052
0320
1
F
Solving Editor’s Notes on Resource Owner authorization
19.7.0
2025-09
SA#109
SP-251052
0321
2
F
Solving ENs in authorization related to network slice
19.7.0
2025-09
SA#109
SP-251052
0322
1
F
Completion of authorization revocation
19.7.0
2025-09
SA#109
SP-251052
0323
1
F
Solving ENs on client-side service authorization and API invoker roles
19.7.0
|
235ff1c5a6dec6f988ef6afae94ebbde | 23.228 | 1 Scope
| This document defines the stage-2 service description for the IP Multimedia Core Network Subsystem (IMS), which includes the elements necessary to support IP Multimedia (IM) services. ITU‑T Recommendation I.130 [4] describes a three-stage method for characterisation of telecommunication services and ITU‑T Recommendation Q.65 [3] defines stage 2 of the method.
This document does not cover the Access Network functionality except as they relate to provision of IM services, these aspects are covered in the normative Annexes.
This document identifies the mechanisms to enable support for IP multimedia applications. In order to align IP multimedia applications wherever possible with non-3GPP IP applications, the general approach is to adopt non-3GPP specific IP based solutions.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.