Endpoint
/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}/notifier
Path Parameters
tenantIdstring
installedIntgIdstring
accessTokenURLstring
Access Token URL: Mandatory if authType is OAUTH2.
apiKeystring
API Key: Mandatory if authType is OAUTH2.
apiSecretstring
API Secret: Mandatory if authType is OAUTH2.
authTypestring
Authentication type.
baseURIstring
grantTypestring
Grant type for notification.
passwordstring
Password: Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
resourceAuthHeadersarray
(JWT only) Authorization header for resource calls.
Child Parameters
- resourceAuthHeaders.key
- resourceAuthHeaders.value
tokenHeadersarray
(JWT only) Headers to request the token.
Child Parameters
- tokenHeaders.key
- tokenHeaders.value
tokenPayloadobject
(JWT only) Payload for the token.
tokenURLstring
(JWT only) Access token URI.
tokensPatharray
(JWT only) Token path in the response of the authentication REST call.
Child Parameters
- tokensPath.key
- tokensPath.value
typestring
Notification type.
userNamestring
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
accessTokenURLstring
Access Token URL: Mandatory if authType is OAUTH2.
apiKeystring
API Key: Mandatory if authType is OAUTH2.
apiSecretstring
API Secret: Mandatory if authType is OAUTH2.
authTypestring
Authentication type.
baseURIstring
grantTypestring
Grant type for notification.
passwordstring
Password: Mandatory when authType is OAUTH2 and grantType is PASSWORD/REFRESH_TOKEN.
resourceAuthHeadersarray
(JWT only) Authorization header for resource calls.
Child Parameters
- resourceAuthHeaders.key
- resourceAuthHeaders.value
tokenHeadersarray
(JWT only) Headers to request the token.
Child Parameters
- tokenHeaders.key
- tokenHeaders.value
tokenPayloadobject
(JWT only) Payload for the token.
tokenURLstring
(JWT only) Access token URI.
tokensPatharray
(JWT only) Token path in the response of the authentication REST call.
Child Parameters
- tokensPath.key
- tokensPath.value
typestring
Notification type.
userNamestring
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"
}