Notification API Service

allowedDomains
optional

The list of allowed domains for the Account.

< string > array

distributionListId
optional

Optional identifier of an existing distribution list, if specified, is used for an update.

string

distributionListManagementType
required

SYSTEM_MANAGED: Created by internal actors, modifiable only by internal users. USER_MANAGED: Created by non-internal actors, modifiable by internal or external users

string

emailAddresses
optional

List of recipient email addresses.

< string > array

eventChannelPreferences
optional

Channel preference for individual events to be subscribed to, does not require notification type.

< EventChannelPreference > array

parentResourceCrn
optional

Parent resource crn for which the resource authorization has to be done.

string

resourceCrn
required

CRN of resource to create a topic for.

string

resourceName
required

The name of the resource to be subscribed.

string

slackChannelIds
optional

List of recipient Slack channel identifiers.

< string > array

distributionListDetails
optional

Contains details of the distribution lists created or updated.

< DistributionListDetails > array

eventChannelPreferences
optional

Channel preference for the individual events.

< EventChannelPreference > array

existingSubscriptionId
optional

Existing subscription identifier, an optional parameter to be passed when updating the existing subscription.

string

parentResourceCrn
optional

Parent resource crn for which the resource authorization has to be done.

string

resourceCrn
optional

CRN of resource for which user want to subscribe.

string

subscriptionDetails
optional

Contains details of the subscription created.

SubscriptionDetails

resourceCrn
required

CRN of the resource for which all associated resource subscriptions must be deleted.

string

recordsDeleted
optional

Response string which describes the number of records deleted.

string

notificationType
optional

Notification identifier for the apps

NotificationAppType

distributionListId
required

The identifier of the distribution list to be deleted.

string

resourceCrn
required

CRN of resource for which the resource subscriptions has to be delete.

string

recordsDeleted
optional

Response string which describes the number of records deleted.

string

subscriptionId
required

The subscription identifier of the subscription to be deleted for the user.

string

resourceCrn
required

CRN of resource for which the resource subscriptions has to be delete.

string

recordsDeleted
optional

Response string which describes the number of records deleted.

string

distributionListId
optional

The distribution list identifier.

string

distributionListManagementType
optional

Attribute to identify system vs user managed distribution list.

DistributionListManagementType

emailAddresses
optional

The list of email addresses if configured.

< string > array

parentResourceCrn
optional

CRN of the parent resource of the Distribution List’s resource.

string

resourceCrn
optional

CRN of resource the group has subscribed to.

string

resourceName
optional

The name of the resource to be subscribed.

string

resourceType
optional

Type of resource. This should be service name as represented in a CRN.

string

slackChannelIds
optional

The list of Slack channel ids configured.

< string > array

subscribedEvents
optional

List of all events subscribed under the given resource.

< SubscribedEvents > array

distributionListId
optional

Identifier of the distribution list.

string

resourceCrn
optional

The resourceCrn of the subscription.

string

code
optional

The error code.

string

message
optional

The error message.

string

eventDescription
optional

Description of the event in the catalog.

string

eventName
optional

Name of the event in the catalog.

string

eventSeverityLists
optional

List of severity for the catalog.

< string > array

eventTypeId
optional

ID of the event in the catalog.

string

targetedEventType
optional

Type of the targeted event. Either user_targeted or resource_targeted.

TargetedEventType

channels
optional

The channel preference for the event where the event notification has to be delivered. e.g.: IN_APP, EMAIL

< ChannelType > array

eventSeverityLists
optional

The chosen severity list for the particular event.

< string > array

eventTypeId
optional

The event identifier.

string

allowedDomains
optional

Get allowed domains for the Account.

< string > array

notificationType
optional

Notification identifier for the apps

NotificationAppType

appRegistrationStatus
optional

The App app registration status for the tenant.

string

distributionListId
required

The identifier for which the distribution list is requested.

string

distributionList
optional

Contains details of the distribution list fetched.

DistributionList

requestUrl
optional

OAuth Request url.

string

resourceCrn
required

The resource crn for which the subscription is requested.

string

resourceSubscription
optional

Contains details of the resource subscription fetched.

ResourceSubscription

distributionListManagementType
optional

The optional distribution list management type, if specified, only distribution lists related to this type will be returned.

string

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 50

integer (int32)

pageToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

resourceCrn
optional

The optional resource CRN, if specified, only distribution lists related to this resource will be returned.

string

distributionLists
optional

List of distribution lists.

< DistributionList > array

nextPageToken
optional

The token to use when requesting the next set of results. If not present, there are no additional results.

string

totalSubscriptions
optional

This field represents the total number of resource subscriptions.

integer (int32)

resourceCrn
required

The resource CRN to which the resource catalog events are associated with.

string

resourceEvents
optional

List of resource events that the user can potentially subscribe to.

< EventCatalog > array

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 50

integer (int32)

pageToken
optional

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

string

resourceCrn
optional

The optional resource CRN, if specified, only subscriptions related to this resource will be returned.

string

nextPageToken
optional

The token to use when requesting the next set of results. If not present, there are no additional results.

string

resourceSubscriptions
optional

List of resource subscriptions for the user.

< ResourceSubscription > array

totalSubscriptions
optional

This field represents the total number of resource subscriptions.

integer (int32)

parentResourceCrn
optional

CRN of the parent resource of the resource for which the notification event is subscribed.

string

resourceCrn
optional

CRN of resource for which the event is subscribed.

string

resourceName
optional

Name of the resource for which the event is scoped to. This should be resource name as represented in a CRN.

string

serviceName
optional

Name of the service for which the event is scoped to. This should be service name as represented in a CRN.

string

subscribedEvents
optional

List of all events subscribed under the given resource.

< SubscribedEvents > array

subscriptionId
optional

The Subscription identifier.

string

channels
optional

Subscribed channel preferences of the event.

< ChannelType > array

description
optional

Description of the event.

string

eventName
optional

Name of an event.

string

eventSeverityLists
optional

The list of severity for the event.

< string > array

eventTypeId
optional

ID of an event.

string

resourceCrn
optional

The resourceCrn of the subscription.

string

subscriptionId
optional

Identifier of the newly created subscription.

string

userCrn
optional

The userCrn of the subscription.

string

notificationType
optional

Notification identifier for the apps

NotificationAppType

temporaryAuthorizationCode
required

The App temporary authorization code which needs to be passed to backend notification service.

string