NotificationSetting

class oci.identity_domains.models.NotificationSetting(**kwargs)

Bases: object

Notification resource.

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

A constant which can be used with the idcs_prevented_operations property of a NotificationSetting.

IDCS_PREVENTED_OPERATIONS_REPLACE

A constant which can be used with the idcs_prevented_operations property of a NotificationSetting.

IDCS_PREVENTED_OPERATIONS_UPDATE

A constant which can be used with the idcs_prevented_operations property of a NotificationSetting.

compartment_ocid

Gets the compartment_ocid of this NotificationSetting.

delete_in_progress

Gets the delete_in_progress of this NotificationSetting.

domain_ocid

Gets the domain_ocid of this NotificationSetting.

event_settings

[Required] Gets the event_settings of this NotificationSetting.

external_id

Gets the external_id of this NotificationSetting.

from_email_address

[Required] Gets the from_email_address of this NotificationSetting.

id

Gets the id of this NotificationSetting.

idcs_created_by

Gets the idcs_created_by of this NotificationSetting.

idcs_last_modified_by

Gets the idcs_last_modified_by of this NotificationSetting.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this NotificationSetting.

idcs_prevented_operations

Gets the idcs_prevented_operations of this NotificationSetting.

meta

Gets the meta of this NotificationSetting.

notification_enabled

[Required] Gets the notification_enabled of this NotificationSetting.

ocid

Gets the ocid of this NotificationSetting.

schemas

[Required] Gets the schemas of this NotificationSetting.

send_notification_to_old_and_new_primary_emails_when_admin_changes_primary_email

Gets the send_notification_to_old_and_new_primary_emails_when_admin_changes_primary_email of this NotificationSetting.

send_notifications_to_secondary_email

Gets the send_notifications_to_secondary_email of this NotificationSetting.

tags

Gets the tags of this NotificationSetting.

tenancy_ocid

Gets the tenancy_ocid of this NotificationSetting.

test_mode_enabled

Gets the test_mode_enabled of this NotificationSetting.

test_recipients

Gets the test_recipients of this NotificationSetting.

Methods:

__init__(**kwargs)

Initializes a new NotificationSetting object with values from keyword arguments.

IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'

A constant which can be used with the idcs_prevented_operations property of a NotificationSetting. This constant has a value of “delete”

IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'

A constant which can be used with the idcs_prevented_operations property of a NotificationSetting. This constant has a value of “replace”

IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'

A constant which can be used with the idcs_prevented_operations property of a NotificationSetting. This constant has a value of “update”

__init__(**kwargs)

Initializes a new NotificationSetting object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this NotificationSetting.

  • ocid (str) – The value to assign to the ocid property of this NotificationSetting.

  • schemas (list[str]) – The value to assign to the schemas property of this NotificationSetting.

  • meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this NotificationSetting.

  • idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this NotificationSetting.

  • idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this NotificationSetting.

  • idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this NotificationSetting. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this NotificationSetting.

  • delete_in_progress (bool) – The value to assign to the delete_in_progress property of this NotificationSetting.

  • idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this NotificationSetting.

  • domain_ocid (str) – The value to assign to the domain_ocid property of this NotificationSetting.

  • compartment_ocid (str) – The value to assign to the compartment_ocid property of this NotificationSetting.

  • tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this NotificationSetting.

  • external_id (str) – The value to assign to the external_id property of this NotificationSetting.

  • notification_enabled (bool) – The value to assign to the notification_enabled property of this NotificationSetting.

  • test_mode_enabled (bool) – The value to assign to the test_mode_enabled property of this NotificationSetting.

  • test_recipients (list[str]) – The value to assign to the test_recipients property of this NotificationSetting.

  • send_notifications_to_secondary_email (bool) – The value to assign to the send_notifications_to_secondary_email property of this NotificationSetting.

  • send_notification_to_old_and_new_primary_emails_when_admin_changes_primary_email (bool) – The value to assign to the send_notification_to_old_and_new_primary_emails_when_admin_changes_primary_email property of this NotificationSetting.

  • from_email_address (oci.identity_domains.models.NotificationSettingsFromEmailAddress) – The value to assign to the from_email_address property of this NotificationSetting.

  • event_settings (list[oci.identity_domains.models.NotificationSettingsEventSettings]) – The value to assign to the event_settings property of this NotificationSetting.

property compartment_ocid

