notifications_api_v1		index
https://github.com/ibm-cloud-security/security-advisor-sdk-python/blob/master/ibm_cloud_security_advisor/notifications_api_v1.py

notifications-api

 
Modules
       
json

 
Classes
       
builtins.object
BulkDeleteChannelsResponse
ChannelResponseDefinition
ChannelResponseDefinitionAlertSourceItem
ChannelResponseDefinitionSeverity
CreateChannelsResponse
DeleteChannelResponse
GetChannelResponse
GetChannelResponseChannel
GetChannelResponseChannelAlertSource
GetChannelResponseChannelSeverity
ListChannelsResponse
NotificationChannelAlertSourceItem
PublicKeyResponse
TestChannelResponse
UpdateChannelResponse
ibm_cloud_sdk_core.base_service.BaseService(builtins.object)
NotificationsApiV1

 
class BulkDeleteChannelsResponse(builtins.object)
    BulkDeleteChannelsResponse(*, message: str = None) -> None
 
Response of all deleted channels.
 
:attr str message: (optional) response message.
 
  Methods defined here:
__eq__(self, other: 'BulkDeleteChannelsResponse') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, message: str = None) -> None
Initialize a BulkDeleteChannelsResponse object.
 
:param str message: (optional) response message.
__ne__(self, other: 'BulkDeleteChannelsResponse') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this BulkDeleteChannelsResponse object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'BulkDeleteChannelsResponse' from builtins.type
Initialize a BulkDeleteChannelsResponse object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class ChannelResponseDefinition(builtins.object)
    ChannelResponseDefinition(*, channel_id: str = None, name: str = None, description: str = None, type: str = None, severity: 'ChannelResponseDefinitionSeverity' = None, endpoint: str = None, enabled: bool = None, alert_source: List[ForwardRef('ChannelResponseDefinitionAlertSourceItem')] = None, frequency: str = None) -> None
 
Response including channels.
 
:attr str channel_id: (optional) unique id of the channel.
:attr str name: (optional)
:attr str description: (optional) A one sentence description of this `Channel`.
:attr str type: (optional) Type of callback URL.
:attr ChannelResponseDefinitionSeverity severity: (optional) Severity of the
      notification.
:attr str endpoint: (optional) The callback URL which receives the notification.
:attr bool enabled: (optional) Channel is enabled or not. Default is disabled.
:attr List[ChannelResponseDefinitionAlertSourceItem] alert_source: (optional)
:attr str frequency: (optional)
 
  Methods defined here:
__eq__(self, other: 'ChannelResponseDefinition') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, channel_id: str = None, name: str = None, description: str = None, type: str = None, severity: 'ChannelResponseDefinitionSeverity' = None, endpoint: str = None, enabled: bool = None, alert_source: List[ForwardRef('ChannelResponseDefinitionAlertSourceItem')] = None, frequency: str = None) -> None
Initialize a ChannelResponseDefinition object.
 
:param str channel_id: (optional) unique id of the channel.
:param str name: (optional)
:param str description: (optional) A one sentence description of this
       `Channel`.
:param str type: (optional) Type of callback URL.
:param ChannelResponseDefinitionSeverity severity: (optional) Severity of
       the notification.
:param str endpoint: (optional) The callback URL which receives the
       notification.
:param bool enabled: (optional) Channel is enabled or not. Default is
       disabled.
:param List[ChannelResponseDefinitionAlertSourceItem] alert_source:
       (optional)
:param str frequency: (optional)
__ne__(self, other: 'ChannelResponseDefinition') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this ChannelResponseDefinition object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'ChannelResponseDefinition' from builtins.type
Initialize a ChannelResponseDefinition object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
TypeEnum = <enum 'TypeEnum'>
Type of callback URL.
__hash__ = None

 
class ChannelResponseDefinitionAlertSourceItem(builtins.object)
    ChannelResponseDefinitionAlertSourceItem(*, provider_name: str = None, finding_types: List[str] = None) -&gt; None
 
The alert sources. They identify the providers and their finding types which makes the
findings available to Security Advisor.
 
:attr str provider_name: (optional) Below is a list of builtin providers that
      you can select in addition to the ones you obtain by calling Findings API
      /v1/{account_id}/providers :
       | provider_name | The source they represent |
       |-----|-----|
       | VA  | Vulnerable image findings|
       | NA  | Network Insights findings|
       | ATA | Activity Insights findings|
       | CERT | Certificate Manager findings|
       | ALL | Special provider name to represent all the providers. Its mutually
      exclusive with other providers meaning either you choose ALL or you don't|.
