/onboardedInvokers
Method: Post
Description: Creates a new individual API Invoker profile.
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/APIInvokerEnrolmentDetails'
Callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
Method: Post
Description: Notify the API Invoker about the onboarding completion
Request Body: # contents of the callback message
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/OnboardingNotification'
Responses:
'204' No Content (successful onboarding 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' API invoker on-boarded successfully
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/APIInvokerEnrolmentDetails'
Headers:
Location:
Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/api-invoker-management/v1/onboardedInvokers/{onboardingId}'
Required/Optional: true
Schema:
Type: string
'202' The CAPIF core has accepted the Onboarding request and is processing it.
'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'