Rule

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

Bases: object

Rule resource. A unit that has a condition which on evaluation with input returns defined values.

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

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

IDCS_PREVENTED_OPERATIONS_REPLACE

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

IDCS_PREVENTED_OPERATIONS_UPDATE

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

active

Gets the active of this Rule.

compartment_ocid

Gets the compartment_ocid of this Rule.

condition

[Required] Gets the condition of this Rule.

condition_group

Gets the condition_group of this Rule.

delete_in_progress

Gets the delete_in_progress of this Rule.

description

Gets the description of this Rule.

domain_ocid

Gets the domain_ocid of this Rule.

external_id

Gets the external_id of this Rule.

id

Gets the id of this Rule.

idcs_created_by

Gets the idcs_created_by of this Rule.

idcs_last_modified_by

Gets the idcs_last_modified_by of this Rule.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this Rule.

idcs_prevented_operations

Gets the idcs_prevented_operations of this Rule.

locked

Gets the locked of this Rule.

meta

Gets the meta of this Rule.

name

[Required] Gets the name of this Rule.

ocid

Gets the ocid of this Rule.

policy_type

[Required] Gets the policy_type of this Rule.

rule_groovy

Gets the rule_groovy of this Rule.

schemas

[Required] Gets the schemas of this Rule.

tags

Gets the tags of this Rule.

tenancy_ocid

Gets the tenancy_ocid of this Rule.

urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy

Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy of this Rule.

Methods:

__init__(**kwargs)

Initializes a new Rule 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 Rule. 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 Rule. 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 Rule. This constant has a value of “update”

__init__(**kwargs)

Initializes a new Rule 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 Rule.

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

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

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

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

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

  • idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this Rule. 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 Rule.

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

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

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

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

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

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

  • name (str) – The value to assign to the name property of this Rule.

  • description (str) – The value to assign to the description property of this Rule.

  • active (bool) – The value to assign to the active property of this Rule.

  • locked (bool) – The value to assign to the locked property of this Rule.

  • rule_groovy (str) – The value to assign to the rule_groovy property of this Rule.

  • condition (str) – The value to assign to the condition property of this Rule.

  • condition_group (oci.identity_domains.models.RuleConditionGroup) – The value to assign to the condition_group property of this Rule.

  • policy_type (oci.identity_domains.models.RulePolicyType) – The value to assign to the policy_type property of this Rule.

  • _return (list[oci.identity_domains.models.RuleReturn]) – The value to assign to the _return property of this Rule.

  • urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy (oci.identity_domains.models.RuleExtensionOciconsolesignonpolicyconsentPolicy) – The value to assign to the urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy property of this Rule.

property active

Gets the active of this Rule. If true, rule is active

SCIM++ Properties:
  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The active of this Rule.

Return type

bool

property compartment_ocid

Gets the compartment_ocid of this Rule. 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 Rule.

Return type

str

property condition

[Required] Gets the condition of this Rule. SCIM filters

Deprecated Since: 17.3.4

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: none

Returns

The condition of this Rule.

Return type

str

property condition_group

Gets the condition_group of this Rule.

Returns

The condition_group of this Rule.

Return type

oci.identity_domains.models.RuleConditionGroup

property delete_in_progress

Gets the delete_in_progress of this Rule. 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 Rule.

Return type

bool

property description

Gets the description of this Rule. Rule Description

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The description of this Rule.

Return type

str

property domain_ocid

Gets the domain_ocid of this Rule. 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 Rule.

Return type

str

property external_id

Gets the external_id of this Rule. 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 be 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

  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The external_id of this Rule.

Return type

str

property id

Gets the id of this Rule. 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 Rule.

Return type

str

property idcs_created_by

Gets the idcs_created_by of this Rule.

Returns

The idcs_created_by of this Rule.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this Rule.

Returns

The idcs_last_modified_by of this Rule.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this Rule. 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 Rule.

Return type

str

property idcs_prevented_operations

Gets the idcs_prevented_operations of this Rule. 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 Rule.

Return type

list[str]

property locked

Gets the locked of this Rule. Shows if the rule is locked

SCIM++ Properties:
  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The locked of this Rule.

Return type

bool

property meta

Gets the meta of this Rule.

Returns

The meta of this Rule.

Return type

oci.identity_domains.models.Meta

property name

[Required] Gets the name of this Rule. Rule name

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: always

  • type: string

  • uniqueness: none

Returns

The name of this Rule.

Return type

str

property ocid

Gets the ocid of this Rule. 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 Rule.

Return type

str

property policy_type

[Required] Gets the policy_type of this Rule.

Returns

The policy_type of this Rule.

Return type

oci.identity_domains.models.RulePolicyType

property rule_groovy

Gets the rule_groovy of this Rule. The Groovy script that is run instead of the rule, if policy type allows the rule to be a Groovy script.

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The rule_groovy of this Rule.

Return type

str

property schemas

[Required] Gets the schemas of this Rule. 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 Rule.

Return type

list[str]

property tags

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

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

  • idcsCsvAttributeNameMappings: [[columnHeaderName:Tag Key, mapsTo:tags.key], [columnHeaderName:Tag Value, mapsTo:tags.value]]

  • idcsSearchable: true

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: request

  • type: complex

  • uniqueness: none

Returns

The tags of this Rule.

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

Gets the tenancy_ocid of this Rule. 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 Rule.

Return type

str

property urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy

Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy of this Rule.

Returns

The urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy of this Rule.

Return type

oci.identity_domains.models.RuleExtensionOciconsolesignonpolicyconsentPolicy