UserPasswordResetter¶

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

Bases: object

The schema used to handle a user password reset by an administrator.

Attributes

`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a UserPasswordResetter.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a UserPasswordResetter.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a UserPasswordResetter.
`bypass_notification`	Gets the bypass_notification of this UserPasswordResetter.
`compartment_ocid`	Gets the compartment_ocid of this UserPasswordResetter.
`delete_in_progress`	Gets the delete_in_progress of this UserPasswordResetter.
`domain_ocid`	Gets the domain_ocid of this UserPasswordResetter.
`external_id`	Gets the external_id of this UserPasswordResetter.
`id`	Gets the id of this UserPasswordResetter.
`idcs_created_by`	Gets the idcs_created_by of this UserPasswordResetter.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this UserPasswordResetter.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this UserPasswordResetter.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this UserPasswordResetter.
`meta`	Gets the meta of this UserPasswordResetter.
`notification_email_template_id`	Gets the notification_email_template_id of this UserPasswordResetter.
`ocid`	Gets the ocid of this UserPasswordResetter.
`one_time_password`	Gets the one_time_password of this UserPasswordResetter.
`schemas`	[Required] Gets the schemas of this UserPasswordResetter.
`tags`	Gets the tags of this UserPasswordResetter.
`tenancy_ocid`	Gets the tenancy_ocid of this UserPasswordResetter.
`urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user`	Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user of this UserPasswordResetter.
`user_flow_controlled_by_external_client`	Gets the user_flow_controlled_by_external_client of this UserPasswordResetter.
`user_token`	Gets the user_token of this UserPasswordResetter.

Methods

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

__init__(**kwargs)¶

Initializes a new UserPasswordResetter 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 UserPasswordResetter.
ocid (str) – The value to assign to the ocid property of this UserPasswordResetter.
schemas (list[str]) – The value to assign to the schemas property of this UserPasswordResetter.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this UserPasswordResetter.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this UserPasswordResetter.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this UserPasswordResetter.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this UserPasswordResetter. 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 UserPasswordResetter.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this UserPasswordResetter.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this UserPasswordResetter.
domain_ocid (str) – The value to assign to the domain_ocid property of this UserPasswordResetter.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this UserPasswordResetter.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this UserPasswordResetter.
external_id (str) – The value to assign to the external_id property of this UserPasswordResetter.
bypass_notification (bool) – The value to assign to the bypass_notification property of this UserPasswordResetter.
user_flow_controlled_by_external_client (bool) – The value to assign to the user_flow_controlled_by_external_client property of this UserPasswordResetter.
user_token (oci.identity_domains.models.UserPasswordResetterUserToken) – The value to assign to the user_token property of this UserPasswordResetter.
notification_email_template_id (str) – The value to assign to the notification_email_template_id property of this UserPasswordResetter.
one_time_password (str) – The value to assign to the one_time_password property of this UserPasswordResetter.
urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user (oci.identity_domains.models.ExtensionSelfChangeUser) – The value to assign to the urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user property of this UserPasswordResetter.

bypass_notification¶

Gets the bypass_notification of this UserPasswordResetter. Indicates whether to send an email notification after resetting the user’s password.

SCIM++ Properties:

caseExact: false
idcsSearchable: false
multiValued: false
mutability: immutable
required: false
returned: never
type: boolean
uniqueness: none

Returns:	The bypass_notification of this UserPasswordResetter.
Return type:	bool

compartment_ocid¶

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

delete_in_progress¶

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

domain_ocid¶

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

external_id¶

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

type: string
multiValued: false
required: false
mutability: readWrite
returned: default
uniqueness: none

Returns:	The external_id of this UserPasswordResetter.
Return type:	str

id¶

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

idcs_created_by¶

Gets the idcs_created_by of this UserPasswordResetter.

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

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this UserPasswordResetter.

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

idcs_last_upgraded_in_release¶

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

idcs_prevented_operations¶

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

meta¶

Gets the meta of this UserPasswordResetter.

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

notification_email_template_id¶

Gets the notification_email_template_id of this UserPasswordResetter. Specifies the EmailTemplate to be used when sending notifications to the user. If specified, it overrides the default EmailTemplate.

SCIM++ Properties:

caseExact: false
idcsSearchable: false
multiValued: false
mutability: writeOnly
required: false
returned: never
type: string
uniqueness: none

Returns:	The notification_email_template_id of this UserPasswordResetter.
Return type:	str

ocid¶

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

one_time_password¶

Gets the one_time_password of this UserPasswordResetter. A one time password will be returned when the user doesn’t have a primary email address.

SCIM++ Properties:

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

Returns:	The one_time_password of this UserPasswordResetter.
Return type:	str

schemas¶

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

tags¶

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

tenancy_ocid¶

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

urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user¶

Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user of this UserPasswordResetter.

Returns:	The urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user of this UserPasswordResetter.
Return type:	oci.identity_domains.models.ExtensionSelfChangeUser

user_flow_controlled_by_external_client¶

Gets the user_flow_controlled_by_external_client of this UserPasswordResetter. A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow.

SCIM++ Properties:

type: boolean
caseExact: false
idcsSearchable: false
multiValued: false
mutability: immutable
required: false
returned: never
uniqueness: none

Returns:	The user_flow_controlled_by_external_client of this UserPasswordResetter.
Return type:	bool

user_token¶

Gets the user_token of this UserPasswordResetter.

Returns:	The user_token of this UserPasswordResetter.
Return type:	oci.identity_domains.models.UserPasswordResetterUserToken