Policy

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

Bases: object

Policy resource. A named list of rules.

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

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

IDCS_PREVENTED_OPERATIONS_REPLACE

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

IDCS_PREVENTED_OPERATIONS_UPDATE

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

active

Gets the active of this Policy.

compartment_ocid

Gets the compartment_ocid of this Policy.

delete_in_progress

Gets the delete_in_progress of this Policy.

description

Gets the description of this Policy.

domain_ocid

Gets the domain_ocid of this Policy.

external_id

Gets the external_id of this Policy.

id

Gets the id of this Policy.

idcs_created_by

Gets the idcs_created_by of this Policy.

idcs_last_modified_by

Gets the idcs_last_modified_by of this Policy.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this Policy.

idcs_prevented_operations

Gets the idcs_prevented_operations of this Policy.

meta

Gets the meta of this Policy.

name

[Required] Gets the name of this Policy.

ocid

Gets the ocid of this Policy.

policy_groovy

Gets the policy_groovy of this Policy.

policy_type

[Required] Gets the policy_type of this Policy.

rules

Gets the rules of this Policy.

schemas

[Required] Gets the schemas of this Policy.

tags

Gets the tags of this Policy.

tenancy_ocid

Gets the tenancy_ocid of this Policy.

urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy

Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy of this Policy.

Methods:

__init__(**kwargs)

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

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • policy_groovy (str) – The value to assign to the policy_groovy property of this Policy.

  • rules (list[oci.identity_domains.models.PolicyRules]) – The value to assign to the rules property of this Policy.

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

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

property active

Gets the active of this Policy. If true, Policy is active.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The active of this Policy.

Return type

bool

property compartment_ocid

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

Return type

str

property delete_in_progress

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

Return type

bool

property description

Gets the description of this Policy. Policy Description

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The description of this Policy.

Return type

str

property domain_ocid

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

Return type

str

property external_id

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

Return type

str

property id

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

Return type

str

property idcs_created_by

Gets the idcs_created_by of this Policy.

Returns

The idcs_created_by of this Policy.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this Policy.

Returns

The idcs_last_modified_by of this Policy.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

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

Return type

str

property idcs_prevented_operations

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

Return type

list[str]

property meta

Gets the meta of this Policy.

Returns

The meta of this Policy.

Return type

oci.identity_domains.models.Meta

property name

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

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: always

  • type: string

  • uniqueness: none

Returns

The name of this Policy.

Return type

str

property ocid

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

Return type

str

property policy_groovy

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

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The policy_groovy of this Policy.

Return type

str

property policy_type

[Required] Gets the policy_type of this Policy.

Returns

The policy_type of this Policy.

Return type

oci.identity_domains.models.PolicyPolicyType

property rules

Gets the rules of this Policy. Rules assigned to this policy

SCIM++ Properties:
  • idcsCompositeKey: [value]

  • idcsSearchable: true

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: request

  • type: complex

  • uniqueness: none

Returns

The rules of this Policy.

Return type

list[oci.identity_domains.models.PolicyRules]

property schemas

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

Return type

list[str]

property tags

Gets the tags of this Policy. 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 Policy.

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

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

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 Policy.

Returns

The urn_ietf_params_scim_schemas_oracle_idcs_extension_ociconsolesignonpolicyconsent_policy of this Policy.

Return type

oci.identity_domains.models.PolicyExtensionOciconsolesignonpolicyconsentPolicy