:attr List[str] finding_types: (optional) An array of the finding types of the
      provider_name or "ALL" to specify all finding types under that provider Below is
      a list of supported finding types for each built in providers
      | provider_name | Supported finding types |
      |-----|-----|
      | VA  | "image_with_vulnerabilities", "image_with_config_issues"|
      | NA  | "anonym_server", "malware_server", "bot_server", "miner_server",
      "server_suspected_ratio", "server_response", "data_extrusion",
      "server_weaponized_total"|
      | ATA | "appid", "cos", "iks", "iam", "kms", "cert", "account", "app"|
      | CERT | "expired_cert", "expiring_1day_cert", "expiring_10day_cert",
      "expiring_30day_cert", "expiring_60day_cert", "expiring_90day_cert"|
      | config-advisor | "appprotection-dns_not_proxied", "appprotection-dnssec_off",
      "appprotection-ssl_not_strict", "appprotection-tls_min_version",
      "appprotection-waf_off", "appprotection-waf_rules", "calico-deny_all_rule",
      "calico-nonstandard_ports", "calico-update_cis_whitelist",
      "datacos-cos_managers", "datacos-not_encrypted_via_kp",
      "datacos-not_in_private_network", "datacos-public_bucket_acl",
      "datacos-public_bucket_iam", "datacos-public_object_acl", "iam-account_admins",
      "iam-all_resource_managers", "iam-all_resource_readers", "iam-identity_admins",
      "iam-kms_managers", "iam-out_of_group"|
      | ALL | "ALL"|.
 
  Methods defined here:
__eq__(self, other: 'ChannelResponseDefinitionAlertSourceItem') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, provider_name: str = None, finding_types: List[str] = None) -> None
Initialize a ChannelResponseDefinitionAlertSourceItem object.
 
:param str provider_name: (optional) Below is a list of builtin providers
       that you can select in addition to the ones you obtain by calling Findings
       API /v1/{account_id}/providers :
        | provider_name | The source they represent |
        |-----|-----|
        | VA  | Vulnerable image findings|
        | NA  | Network Insights findings|
        | ATA | Activity Insights findings|
        | CERT | Certificate Manager findings|
        | ALL | Special provider name to represent all the providers. Its mutually
       exclusive with other providers meaning either you choose ALL or you don't|.
:param List[str] finding_types: (optional) An array of the finding types of
       the provider_name or "ALL" to specify all finding types under that provider
       Below is a list of supported finding types for each built in providers
       | provider_name | Supported finding types |
       |-----|-----|
       | VA  | "image_with_vulnerabilities", "image_with_config_issues"|
       | NA  | "anonym_server", "malware_server", "bot_server", "miner_server",
       "server_suspected_ratio", "server_response", "data_extrusion",
       "server_weaponized_total"|
       | ATA | "appid", "cos", "iks", "iam", "kms", "cert", "account", "app"|
       | CERT | "expired_cert", "expiring_1day_cert", "expiring_10day_cert",
       "expiring_30day_cert", "expiring_60day_cert", "expiring_90day_cert"|
       | config-advisor | "appprotection-dns_not_proxied",
       "appprotection-dnssec_off", "appprotection-ssl_not_strict",
       "appprotection-tls_min_version", "appprotection-waf_off",
       "appprotection-waf_rules", "calico-deny_all_rule",
       "calico-nonstandard_ports", "calico-update_cis_whitelist",
       "datacos-cos_managers", "datacos-not_encrypted_via_kp",
       "datacos-not_in_private_network", "datacos-public_bucket_acl",
       "datacos-public_bucket_iam", "datacos-public_object_acl",
       "iam-account_admins", "iam-all_resource_managers",
       "iam-all_resource_readers", "iam-identity_admins", "iam-kms_managers",
       "iam-out_of_group"|
       | ALL | "ALL"|.
__ne__(self, other: 'ChannelResponseDefinitionAlertSourceItem') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this ChannelResponseDefinitionAlertSourceItem object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'ChannelResponseDefinitionAlertSourceItem' from builtins.type
Initialize a ChannelResponseDefinitionAlertSourceItem object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class ChannelResponseDefinitionSeverity(builtins.object)
    ChannelResponseDefinitionSeverity(*, high: bool = None, medium: bool = None, low: bool = None) -&gt; None
 
