/trustedInvokers/{apiInvokerId}
get:
Parameters:
- name: apiInvokerId
In: path
Description: Identifier of an individual API invoker
Required/Optional: true
Schema:
Type: string
- name: authenticationInfo
In: query
Description: When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
Schema:
Type: boolean
- name: authorizationInfo
In: query
Description: When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
Schema:
Type: boolean
Responses:
'200' The security related information of the API Invoker based on the request from the API exposing function.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceSecurity'
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'
'414': Reference 'TS29122_CommonData.yaml#/components/responses/414'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
put:
Parameters:
- name: apiInvokerId
In: path
Description: Identifier of an individual API invoker
Required/Optional: true
Schema:
Type: string
Request Body:
Description: create a security context for an API invoker
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceSecurity'
Callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SecurityNotification'
Responses:
'204' No Content (successful notification)
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'
'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
Responses:
'201' Successful created.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceSecurity'
Headers:
Location:
Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/capif-security/v1/trustedInvokers/{apiInvokerId}'
Required/Optional: true
Schema:
Type: string
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'
'414': Reference 'TS29122_CommonData.yaml#/components/responses/414'
'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
delete:
Parameters:
- name: apiInvokerId
In: path
Description: Identifier of an individual API invoker
Required/Optional: true
Schema:
Type: string
Responses:
'204' No Content (Successful deletion of the existing subscription)
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'