Data Source: oci_identity_domains_notification_setting

This data source provides details about a specific Notification Setting resource in Oracle Cloud Infrastructure Identity Domains service.

Get Notification Settings

Example Usage

data "oci_identity_domains_notification_setting" "test_notification_setting" {
	#Required
	idcs_endpoint = data.oci_identity_domain.test_domain.url
	notification_setting_id = oci_identity_domains_notification_setting.test_notification_setting.id

	#Optional
	attribute_sets = ["all"]
	attributes = ""
	authorization = var.notification_setting_authorization
	resource_type_schema_version = var.notification_setting_resource_type_schema_version
}

Argument Reference

The following arguments are supported:

• attribute_sets - (Optional) A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If ‘attributes’ query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.
• attributes - (Optional) A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
• authorization - (Optional) The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
• idcs_endpoint - (Required) The basic endpoint for the identity domain
• notification_setting_id - (Required) ID of the resource
• resource_type_schema_version - (Optional) An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

Attributes Reference

The following attributes are exported:

• compartment_ocid - Oracle Cloud Infrastructure 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

• delete_in_progress - 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

• domain_ocid - Oracle Cloud Infrastructure 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

• event_settings - Event settings

  SCIM++ Properties:

  • caseExact: false

  • idcsCompositeKey: [eventId]

  • idcsSearchable: false

  • multiValued: true

  • mutability: readWrite

  • required: true

  • returned: default

  • type: complex

  • uniqueness: none

  • enabled - Specify if notifications are enabled for the event

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none

  • event_id - IDCS-generated event

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none

• external_id - 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

• from_email_address - From email address to be used in the notification emails

  SCIM++ Properties:

  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: always

  • type: complex

  • uniqueness: none

  • display_name - Display name for the From email address

    Added In: 19.2.1

    SCIM++ Properties:

    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string

  • validate - From address verification mode. If postmaster account is available then ‘domain’ mode is used or entire valid email can be verified using ‘email’ mode

    Added In: 18.2.6

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none

  • validation_status - Validation status for the From email address

    SCIM++ Properties:

    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string

  • value - Value of the From email address

    SCIM++ Properties:

    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string

• id - 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

• idcs_created_by - The User or App who created the Resource

  SCIM++ Properties:

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: true

  • returned: default

  • type: complex

  • ref - The URI of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none

  • display - The displayName of the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

  • ocid - The OCID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none

  • type - The type of resource, User or App, that created this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

  • value - The ID of the SCIM resource that represents the User or App who created this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none

• idcs_last_modified_by - The User or App who modified the Resource

  SCIM++ Properties:

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: complex

  • ref - The URI of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none

  • display - The displayName of the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

  • ocid - The OCID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none

  • type - The type of resource, User or App, that modified this Resource

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

  • value - The ID of the SCIM resource that represents the User or App who modified this Resource

    SCIM++ Properties:

    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none

• idcs_last_upgraded_in_release - 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

• idcs_prevented_operations - 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

• meta - A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

  SCIM++ Properties:

  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]

  • type: complex

  • created - The DateTime the Resource was added to the Service Provider

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none

  • last_modified - The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none

  • location - The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

  • resource_type - Name of the resource type of the resource–for example, Users or Groups

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

  • version - The version of the Resource being returned. This value must be the same as the ETag HTTP response header.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none

• notification_enabled - 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

• ocid - Unique Oracle Cloud Infrastructure identifier for the SCIM Resource.

  SCIM++ Properties:

  • caseExact: true
  • idcsSearchable: true
  • multiValued: false
  • mutability: immutable
  • required: false
  • returned: default
  • type: string
  • uniqueness: global

• schemas - 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

• send_notification_to_old_and_new_primary_emails_when_admin_changes_primary_email - 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

• send_notifications_to_secondary_email - 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

• tags - 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

  • key - Key or name of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none

  • value - Value of the tag.

    SCIM++ Properties:

    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none

• tenancy_ocid - Oracle Cloud Infrastructure 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

• test_mode_enabled - 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

• test_recipients - 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