Gets the compartment_ocid of this NotificationSetting. OCI Compartment Id (ocid) in which the resource lives.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The compartment_ocid of this NotificationSetting.

Return type

str

property delete_in_progress

Gets the delete_in_progress of this NotificationSetting. A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The delete_in_progress of this NotificationSetting.

Return type

bool

property domain_ocid

Gets the domain_ocid of this NotificationSetting. OCI Domain Id (ocid) in which the resource lives.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The domain_ocid of this NotificationSetting.

Return type

str

property event_settings

[Required] Gets the event_settings of this NotificationSetting. Event settings

SCIM++ Properties:
  • caseExact: false

  • idcsCompositeKey: [eventId]

  • idcsSearchable: false

  • multiValued: true

  • mutability: readWrite

  • required: true

  • returned: default

  • type: complex

  • uniqueness: none

Returns

The event_settings of this NotificationSetting.

Return type

list[oci.identity_domains.models.NotificationSettingsEventSettings]

property external_id

Gets the external_id of this NotificationSetting. An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer’s tenant.

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The external_id of this NotificationSetting.

Return type

str

property from_email_address

[Required] Gets the from_email_address of this NotificationSetting.

Returns

The from_email_address of this NotificationSetting.

Return type

oci.identity_domains.models.NotificationSettingsFromEmailAddress

property id

Gets the id of this NotificationSetting. Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: always

  • type: string

  • uniqueness: global

Returns

The id of this NotificationSetting.

Return type

str

property idcs_created_by

Gets the idcs_created_by of this NotificationSetting.

Returns

The idcs_created_by of this NotificationSetting.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this NotificationSetting.

Returns

The idcs_last_modified_by of this NotificationSetting.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this NotificationSetting. The release number when the resource was upgraded.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: request

  • type: string

  • uniqueness: none

Returns

The idcs_last_upgraded_in_release of this NotificationSetting.

Return type

str

property idcs_prevented_operations

Gets the idcs_prevented_operations of this NotificationSetting. Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: request

  • type: string

  • uniqueness: none

Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The idcs_prevented_operations of this NotificationSetting.

Return type

list[str]

property meta

Gets the meta of this NotificationSetting.

Returns

The meta of this NotificationSetting.

Return type

oci.identity_domains.models.Meta

property notification_enabled

[Required] Gets the notification_enabled of this NotificationSetting. Tenant level settings for the notification service

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The notification_enabled of this NotificationSetting.

Return type

bool

property ocid

Gets the ocid of this NotificationSetting. Unique OCI identifier for the SCIM Resource.

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: string

  • uniqueness: global

Returns

The ocid of this NotificationSetting.

Return type

str

property schemas

[Required] Gets the schemas of this NotificationSetting. REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard “enterprise” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: true

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: none

Returns

The schemas of this NotificationSetting.

Return type

list[str]

property send_notification_to_old_and_new_primary_emails_when_admin_changes_primary_email

Gets the send_notification_to_old_and_new_primary_emails_when_admin_changes_primary_email of this NotificationSetting. If true and admin changed user’s primary email, send user’s profile changed email to old and new primary email address.

Added In: 20.1.3

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The send_notification_to_old_and_new_primary_emails_when_admin_changes_primary_email of this NotificationSetting.

Return type

bool

property send_notifications_to_secondary_email

Gets the send_notifications_to_secondary_email of this NotificationSetting. Indicates whether to allow notifications on a secondary email.

Deprecated Since: 19.2.1

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The send_notifications_to_secondary_email of this NotificationSetting.

Return type

bool

property tags

Gets the tags of this NotificationSetting. A list of tags on this resource.

SCIM++ Properties:
  • idcsCompositeKey: [key, value]

  • idcsSearchable: true

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: request

  • type: complex

  • uniqueness: none

Returns

The tags of this NotificationSetting.

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

Gets the tenancy_ocid of this NotificationSetting. OCI Tenant Id (ocid) in which the resource lives.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The tenancy_ocid of this NotificationSetting.

Return type

str

property test_mode_enabled

Gets the test_mode_enabled of this NotificationSetting. Specify if the notification service is in test mode

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The test_mode_enabled of this NotificationSetting.

Return type

bool

property test_recipients

Gets the test_recipients of this NotificationSetting. List of the test recipient email addresses

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The test_recipients of this NotificationSetting.

Return type

list[str]