hash
stringlengths 32
32
| doc_id
stringlengths 5
12
| section
stringlengths 4
595
| content
stringlengths 0
6.67M
|
|---|---|---|---|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.15.3 Procedure
|
Figure 8.15.3-1 illustrates the procedure for authentication of the API invoker by the AEF, where the authentication information is carried in the API invocation request.
Pre-conditions:
1. Optionally, the CAPIF core function has shared the information required for authentication of the API invoker with the AEF.
Figure 8.15.3-1: Procedure for authentication between the API invoker and the AEF upon the service API invocation
1. The API invoker invokes a service API invocation request with authentication information to the AEF, and includes in this request authentication information, including the API invoker identity.
2. The AEF obtains the API invoker information required for authentication by the AEF, if not available.
3. The AEF verifies the identity of the API invoker and authenticates the API invoker.
NOTE 1: The authentication process is specified in subclause 6.5.2 of 3GPP TS 33.122 [12].
4. If the verification was successful, the AEF returns the result of the service API invocation in the Service API invocation response.
NOTE 2: The authentication is terminated at the AEF acting as the service communication entry point when topology hiding is enabled for the service API.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.16 Service API invocation with AEF authorization
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.16.1 General
|
The procedure in this subclause corresponds to the architectural requirements to validate authorization of API invokers upon the service API invocation.
To reduce latency during API invocation, the API invoker associated authorization information can be made available at the AEF after authentication between the API invoker and the CAPIF core function.
NOTE: The security aspects of service API invocation are specified in TS 33.122 [12] clause 6.4 (CAPIF-2) and 6.5 (CAPIF-2e).
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.16.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.16.2.1 Service API invocation request
|
The information flow service API invocation request from the API invoker to the AEF is service API specific and the complete detail of the service API invocation request is out of scope of the present document. Table 8.16.2.1-1 describes only the CAPIF related information elements which are included in the service API invocation request.
Table 8.16.2.1-1: Service API invocation request
Information element
Status
Description
API invoker identity information
M
The information that determines the identity of the API invoker
Authorization information
O
(see NOTE)
The authorization information obtained before initiating the service API invocation request
Network Slice Info
O
(see NOTE)
The desired network slice information of the service API
Service API identification
M
The identification information of the service API for which invocation is requested. The service API identification is part of the specific service API invocation request.
NOTE: The inclusion of this information element depends on the chosen solution for authorization.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.16.2.2 Service API invocation response
|
The information flow service API invocation response from the AEF to the API invoker is service API specific and the complete detail of the service API invocation response is out of scope of the present document. Table 8.16.2.2-1 describes only the CAPIF related information elements which are included in the service API invocation response.
Table 8.16.2.2-1: Service API invocation response
Information element
Status
Description
Result
M
Indicates the success or failure of service API invocation.
Authorization information with resource owner required
O
This information element may be present when the result is failure. Indicates that the required authorization information with resource owner is required.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.16.3 Procedure
|
Figure 8.16.3-1 illustrates the procedure for API invoker authorization to access service APIs.
Pre-conditions:
1. The API invoker has been authenticated.
2. The API invoker associated authorization information is available at AEF.
Figure 8.16.3-1: Procedure for API invoker authorization to access service APIs
1. The API invoker triggers service API invocation request to the AEF, including the service API to be invoked.
NOTE 1: Authentication can also be performed if not authenticated previously.
NOTE 2: The API invoker can trigger several service API invocations asynchronously.
2. Upon receiving the service API invocation request, the AEF checks whether the API invoker is authorized to invoke that service API, based on the authorization information.
2a. If the AEF does not have information required to authorize service API invocation, the AEF obtains the authorization information from the CAPIF core function.
3. The AEF executes the service logic for the invoked service API.
4. The API invoker receives the service API invocation response as a result of the service API invocation. If in step 2, the AEF determines that the required resource owner authorization information is not available for the requested service API, then the AEF responds to API Invoker with failure status message indicating that the authorization information with resource owner is not available, as specified in Table 8.16.2.2-1.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.17 CAPIF access control
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.17.1 General
|
The CAPIF controls the access of service API by the API invoker based on policy or usage limits.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.17.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.17.2.1 Service API invocation request
|
The information flow service API invocation request from the API invoker to the AEF is service API specific and the complete detail of the service API invocation request is out of scope of the present document. Table 8.17.2.1-1 describes only the CAPIF related information elements which are included in the service API invocation request.
Table 8.17.2.1-1: Service API invocation request
Information element
Status
Description
API invoker identity information
M
The information that determines the identity of the API invoker
Authorization information
O
(see NOTE)
The authorization information obtained before initiating the service API invocation request
Service API identification
M
The identification information of the service API for which invocation is requested. The service API identification is part of the specific service API invocation request.
NOTE: The inclusion of this information element depends on the chosen solution for authorization.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.17.2.2 Service API invocation response
|
The information flow service API invocation response from the AEF to the API invoker is service API specific and the complete detail of the service API invocation response is out of scope of the present document. Table 8.17.2.2-1 describes only the CAPIF related information elements which are included in the service API invocation response.
Table 8.17.2.2-1: Service API invocation response
Information element
Status
Description
Result
M
Indicates the success or failure of service API invocation.
Cause
O
The cause for the request failure.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.17.3 Procedure
|
Figure 8.17.3-1 illustrates the procedure for service API access control.
Pre-conditions:
1. The API invoker has performed the service API discovery and received the details of the service API which includes the information about the service communication entry point of the AEF in the CAPIF.
2. The API invoker is authenticated and authorized to use the service API.
3. The AEF in the CAPIF is configured with at least one access policy to be applied to the service API invocation corresponding to the API invoker and service API.
Figure 8.17.3-1: Procedure for service API access control
1. The API invoker performs service API invocation according to the interface of the service API by sending a service API invocation request towards the AEF which exposes the service API towards the API invoker. The AEF acts as an access control entity.
2. If the access control policy is not configured with AEF, then the AEF may obtain the access control policy configuration from the CAPIF core function.
3. Upon receiving the service API invocation request from the API invoker, the AEF checks for configuration for access control. As per the configuration for access control, the AEF performs access control on the service API invocation request as per the operator policy.
4. The API invoker receives a service API invocation response for service API invocation from the AEF providing the service API.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.18 CAPIF access control with cascaded AEFs
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.18.1 General
|
The procedure in this subclause corresponds to the architectural requirements related to some common access control requirements for service API invocations. It provides access control, based on two cascaded API Exposing Function (AEF) instances. While one AEF instance provides the entry point for the service API and acts as access controller, further AEF instances deliver the functionality of the actual service APIs.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.18.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.18.2.1 Service API invocation request
|
The information flow service API invocation request from the API invoker to the AEF and between AEFs is service API specific and the complete detail of the service API invocation request is out of scope of the present document. Table 8.17.2.1-1 describes the CAPIF related information elements which are included in the service API invocation request.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.18.2.2 Service API invocation response
|
The information flow service API invocation response from the AEF to the API invoker and between AEFs is service API specific and the complete detail of the service API invocation response is out of scope of the present document. Table 8.17.2.2-1 describes the CAPIF related information elements which are included in the service API invocation response.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.18.3 Procedure
|
Figure 8.18.3-1 illustrates the procedure for CAPIF access control.
Pre-conditions:
1. The API invoker has performed the service discovery and received the details of the service API which includes the information about the service communication entry point of the AEF-1 in the CAPIF.
2. The API invoker is authenticated and authorized to use the service API.
3. The AEF-1 in the CAPIF is configured with at least one access policy to be applied to the service API invocation corresponding to the API invoker and service API.
Figure 8.18.3-1: Procedure for CAPIF access control with cascaded AEFs
1. The API invoker performs service API invocation according to the interface of the service API by sending a service API invocation request towards the AEF-1 which exposes the service API towards the API invoker, and acts as access control entity.
2. Upon receiving the service API invocation request from the API invoker, the AEF-1 checks for configuration for access control. As per the configuration for access control, the AEF-1 performs access control on the service API invocation as per the operator policy.
3. The AEF-1 forwards the incoming service API invocation request to the service API provided by AEF-2.
4. The AEF-1 receives a service API invocation response for service API invocation from AEF-2.
5. The AEF-1 resolves the destination API invoker address and modifies the source address information of AEF-2 within the service API invocation response and forwards the service API invocation response to the API invoker.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.19 Logging service API invocations
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.19.1 General
|
The procedure in this subclause corresponds to the architectural requirements for logging service API invocations at AEF. The AEF can be within PLMN trust domain or within 3rd party trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.19.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.19.2.1 API invocation log request
|
Table 8.19.2.1-1 describes the information flow API invocation log request from the API exposing function to the CAPIF core function.
Table 8.19.2.1-1: API invocation log request
Information element
Status
Description
API exposing identity information
M
Identity information of the AEF logging service API(s) invocations
API invocation log information
M
API invocation log information such as API invoker's ID, IP address, service API name, version, invoked operation, input parameters, invocation result, time stamp information, Network Slice Info, invocation latency (the time interval between the reception of the API invocation request and the sending of the API invocation response at the AEF)
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.19.2.2 API invocation log response
|
Table 8.19.2.2-1 describes the information flow API invocation log response from the CAPIF core function to the API exposing function.
Table 8.19.2.2-1: API invocation log response
Information element
Status
Description
Result
M
Indicates the success or failure of API(s) invocation log request
Cause
O
The cause for the request failure.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.19.3 Procedure
|
Figure 8.19.3-1 illustrates the procedure for logging service API invocations at AEF.
Pre-conditions:
1. The API invoker(s) has invoked certain service API(s).
2. Authorization details of the AEF are available with the CAPIF core function.
Figure 8.19.3-1: Procedure for logging service API invocations
1. Upon invocation of service API(s) from one more API invokers, the AEF triggers API invocation log request towards the CAPIF core function.
NOTE 1: The AEF can collect the log information associated to several API invocations before triggering API invocation log request asynchronously.
2. The CAPIF core function makes a log entry and stores the information e.g. for charging purposes, for access by authorized users and entities.
NOTE 2: API invocation log is stored for a configured duration.
3. AEF receives the API invocation log response from the CAPIF core function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.20 Charging the invocation of service APIs
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.20.1 General
|
The procedure in this subclause corresponds to the architectural requirements for charging the invocation of service APIs. The AEF can be within PLMN trust domain or within 3rd party trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.20.2 Information flows
|
NOTE: It is in SA5 scope to develop the charging related information flows for this procedure.
Editor's note: Reference to the appropriate SA5 specification is needed.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.20.3 Procedure
|
Figure 8.20.3-1 illustrates the procedure for charging the invocation of service APIs.
Pre-conditions:
1. Authorization details of the AEF are available with the CAPIF core function.
Figure 8.20.3-1: Procedure for charging the invocation of service APIs
1. Upon invocation of service API(s) from one more API invokers, the AEF triggers an API invocation charging request and includes API invoker information (e.g. invoker's ID and IP address, location, timestamp) and service API information (e.g. service API name and version, invoked operation, input parameters, invocation result), Network Slice Info of the service API towards the CAPIF core function.
NOTE: These requests can be triggered asynchronously.
2. The CAPIF core function performs a charging procedure which includes storing the information for access by authorized API management.
3. The AEF receives the API invocation charging response from the CAPIF core function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.21 Monitoring service API invocation
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.21.1 General
|
The procedure in this subclause corresponds to the architectural requirements for monitoring service API invocation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.21.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.21.2.1 Monitoring service API event notification
|
The information flow for the monitoring service API event notification from the CAPIF core function to the API management function is same as the event notification from the CAPIF core function to the subscribing entity. Table 8.8.2.3-1 describes the information elements which are included in the monitoring service API event notification.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.21.2.2 Monitoring service API event notification acknowledgement
|
The information flow for the monitoring service API event notification acknowledgement from the API management function to the CAPIF core function is same as the event notification acknowledgement from subscribing entity to the CAPIF core function. Table 8.8.2.4-1 describes the information elements which are included in the monitoring service API event notification acknowledgement.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.21.3 Procedure
|
Figure 8.21.3-1 illustrates the procedure for monitoring service API invocation.
Pre-conditions:
1. The API management function has subscribed to monitoring event including filters such as invoker's ID and IP address, service API name and version, input parameters, and invocation result.
Figure 8.21.3-1: Procedure for monitoring service API invocation
1. The CAPIF core function monitors the service API invocations applying the monitoring filters specified before.
2. Detection of a monitoring event by the CAPIF core function triggers notification to the API management function with the details of the monitored event.
NOTE: API provider action subsequent to monitoring service API notification is out-of-scope of this specification.
3. The API management function sends a monitoring service API event notification acknowledgement to the CAPIF core function for the notification received.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.22 Auditing service API invocation
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.22.1 General
|
The procedure in this subclause corresponds to the architectural requirements for auditing service API invocation. This procedure can be used for auditing of other CAPIF interactions i.e. service API invocation events, API invoker onboarding events and API invoker interactions with the CAPIF (e.g. authentication, authorization, discover service APIs) as well. The API management function can be within PLMN trust domain or within 3rd party trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.22.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.22.2.1 Query service API log request
|
Table 8.22.2.1-1 describes the information flow query service API log request from the API management function to the CAPIF core function.
Table 8.22.2.1-1: Query service API log request
Information element
Status
Description
Identity information
M
Identity information of the entity querying service API log request
Query information
M
List of query filters such as invoker's ID and IP address, service API name and version, input parameters, and invocation result
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.22.2.2 Query service API log response
|
Table 8.22.2.2-1 describes the information flow query service API log response from the CAPIF core function to the API management function.
Table 8.22.2.2-1: Query service API log response
Information element
Status
Description
Result
M
Indicates the success or failure of query service API log request
API invocation log information
O
(see NOTE)
API invocation log information such as API invoker's ID, IP address, service API name, version, invoked operation, input parameters, invocation result, time stamp information, Network Slice Info
NOTE: Information element shall be present when result indicates success.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.22.3 Procedure
|
Figure 8.22.3-1 illustrates the procedure for auditing service API invocation.
Pre-conditions:
1. Service API invocation logs are available at the CAPIF core function.
2. Authorization details of the AMF are available with the CAPIF core function.
Figure 8.22.3-1: Procedure for auditing service API invocation
1. For auditing service API invocations, the API management function triggers query service API log request to the CAPIF core function.
2. Upon receiving the query service API log request, the CAPIF core function accesses the necessary service API log information for auditing purposes.
3. The CAPIF core function returns the log information to the API management function in the query service API log response.
NOTE: The API management function detecting abuse of the service API invocation and actions, subsequent to query service API log response, are out-of-scope of this specification.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.23 CAPIF revoking API invoker authorization
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.23.1 General
|
The CAPIF controls the access of service API by the API invoker based on policy or usage limits. If the usage limits have exceeded, the authorization of the API invoker for accessing the service APIs is revoked. The decision to revoke the API invoker authorization may be triggered by the AEF or the CAPIF core function. The AEF can be within PLMN trust domain or within 3rd party trust domain.
In RNAA scenarios, the decision to revoke the API invoker authorization may be initiated by the CAPIF core function based on triggers at the CAPIF core function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.23.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.23.2.1 Revoke API invoker authorization request
|
Table 8.23.2.1-1 describes the information flow revoke API invoker authorization request from the API exposing function to the CAPIF core function or from the CAPIF core function to the API exposing function.
Table 8.23.2.1-1: Revoke API invoker authorization request
Information element
Status
Description
API invoker identity information
M
The information that determines the identity of the API invoker
Service API identification
M
The identification information of the service API for which the authorization is revoked.
Cause
M
The cause for revoking the API invoker authorization
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.23.2.2 Revoke API invoker authorization response
|
Table 8.23.2.2-1 describes the information flow revoke API invoker authorization response from the CAPIF core function to the API exposing function or from the API exposing function to the CAPIF core function.
Table 8.23.2.2-1: Revoke API invoker authorization response
Information element
Status
Description
Result
M
Indicates the success or failure of revoke API invoker authorization.
Cause
O
The cause for the request failure.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.23.2.3 Revoke API invoker authorization notify
|
Table 8.23.2.3-1 describes the information flow revoke API invoker authorization notify from the CAPIF core function to the API invoker.
Table 8.23.2.3-1: Revoke API invoker authorization notify
Information element
Status
Description
API invoker identity information
M
The information that determines the identity of the API invoker whose authorization has been revoked
Service API identification
M
The identification information of the service API for which the authorization is revoked.
Cause
M
The cause for revoking the API invoker authorization
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.23.3 Procedure for CAPIF revoking API invoker authorization initiated by AEF
|
Figure 8.23.3-1 illustrates the procedure for revoking API invoker authorization to access service API initiated by the AEF.
Pre-conditions:
1. The API invoker is authenticated and authorized to use the service API.
2. The AEF in the CAPIF is configured with the access policy to be applied to the service API invocation corresponding to the API invoker and the service API.
3. Authorization details of the AEF are available with the CAPIF core function.
Figure 8.23.3-1: Procedure for revoking API invoker authorization initiated by AEF
1. The AEF triggers the revocation of the API invoker authorization.
2. The AEF sends revoke API invoker authorization request to the CAPIF core function with the details of the API invoker and the service API.
3. Upon receiving the information to revoke the API invoker's authorization for service API invocation, the CAPIF core function invalidates the API invoker authorization corresponding to the service API.
4. The CAPIF core function sends a revoke API invoker authorization response to the AEF.
5. Upon successful revocation of API invoker authorization corresponding to the service API at the CAPIF core function, the AEF invalidates the API invoker authorization corresponding to the service API.
6. The CAPIF core function sends a revoke API invoker authorization notify to the API invoker whose authorization to access the service API has been revoked.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.23.4 Procedure for CAPIF revoking API invoker authorization initiated by CAPIF core function
|
Figure 8.23.4-1 illustrates the procedure for revoking API invoker authorization to access service API initiated by the CAPIF core function. This procedure is also used for revoking API invoker authorization supporting RNAA scenarios.
Pre-conditions:
1. The API invoker is authenticated and authorized to use the service API.
2. The AEF in the CAPIF is configured with the access policy to be applied to the service API invocation corresponding to the API invoker and the service API.
Figure 8.23.4-1: Procedure for revoking API invoker authorization initiated by CAPIF core function
1. The CAPIF core function is triggered to revoke the API invoker authorization.
2. The CAPIF core function sends revoke API invoker authorization request to the AEF with the details of the API invoker and the service API.
3. Upon receiving the information to revoke the API invoker's authorization for service API invocation, the AEF invalidates the API invoker authorization corresponding to the service API.
4. The AEF sends a revoke API invoker authorization response to the CAPIF core function.
5. The CAPIF core function invalidates the API invoker authorization corresponding to the service API.
6. The CAPIF core function sends a revoke API invoker authorization notify to the API invoker whose authorization to access the service API has been revoked.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.24 API topology hiding management
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.24.1 General
|
The following procedure in this subclause corresponds to the architectural requirements on API topology hiding. The procedure in this subclause supports API topology hiding by dynamically configuring the address of the AEF providing the Service API to the AEF entry point providing the topology hiding. The API publishing function and the API exposing function can be within PLMN trust domain or within 3rd party trust domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.24.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.24.2.1 API topology hiding notify
|
Table 8.24.2.1-1 describes the information flow API topology hiding notify from the CAPIF core function to the API exposing function.
Table 8.24.2.1-1: API topology hiding notify
Information element
Status
Description
Service API identification
M
The identification information of the service API with the API topology hiding
API exposing function(s) information
M
Indicates the one or more AEF(s) which provides the service API to apply the topology hiding including the interface details (e.g. IP address, port number, URI).
Action
M
Indicates the notification action for the API topology hiding (created or revoked).
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.24.3 Procedure
|
Figure 8.24.3-1 illustrates the procedure for API topology hiding management by API (un)publish function.
Pre-condition:
1. Authorization details of the APF are available with the CAPIF core function.
2. The API exposing function has subscribed to CAPIF event for API topology hiding status.
Figure 8.24.3-1: API topology hiding via API (un)publish
1. The API publishing function sends a service API publish request as described in subclause 8.3.2.1 or a service API unpublish request as described in subclause 8.4.2.1 to the CAPIF core function.
2. Upon receiving the service API (un)publish request, the CAPIF core function checks whether the API publishing function is authorized to perform the service API (un)publish. If authorized, based on the service APIs and policy:
- For service API publish, the CCF applies the topology hiding by selecting an AEF providing the topology hiding as the entry point for service API invocation. The selected AEF information is stored with the service API information received from API publish function at the CAPIF core function (API registry).
- For service API unpublish, the previously selected AEF as topology hiding entry point and the associated service API information at the CAPIF core function (API registry) are removed.
3. The CCF sends the API topology notify to the AEF selected as the entry point for service API invocation. The service API identification and the AEF(s) information which provides the service API details are included.
4. Upon receiving the notification, the AEF stores the received information for further service API invocation request forwarding if the action in the API topology notify indicates "created" or removes the stored API forwarding information if the action in the API topology notify indicates "revoked".
5. The CCF sends an API (un)publish response to the API publish function.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25 Support for CAPIF interconnection
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.1 General
|
The procedures in this subclause corresponds to the architectural requirements on CAPIF interconnection.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.1 Interconnection API publish request
|
Table 8.25.2.1-1 describes the information flow interconnection API publish request from CAPIF core function to CAPIF core function.
Table 8.25.2.1-1: Interconnection API publish request
Information element
Status
Description
CCF information
M
The information of the CAPIF core function which publishes APIs, may include identity, authentication and authorization information
Service API information
O
(see NOTE 1)
The service API information as specified in Table 8.3.2.1-1.
Service API category
O
Service API category.
Shareable information
O
(see NOTE 2)
Indicates whether the service API information or the service API category can be published to other CCFs. And if sharing, a list of CAPIF provider domain information where the service API information or the service API category can be published is contained.
NOTE 1: Either the Service API information or Service API category shall be present.
NOTE 2: If the shareable information is not present, the service API information is not allowed to be shared. There is one and only one CAPIF provider domain information sharable via the CAPIF-6e interface.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.2 Interconnection API publish response
|
Table 8.25.2.2-1 describes the information flow interconnection API publish response from CAPIF core function to CAPIF core function.
Table 8.25.2.2-1: Interconnection API publish response
Information element
Status
Description
Result
M
Indicates the success or failure of publishing the service API information
Cause
O
The cause for the request failure.
Service API published information reference
O
(see NOTE)
The information which can be used for referencing the information (set) about the published service API by the CCF which publishes service APIs
NOTE: This information element is included when the Result indicates success.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.3 Interconnection service API discover request
|
Table 8.25.2.3-1 describes the information flow interconnection service API discover request from one CAPIF core function to another CAPIF core function.
Table 8.25.2.3-1: Interconnection service API discover request
Information element
Status
Description
CAPIF core function identity information
M
Identity information of the CAPIF core function discovering service APIs
Query information
M
Criteria for discovering matching service APIs or CAPIF core function (e.g. service API category, Serving Area Information (optional), UE IP address (optional), preferred AEF location (optional), required API provider name (optional), interfaces, protocols, Service KPIs (optional), and Network Slice Info (optional))
(see NOTE)
NOTE: It should be possible to discover all the service APIs.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.4 Interconnection service API discover response
|
Table 8.25.2.4-1 describes the information flow interconnection service API discover response from one CAPIF core function to another CAPIF core function.
Table 8.25.2.4-1: Interconnection service API discover response
Information element
Status
Description
Result
M
Indicates the success or failure of the discovery of the service API information
Cause
O
The cause for the request failure.
Service API information
O
(see NOTE)
List of service APIs corresponding to the request, including service API information as specified in Table 8.7.2.2-1.
CAPIF core function identity information
O
(see NOTE)
Indicates the CAPIF core function matching the query criteria.
NOTE: The service API information or the CAPIF core function identity information or both shall be present, if the Result information element indicates that the interconnection service API discover operation is successful. Otherwise, both shall not be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.5 Interconnection API unpublish request
|
Table 8.25.2.5-1 describes the information flow interconnection API unpublish request from a CAPIF core function to another CAPIF core function.
Table 8.25.2.5-1: Interconnection API unpublish request
Information element
Status
Description
CCF information
M
The information of the CAPIF core function which unpublishes service APIs, may include identity, authentication and authorization information
Service API published information reference (see NOTE)
M
The information which can be used for referencing the information (set) about the published service API by the CCF which publishes service APIs
NOTE: Obtained during the interconnection API publish procedure in clause 8.25.3.1.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.6 Interconnection API unpublish response
|
Table 8.25.2.6-1 describes the information flow interconnection API unpublish response from a CAPIF core function to another CAPIF core function.
Table 8.25.2.6-1: Interconnection API unpublish response
Information element
Status
Description
Result
M
Indicates the success or failure of unpublishing the service API information
Cause
O
The cause for the request failure.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.7 Interconnection get service API request
|
Table 8.25.2.7-1 describes the information flow interconnection get service API request from a CAPIF core function to another CAPIF core function.
Table 8.25.2.7-1: Interconnection get service API request
Information element
Status
Description
CCF information
M
The information of the CAPIF core function that wants to retrieve service APIs information. It may include identity, authentication and authorization information
Service API published information reference (see NOTE)
M
The information which can be used for referencing the information (set) about the published service API by the CCF which publishes service APIs
NOTE: Obtained during the interconnection API publish procedure in clause 8.25.3.1.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.8 Interconnection get service API response
|
Table 8.25.2.8-1 describes the information flow interconnection get service API response from a CAPIF core function to another CAPIF core function.
Table 8.25.2.8-1: Interconnection get service API response
Information element
Status
Description
Result
M
Indicates the success or failure of getting the service API information.
Cause
O
The cause for the request failure.
Service API information
O
(see NOTE)
The service API information as specified in Table 8.3.2.1-1.
NOTE: Shall be present if the Result information element indicates that the interconnection get service API request is successful. Otherwise, service API information shall not be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.9 Interconnection update service API request
|
Table 8.25.2.9-1 describes the information flow interconnection update service API request from a CAPIF core function to another CAPIF core function.
Table 8.25.2.9-1: Interconnection update service API request
Information element
Status
Description
CCF information
M
The information of the CCF requesting the update operation. It may include identity, authentication and authorization information.
Service API information
O
(see NOTE 1)
The service API information as specified in Table 8.3.2.1-1.
Service API category
O
(see NOTE 1)
The category of the service APIs to be published, (e.g. V2X, IoT).
Shareable information
O
(see NOTE 2)
Indicates whether the service API information or the service API category can be published to other CCFs. And if sharing, a list of CAPIF provider domain information where the service API information or the service API category can be published is contained.
NOTE 1: Either the Service API information or Service API category shall be present.
NOTE 2: If the shareable information is not present, the service API information is not allowed to be shared. There is one and only one CAPIF provider domain information sharable via the CAPIF-6e interface.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.10 Interconnection update service API response
|
Table 8.25.2.10-1 describes the information flow interconnection update service API response from a CAPIF core function to another CAPIF core function.
Table 8.25.2.10-1: Interconnection update service API response
Information element
Status
Description
Result
M
Indicates the success or failure of updating the service API information
Cause
O
The cause for the request failure.
Service API information
O
The authorized service API information during update, applicable when the update result is success. This can be a subset or the full set, of the Service API information as specified in Table 8.3.2.1-1.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.11 Interconnection revoke API invoker authorization request
|
Table 8.25.2.11-1 describes the information flow interconnection revoke API invoker authorization request from one CCF to another CCF.
Table 8.25.2.11-1: Interconnection revoke API invoker authorization request
Information element
Status
Description
CCF information
M
The information of the requesting CAPIF core function, may include identity, authentication and authorization information.
Service API identification
M
The identification information of the service API for which the authorization is revoked.
Cause
M
The cause for revoking the API invoker authorization
Editor's note: It is FFS whether additional IEs need to be included e.g. API invoker information based on SA3 progress on RNAA authorization token revocation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.12 Interconnection revoke API invoker authorization response
|
Table 8.25.2.12-1 describes the information flow interconnection revoke API invoker authorization response from one CCF to another CCF.
Table 8.25.2.12-1: Interconnection revoke API invoker authorization response
Information element
Status
Description
Result
M
Indicates the success or failure of interconnection revoke API invoker authorization.
Cause
O
The cause for the request failure.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.13 Interconnection revoke API invoker authorization notify
|
Table 8.25.2.13-1 describes the information flow interconnection revoke API invoker authorization notify from one CCF to another CCF.
Table 8.25.2.13-1: Interconnection revoke API invoker authorization notify
Information element
Status
Description
CCF information
M
The information of the notifying CAPIF core function, may include identity, authentication and authorization information.
Service API identification
M
The identification information of the service API for which the authorization is revoked.
Cause
M
The cause for revoking the API invoker authorization
Editor's note: It is FFS whether additional IEs need to be included (e.g. API invoker information) based on SA3 progress on RNAA authorization token revocation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.14 Interconnection obtain access control policy request
|
Table 8.25.2.14-1 describes the information flow interconnection obtain access control policy request from one CCF to another CCF.
Table 8.25.2.14-1: Interconnection obtain access control policy request
Information element
Status
Description
Identity information
M
Identity information of the entity requesting the access control policy
Service API identification
M
The identification information of the service API for which the access control policy is being requested.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.15 Interconnection obtain access control policy response
|
Table 8.25.2.15-1 describes the information flow interconnection obtain access control policy response from one CCF to another CCF.
Table 8.25.2.15-1: Interconnection obtain access control policy response
Information element
Status
Description
Result
M
Indicates the success or failure of the obtain access control policy operation
Cause
O
The cause for the request failure.
Access control policy information
O (see NOTE)
The access control policy information corresponding to the requested service API. (See Table E-1)
NOTE: Shall be present if the Result information element indicates that the obtain access control policy operation is successful. Otherwise access control policy information shall not be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.16 Interconnection API invoker obtaining authorization to access service API
|
Editor's note: The information exchanged between CCF-B and CCF-A in the interconnection obtain API authorization procedure will be addressed by SA3.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.2.17 Interconnection Authentication and authorization between the API invoker and the AEF
|
Editor's note: The information exchanged between CCF-B and CCF-A in the interconnection to obtain API invoker authentication and authorization procedure will be addressed by SA3.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3 Procedure
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.1 Service API publish for CAPIF interconnection
|
This subclause describes the procedure for service API publish for CAPIF interoperation.
Pre-condition:
1. CCF-A and CCF-B connect to each other, and either belong to the single trust domain of the same CAPIF provider or trust domains of different CAPIF providers.
2. CCF-B is configured as the designated CAPIF core function in the trust domain of CAPIF provider A.
3. When CCF-A and CCF-B belong to trust domains of different CAPIF providers, the two CAPIF providers have business agreement for service API sharing.
Figure 8.25.3.1-1: Interconnection API publish
1. CCF-A gets the service APIs to be shared with CCF-B from the API publish function which is in the same CAPIF provider domain of CCF-A as described in subclause 8.3.3, or from another CCF as described in this procedure.
2. Based on the shareable information for the service API or the service API category information, the CCF-A determines to publish the service API or the service API category information to the CCF-B. The CCF-A sends the interconnection API publish request to CCF-B with the details of at least one of service APIs or the category information of the service APIs, along with the identity information of CCF-A, shareable information and CAPIF provider domain information if allowed to share. The API topology hiding may be enabled.
3. CCF-B stores the service API information or service API category provided by the CCF-A.
4. CCF-B provides an interconnection API publish response to the CCF-A indicating success or failure result and triggers notifications to subscribed API invokers as described in subclause 8.8.4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.2 Service API discovery involving multiple CCFs
|
This subclause describes a procedure for service API discovery involving multiple CCFs
Pre-condition:
1. CCF-A and CCF-B connect to each other, and either belong to the single trust domain of the same CAPIF provider or trust domains of different CAPIF providers.
2. When CCF-A and CCF-B belong to trust domains of different CAPIF providers, the two CAPIF providers have business agreement for service API sharing.
Figure 8.25.3.2-1: Service API discovery involving multiple CCFs
1. The API invoker sends a service API discover request to the CCF-A. It includes the API invoker identity and query information.
2. The CCF-A verifies the identity of the API invoker and retrieves the stored service API(s) information. The information of CCF-B matching the discovery criteria is returned to API invoker in the service API discover response.
NOTE: The remaining steps are only applied when the service API category without detail service API information is included in the interconnection API publish request as described in subclause 8.25.2.1.
3. The API invoker sends an service API discover request to the CCF-B. The identity of API invoker is included. The query information is also provided.
4. Upon receiving the service API discover request, the CCF-B verifies the identity of the API invoker. The CCF-B retrieves the stored service API(s) information as per the query information in the service API discover request. Further, the CCF-B applies the discovery policy and performs filtering of service APIs information which matches the discovery criteria.
5. The CCF-B sends an service API discover response to the API invoker with the list of service API information for which the API invoker has the required authorization.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.3 Service API discovery for CAPIF interconnection
|
This subclause describes a procedure for service API discovery for CAPIF interconnection. The CCF-A and the CCF-B may belong to the same CAPIF provider domain or different CAPIF provider domains. When the CCF-A and the CCF‑B belong to different CAPIF provider domains, the two CAPIF providers shall have business agreement for service API discovery.
Pre-conditions:
1. The CCF-A is configured with the CCF-B information.
2. The CCF-B is configured with the CCF-A information.
3. The CCF-A is triggered (e.g. API invoker service API discovery, periodic service API discovery) to perform service API discovery with the CCF-B.
Figure 8.25.3.3-1: Service API discovery for CAPIF interconnection
1. The CCF-A sends the interconnection service API discover request to the CCF-B. The identity of the CCF-A and the query information are included.
2. The CCF-B upon receiving the interconnection service API discover request verifies the identity of the CCF-A. The CCF-B retrieves the stored service API(s) or the CCF(s) information as per the query information in the interconnection service API discover request. Further, the CCF-B applies the discovery policy and performs the filtering of service APIs or the CCF(s) information. The topology hiding policy may be applied to the retrieved list of service API information.
3. The CCF-B sends the interconnection service API discover response to the CCF-A with the list of service API information for which the CCF-A has the required authorization or the CCF(s) information that matches the discovery criteria.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.4 Service API unpublish for CAPIF interconnection
|
This clause describes the procedure for service API unpublish for CAPIF interconnection.
Pre-condition:
1. CCF-A and CCF-B connect to each other, and either belong to the single trust domain of the same CAPIF provider or trust domains of different CAPIF providers. When CCF-A and CCF-B belong to trust domains of different CAPIF providers, the two CAPIF providers have business agreement for service API sharing.
2. CCF-B is configured as the designated CAPIF core function in the trust domain of CAPIF provider A.
3. CCF-A has successfully published service APIs to the designated CCF (i.e., CCF-B) using the procedure in clause 8.25.3.1.
Figure 8.25.3.4-1: Interconnection API unpublish
1. CCF-A sends an interconnection API unpublish request to CCF-B. The request includes a service API published information reference. If the shareable information IE was present in the interconnection API publish request (see clause 8.25.2.1), the API unpublish request should be forwarded to the provided list of CAPIF provider domain information during the publish procedure.
2. Upon receiving the interconnection API unpublish request, the CCF-B checks whether the CCF-A is authorized to unpublish service APIs. If the check is successful, CCF-B will remove the requested service API information from the API registry.
3. CCF-B sends an interconnection API unpublish response to CCF-A containing the operation result and triggers notifications to subscribed API invokers (if any) as described in subclause 8.8.4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.5 Retrieve service APIs for CAPIF interconnection
|
This clause describes the procedure to retrieve service APIs information in a CAPIF interconnection scenario.
Pre-condition:
1. CCF-A and CCF-B connect to each other, and either belong to the single trust domain of the same CAPIF provider or trust domains of different CAPIF providers. When CCF-A and CCF-B belong to trust domains of different CAPIF providers, the two CAPIF providers have business agreement for service API sharing.
2. CCF-B is configured as the designated CAPIF core function in the trust domain of CAPIF provider A.
Figure 8.25.3.5-1: Retrieve service APIs for CAPIF interconnection
1. CCF-A sends an interconnection get service API request to CCF-B with service API published information reference provided by the CAPIF core function when the service API was published.
2. Upon receiving interconnection get service API request, CCF-B checks whether CCF-A is authorized to get the published service APIs information. If the check is successful, the corresponding service API information is retrieved from the CAPIF core function (API registry).
3. CCF-B sends a service API get response to CCF-A which includes the requested service API information if the retrieval operation was successful.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.6 Update service APIs for CAPIF interconnection
|
Figure 8.25.3.6-1 illustrates the procedure for updating the published service APIs information by a CAPIF core function.
Pre-conditions:
1. CCF-A and CCF-B connect to each other, and either belong to the single trust domain of the same CAPIF provider or trust domains of different CAPIF providers. When CCF-A and CCF-B belong to trust domains of different CAPIF providers, the two CAPIF providers have business agreement for service API sharing.
2. CCF-B is configured as the designated CAPIF core function in the trust domain of CAPIF provider A.
Figure 8.25.3.6-1: Update service APIs for CAPIF interconnection
1. The CCF-A sends an interconnection update service API request to the CCF-B, including the information in table 8.25.2.9-1.
2. Upon receiving the interconnection update service API request, the CCF-B checks whether the CCF-A is authorized to update the published service APIs information. If the check is successful, the service API information provided by the CCF-A is updated at the CCF-B (API registry).
3. The CCF-B provides an interconnection update service API response to the CCF-A containing the result of the update operation and triggers notifications to subscribed API invokers (if any) as described in subclause 8.8.4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.7 API invoker obtaining authorization for service API access in CAPIF interconnection
|
Pre-condition:
1. The API invoker has discovered service APIs provided by an AEF via procedure defined in step 1 and 2 of clause 8.25.3.2.
2. The API invoker and the CCF-B are in the same trusted domain.
3. The AEF and the CCF-A are in the same trusted domain.
4. The CCF-A and the CCF-B are connected to each other, and they have business agreement for service API authorization.
5. The CCF-A is the authorization function for service API access on the AEF.
Figure 8.25.3.7-1: Procedure for the API invoker obtaining authorization for service API access
1. The API invoker sends an obtain service API authorization request to the CCF-B for obtaining permission to access the service API by including the API invoker identity information and any information required for authentication of the API invoker.
2. After successful authentication validation of the API invoker, if the CCF-B determines that the service API access authorization cannot be done by itself alone, then the CCF-B sends an interconnection obtain API authorization from the CCF-A.
3. The authorization information to access the service APIs is sent to the API invoker in the obtain service API authorization response.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.8 Procedure for CAPIF revoking API invoker authorization in CAPIF interconnection
|
Pre-conditions:
1. The CCF-A is triggered to revoke API invoker authorization for service API access.
Figure 8.25.3.8-1: Procedure for revoking API invoker authorization in CAPIF interconnection
1. If the CCF-B performed service API authorization, the CCF-A sends an interconnection revoke API invoker authorization request to the CCF-B with the details of the API invoker, the AEF and the service API.
2. Upon receiving the information to revoke the API invoker's authorization for service API invocation, the CCF-B invalidates the API invoker authorization corresponding to the service API.
3. The CCF-B sends an interconnection revoke API invoker authorization response to the CCF-A.
4. Instead of step 1 to 3, if the CCF-A performed service API authorization, the CCF-A sends an interconnection revoke API invoker authorization notify to the CCF-B.
5. The CCF-A invalidates the API invoker authorization corresponding to the service API.
6. The CCF-B sends a revoke API invoker authorization notify to the API invoker whose authorization to access the service API has been revoked.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.9 Procedure for obtaining access control policy in CAPIF interconnection
|
Pre-condition:
1. The AEF is hosting the service API but the policy to perform access control is not available with AEF.
2. The CCF-B has available access control policies corresponding to one or more service APIs.
3. The AEF and the CCF-A are in the same trusted domain.
Figure 8.25.3.9-1: Procedure for obtaining access control policy in CAPIF interconnection
1. The AEF sends an obtain access control policy request to the CCF-A for obtaining the policy to perform the access control on service API invocations by including the details of the hosted service API.
2. After successful authentication validation of the AEF, if the CCF-A determines that the service API access control policy authorization cannot be done by itself alone, then the CCF-A sends an interconnection obtain access control policy request to the CCF-B.
NOTE 1: If the CCF-A has enough access control policy available, it executes the procedure defined in clause 8.12.3 without interaction with the CCF-B.
3-4. The CCF-B determines appropriate access control policy for service APIs upon the request sent by the CCF-A. The access control policy information is sent to the AEF (via the CCF-A) in the (interconnection) obtain access control policy response.
NOTE 2: To maintain synchronization between the AEF and the CCF for the policy cached at AEF, the AEF can subscribe to the policy update event at the CCF-A according to the procedure in clause 8.8.3 and receive notifications about any updated policy at the CCF-A according to the procedure in clause 8.8.4. Correspondingly, the CCF-A can subscribe to policy update event at the CCF-B if service API authorization is performed by the CCF-B.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.25.3.10 Procedure for obtaining security information in CAPIF interconnection
|
Pre-condition:
1. The AEF has no security information available for authentication and/or authorization.
2. The CCF-B has security information available for authentication and/or authorization corresponding to one or more service APIs.
3. The AEF and the CCF-A are in the same trusted domain.
Figure 8.25.3.10-1: Procedure for obtaining security information in CAPIF interconnection
1. The AEF obtains the API invoker information required for authentication and/or authorization by the AEF from the CCF-A by including the details of the API invoker and hosted service API. After successful authentication validation of AEF, if the CCF-A determines that it has no security information, then the CCF-A obtains security information request from the CCF-B. Then the security information required for service API invocations is sent to the AEF.
NOTE 1: If the CCF-A has security information available, it executes the procedure defined in clause 8.14.3, clause 8.15.3 or clause 8.16.3 without interaction with the CCF-B.
NOTE 2: The CCF-A can subscribe to API invoker onboarding event at the CCF-B according to the procedure in clause 8.8.3 and receive notifications about any onboarded API invoker and its security related onboarding information at the CCF-B according to the procedure in clause 8.8.4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.26 Update API invoker's API list
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.26.1 General
|
The procedure in this subclause corresponds to the architectural requirements for updating the API invoker's API list on the CAPIF core function. The CAPIF enables API invoker to update its own API list e.g. subsequent to discovering new API(s).
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.26.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.26.2.1 Update API invoker API list request
|
Table 8.26.2.1-1 describes the information flow update API invoker API list request from the API invoker to the CAPIF core function.
Table 8.26.2.1-1: Update API invoker API list request
Information element
Status
Description
API invoker identity information
M
Identity information of the API invoker requesting update
APIs for update
M
List of APIs that need update (e.g. enroll new API(s), disenroll API(s)).
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.26.2.2 Update API invoker API list response
|
Table 8.26.2.2-1 describes the information flow update API invoker API list response from the CAPIF core function to the API invoker.
Table 8.26.2.2-1: Update API invoker API list response
Information element
Status
Description
Result
M
Indicates the completely successful or partially successful or failure of the update operation
API information
O
(see NOTE 1)
List of APIs and the categories of service APIs that the API invoker can access
Reason
O
(see NOTE 2)
This element indicates the reason for failure or the reason for partial successful with information for which API(s) the update operation has failed.
NOTE 1: Information element shall be present when update API invoker API list status is partial or completely successful.
NOTE 2: Information element shall be present when update API invoker API list status is partial successful or failure.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.26.3 Procedure
|
Figure 8.26.3-1 illustrates the procedure for updating the API invoker API list on the CAPIF.
Pre-conditions:
1. The API invoker has been onboarded as a recognized user of the CAPIF and associated API invoker profile is provisioned.
2. The API invoker has visibility to new APIs information (e.g. updates on API catalogue or dashboard, API discovery).
Figure 8.26.3-1: Procedure for updating the API invoker profile on the CAPIF
1. For updating of the API invoker API list on the CAPIF, the API invoker triggers update API invoker API list request towards the CAPIF core function, providing the information to be updated (e.g. enroll new APIs, disenroll APIs).
2. The CAPIF core function updates the API invoker API list of the requesting API invoker, according to the grant from the CAPIF administrator or the API management.
NOTE: Completion of updating process can require explicit grant by the CAPIF administrator or the API management, which is left out-of-scope of this solution. CAPIF can handle the grant process internally without the need of explicit grant by the CAPIF administrator.
3. The update API invoker API list response provides partial success or complete success or failure indication. Partial success and complete success result will include APIs information that the API invoker can access. When the update status is failure, the reason for failure is included. When the update status is partial successful, the reason for partial successful and information for which API(s) the update operation has failed are included.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.27 Dynamically routing service API invocation
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.27.1 General
|
The procedure in this subclause corresponds to the architectural requirements for dynamic routing of service API invocation. The CAPIF enables dynamically routing the service API invocation request based on the detailed information of the invocation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.27.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.27.2.1 Obtain routing information request
|
Table 8.27.2.1-1 describes the information flow dynamic routing information request from the API exposing function to the CAPIF core function.
Table 8.27.2.1-1: Obtain routing information request
Information element
Status
Description
Service API identification
M
The identification information of the service API for which invocation is requested. The service API identification is part of the specific service API invocation request.
AEF identity information
M
Identity information of the entity requesting the routing information
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.27.2.2 Obtain routing information response
|
Table 8.27.2.2-1 describes the information flow dynamic routing information response from the CAPIF core function to the API exposing function.
Table 8.27.2.2-1: Obtain routing information response
Information element
Status
Description
Service API identification information
M
The identification information of the service API for which invocation is requested.
Routing rule(s) information for service API invocation
M
Indicates the routing rule(s) for service API invocation, e.g., mapping of IP address range and AEF identity, or mapping of area serving the service API and AEF information.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.27.3 Procedure
|
Figure 8.27.3-1 illustrates the procedure for dynamically routing the service API invocation from the AEF acting as service communication entry point to the destination AEF for handling service API.
Pre-conditions:
1. The API invoker has performed the service discovery and received the details of the service API which includes the information about the service communication entry point of the AEF-1 in the CAPIF.
2. The API invoker is authenticated and authorized to use the service API.
3. The AEF-1 is the AEF acting as service communication entry point for the service API, and AEF-2 is one of the multiple destination AEF which provides the service API.
Figure 8.27.3-1: Procedure for dynamic routing of service API invocation
1. The API invoker performs service API invocation according to the interface of the service API by sending a service API invocation request towards the AEF-1 which exposes the service API towards the API invoker, and acts as topology hiding entity.
2. If the routing rule information for the service API invocation is not available, the AEF-1 sends obtain routing information request to the CAPIF core function.
3. The CAPIF core function creates routing rule information for the service API and sends obtain routing information response with the routing rule information.
NOTE: Steps 2 and 3 can be performed before step 1and after receiving the API topology hiding notify as described in subclause 8.24.3.
4. The AEF-1 further resolves the actual destination of the service API address information (AEF-2) according to the routing rule information and the invocation parameters in service API invocation request.
5. The AEF-1 forwards the incoming service API invocation request to AEF-2.
6. The AEF-2 returns the service API invocation response to AEF-1.
7. The AEF-1 sends the service API invocation response to the API invoker.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.28 Registering the API provider domain functions on the CAPIF
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.28.1 General
|
The procedure in this subclause corresponds to the architectural requirements for registering the API provider domain functions on the CAPIF. This procedure registers the API provider domain functions as authorized users of the CAPIF functionalities.
NOTE: The security aspects of this procedure are specified in 3GPP TS 33.122 [12] clauses 6.6 and 6.10.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.28.2 Information flows
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.