hash
stringlengths 32
32
| doc_id
stringlengths 5
12
| section
stringlengths 4
595
| content
stringlengths 0
6.67M
|
|---|---|---|---|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.28.2.1 Registration request
|
Table 8.28.2.1-1 describes the information flow, registration request, from the API management function to the CAPIF core function.
Table 8.28.2.1-1: Registration request
Information element
Status
Description
List of API provider domain functions
M
List of API provider domain functions including role (e.g. AEF, APF, AMF) and, if required, specific security information.
API provider name
O
The API provider name uniquely identifies an API provider (e.g. Internet Service Provider).
Security information
M
Information for CAPIF core function to validate the registration request
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.28.2.2 Registration response
|
Table 8.28.2.2-1 describes the information flow, registration response, from the CAPIF core function to the API management function.
Table 8.28.2.2-1: Registration response
Information element
Status
Description
List of identities
M
(see NOTE 1)
List of identities, for each successfully registered API provider domain function and any specific security information.
Security information
O
Information to be used by the API provider domain function in subsequent CAPIF API invocations. Provided when registration is successful.
Reason
O
(see NOTE 2)
Information related to registration result specific to individual API provider domain functions. Provided when the registration fails.
NOTE 1: Information element shall be present when at least one registration request is successful.
NOTE 2: Information element may be present when at least one registration requests fail.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.28.3 Procedure
|
Figure 8.28.3-1 illustrates the procedure for registering API provider domain functions on the CAPIF core function.
Figure 8.28.3-1: Procedure for registration of API provider domain functions on CAPIF
1. For registration of API provider domain functions on the CAPIF core function, the API management function sends a registration request to the CAPIF core function. The registration request contains a list of information about all the API provider domain functions, which require registration on the CAPIF core function.
2. The CAPIF core function validates the received request and generates the identity and other security related information for all the API provider domain functions listed in the registration request.
3. The CAPIF core function sends the generated information in the registration response message to the API management function.
4. The API management function configures the received information to the individual API provider domain functions.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.29 Update registration information of the API provider domain functions on the CAPIF
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.29.1 General
|
The procedure in this subclause corresponds to the architectural requirements for update of the registration information of the API provider domain functions on the CAPIF.
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.29.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.29.2.1 Registration update request
|
Table 8.29.2.1-1 describes the information flow, registration update request, from the API management function to the CAPIF core function.
Table 8.29.2.1-1: Registration update request
Information element
Status
Description
List of API provider domain functions requiring update
M
List of API provider domain functions requiring updates, including role (e.g. AEF, APF, AMF) and, if required, specific security information.
Security information
M
Information for CAPIF core function to validate the registration request
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.29.2.2 Registration update response
|
Table 8.29.2.2-1 describes the information flow, registration update response, from the CAPIF core function to the API management function.
Table 8.29.2.2-1: Registration update response
Information element
Status
Description
List of identities
M
(see NOTE 1)
List of identities, for each successfully updated API provider domain function and any specific security information.
Security information
O
Information to be used by the API provider domain function in subsequent CAPIF API invocations. Provided when registration update is successful.
Reason
O
(see NOTE 2)
Information related to registration update result specific to individual API provider domain functions. Provided when the registration fails.
NOTE 1: Information element shall be present when at least one registration update request is successful.
NOTE 2: Information element may be present when at least one registration update requests fail.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.29.3 Procedure
|
Figure 8.29.3-1 illustrates the procedure for updating the registration information of the API provider domain functions on the CAPIF core function.
Figure 8.29.3-1: Procedure for update of registration information of API provider domain functions on CAPIF
1. For updating the registration information of API provider domain functions on the CAPIF core function, the API management function sends a registration update request to the CAPIF core function. The registration update request contains a list of information about all the API provider domain functions, which require registration update on the CAPIF core function.
2. The CAPIF core function validates the received request and updates the identity and other security related information for all the API provider domain functions listed in the registration request.
3. The CAPIF core function sends the updated information in the registration update response message to the API management function.
4. The API management function configures the received information to the individual API provider domain functions.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.30 Deregistering the API provider domain functions on the CAPIF
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.30.1 General
|
The procedure in this subclause corresponds to the architectural requirements for deregistering the API provider domain functions on the CAPIF. This procedure deregisters 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.30.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.30.2.1 Deregistration request
|
Table 8.30.2.1-1 describes the information flow, deregistration request, from the API management function to the CAPIF core function.
Table 8.30.2.1-1: Deregistration request
Information element
Status
Description
Security information
M
Information for CAPIF core function to validate the deregistration request
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.30.2.2 Deregistration response
|
Table 8.30.2.2-1 describes the information flow, deregistration response, from the CAPIF core function to the API management function.
Table 8.30.2.2-1: Deregistration response
Information element
Status
Description
Result
M
Indicates the success or failure of the deregistration operation
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.30.3 Procedure
|
Figure 8.30.3-1 illustrates the procedure for deregistering API provider domain functions on the CAPIF core function.
Figure 8.30.3-1: Procedure for deregistration of API provider domain functions on CAPIF
1. For deregistration of API provider domain functions on the CAPIF core function, the API management function sends a deregistration request to the CAPIF core function.
2. The CAPIF core function validates the received request and processes the deregistration request.
3. The CAPIF core function sends a deregistration response message to the API management function.
4. The API management function processes the deregistration to the individual API provider domain functions.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.31 API invoker obtaining authorization from resource owner
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.31.1 General
|
CAPIF may authorize the API invoker to invoke the service API based on the authorization information from the resource owner given before the API invocation.
Clause 8.31.3 shows the procedure for obtaining the authorization information.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.31.2 Information flows
|
NOTE: The security aspects of this procedure are specified in TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.31.3 Procedure
|
Figure 8.31.3-1 illustrates the procedure for API invoker obtaining authorization from resource owner.
Pre-conditions:
1. The resource owner function (ROF) can communicate with the CCF (Authorization function).
2. Access to an API exposing function offered service API requires obtaining authorization from a resource owner (RO).
Figure 8.31.3-1: Procedure for API invoker obtaining authorization from resource owner
1. The API invoker requests to obtain authorization information to invoke the service API exposed by the API exposing function (AEF) and to access information owned by the resource owner at the AEF through the invocation of an obtain service API authorization request to the CCF. The request contains API invoker information (its identity and optionally application service information such as application service provider and application identifier), the purpose for data processing and any information required for authentication of the API invoker. The request may include resource owner-related finer level service API access requirements (e.g., access per service API operation or access per API service resource) and resource owner-related information the API invoker intends to provide to the AEF at service invocation (i.e., service API data model information elements the API invoker seeks authorization to provide to the AEF).
2. The CCF performs the authentication of the API invoker (using authentication information). Then the Authorization function determines the authorization by checking the authorization information provided by the RO via the ROF. The request to the ROF contains the request parameters described in step 1.
NOTE 1: The detailed procedure to obtain the RO's authorization information is specified in TS 33.122 [12].
NOTE 2: Step 1 can occur when the API invoker receives a failure in Service API invocation response indicating that authorization information from resource owner(s) is required.
Editor's Note: Authorization for finer level service API access and information intended to be provided by the API invoker at invocation, whilst accounting for the provided purpose for data processing, is to be detailed by SA3.
3. Based on the RO authorization information obtained via the ROF, the CCF sends an obtain service API authorization response to the API invoker.
4. The API invoker sends service API invocation request to the API exposing function with the authorization information received from CCF (Authorization function) in step 3.
5. The API invoker receives the service API invocation response resulting from the service API invocation once the API exposing function has checked whether the API invoker is authorized to invoke that service API based on the authorization information received from CCF (Authorization function).
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.32 Reducing authorization information inquiry in a nested API invocation
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.32.1 General
|
The nested API invocation scenario is a scenario where an API invocation towards a first API exposing function triggers that API exposing function to request an API invocation towards a second API exposing function, which is in the same API provider domain as the first API exposing function. This scenario addresses the situation in which a service API may require the services of other service APIs. For example, if the API invoker invokes SEAL SS_LocationInfoRetrieval API (clause 9.4.4 of TS 23.434 [15]), the location management server (acting as an API exposing function for the API invoker and as an API invoker for the NEF) may invoke NEF API to retrieve UE location information from 5GC. In this scenario, the CAPIF may reduce the authorization information inquiries for a nested API invocation using procedure described in clause 8.32.3.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.32.2 Information flows
|
NOTE: The security aspects of this procedure are specified in TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.32.3 Procedure
|
Figure 8.32.3-1 illustrates the procedure to obtain authorization information in a nested API invocation, in which an API exposing function receiving the service API invocation request interacts with another API exposing function to provide the service.
Pre-conditions:
1. The resource owner function can communicate with the API invoker.
2. The API exposing functions 1 and 2 are in the same trust domain.
Figure 8.32.3-1: Procedure for obtaining authorization information in a nested API invocation
1. The API invoker requests authorization information to invoke the service API exposed by API exposing function 1.
NOTE 1: This step may use either the existing procedure to obtain authorization to access service API specified in clause 8.11 or the procedure that involves the resource owner function to get authorization information. For the latter case, the mechanisms to support interactions with the Resource owner are specified in 3GPP TS 33.122 [12], with further possible CAPIF support for these mechanisms being out of scope of the current release.
2. The API invoker sends a service API invocation request to API exposing function 1 with the authorization information received in step 1.
3. Based on the service API invocation request, API exposing function 1 decides to invoke another service API exposed by API exposing function 2.
4. API exposing function 1, acting as an API invoker, obtains from the CCF the authorization information to access the service API exposed by API exposing function 2.
NOTE 2: To obtain the authorization information further interaction with the API invoker can be avoided if API exposing function 1 exchanges the authorization information provided in the API invoker's request (in step 2) with authorization information for accessing to access the service API exposed by API exposing function 2. The security mechanism involved in this exchange are out of scope of the present document.
5. API exposing function 1, acting as an API invoker sends a service API invocation request to API exposing function 2 with the authorization information received in step 4.
6. The API exposing function 1 receives the service API invocation response resulting from the service API invocation once API exposing function 2 has checked whether the API invoker is authorized to invoke that service API based on the authorization information.
7. The API invoker receives the service API invocation response resulting from the service API invocation.
8.33 Obtaining collective authorization from a resource owner
8.33.1 General
Using the procedure described in clause 8.31 the CAPIF may authorize an API invoker to invoke a service API based on the authorization information from the resource owner given before the API invocation. This clause describes an extension to that procedure to enable the CAPIF to obtain authorization information from the resource owner relating to multiple API invokers and service APIs in a single interaction.
Clause 8.33.3 shows the procedure for obtaining collective authorization information from a resource owner via their resource owner function.
8.33.2 Information flows
Editor's note: The security aspects of this procedure are to be specified in TS 33.122 [12].
8.33.3 Procedure
Figure 8.33.3-1 illustrates the procedure for API invokers obtaining collective authorization from resource owner.
The mechanism to obtain collective authorization from a resource owner is supported by the CAPIF core function.
Pre-conditions:
1. The resource owner function can communicate with the CCF (Authorization function).
2. Access to an API exposing function offered service API requires obtaining authorization from a resource owner.
3. The API invoker is successfully onboarded as described in clause 8.1.
4. The CCF is configured for handling collective authorization, see table 8.33.3-1.
Figure 8.33.3-1: Procedure for API invoker obtaining collective authorization from resource owner
1. An API invoker sends obtain service API authorization request to the CAPIF core function for obtaining permission to access a service API by including its API invoker identity information and any information required for authentication of the API invoker. The API invoker includes in the request information about the purpose and the targeted resources and operations to be performed on those resources.
2. The CCF performs the authentication of the API invoker (using authentication information) and checks whether it is permitted to access the requested service API by checking whether a resource owner authorization information is already available for that API invoker. If the authorization for accessing the requested resources for the signalled purpose is already granted, the procedure continues with step 5.
3. If authorization information is not available regarding whether the API invoker is permitted to access the requested service API (i.e., there is no applicable resource owner authorization information available) the collective resource owner authorization configuration (table 8.33.3-1) is assessed.
If authorization trigger criteria have been specified as part of the collective resource owner authorization configuration, interactions with the resource owner are only initiated once the trigger conditions are met.
If trigger criteria have not been set or once the trigger conditions are met, the authorization function determines the authorization by interacting with the resource owner via the ROF deployed on a UE. Based on the configured collective resource owner authorization configuration at the CCF and any cached “obtain service API authorization requests”, the scope of the request towards the ROF can be expanded to include additional API invokers and or service APIs based on the assumption that there is an association between the requesting API invoker and the API exposing functions and API invokers listed in the CCF configuration.
Editor's Note: The detailed procedure to obtain the resource owner's authorization information for multiple API invokers in one request require further investigation and is in scope of SA3. However, it is recommended that the resource owner is provided with at least the option to only grant authorization for only the API invoker initiating the authorization request and then only for the specific service being requested.
NOTE 2: The details of the interaction between RO and ROF for capturing the resource owner authorization are considered out-of-scope of the present specification.
4. Based on the RO authorization information obtained via the ROF, the CCF sends an API invoker specific service API authorization response to the API invoker that initially triggered the collective resource owner authorization information requested and to each API invoker for which a obtain service API authorization request was received (for the same service API) whilst the collective resource owner authorization configuration duration timer was running, i.e., the cached requests.
5. An API invoker that receives the service API authorization response can send service API invocation requests to the API exposing function with their API invoker specific resource owner authorization information.
6. The API exposing function will send a service API invocation response once it has successfully checked that the API invoker is authorized to invoke that service API based on the authorization information.
Table 8.33.3-1: Collective resource owner authorization configuration
Information element
Status
Description
List of API invoker associations (NOTE 1)
O
Lists of API invokers with their associated service APIs
> API invoker identity information list
M
List of API invoker identities
> Service API identification list
M
List of AEF service API identities.
List of trigger criteria (NOTE 1)
O
Criteria for triggering requesting of resource owner authorization
> Duration (NOTE 2)
O
Initiate request towards RO via ROF after the given duration (in seconds) after receiving a obtain service authorization request from an API invoker
> Timeperiod (NOTE 2)
O
Time period during which notifications may be sent towards RO via ROF.
> Resource owner identifier
O
Can only be included if a duration or timeslot is included. Indicates that the resource owner authorization trigger criteria is to be applied to the specific resource owner identified by their GPSI, i.e., no other resource owner authorization trigger criteria shall be applied for that resource owner.
NOTE 1: At least one of these attributes shall be present
NOTE 2: Only one of these attributes shall be present
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.34 UE-deployed API invoker accessing other UEs’ resources of a group
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.34.1 General
|
This clause specifies the procedures for API invoker on a UE to be able to access the services exposing resources of other UEs of a group. The UEs belong to the same group and the same VAL service provider (IoT case) or the same user and all of them belong to the same CAPIF provider domain.
The following scenarios are supported:
1. Obtaining resource owner authorization information by the API invoker when the authorization relationship between UE2 (the API invoker is in UE2) and UE1 is given by the membership to the same group, where the group is within the application control. The difference with the procedure described in clause 8.31 is that the API invoker is deployed in a UE different to the UE whose resources are being accessed, the API invoker needs to provide in the request, in addition to the identity of the UE whose resources are being accessed, the group identifier. and the CAPIF provider domain needs to be configured with the identifier of the Group Resource Owner, which is responsible of providing authorization information on behalf of the UEs that belong to the group.
2. Obtaining resource owner authorization information by the API invoker when the authorization relationship between UE2 (the API invoker is in UE2) and UE1 is given by the membership to the same group, where the group information is within the CAPIF provider domain. The difference with the procedure described in clause 8.31, in addition to the differences described in bullet 1, is that the identity of the UE2 needs to be included in the request, and the group membership needs to be managed in the CAPIF provider domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.34.2 Information flows
|
Editor’s note: The security aspects of this procedure are to be specified by SA3.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.34.3 Procedure
|
Figure 8.34.3-1 presents the procedure for enabling a UE-hosted API invoker accessing network-hosted resources owned by other UEs that belong to the same group.
Pre-condition:
1. The network hosts individual resources for a group of UEs which can be accessed via AEF provided the necessary security conditions are met.
2. UE 1 and UE 2 belong to the same group and the same VAL service provider (IoT case) or the same user.
3. CCF is provisioned with the information of a Group Resource Owner (GRO) which indicates UE 1 as the authorized RO (e.g. by business relationship between the group of UEs) to provide resource owner authorization for the resources belonging to the UEs in this group.
Figure 8.34.3-1: UE-deployed API invoker accessing other UEs’ resources of a group
1. The API invoker (e.g., in UE 2) sends an Obtain service API authorization request to the CCF for obtaining permission to access the service API for other UE's resources hosted in the network (e.g., location) by including the API invoker identity information and any information required for authentication of the API invoker. The request includes API invoker information, the group identifier, and the UE in a group whose resources are to be accessed. Alternatively, the request shall include the API invoker information (identity of UE2). Additionally, the API invoker may include in the request information about the purpose and operations (scope) to be performed on the targeted resources.
Editor’s note: How the alternatives can be chosen by API invoker is FFS.
2. CCF performs authentication of the API invoker (using authentication information) as specified in 3GPP TS 33.122 [12].
3. CCF, based on the group identifer determines that RO authorization is provided by a GRO. The CCF then resolves the identity of the GRO responsible for the group of UEs based on the provisioned information related to the GRO. If the UE2 identity (API invoker) was received in step 1, the CCF shall additionally check whether UE2 belongs to the group.
4. If step 3 is successful, the CCF performs the resource owner authorization check using the GRO as the RO for the requested resources of other UE(s) belonging to the group.
Editor’s note: The authorization details for step 4 of how CCF interacts with GRO to obtain authorization which also includes the group identification is FFS and will be specified by SA3.
5. Based on the group resource owner authorization received in step 4, the CCF sends an Obtain service API authorization response to the API invoker. The authorization response indicates that the access to UE (resource owner) network resource(s) is authorized for an indicated scope.
NOTE: In this release of the specification, the authorization revokation due to the removal of any of the UE(s) from the group is triggered by the GRO.
6. The API invoker sends service API invocation request to the API exposing function with the RO authorization information received in step 5.
7. The API invoker receives the service API invocation response resulting from the service API invocation once the API exposing function has checked whether the API invoker is authorized to invoke that service API based on the RO authorization information
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.35 Revoking resource owner authorization
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.35.1 General
|
The procedure in this subclause corresponds to the architectural requirements for revoking resource owner authorization.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.35.2 Information flows
|
Editor's Note: The security aspects of this procedure are to be detailed by SA3.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.35.3 Procedure
|
Figure 8.35.3-1 illustrates the procedure for revoking resource owner authorization to access service API initiated by the resource owner function.
Pre-conditions:
1. The API invoker is authenticated and authorized to use the service API.
Figure 8.35.3-1: Procedure for revoking resource owner authorization
1. The RO triggers the revocation of the resource authorization via ROF.
2. The ROF requests resource authorization revocation to the CAPIF core function.
NOTE: The detailed procedure of resource authorization revocation is to be specified in TS 33.122 [12].
3. The CAPIF core function sends a revoke resource authorization notification to the API invoker according to the procedure in clause 8.23.4.
4. The CAPIF core function sends a revoke resource authorization notification to the API exposing function according to the procedure in clause 8.23.4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.36 CCF Obtaining Resource Owner Authorization
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.36.1 General
|
The procedure in this subclause corresponds to the architectural requirements for CCF obtaining resource owner authorization.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.36.2 Information flows
|
Editor's Note: The security aspects of this procedure are to be detailed by SA3.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.36.3 Procedure
|
Figure 8.36.3-1 illustrates the procedure for CCF obtaining resource owner authorization.
Pre-condition:
1. ROF and CCF have successfully completed mutual authentication.
Figure 8.36.3-1: Procedure for obtaining resource owner authorization
1. The CAPIF core function sends the resource owner authorization information request along with the API invoker information received in the obtaining service API authorization procedure as described in clause 8.31.3.
2. Authentication of the resource owner is performed.
3. The resource owner sends the resource owner authorization information response via ROF to the CAPIF core function along with the resource authorization information as specified in clause 8.31.3.
4. The CAPIF core function stores the resource owner authorization information.
NOTE: Authentication of the resource owner is to be specified in TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.37 UE-deployed API invoker accessing other UEs’ resources
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.37.1 General
|
This clause specifies the procedures for API invoker on a UE to be able to access the services exposing resources of other UEs.
The following scenarios are supported:
1. Obtaining resource owner authorization information by the API invoker when the authorization relationship between UE2 (the API invoker is in UE2) and UE1 (UE1 is the resource owner of the accessed network resources) is in the application. The difference with the procedure described in clause 8.31 is that the API invoker is deployed in a UE different to the resource owner UE.
2. Obtaining resource owner authorization information by the API invoker when the authorization relationship between UE2 (the API invoker is in UE2) and UE1 (UE1 is the resource owner of the accessed network resources) is in the CAPIF provider domain. The difference with the procedure described in clause 8.31 is that the API invoker is deployed in a UE different to the resource owner UE and the API invoker needs to provide in the request, in addition to the identity of the resource owner, the identity of the UE accessing to resource owner’s resources.
NOTE: In this release of the specification, the UEs belong to the same CAPIF provider domain.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.37.2 Information flows
|
NOTE: The security aspects of this procedure are specified in 3GPP TS 33.122 [12].
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.37.3 Procedure
|
Figure 8.37.3-1 presents the procedure for enabling a UE-hosted API invoker accessing network-hosted resources owned by other UEs for the scenarios introduced in clause 8.x.1.
Pre-condition:
1. The network hosts individual resource(s) for a UE which can be accessed via AEF provided the necessary security conditions are met.
2. UE 1 and UE 2 belong to the same CAPIF provider domain. The API invoker in UE2 knows the RO identifier for UE1.
3. The CCF may have stored the resource owner authorization information for UE1 (e.g. whether UE2 is allowed to access to UE1 network resources).
Figure 8.37.3-1: UE-deployed API invoker accessing other UEs’ resources
1. The API invoker in UE2 sends an Obtain service API authorization request to the CCF for obtaining permission to access the service API for other UE’s (UE1) resources hosted in the network by including the API invoker identity information and any information required for authentication of the API invoker.
The request shall include the RO identity for UE1, whose resources are trying to be accessed, the API invoker information that is requesting the access, and the information about the purpose and scope to be performed on the targeted resources. Alternatively, the request shall include the identity of UE2.
Editor's note: How the alternatives can be chosen by API invoker is FFS.2. The CCF validates and authorizes the API invoker in UE2 as specified in 3GPP TS 33.122 [3]. If the API invoker validation is successful, the CCF checks the Resource Owner authorization information of UE1. The CCF obtains whether UE1 authorized to the API invoker the access to the network resource(s) for the specified purpose and scope. If the UE2 identity (as API invoker) was received in step 1, the CCF shall additionally validate whether UE2 is authorized by UE1. If the RO authorization information is not available, the CCF may interact with UE1 via ROF to obtain it.
3. Based on the UE1 resource owner authorization obtained in step 2, the CCF sends an Obtain service API authorization response to the API invoker. The response indicates that UE1, as resource owner, authorizes the service API access for an indicated scope.
4. The API invoker sends service API invocation request to the API exposing function with the RO authorization information received in step 2.
5. The API invoker receives the service API invocation response resulting from the service API invocation once the API exposing function has checked whether the API invoker is authorized to invoke that service API based on the RO authorization information.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.38 Open Discover service APIs
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.38.1 General
|
The following procedure in this subclause corresponds to supporting open discover service APIs. Such open discovery operation allows requestor to discover service API information about the available set of APIs offered by CCF before onboarding.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.38.2 Information flows
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.38.2.1 Open Service API discover request
|
Table 8.38.2.1-1 describes the information flow open service API discover request from the requestor to the CAPIF core function.
Table 8.38.2.1-1: Open Service API discover request
Information element
Status
Description
Query information
O
(see NOTE)
Criteria for discovering matching service APIs. It may contain Service API information described in table 8.3.2.1-1, except service API interface details.
NOTE: It should be possible to discover all the service APIs.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.38.2.2 Open Service API discover response
|
Table 8.38.2.2-1 describes the information flow open service API discover response from the CAPIF core function to the requestor.
Table 8.38.2.2-1: Open Service API discover response
Information element
Status
Description
Result
M
Indicates the success or failure of the open discovery of the service API information
Service API information
O
(see NOTE)
Filtered service APIs information that can be shared to the requestor not a recognized user of the CAPIF. It may contain Service API information described in table 8.3.2.1-1, except service API interface details.
NOTE: The service API information shall be present if the Result information element indicates that the open service API discover operation is successful. Otherwise, it shall not be present.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
8.38.3 Procedure
|
Figure 8.38.3-1 illustrates the procedure for open discover service APIs.
The open service API discovery mechanism is supported by the CAPIF core function.
Pre-conditions:
1. The requestor is not a recognized user of the CAPIF.
Editor's note: The access credentials the API provider domain provides to the requestor to enable the discovery request from a user not recognized by CAPIF is specified by SA3.
2. The CAPIF core function is aware of the Service API information that can be disseminated according to the requestor who is not a recognized user of the CAPIF.
Figure 8.38.3-1: Open Discover service APIs
1. The requestor sends an open service API discover request to the CAPIF core function. It may include the query information from the requestor.
2. Upon receiving the open service API discover request, the CAPIF core function retrieves the stored service API(s) information as per the query information in the open service API discover request. Further, since the requestor is not a recognized user of CAPIF, the CAPIF core function performs filtering of service APIs information.
3. The CAPIF core function sends an open service API discover response to the requestor with the filtered list of service API information.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
9 API consistency guidelines
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
9.1 General
|
This clause specifies the API consistency guidelines for all northbound APIs utilizing CAPIF architecture. The guidelines are categorized as follows:
- fundamental API guidelines, applicable to all northbound APIs utilizing CAPIF; and
- architecture design considerations, applicable to all northbound APIs utilizing CAPIF.
The API guidelines are also applicable for CAPIF APIs specified in the current specification.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
9.2 Fundamental API Guidelines
|
The specification of each northbound API utilizing the common API framework should define:
1. the function of the API;
2. the resource(s) or endpoints involved;
3. the list of supported operations and their usage;
4. the list of input and output parameters along with applicable schemas, as required;
5. the list of supported response codes;
6. the behaviour of the network entity exposing the APIs (e.g. the CAPIF core function or the API exposing function) for each supported operation;
7. the list of applicable data types; and
8. the list of applicable protocols and data serialization formats.
In order to facilitate the consistency of the northbound APIs utilizing the common API framework it is recommended to adopt the guidelines which define the following:
1. consistent nomenclature for the operations, data structures and resources/endpoints;
2. design principles for the use of operations for common tasks; and
3. a template for the consistent documentation of APIs.
The northbound APIs utilizing the common API framework should support the following properties:
1. be extensible, such that it is possible to accommodate future requirements, including vendor-specific needs;
NOTE: The extension does not replace any existing function in Northbound APIs.
2. support access control mechanisms;
3. support charging, if applicable; and
4. be backward and forward compatible with different versions of the same API.
The guidelines above are generic with regard to the API architecture. They are valid for network APIs that follow the RESTful architectural style and that expose resources towards the API invoker, as well as for network APIs of other architectures that expose general network endpoints towards the API invoker. A network endpoint represents one end of a communication channel through which the API consumer communicates with the API producer, using messages of a protocol defined by the API architecture. A resource is identified, and the corresponding endpoint is addressed, by a resource identifier (such as a URI).
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
9.3 Architecture design considerations
|
Northbound APIs utilizing common API framework should adhere to RESTful architecture, whenever possible. Service operations can use custom API operations (RPC-style interaction), when it is seen a better fit for the style of interaction to model, e.g. non-CRUD service operations.
NOTE: The selection of a particular API style is specific to each API implementation, and subject to Stage 3 scope.
The API design:
1. should have a uniform interface that conveys the resource/data model of the API to its client developers and:
a. the implementation of the resource(s)/operations involved in the APIs should be hidden from the client, and adequate operations should be designed to operate on the resource(s)/data;
b. any single API should be atomic;
c. all resources/operations involved in APIs should be accessible through a common approach, and resources/data should be similarly modified using a consistent approach;
2. should allow the client (such as the API invoker) and the server (such as the CAPIF core function or the API exposing function) to evolve independently, i.e. the client should not have to be aware of the execution aspects of the APIs on the server;
3. should be stateless such that each request from the client (such as the API invoker) to the server (such as the CAPIF core function or the API exposing function) contains all of the information necessary for the server to understand the request;
4. should define the usage of standard operations, such as Create, Read, Update and Delete, consistently along with the applicable response codes;
5. should allow to label responses as cacheable or non-cacheable, to improve network efficiency by supporting caching in the client (such as the API invoker), if applicable in the API architecture;
6. should prevent unwanted modification of the resources/data during invocation of APIs; and
7. should support version control.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10 CAPIF core function APIs
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.1 General
|
Table 10.1-1 illustrates the CAPIF core function APIs.
Table 10.1-1: List of CAPIF core function APIs
API Name
API Operations
Known Consumer(s)
Communication Type
CAPIF_Discover_Service_API
Discover_Service_API
API Invoker, CAPIF core function
Request/ Response
Subscribe_Event
API Invoker
Request/ Response
Update_Event_Subscription
API Invoker
Request/ Response
Notify_Event
API Invoker
Notify
Unsubscribe_Event
API Invoker
Request/ Response
CAPIF_Publish_Service_API
Publish_Service_API
API Publishing Function, CAPIF core function
Request/ Response
Unpublish_Service_API
API Publishing Function, CAPIF core function
Request/ Response
Update_Service_API
API Publishing Function, CAPIF core function
Request/ Response
Get_Service_API
API Publishing Function, CAPIF core function
Request/ Response
Subscribe_Event
API Publishing Function
Request/ Response
Update_Event_Subscription
API Publishing Functionr
Request/ Response
Notify_Event
API Publishing Function
Notify
Unsubscribe_Event
API Publishing Function
Request/ Response
CAPIF_Events API
Subscribe_Event
API Invoker, API Publishing Function, API Management Function, API Exposing Function
Request/ Response
Update_Event_Subscription
API Invoker, API Publishing Function, API Management Function, API Exposing Function
Request/ Response
Notify_Event
API Invoker, API Publishing Function, API Management Function, API Exposing Function
Notify
Unsubscribe_Event
API Invoker, API Publishing Function, API Management Function, API Exposing Function
Request/ Response
CAPIF_API_Invoker_management API
Onboard_API_Invoker
API Invoker
Request/ Response
Offboard_API_Invoker
API Invoker
Request/ Response
Subscribe_Event
API Management Function
Request/ Response
Update_Event_Subscription
API Management Function
Request/ Response
Notify_Event
API Management Function
Notify
Unsubscribe_Event
API Management Function
Request/ Response
CAPIF_API_Provider_Management_API
Register_API_Provider
API Management Function
Request/Response
Update_API_Provider
API Management Function
Request/Response
Deregister_API_Provider
API Management Function
Request/Response
CAPIF_Security API
Obtain_Security_Method
API Invoker
Request/ Response
Obtain_Authorization
API Invoker
Request/ Response
Obtain_API_Invoker_Info
API Exposing Function
Request/ Response
Revoke_Authorization
API Exposing Function
Request/ Response
CAPIF_Monitoring API
Subscribe_Event
API Management Function
Request/ Response
Update_Event_Subscription
API Management Function
Request/ Response
Notify_Monitoring_Service_Event
API Management Function
Notify
Unsubscribe_Event
API Management Function
Request/ Response
CAPIF_Logging_API_Invocation API
Log_API_Invocation
API exposing function
Request/ Response
CAPIF_Auditing API
Query_API_Invocation_Log
API management function
Request/ Response
CAPIF_Access_Control_Policy API
Obtain_Access_Control_Policy
API exposing function
Request/Response
CAPIF_Routing_Info API
Obtain_Routing_Info
API exposing function
Request/Response
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.2 CAPIF_Discover_Service_API API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.2.1 General
|
API description: This API enables the API invoker to communicate with the CAPIF core function to discover the published service API information over CAPIF-1 or CAPIF-1e.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.2.2 Discover_Service_API operation
|
API operation name: Discover_Service_API
Description: Provides the published service APIs information.
Known Consumers: API invoker.
Inputs: Refer subclause 8.7.2.1.
Outputs: Refer subclause 8.7.2.2.
See subclause 8.7.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.2.3 Subscribe_Event operation
|
API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API invoker.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.2.4 Notify_Event operation
|
API operation name: Notify_Event
Description: Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers: API invoker.
Inputs: Refer subclause 8.8.2.3.
Outputs: Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.2.5 Unsubscribe_Event operation
|
API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API invoker.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.2.6 Update_Event_Subscription operation
|
API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API invoker.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3 CAPIF_Publish_Service_API API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.1 General
|
API description: This API enables the API publishing function to communicate with the CAPIF core function to publish the service API information and manage the published service API information over CAPIF-4.
NOTE: Stage 3 can decide whether the API for CAPIF_Publish_Service_API can be enabled over CAPIF-4.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.2 Publish_Service_API operation
|
API operation name: Publish_Service_API
Description: Publish the service API information.
Known Consumers: API publishing function, CAPIF core function.
Inputs: Refer subclause 8.3.2.1, 8.25.2.1.
Outputs: Refer subclause 8.3.2.2, 8.25.2.2.
See subclause 8.3.3 and 8.25.3.1 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.3 Unpublish_Service_API operation
|
API operation name: Unpublish_Service_API
Description: Remove the published service API information.
Known Consumers: API publishing function, CAPIF core function.
Inputs: Refer subclause 8.4.2.1, 8.25.2.5.
Outputs: Refer subclause 8.4.2.2, 8.25.2.6.
See subclause 8.4.3 and 8.25.3.4 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.4 Update_Service_API operation
|
API operation name: Update_Service_API
Description: Update the published service API information.
Known Consumers: API publishing function, CAPIF core function.
Inputs: Refer subclause 8.6.2.1, 8.25.2.9.
Outputs: Refer subclause 8.6.2.2, 8.25.2.10.
See subclause 8.6.3 and 8.25.3.6 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.5 Get_Service_API operation
|
API operation name: Get_Service_API
Description: Retrieve the published service API information.
Known Consumers: API publishing function, CAPIF core function.
Inputs: Refer subclause 8.5.2.1, 8.25.2.7.
Outputs: Refer subclause 8.5.2.2, 8.25.2.8.
See subclause 8.5.3 and 8.25.3.5 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.6 Subscribe_Event operation
|
API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API publishing function.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.7 Notify_Event operation
|
API operation name: Notify_Event
Description: Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers: API publishing function.
Inputs: Refer subclause 8.8.2.3.
Outputs: Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.8 Unsubscribe_Event operation
|
API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API publishing function.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.3.9 Update_Event_Subscription operation
|
API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API publishing function.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.4 CAPIF_Events API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.4.1 General
|
API description: This API enables the API subscribing entity to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events and receive subsequent notification of CAPIF events. This API is used for the subscription to and notifications of those CAPIF events that are not bound to any of the other CAPIF core function APIs. The following are the key functionalities:
- API invoker subscribes to CAPIF events over CAPIF-1 or CAPIF-1e.
- API invoker receives notifications for subscribed CAPIF events over CAPIF-1 or CAPIF-1e.
- API invoker unsubscribes from CAPIF events over CAPIF-1 or CAPIF-1e.
- API invoker updates subscriptions for CAPIF events over CAPIF-1 or CAPIF-1e.
- API exposing function subscribes to CAPIF events over CAPIF-3.
- API exposing function receives notifications for subscribed CAPIF events over CAPIF-3.
- API exposing function unsubscribes from CAPIF events over CAPIF-3.
- API exposing function updates subscriptions for CAPIF events over CAPIF-3.
- API publishing function subscribes to CAPIF events over CAPIF-4.
- API publishing function receives notifications for subscribed CAPIF events over CAPIF-4.
- API publishing function unsubscribes from CAPIF events over CAPIF-4.
- API publishing function updates subscriptions for CAPIF events over CAPIF-4.
- API management function subscribes to CAPIF events over CAPIF-5.
- API management function receives notifications for subscribed CAPIF events over CAPIF-5.
- API management function unsubscribes from CAPIF events over CAPIF-5.
- API management function updates subscriptions for CAPIF events over CAPIF-5.
NOTE: Stage 3 can further decide if CAPIF_Events API can be further fine grained into more APIs.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.4.2 Subscribe_Event operation
|
API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API invoker, API publishing function, API management function, API exposing function.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.4.3 Notify_Event operation
|
API operation name: Notify_Event
Description: Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers: API invoker, API publishing function, API management function, API exposing function.
Inputs: Refer subclause 8.8.2.3.
Outputs: Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.4.4 Unsubscribe_Event operation
|
API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API invoker, API publishing function, API management function, API exposing function.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.4.5 Update_Event_Subscription operation
|
API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API invoker, API publishing function, API management function, API exposing function.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.5 CAPIF_API_invoker_management API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.5.1 General
|
API description: This API enables the API invoker to communicate with the CAPIF core function to enroll as a registered user of CAPIF and manage the enrollment information over CAPIF-1 or CAPIF-1e.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.5.2 Onboard_API_Invoker operation
|
API operation name: Onboard_API_Invoker
Description: Enrolls the API invoker as a recognized user of the CAPIF.
Known Consumers: API invoker.
Inputs: Refer subclause 8.1.2.1.
Outputs: Refer subclause 8.1.2.2.
See subclause 8.1.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.5.3 Offboard_API_Invoker operation
|
API operation name: Offboard_API_Invoker
Description: Cancels enrollment of the API invoker as a recognized user of the CAPIF.
Known Consumers: API invoker.
Inputs: Refer subclause 8.2.2.1.
Outputs: Refer subclause 8.2.2.2.
See subclause 8.2.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.5.4 Subscribe_Event operation
|
API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.5.5 Notify_Event operation
|
API operation name: Notify_Event
Description: Provides the relevant CAPIF event information to the subscribed entities.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.3.
Outputs: Refer subclause 8.8.2.4.
See subclause 8.8.4 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.5.6 Unsubscribe_Event operation
|
API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.5.7 Update_Event_Subscription operation
|
API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.6 CAPIF_Security API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.6.1 General
|
API description: This API enables the API invoker to communicate with the CAPIF core function to authenticate and obtain authorization to access service APIs over CAPIF-1 or CAPIF-1e. This API also enables the API exposing function (AEF) to obtain API invoker information and revoke API invoker authorization over CAPIF-3.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.6.2 Obtain_Security_Method operation
|
API operation name: Obtain_Security_Method
Description: Obtain information about service API security method with CAPIF core function for service API invocations.
Known Consumers: API invoker.
Inputs: Refer subclause 8.10.2.
Outputs: Refer subclause 8.10.2.
See subclause 8.10.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.6.3 Obtain_Authorization operation
|
API operation name: Obtain_Authorization
Description: Provides the authorization information to access relevant service API.
Known Consumers: API invoker.
Inputs: Refer subclause 8.11.2.
Outputs: Refer subclause 8.11.2.
See subclause 8.11.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.6.4 Obtain_API_Invoker_Info operation
|
API operation name: Obtain_API_Invoker_Info
Description: Obtains the API invoker information.
Known Consumers: API exposing function.
Inputs: Refer subclause 8.16.2.1.
Outputs: Refer subclause 8.16.2.2.
See subclause 8.16.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.6.5 Revoke_Authorization operation
|
API operation name: Revoke_Authorization
Description: Revokes API invoker authorization to access service API.
Known Consumers: API exposing function.
Inputs: Refer subclause 8.23.2.
Outputs: Refer subclause 8.23.2.
See subclause 8.23.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.7 CAPIF_Monitoring API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.7.1 General
|
API description: This API enables the API management function to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events related to monitoring and receive subsequent notification of CAPIF monitoring events over CAPIF-5.
NOTE: Stage 3 can decide whether the API for CAPIF_Monitoring can be enabled over CAPIF-5.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.7.2 Subscribe_Event operation
|
API operation name: Subscribe_Event
Description: Provides subscription to the CAPIF related event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.1.
Outputs: Refer subclause 8.8.2.2.
See subclause 8.8.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.7.3 Notify_Monitoring_Service_Event operation
|
API operation name: Notify_Monitoring_Service_Event
Description: Provides the notification of the events related to monitoring service API invocations to the subscribed API management function.
Known Consumers: API management function.
Inputs: Refer subclause 8.21.2.1.
Outputs: Refer subclause 8.21.2.2.
See subclause 8.21.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.7.4 Unsubscribe_Event operation
|
API operation name: Unsubscribe_Event
Description: Unsubscription to the CAPIF event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.5.
Outputs: Refer subclause 8.8.2.6.
See subclause 8.8.5 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.7.5 Update_Event_Subscription operation
|
API operation name: Update_Event_Subscription
Description: Updates a subscription to CAPIF related event information.
Known Consumers: API management function.
Inputs: Refer subclause 8.8.2.7.
Outputs: Refer subclause 8.8.2.8.
See subclause 8.8.5a for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.8 CAPIF_Logging_API_Invocation API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.8.1 General
|
API description: This API enables the API exposing function to communicate with the CAPIF core function to log the information related to service API invocation over CAPIF-3.
NOTE: Stage 3 can decide whether the API for CAPIF_Logging_API_Invocation can be enabled over CAPIF‑3.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.8.2 Log_API_Invocation operation
|
API operation name: Log_API_Invocation
Description: Enables to log API invocation information.
Known Consumers: API exposing function.
Inputs: Refer subclause 8.19.2.1.
Outputs: Refer subclause 8.19.2.2.
See subclause 8.19.3 for the details of usage of this API operation.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.9 CAPIF_Auditing API
| |
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.9.1 General
|
API description: This API enables the API management function to communicate with the CAPIF core function to retrieve the log information related to service API invocation over CAPIF-5.
NOTE: Stage 3 can decide whether the API for CAPIF_Auditing can be enabled over CAPIF‑5.
|
654592d6e30fb2596cb6e134b557471f
|
23.222
|
10.9.2 Query_ API_Invocation_Log operation
|
API operation name: Query_API_Invocation_Log
Description: Query the API invocation log information.
Known Consumers: API management function.
Inputs: Refer subclause 8.22.2.1.
Outputs: Refer subclause 8.22.2.2.
See subclause 8.22.3 for the details of usage of this API operation.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.