Documentation is now available for the Fall 2020 Update release!

Create or update installed integration base notifier

This endpoint is used to create or update an installed integration base notifier.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}/notifier

Sample URLs

https://{api-url}/api/v2/tenants/client_398/integrations/installed/INTG-30afec31-9c37-4784-a6de-051997a5715e/notifier

Parameters

The fields are required unless specific to an authType.

FieldData TypeDescription
typeStringNotifier type.
authTypeStringAuthentication type: NONE, OAUTH2, JWT.
grantTypeStringSecurity credentials are CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN.
Example: PASSWORD
userNameStringUser name.
passwordStringPassword.
apiKeyString(OAUTH2 only) API key.
apiSecretString(OAUTH2 only) API secret.
accessTokenURIString(OAUTH2 only) Access token URI.
tokenPayloadString(JWT only) Payload for the token.
tokenURLString(JWT only) Access token URI.
tokenHeadersString(JWT only) Headers to request the token.
tokensPathString(JWT only) Token path in the response of the authentication REST call.
resourceAuthHeadersString(JWT only) Authorization header for resource calls.

The SOAP API supports only NONE authentication types.

Status code

200 OK

Create or update notifier with authentication type NONE

This is a sample request to create or update a notifier with authType NONE. The sample response creates a notifier.

Sample request

{
	"type": "SOAP API",
	"baseURI": "www.google.com",
	"authType": "NONE"
}

Sample response

{
	"baseURI": "www.google.com",
	"authType": "NONE"
}

Create or update notifier with authentication type OAUTH2 and grant type CLIENT_CREDENTIALS

This is a sample request to create or update a notifier with OAUTH2 and Grant Type CLIENT_CREDENTIALS. The sample response creates a notifier.

Sample request

{
	"type": "REST_API",
	"baseURI": "www.google.com",
	"authType": "OAUTH2",
	"grantType": "CLIENT_CREDENTIALS",
	"accessTokenURI": "www.token.com/cred",
	"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
	"apiSecret": "**********************"
}

Sample response

{
	"baseURI": "www.google.com",
	"authType": "OAUTH2",
	"grantType": "CLIENT_CREDENTIALS",
	"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
	"accessTokenURI": "www.token.com/cred"
}

Create or update notifier with authentication type OAUTH2 and grant type PASSWORD

This is a sample request to create or update a notifier with OAUTH2 and Grant Type PASSWORD. The sample response creates a notifier.

Sample request

{
	"type": "REST_API",
	"baseURI": "www.google.com",
	"authType": "OAUTH2",
	"grantType": "PASSWORD",
	"userName": "testUser",
	"password": "**********",
	"accessTokenURI": "www.token.com/cred",
	"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
	"apiSecret": "*****************************************"
}

Sample response

{
	"baseURI": "www.google.com",
	"authType": "OAUTH2",
	"grantType": "PASSWORD",
	"userName": "testUser",
	"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
	"accessTokenURI": "www.token.com/cred"
}

Create or update notifier with authentication type JWT

This is a sample request to create or update a notifier with JWT. The sample response creates a notifier.

Sample request

{
    "type": "REST_API",
    "baseURI": "https://us1-smax.saas.microfocus.com",
    "authType": "JWT",
    "userName":"test",
    "password":"Test",
    "tokenPayload" : {"rest":""},
    "tokenURL" : "https://us1-smax.saas.microfocus.com/auth/authentication-endpoint/authenticate/login",
    "tokenHeaders" : [
        {
            "key" : "Authorization",
            "value" : "Basic Base64EncodedCredentials"
        },
        {
            "key" : "accept",
            "value" : "application/json"
        },
        {
            "key" : "Content-Type",
            "value" : "application/json"
        }   
    ],
    "tokensPath" : [
        {
            "key" : "jwtToken",
            "value" : "rest_access.access_key"
        }
    ],
    "resourceAuthHeaders" : [
        {
            "key" : "accept",
            "value" : "$jwtToken"
        }
    ]
    
}

Sample response

{
    "baseURI": "https://us1-smax.saas.microfocus.com",
    "authType": "JWT",
    "userName": "test"
}