Severity of the notification.
 
:attr bool high: (optional) High Severity.
:attr bool medium: (optional) Medium Severity.
:attr bool low: (optional) Low Severity.
 
  Methods defined here:
__eq__(self, other: 'ChannelResponseDefinitionSeverity') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, high: bool = None, medium: bool = None, low: bool = None) -> None
Initialize a ChannelResponseDefinitionSeverity object.
 
:param bool high: (optional) High Severity.
:param bool medium: (optional) Medium Severity.
:param bool low: (optional) Low Severity.
__ne__(self, other: 'ChannelResponseDefinitionSeverity') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this ChannelResponseDefinitionSeverity object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'ChannelResponseDefinitionSeverity' from builtins.type
Initialize a ChannelResponseDefinitionSeverity object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class CreateChannelsResponse(builtins.object)
    CreateChannelsResponse(*, channel_id: str = None, status_code: int = None) -&gt; None
 
Response of created channel.
 
:attr str channel_id: (optional) id of the created channel.
:attr int status_code: (optional) response code.
 
  Methods defined here:
__eq__(self, other: 'CreateChannelsResponse') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, channel_id: str = None, status_code: int = None) -> None
Initialize a CreateChannelsResponse object.
 
:param str channel_id: (optional) id of the created channel.
:param int status_code: (optional) response code.
__ne__(self, other: 'CreateChannelsResponse') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this CreateChannelsResponse object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'CreateChannelsResponse' from builtins.type
Initialize a CreateChannelsResponse object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class DeleteChannelResponse(builtins.object)
    DeleteChannelResponse(*, channel_id: str = None, message: str = None) -&gt; None
 
Response of deleted channel.
 
:attr str channel_id: (optional) id of the created channel.
:attr str message: (optional) response message.
 
  Methods defined here:
__eq__(self, other: 'DeleteChannelResponse') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, channel_id: str = None, message: str = None) -> None
Initialize a DeleteChannelResponse object.
 
:param str channel_id: (optional) id of the created channel.
:param str message: (optional) response message.
__ne__(self, other: 'DeleteChannelResponse') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this DeleteChannelResponse object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'DeleteChannelResponse' from builtins.type
Initialize a DeleteChannelResponse object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class GetChannelResponse(builtins.object)
    GetChannelResponse(*, channel: 'GetChannelResponseChannel' = None) -&gt; None
 
Response of get channel.
 
:attr GetChannelResponseChannel channel: (optional) Response including channels.
 
  Methods defined here:
__eq__(self, other: 'GetChannelResponse') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, channel: 'GetChannelResponseChannel' = None) -> None
Initialize a GetChannelResponse object.
 
:param GetChannelResponseChannel channel: (optional) Response including
       channels.
__ne__(self, other: 'GetChannelResponse') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this GetChannelResponse object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'GetChannelResponse' from builtins.type
Initialize a GetChannelResponse object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class GetChannelResponseChannel(builtins.object)
    GetChannelResponseChannel(*, channel_id: str = None, name: str = None, description: str = None, type: str = None, severity: 'GetChannelResponseChannelSeverity' = None, endpoint: str = None, enabled: bool = None, alert_source: List[ForwardRef('GetChannelResponseChannelAlertSource')] = None, frequency: str = None) -&gt; None
 
Response including channels.
 
:attr str channel_id: (optional) unique id of the channel.
:attr str name: (optional)
:attr str description: (optional) A one sentence description of this `Channel`.
:attr str type: (optional) Type of callback URL.
:attr GetChannelResponseChannelSeverity severity: (optional) Severity of the
      notification.
:attr str endpoint: (optional) The callback URL which receives the notification.
:attr bool enabled: (optional) Channel is enabled or not. Default is disabled.
:attr List[GetChannelResponseChannelAlertSource] alert_source: (optional)
:attr str frequency: (optional)
 
  Methods defined here:
__eq__(self, other: 'GetChannelResponseChannel') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, channel_id: str = None, name: str = None, description: str = None, type: str = None, severity: 'GetChannelResponseChannelSeverity' = None, endpoint: str = None, enabled: bool = None, alert_source: List[ForwardRef('GetChannelResponseChannelAlertSource')] = None, frequency: str = None) -> None
Initialize a GetChannelResponseChannel object.
 
