Create API Invoker Profile

Create API Invoker Profile

Creates a new individual API Invoker profile.

Request
URI
POST
https://{api_host}/dms/api-invoker-management/v1/onboardedInvokers
COPY
Header Parameters
string
Version
Optional

If provided in a request, the value of the header is a string signalling the desired version of the API to be used in handling the request. If the provided version is not available, a 406 Not Acceptable response will be sent. If no Version header is provided, the latest available version will be used. This mechanism allows a user-agent to request a specfic version of the API when multiple versions are available.

Request Body
APIInvokerEnrolmentDetails of type(s) application/json
Required 
{
    "apiInvokerId": "API_INVOKER_12345",
    "onboardingInformation": {
        "apiInvokerPublicKey": "PUBLIC_KEY_STRING",
        "apiInvokerCertificate": "CERTIFICATE_STRING",
        "onboardingSecret": "SECRET_STRING"
    },
    "notificationDestination": "string",
    "requestTestNotification": true,
    "apiInvokerInformation": "Generic details about API invoker"
}
string
apiInvokerId
Optional

API invoker ID assigned by the CAPIF core function to the API invoker. Must not be present in a request body.

OnboardingInformation
onboardingInformation
Required

onboardingInformation

string
notificationDestination
Required

The target URI for notifications.

boolean
requestTestNotification
Optional

Request for CAPIF core function to send a test notification.

string
apiInvokerInformation
Optional

Generic information related to the API invoker.

Responses
201

API invoker on-boarded successfully.

Returns APIInvokerEnrolmentDetails of type(s) application/json 
{
    "apiInvokerId": "API_INVOKER_12345",
    "onboardingInformation": {
        "apiInvokerPublicKey": "PUBLIC_KEY_STRING",
        "apiInvokerCertificate": "CERTIFICATE_STRING",
        "onboardingSecret": "SECRET_STRING"
    },
    "notificationDestination": "string",
    "requestTestNotification": true,
    "apiInvokerInformation": "Generic details about API invoker"
}
string
apiInvokerId
Optional

API invoker ID assigned by the CAPIF core function to the API invoker. Must not be present in a request body.

OnboardingInformation
onboardingInformation
Required

onboardingInformation

string
notificationDestination
Required

The target URI for notifications.

boolean
requestTestNotification
Optional

Request for CAPIF core function to send a test notification.

string
apiInvokerInformation
Optional

Generic information related to the API invoker.

Response Headers

string
Version

The Version header in a response indicates the version of the API used to handle this request-response pair, in an API which has the potential to support multiple versions. Different versions may be requested using a Version header in a request.

string
Location

Contains the URI of the newly created resource, according to the structure {apiRoot}/api-invoker-management/v1/onboardedInvokers/{onboardingId}


400
Returns BadRequest of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


401
Returns Unauthorized of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


403
Returns Forbidden of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


404
Returns NotFound of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


406
Returns Unacceptable of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


500
Returns ServerError of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


503
Returns ServiceUnavailable of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


On This Page
Api Invoker Management Operations
POST
Create API Invoker Profile
DELETE
Delete API Invoker
PATCH
Modify API Invoker Details
PUT
Update API Invoker Details