Endpoint
/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}/notifier
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

installedIntgId
string

Unique Identifier of the installed integration

accessTokenURL
string

Access Token URL: Mandatory if authType is OAUTH2.

apiKey
string

API Key: Mandatory if authType is OAUTH2.

apiSecret
string

API Secret: Mandatory if authType is OAUTH2.

authType
string

Authentication type.

baseURI
string

grantType
string

Grant type for notification.

password
string

Password: Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.

resourceAuthHeaders
array

(JWT only) Authorization header for resource calls.

resourceAuthHeaders.key
resourceAuthHeaders.value
tokenHeaders
array

(JWT only) Headers to request the token.

tokenHeaders.key
tokenHeaders.value
tokenPayload
object

(JWT only) Payload for the token.

tokenURL
string

(JWT only) Access token URI.

tokensPath
array

(JWT only) Token path in the response of the authentication REST call.

tokensPath.key
tokensPath.value
type
string

Notification type.

userName
string

Username: Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.

{
  "authType": "JWT",
  "baseURI": "https://us1-smax.saas.microfocus.com",
  "password": "Test",
  "resourceAuthHeaders": [
    {
      "key": "accept",
      "value": "$jwtToken"
    }
  ],
  "tokenHeaders": [
    {
      "key": "Authorization",
      "value": "Basic Base64EncodedCredentials"
    },
    {
      "key": "accept",
      "value": "application/json"
    },
    {
      "key": "Content-Type",
      "value": "application/json"
    }
  ],
  "tokenPayload": {
    "rest": ""
  },
  "tokenURL": "https://us1-smax.saas.microfocus.com/auth/authentication-endpoint/authenticate/login",
  "tokensPath": [
    {
      "key": "jwtToken",
      "value": "rest_access.access_key"
    }
  ],
  "type": "REST_API",
  "userName": "test"
}
{
  "authType": "NONE",
  "baseURI": "www.google.com",
  "type": "SOAP_API"
}
{
  "accessTokenURI": "www.token.com/cred",
  "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
  "apiSecret": "**********************",
  "authType": "OAUTH2",
  "baseURI": "www.google.com",
  "grantType": "CLIENT_CREDENTIALS",
  "type": "REST_API"
}
{
  "accessTokenURI": "www.token.com/cred",
  "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
  "apiSecret": "*****************************************",
  "authType": "OAUTH2",
  "baseURI": "www.google.com",
  "grantType": "PASSWORD",
  "password": "**********",
  "type": "REST_API",
  "userName": "testUser"
}

Responses

OK

accessTokenURL
string

Access Token URL: Mandatory if authType is OAUTH2.

apiKey
string

API Key: Mandatory if authType is OAUTH2.

apiSecret
string

API Secret: Mandatory if authType is OAUTH2.

authType
string

Authentication type.

baseURI
string

grantType
string

Grant type for notification.

password
string

Password: Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.

resourceAuthHeaders
array

(JWT only) Authorization header for resource calls.

resourceAuthHeaders.key
resourceAuthHeaders.value
tokenHeaders
array

(JWT only) Headers to request the token.

tokenHeaders.key
tokenHeaders.value
tokenPayload
object

(JWT only) Payload for the token.

tokenURL
string

(JWT only) Access token URI.

tokensPath
array

(JWT only) Token path in the response of the authentication REST call.

tokensPath.key
tokensPath.value
type
string

Notification type.

userName
string

Username: Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.

{
  "authType": "JWT",
  "baseURI": "https://us1-smax.saas.microfocus.com",
  "userName": "test"
}
{
  "authType": "NONE",
  "baseURI": "www.google.com"
}
{
  "accessTokenURI": "www.token.com/cred",
  "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
  "authType": "OAUTH2",
  "baseURI": "www.google.com",
  "grantType": "CLIENT_CREDENTIALS"
}
{
  "accessTokenURI": "www.token.com/cred",
  "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
  "authType": "OAUTH2",
  "baseURI": "www.google.com",
  "grantType": "PASSWORD",
  "userName": "testUser"
}