:param str channel_id: (optional) unique id of the channel.
:param str name: (optional)
:param str description: (optional) A one sentence description of this
       `Channel`.
:param str type: (optional) Type of callback URL.
:param GetChannelResponseChannelSeverity severity: (optional) Severity of
       the notification.
:param str endpoint: (optional) The callback URL which receives the
       notification.
:param bool enabled: (optional) Channel is enabled or not. Default is
       disabled.
:param List[GetChannelResponseChannelAlertSource] alert_source: (optional)
:param str frequency: (optional)
__ne__(self, other: 'GetChannelResponseChannel') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this GetChannelResponseChannel object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'GetChannelResponseChannel' from builtins.type
Initialize a GetChannelResponseChannel object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
TypeEnum = <enum 'TypeEnum'>
Type of callback URL.
__hash__ = None

 
class GetChannelResponseChannelAlertSource(builtins.object)
    GetChannelResponseChannelAlertSource(*, provider_name: str = None, finding_types: List[str] = None) -&gt; None
 
The alert sources. They identify the providers and their finding types which makes the
findings available to Security Advisor.
 
:attr str provider_name: (optional) Below is a list of builtin providers that
      you can select in addition to the ones you obtain by calling Findings API
      /v1/{account_id}/providers :
       | provider_name | The source they represent |
       |-----|-----|
       | VA  | Vulnerable image findings|
       | NA  | Network Insights findings|
       | ATA | Activity Insights findings|
       | CERT | Certificate Manager findings|
       | ALL | Special provider name to represent all the providers. Its mutually
      exclusive with other providers meaning either you choose ALL or you don't|.
:attr List[str] finding_types: (optional) An array of the finding types of the
      provider_name or "ALL" to specify all finding types under that provider Below is
      a list of supported finding types for each built in providers
      | provider_name | Supported finding types |
      |-----|-----|
      | VA  | "image_with_vulnerabilities", "image_with_config_issues"|
      | NA  | "anonym_server", "malware_server", "bot_server", "miner_server",
      "server_suspected_ratio", "server_response", "data_extrusion",
      "server_weaponized_total"|
      | ATA | "appid", "cos", "iks", "iam", "kms", "cert", "account", "app"|
      | CERT | "expired_cert", "expiring_1day_cert", "expiring_10day_cert",
      "expiring_30day_cert", "expiring_60day_cert", "expiring_90day_cert"|
      | config-advisor | "appprotection-dns_not_proxied", "appprotection-dnssec_off",
      "appprotection-ssl_not_strict", "appprotection-tls_min_version",
      "appprotection-waf_off", "appprotection-waf_rules", "calico-deny_all_rule",
      "calico-nonstandard_ports", "calico-update_cis_whitelist",
      "datacos-cos_managers", "datacos-not_encrypted_via_kp",
      "datacos-not_in_private_network", "datacos-public_bucket_acl",
      "datacos-public_bucket_iam", "datacos-public_object_acl", "iam-account_admins",
      "iam-all_resource_managers", "iam-all_resource_readers", "iam-identity_admins",
      "iam-kms_managers", "iam-out_of_group"|
      | ALL | "ALL"|.
 
  Methods defined here:
__eq__(self, other: 'GetChannelResponseChannelAlertSource') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, provider_name: str = None, finding_types: List[str] = None) -> None
Initialize a GetChannelResponseChannelAlertSource object.
 
:param str provider_name: (optional) Below is a list of builtin providers
       that you can select in addition to the ones you obtain by calling Findings
       API /v1/{account_id}/providers :
        | provider_name | The source they represent |
        |-----|-----|
        | VA  | Vulnerable image findings|
        | NA  | Network Insights findings|
        | ATA | Activity Insights findings|
        | CERT | Certificate Manager findings|
        | ALL | Special provider name to represent all the providers. Its mutually
       exclusive with other providers meaning either you choose ALL or you don't|.
