SubscriptionAuthentication

SubscriptionAuthentication
SubscriptionAuthentication
JSON Example
{
    "authType": [
        "string"
    ],
    "paramsBasic": {
        "userName": "string",
        "password": "string"
    },
    "paramsOauth2ClientCredentials": {
        "clientId": "string",
        "clientPassword": "string",
        "tokenEndpoint": "string"
    }
}
array of string
authType
Required

Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: * BASIC: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials.

  • OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained using the client credentials grant type.
  • TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the server is authenticated, but also the client is authenticated during the TLS tunnel setup.
object
paramsBasic
Optional

Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and the contained information has not been provisioned out of band. Shall be absent otherwise.

object
paramsOauth2ClientCredentials
Optional

Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be absent otherwise.