KmsiSetting¶

class oci.identity_domains.models.KmsiSetting(**kwargs)¶

Bases: object

Kmsi Settings schema

Attributes

`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a KmsiSetting.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a KmsiSetting.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a KmsiSetting.
`compartment_ocid`	Gets the compartment_ocid of this KmsiSetting.
`delete_in_progress`	Gets the delete_in_progress of this KmsiSetting.
`domain_ocid`	Gets the domain_ocid of this KmsiSetting.
`external_id`	Gets the external_id of this KmsiSetting.
`id`	Gets the id of this KmsiSetting.
`idcs_created_by`	Gets the idcs_created_by of this KmsiSetting.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this KmsiSetting.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this KmsiSetting.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this KmsiSetting.
`kmsi_feature_enabled`	Gets the kmsi_feature_enabled of this KmsiSetting.
`kmsi_prompt_enabled`	Gets the kmsi_prompt_enabled of this KmsiSetting.
`last_enabled_on`	Gets the last_enabled_on of this KmsiSetting.
`last_used_validity_in_days`	Gets the last_used_validity_in_days of this KmsiSetting.
`max_allowed_sessions`	Gets the max_allowed_sessions of this KmsiSetting.
`meta`	Gets the meta of this KmsiSetting.
`ocid`	Gets the ocid of this KmsiSetting.
`schemas`	[Required] Gets the schemas of this KmsiSetting.
`tags`	Gets the tags of this KmsiSetting.
`tenancy_ocid`	Gets the tenancy_ocid of this KmsiSetting.
`token_validity_in_days`	Gets the token_validity_in_days of this KmsiSetting.
`tou_prompt_disabled`	Gets the tou_prompt_disabled of this KmsiSetting.

Methods

__init__(**kwargs) Initializes a new KmsiSetting 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 KmsiSetting. 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 KmsiSetting. 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 KmsiSetting. This constant has a value of “update”

__init__(**kwargs)¶

Initializes a new KmsiSetting 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 KmsiSetting.
ocid (str) – The value to assign to the ocid property of this KmsiSetting.
schemas (list[str]) – The value to assign to the schemas property of this KmsiSetting.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this KmsiSetting.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this KmsiSetting.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this KmsiSetting.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this KmsiSetting. 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 KmsiSetting.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this KmsiSetting.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this KmsiSetting.
domain_ocid (str) – The value to assign to the domain_ocid property of this KmsiSetting.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this KmsiSetting.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this KmsiSetting.
external_id (str) – The value to assign to the external_id property of this KmsiSetting.
token_validity_in_days (int) – The value to assign to the token_validity_in_days property of this KmsiSetting.
last_used_validity_in_days (int) – The value to assign to the last_used_validity_in_days property of this KmsiSetting.
max_allowed_sessions (int) – The value to assign to the max_allowed_sessions property of this KmsiSetting.
kmsi_feature_enabled (bool) – The value to assign to the kmsi_feature_enabled property of this KmsiSetting.
kmsi_prompt_enabled (bool) – The value to assign to the kmsi_prompt_enabled property of this KmsiSetting.
tou_prompt_disabled (bool) – The value to assign to the tou_prompt_disabled property of this KmsiSetting.
last_enabled_on (str) – The value to assign to the last_enabled_on property of this KmsiSetting.

compartment_ocid¶

Gets the compartment_ocid of this KmsiSetting. 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 KmsiSetting.
Return type:	str

delete_in_progress¶

Gets the delete_in_progress of this KmsiSetting. 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 KmsiSetting.
Return type:	bool

domain_ocid¶

Gets the domain_ocid of this KmsiSetting. 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 KmsiSetting.
Return type:	str

external_id¶

Gets the external_id of this KmsiSetting. 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 KmsiSetting.
Return type:	str

id¶

Gets the id of this KmsiSetting. 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 KmsiSetting.
Return type:	str

idcs_created_by¶

Gets the idcs_created_by of this KmsiSetting.

Returns:	The idcs_created_by of this KmsiSetting.
Return type:	oci.identity_domains.models.IdcsCreatedBy

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this KmsiSetting.

Returns:	The idcs_last_modified_by of this KmsiSetting.
Return type:	oci.identity_domains.models.IdcsLastModifiedBy

idcs_last_upgraded_in_release¶

Gets the idcs_last_upgraded_in_release of this KmsiSetting. 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 KmsiSetting.
Return type:	str

idcs_prevented_operations¶

Gets the idcs_prevented_operations of this KmsiSetting. 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 KmsiSetting.
Return type:	list[str]

kmsi_feature_enabled¶

Gets the kmsi_feature_enabled of this KmsiSetting. Identifier represents KMSI feature is enabled or not.

SCIM++ Properties:

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

Returns:	The kmsi_feature_enabled of this KmsiSetting.
Return type:	bool

kmsi_prompt_enabled¶

Gets the kmsi_prompt_enabled of this KmsiSetting. Identifier represents KMSI to be prompted to user or not.

SCIM++ Properties:

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

Returns:	The kmsi_prompt_enabled of this KmsiSetting.
Return type:	bool

last_enabled_on¶

Gets the last_enabled_on of this KmsiSetting. Timestamp of when the KmsiSettings was enabled last time.

Added In: 2203071610

SCIM++ Properties:

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

Returns:	The last_enabled_on of this KmsiSetting.
Return type:	str

last_used_validity_in_days¶

Gets the last_used_validity_in_days of this KmsiSetting. Identifier represents duration in days within which kmsi token must be used.

SCIM++ Properties:

caseExact: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: integer
idcsMaxValue: 365
idcsMinValue: 1
uniqueness: none

Returns:	The last_used_validity_in_days of this KmsiSetting.
Return type:	int

max_allowed_sessions¶

Gets the max_allowed_sessions of this KmsiSetting. Identifier represents maximum KMSI sessions allowed in the system.

SCIM++ Properties:

caseExact: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: integer
idcsMaxValue: 10
idcsMinValue: 1
uniqueness: none

Returns:	The max_allowed_sessions of this KmsiSetting.
Return type:	int

meta¶

Gets the meta of this KmsiSetting.

Returns:	The meta of this KmsiSetting.
Return type:	oci.identity_domains.models.Meta

ocid¶

Gets the ocid of this KmsiSetting. 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 KmsiSetting.
Return type:	str

schemas¶

[Required] Gets the schemas of this KmsiSetting. 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 KmsiSetting.
Return type:	list[str]

tags¶

Gets the tags of this KmsiSetting. 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 KmsiSetting.
Return type:	list[oci.identity_domains.models.Tags]

tenancy_ocid¶

Gets the tenancy_ocid of this KmsiSetting. 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 KmsiSetting.
Return type:	str

token_validity_in_days¶

Gets the token_validity_in_days of this KmsiSetting. Identifier represents validity duration in days.

SCIM++ Properties:

caseExact: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: integer
idcsMaxValue: 1100
idcsMinValue: 1
uniqueness: none

Returns:	The token_validity_in_days of this KmsiSetting.
Return type:	int

tou_prompt_disabled¶

Gets the tou_prompt_disabled of this KmsiSetting. Identifier represents whether user is prompted for ToU or not.

SCIM++ Properties:

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

Returns:	The tou_prompt_disabled of this KmsiSetting.
Return type:	bool