:param List[str] finding_types: (optional) An array of the finding types of
       the provider_name or "ALL" to specify all finding types under that provider
       Below is a list of supported finding types for each built in providers
       | provider_name | Supported finding types |
       |-----|-----|
       | VA  | "image_with_vulnerabilities", "image_with_config_issues"|
       | NA  | "anonym_server", "malware_server", "bot_server", "miner_server",
       "server_suspected_ratio", "server_response", "data_extrusion",
       "server_weaponized_total"|
       | ATA | "appid", "cos", "iks", "iam", "kms", "cert", "account", "app"|
       | CERT | "expired_cert", "expiring_1day_cert", "expiring_10day_cert",
       "expiring_30day_cert", "expiring_60day_cert", "expiring_90day_cert"|
       | config-advisor | "appprotection-dns_not_proxied",
       "appprotection-dnssec_off", "appprotection-ssl_not_strict",
       "appprotection-tls_min_version", "appprotection-waf_off",
       "appprotection-waf_rules", "calico-deny_all_rule",
       "calico-nonstandard_ports", "calico-update_cis_whitelist",
       "datacos-cos_managers", "datacos-not_encrypted_via_kp",
       "datacos-not_in_private_network", "datacos-public_bucket_acl",
       "datacos-public_bucket_iam", "datacos-public_object_acl",
       "iam-account_admins", "iam-all_resource_managers",
       "iam-all_resource_readers", "iam-identity_admins", "iam-kms_managers",
       "iam-out_of_group"|
       | ALL | "ALL"|.
__ne__(self, other: 'GetChannelResponseChannelAlertSource') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this GetChannelResponseChannelAlertSource object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'GetChannelResponseChannelAlertSource' from builtins.type
Initialize a GetChannelResponseChannelAlertSource object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class GetChannelResponseChannelSeverity(builtins.object)
    GetChannelResponseChannelSeverity(*, high: bool = None, medium: bool = None, low: bool = None) -&gt; None
 
Severity of the notification.
 
:attr bool high: (optional) High Severity.
:attr bool medium: (optional) Medium Severity.
:attr bool low: (optional) Low Severity.
 
  Methods defined here:
__eq__(self, other: 'GetChannelResponseChannelSeverity') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, high: bool = None, medium: bool = None, low: bool = None) -> None
Initialize a GetChannelResponseChannelSeverity object.
 
:param bool high: (optional) High Severity.
:param bool medium: (optional) Medium Severity.
:param bool low: (optional) Low Severity.
__ne__(self, other: 'GetChannelResponseChannelSeverity') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this GetChannelResponseChannelSeverity object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'GetChannelResponseChannelSeverity' from builtins.type
Initialize a GetChannelResponseChannelSeverity object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class ListChannelsResponse(builtins.object)
    ListChannelsResponse(*, channels: List[ForwardRef('ChannelResponseDefinition')] = None) -&gt; None
 
Response including channels.
 
:attr List[ChannelResponseDefinition] channels: (optional)
 
  Methods defined here:
__eq__(self, other: 'ListChannelsResponse') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, channels: List[ForwardRef('ChannelResponseDefinition')] = None) -> None
Initialize a ListChannelsResponse object.
 
:param List[ChannelResponseDefinition] channels: (optional)
__ne__(self, other: 'ListChannelsResponse') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this ListChannelsResponse object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'ListChannelsResponse' from builtins.type
Initialize a ListChannelsResponse object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class NotificationChannelAlertSourceItem(builtins.object)
    NotificationChannelAlertSourceItem(provider_name: str, *, finding_types: List[str] = None) -&gt; None
 
The alert sources. They identify the providers and their finding types which makes the
findings available to Security Advisor.
 
:attr str provider_name: Below is a list of builtin providers that you can
      select in addition to the ones you obtain by calling Findings API
      /v1/{account_id}/providers :
       | provider_name | The source they represent |
       |-----|-----|
       | VA  | Vulnerable image findings|
       | NA  | Network Insights findings|
       | ATA | Activity Insights findings|
       | CERT | Certificate Manager findings|
       | ALL | Special provider name to represent all the providers. Its mutually
      exclusive with other providers meaning either you choose ALL or you don't|.
