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