The procedure in this subclause corresponds to the architectural requirements for API invoker authorization to access service APIs.
A secure communication channel is mandatory in CAPIF.
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.
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 126.96.36.199-1
describes only the CAPIF related information elements which are included in the service API invocation request.
|API invoker identity information||M||The information that determines the identity of the API invoker|
|Authorization information||O (1)||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.|
The inclusion of this information element depends on the chosen solution for authorization.
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 188.8.131.52-1
describes only the CAPIF related information elements which are included in the service API invocation response.
|Result||M||Indicates the success or failure of service API invocation.|
illustrates the procedure for API invoker authorization to access service APIs.
The API invoker has been authenticated.
The API invoker associated authorization information is available at AEF.
The API invoker triggers service API invocation request to the AEF, including the service API to be invoked.
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.
If the AEF does not have information required to authorize service API invocation, the AEF obtains the authorization information from the CAPIF core function.
The AEF executes the service logic for the invoked service API.
The API invoker receives the service API invocation response as a result of the service API invocation.