:attr List[str] finding_types: (optional) An array of the finding types of the
      provider_name or "ALL" to specify all finding types under that provider Below is
      a list of supported finding types for each built in providers
      | provider_name | Supported finding types |
      |-----|-----|
      | VA  | "image_with_vulnerabilities", "image_with_config_issues"|
      | NA  | "anonym_server", "malware_server", "bot_server", "miner_server",
      "server_suspected_ratio", "server_response", "data_extrusion",
      "server_weaponized_total"|
      | ATA | "appid", "cos", "iks", "iam", "kms", "cert", "account", "app"|
      | CERT | "expired_cert", "expiring_1day_cert", "expiring_10day_cert",
      "expiring_30day_cert", "expiring_60day_cert", "expiring_90day_cert"|
      | config-advisor | "appprotection-dns_not_proxied", "appprotection-dnssec_off",
      "appprotection-ssl_not_strict", "appprotection-tls_min_version",
      "appprotection-waf_off", "appprotection-waf_rules", "calico-deny_all_rule",
      "calico-nonstandard_ports", "calico-update_cis_whitelist",
      "datacos-cos_managers", "datacos-not_encrypted_via_kp",
      "datacos-not_in_private_network", "datacos-public_bucket_acl",
      "datacos-public_bucket_iam", "datacos-public_object_acl", "iam-account_admins",
      "iam-all_resource_managers", "iam-all_resource_readers", "iam-identity_admins",
      "iam-kms_managers", "iam-out_of_group"|
      | ALL | "ALL"|.
 
  Methods defined here:
__eq__(self, other: 'NotificationChannelAlertSourceItem') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, provider_name: str, *, finding_types: List[str] = None) -> None
Initialize a NotificationChannelAlertSourceItem object.
 
:param str provider_name: Below is a list of builtin providers that you can
       select in addition to the ones you obtain by calling Findings API
       /v1/{account_id}/providers :
        | provider_name | The source they represent |
        |-----|-----|
        | VA  | Vulnerable image findings|
        | NA  | Network Insights findings|
        | ATA | Activity Insights findings|
        | CERT | Certificate Manager findings|
        | ALL | Special provider name to represent all the providers. Its mutually
       exclusive with other providers meaning either you choose ALL or you don't|.
:param List[str] finding_types: (optional) An array of the finding types of
       the provider_name or "ALL" to specify all finding types under that provider
       Below is a list of supported finding types for each built in providers
       | provider_name | Supported finding types |
       |-----|-----|
       | VA  | "image_with_vulnerabilities", "image_with_config_issues"|
       | NA  | "anonym_server", "malware_server", "bot_server", "miner_server",
       "server_suspected_ratio", "server_response", "data_extrusion",
       "server_weaponized_total"|
       | ATA | "appid", "cos", "iks", "iam", "kms", "cert", "account", "app"|
       | CERT | "expired_cert", "expiring_1day_cert", "expiring_10day_cert",
       "expiring_30day_cert", "expiring_60day_cert", "expiring_90day_cert"|
       | config-advisor | "appprotection-dns_not_proxied",
       "appprotection-dnssec_off", "appprotection-ssl_not_strict",
       "appprotection-tls_min_version", "appprotection-waf_off",
       "appprotection-waf_rules", "calico-deny_all_rule",
       "calico-nonstandard_ports", "calico-update_cis_whitelist",
       "datacos-cos_managers", "datacos-not_encrypted_via_kp",
       "datacos-not_in_private_network", "datacos-public_bucket_acl",
       "datacos-public_bucket_iam", "datacos-public_object_acl",
       "iam-account_admins", "iam-all_resource_managers",
       "iam-all_resource_readers", "iam-identity_admins", "iam-kms_managers",
       "iam-out_of_group"|
       | ALL | "ALL"|.
__ne__(self, other: 'NotificationChannelAlertSourceItem') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this NotificationChannelAlertSourceItem object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'NotificationChannelAlertSourceItem' from builtins.type
Initialize a NotificationChannelAlertSourceItem object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class NotificationsApiV1(ibm_cloud_sdk_core.base_service.BaseService)
    NotificationsApiV1(authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None, service_name: str = 'notifications_api') -&gt; None
 
The Notifications API V1 service.
 
 
Method resolution order:
NotificationsApiV1
ibm_cloud_sdk_core.base_service.BaseService
builtins.object
Methods defined here:
__init__(self, authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None, service_name: str = 'notifications_api') -> None
Construct a new client for the Notifications API service.
 
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
       Get up to date information from https://github.com/IBM/python-sdk-core/blob/master/README.md
       about initializing the authenticator of your choice.
create_notification_channel(self, account_id: str, name: str, type: str, endpoint: str, *, description: str = None, severity: List[str] = None, enabled: bool = None, alert_source: List[ForwardRef('NotificationChannelAlertSourceItem')] = None, **kwargs) -> 'DetailedResponse'
create notification channel.
 
create notification channel.
 
