How the API manages credentials for broker connections.
The API manages credentials for application to securely access brokers that act as event gateways.
It needs to store and maintain credentials so these credentials can be re-applied to an event gateway broker or applied to more brokers in case additional Access Requests are added to an Application Registration that provide access to additional event gateways.
The API stores the client username (clientId) and password (clientSecret) securely in a vault. Your integration can create multiple credentials per Application Registration. You can provide partial or complete credentials or rely on the API to auto generate the credentials.
curl --location 'https://apim-devportal-api.solace-labs.io/api/v2/apim/appRegistrations/{registrationId}/credentials' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <<api-token>>' \
--data '{
"name": "{credentialsName}"
}'
curl --location 'https://apim-devportal-api.solace-labs.io/api/v2/apim/appRegistrations/{registrationId}/credentials' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <<api-token>>' \
--data '{
"name": "{credentialsName}",
"secret": {
"consumerKey": "{clientId}"
}
}'
curl --location 'https://apim-devportal-api.solace-labs.io/api/v2/apim/appRegistrations/{registrationId}/credentials' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <<api-token>>' \
--data '{
"name": "{credentialsName}",
"secret": {
"consumerKey": "{clientId}",
"consumerSecret": "{clientSecret}"
}
}'
If you prefer not to provide basic authentication you can utilise OAuth or mutual SSL. In this case you likely want to use the Auto generate client secret option so you can provide an OAuth client id.