Create or update installed integration base notifier

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.

Field	Data Type	Description
type	String	Notifier type.
authType	String	Authentication type: NONE, OAUTH2, JWT.
grantType	String	Security credentials are CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN. Example: PASSWORD
userName	String	User name.
password	String	Password.
apiKey	String	(OAUTH2 only) API key.
apiSecret	String	(OAUTH2 only) API secret.
accessTokenURI	String	(OAUTH2 only) Access token URI.
tokenPayload	String	(JWT only) Payload for the token.
tokenURL	String	(JWT only) Access token URI.
tokenHeaders	String	(JWT only) Headers to request the token.
tokensPath	String	(JWT only) Token path in the response of the authentication REST call.
resourceAuthHeaders	String	(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"
}