:param str account_id: Account ID.
:param str name:
:param str type: Type of callback URL.
:param str endpoint: The callback URL which receives the notification.
:param str description: (optional) A one sentence description of this
       `Channel`.
:param List[str] severity: (optional) Severity of the notification to be
       received.
:param bool enabled: (optional) Channel is enabled or not. Default is
       disabled.
:param List[NotificationChannelAlertSourceItem] alert_source: (optional)
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
delete_notification_channel(self, account_id: str, channel_id: str, **kwargs) -> 'DetailedResponse'
delete the details of a specific channel.
 
delete the details of a specific channel.
 
:param str account_id: Account ID.
:param str channel_id: Channel ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
delete_notification_channels(self, account_id: str, body: List[str], **kwargs) -> 'DetailedResponse'
bulk delete of channels.
 
bulk delete of channels.
 
:param str account_id: Account ID.
:param List[str] body: Body for bulk delete notification channels.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
get_notification_channel(self, account_id: str, channel_id: str, **kwargs) -> 'DetailedResponse'
get the details of a specific channel.
 
get the details of a specific channel.
 
:param str account_id: Account ID.
:param str channel_id: Channel ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
get_public_key(self, account_id: str, **kwargs) -> 'DetailedResponse'
fetch notifications public key.
 
fetch public key to decrypt messages in notification payload.
 
:param str account_id: Account ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
list_all_channels(self, account_id: str, *, limit: int = None, skip: int = None, **kwargs) -> 'DetailedResponse'
list all channels.
 
list all channels under this account.
 
:param str account_id: Account ID.
:param int limit: (optional) Limit the number of the returned documents to
       the specified number.
:param int skip: (optional) The offset is the index of the item from which
       you want to start returning data from. Default is 0.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
test_notification_channel(self, account_id: str, channel_id: str, **kwargs) -> 'DetailedResponse'
test notification channel.
 
test a nofication channel under this account.
 
:param str account_id: Account ID.
:param str channel_id: Channel ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
update_notification_channel(self, account_id: str, channel_id: str, name: str, type: str, endpoint: str, *, description: str = None, severity: List[str] = None, enabled: bool = None, alert_source: List[ForwardRef('NotificationChannelAlertSourceItem')] = None, **kwargs) -> 'DetailedResponse'
update notification channel.
 
update notification channel.
 
:param str account_id: Account ID.
:param str channel_id: Channel ID.
:param str name:
:param str type: Type of callback URL.
:param str endpoint: The callback URL which receives the notification.
:param str description: (optional) A one sentence description of this
       `Channel`.
:param List[str] severity: (optional) Severity of the notification to be
       received.
:param bool enabled: (optional) Channel is enabled or not. Default is
       disabled.
:param List[NotificationChannelAlertSourceItem] alert_source: (optional)
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
Class methods defined here:
new_instance(service_name: str = 'notifications_api') -> 'NotificationsApiV1' from builtins.type
Data and other attributes defined here:
DEFAULT_SERVICE_NAME = 'notifications_api'
DEFAULT_SERVICE_URL = 'https://us-south.secadvisor.cloud.ibm.com/notifications'
Methods inherited from ibm_cloud_sdk_core.base_service.BaseService:
configure_service(self, service_name: str)
Look for external configuration of a service. Set service properties.
 
Try to get config from external sources, with the following priority:
1. Credentials file(ibm-credentials.env)
2. Environment variables
3. VCAP Services(Cloud Foundry)
 
Args:
    service_name: The service name
 
Raises:
    ValueError: If service_name is not a string.
get_authenticator(self) -> ibm_cloud_sdk_core.authenticators.authenticator.Authenticator
Get the authenticator currently used by the service.
 
Returns:
    The authenticator currently used by the service.
prepare_request(self, method: str, url: str, headers: Union[dict, NoneType] = None, params: Union[dict, NoneType] = None, data: Union[str, dict, NoneType] = None, files: Union[Dict[str, Tuple[str]], List[Tuple[str, Tuple[str, ...]]], NoneType] = None, **kwargs) -> dict
Build a dict that represents an HTTP service request.
 
Clean up headers, add default http configuration, convert data
into json, process files, and merge all into a single request dict.
 
Args:
    method: The HTTP method of the request ex. GET, POST, etc.
    url: The origin + pathname according to WHATWG spec.
 
Keyword Arguments:
    headers: Headers of the request.
    params: Querystring data to be appended to the url.
    data: The request body. Converted to json if a dict.
    files: 'files' can be a dictionary (i.e { '<part-name>': (<tuple>)}),
        or a list of tuples [ (<part-name>, (<tuple>))... ]
 
Returns:
    Prepared request dictionary.
send(self, request: requests.models.Request, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse
Send a request and wrap the response in a DetailedResponse or APIException.
 
Args:
    request: The request to send to the service endpoint.
 
Raises:
    ApiException: The exception from the API.
 
Returns:
    The response from the request.
set_default_headers(self, headers: Dict[str, str])
Set http headers to be sent in every request.
 
Arguments:
    headers: A dictionary of headers
set_disable_ssl_verification(self, status: bool = False)
Set the flag that indicates whether verification of
the server's SSL certificate should be disabled or not.
 
Keyword Arguments:
    status: set to true to disable ssl verification (default: {False})
set_http_config(self, http_config: dict)
Sets the http config dictionary.
 
The dictionary can contain values that control the timeout, proxies, and etc of HTTP requests.
 
Arguments:
    http_config: Configuration values to customize HTTP behaviors.
 
Raises:
    TypeError: http_config is not a dict.
set_service_url(self, service_url: str)
Set the url the service will make HTTP requests too.
 
Arguments:
    service_url: The WHATWG URL standard origin ex. https://example.service.com
 
Raises:
    ValueError: Improperly formatted service_url
Static methods inherited from ibm_cloud_sdk_core.base_service.BaseService:
encode_path_vars(*args: str) -> List[str]
Encode path variables to be substituted into a URL path.
 
Arguments:
    args: A list of strings to be URL path encoded
 
Returns:
    A list of encoded strings that are safe to substitute into a URL path.
Data descriptors inherited from ibm_cloud_sdk_core.base_service.BaseService:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes inherited from ibm_cloud_sdk_core.base_service.BaseService:
ERROR_MSG_DISABLE_SSL = 'The connection failed because the SSL certificat...ble_ssl_verification option of the authenticator.'
SDK_NAME = 'ibm-python-sdk-core'

 
class PublicKeyResponse(builtins.object)
    PublicKeyResponse(public_key: str) -&gt; None
 
PublicKeyResponse.
 
:attr str public_key:
 
  Methods defined here:
__eq__(self, other: 'PublicKeyResponse') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, public_key: str) -> None
Initialize a PublicKeyResponse object.
 
:param str public_key:
__ne__(self, other: 'PublicKeyResponse') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this PublicKeyResponse object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'PublicKeyResponse' from builtins.type
Initialize a PublicKeyResponse object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class TestChannelResponse(builtins.object)
    TestChannelResponse(*, test: str = None) -&gt; None
 
Response of deleted channel.
 
:attr str test: (optional) response status.
 
  Methods defined here:
__eq__(self, other: 'TestChannelResponse') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, test: str = None) -> None
Initialize a TestChannelResponse object.
 
:param str test: (optional) response status.
__ne__(self, other: 'TestChannelResponse') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this TestChannelResponse object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'TestChannelResponse' from builtins.type
Initialize a TestChannelResponse object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
class UpdateChannelResponse(builtins.object)
    UpdateChannelResponse(*, channel_id: str = None, status_code: int = None) -&gt; None
 
Response of updated channel.
 
:attr str channel_id: (optional) id of the updated channel.
:attr int status_code: (optional) response code.
 
  Methods defined here:
__eq__(self, other: 'UpdateChannelResponse') -> bool
Return `true` when self and other are equal, false otherwise.
__init__(self, *, channel_id: str = None, status_code: int = None) -> None
Initialize a UpdateChannelResponse object.
 
:param str channel_id: (optional) id of the updated channel.
:param int status_code: (optional) response code.
__ne__(self, other: 'UpdateChannelResponse') -> bool
Return `true` when self and other are not equal, false otherwise.
__str__(self) -> str
Return a `str` version of this UpdateChannelResponse object.
to_dict(self) -> Dict
Return a json dictionary representing this model.
Class methods defined here:
from_dict(_dict: Dict) -> 'UpdateChannelResponse' from builtins.type
Initialize a UpdateChannelResponse object from a json dictionary.
Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
Data and other attributes defined here:
__hash__ = None

 
Data
        Dict = typing.Dict
List = typing.List