Class: OCI::IdentityDomains::Models::UserPasswordChanger
- Inherits:
-
Object
- Object
- OCI::IdentityDomains::Models::UserPasswordChanger
- Defined in:
- lib/oci/identity_domains/models/user_password_changer.rb
Overview
The schema used to handle a user password change by an administrator.
Constant Summary collapse
- IDCS_PREVENTED_OPERATIONS_ENUM =
[ IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'.freeze, IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'.freeze, IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'.freeze, IDCS_PREVENTED_OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#bypass_notification ⇒ BOOLEAN
Indicates whether to send an email notification after a password is changed.
-
#compartment_ocid ⇒ String
OCI Compartment Id (ocid) in which the resource lives.
-
#delete_in_progress ⇒ BOOLEAN
A boolean flag indicating this resource in the process of being deleted.
-
#domain_ocid ⇒ String
OCI Domain Id (ocid) in which the resource lives.
-
#external_id ⇒ String
An identifier for the Resource as defined by the Service Consumer.
-
#id ⇒ String
Unique identifier for the SCIM Resource as defined by the Service Provider.
- #idcs_created_by ⇒ OCI::IdentityDomains::Models::IdcsCreatedBy
- #idcs_last_modified_by ⇒ OCI::IdentityDomains::Models::IdcsLastModifiedBy
-
#idcs_last_upgraded_in_release ⇒ String
The release number when the resource was upgraded.
-
#idcs_prevented_operations ⇒ Array<String>
Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
- #meta ⇒ OCI::IdentityDomains::Models::Meta
-
#notification_email_template_id ⇒ String
Specifies the EmailTemplate to be used when sending a notification to the user.
-
#ocid ⇒ String
Unique OCI identifier for the SCIM Resource.
-
#password ⇒ String
[Required] The password attribute.
-
#schemas ⇒ Array<String>
[Required] REQUIRED.
-
#tags ⇒ Array<OCI::IdentityDomains::Models::Tags>
A list of tags on this resource.
-
#tenancy_ocid ⇒ String
OCI Tenant Id (ocid) in which the resource lives.
- #urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user ⇒ OCI::IdentityDomains::Models::ExtensionSelfChangeUser
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ UserPasswordChanger
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ UserPasswordChanger
Initializes the object
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 299 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.id = attributes[:'id'] if attributes[:'id'] self.ocid = attributes[:'ocid'] if attributes[:'ocid'] self.schemas = attributes[:'schemas'] if attributes[:'schemas'] self. = attributes[:'meta'] if attributes[:'meta'] self.idcs_created_by = attributes[:'idcsCreatedBy'] if attributes[:'idcsCreatedBy'] raise 'You cannot provide both :idcsCreatedBy and :idcs_created_by' if attributes.key?(:'idcsCreatedBy') && attributes.key?(:'idcs_created_by') self.idcs_created_by = attributes[:'idcs_created_by'] if attributes[:'idcs_created_by'] self.idcs_last_modified_by = attributes[:'idcsLastModifiedBy'] if attributes[:'idcsLastModifiedBy'] raise 'You cannot provide both :idcsLastModifiedBy and :idcs_last_modified_by' if attributes.key?(:'idcsLastModifiedBy') && attributes.key?(:'idcs_last_modified_by') self.idcs_last_modified_by = attributes[:'idcs_last_modified_by'] if attributes[:'idcs_last_modified_by'] self.idcs_prevented_operations = attributes[:'idcsPreventedOperations'] if attributes[:'idcsPreventedOperations'] raise 'You cannot provide both :idcsPreventedOperations and :idcs_prevented_operations' if attributes.key?(:'idcsPreventedOperations') && attributes.key?(:'idcs_prevented_operations') self.idcs_prevented_operations = attributes[:'idcs_prevented_operations'] if attributes[:'idcs_prevented_operations'] self. = attributes[:'tags'] if attributes[:'tags'] self.delete_in_progress = attributes[:'deleteInProgress'] unless attributes[:'deleteInProgress'].nil? raise 'You cannot provide both :deleteInProgress and :delete_in_progress' if attributes.key?(:'deleteInProgress') && attributes.key?(:'delete_in_progress') self.delete_in_progress = attributes[:'delete_in_progress'] unless attributes[:'delete_in_progress'].nil? self.idcs_last_upgraded_in_release = attributes[:'idcsLastUpgradedInRelease'] if attributes[:'idcsLastUpgradedInRelease'] raise 'You cannot provide both :idcsLastUpgradedInRelease and :idcs_last_upgraded_in_release' if attributes.key?(:'idcsLastUpgradedInRelease') && attributes.key?(:'idcs_last_upgraded_in_release') self.idcs_last_upgraded_in_release = attributes[:'idcs_last_upgraded_in_release'] if attributes[:'idcs_last_upgraded_in_release'] self.domain_ocid = attributes[:'domainOcid'] if attributes[:'domainOcid'] raise 'You cannot provide both :domainOcid and :domain_ocid' if attributes.key?(:'domainOcid') && attributes.key?(:'domain_ocid') self.domain_ocid = attributes[:'domain_ocid'] if attributes[:'domain_ocid'] self.compartment_ocid = attributes[:'compartmentOcid'] if attributes[:'compartmentOcid'] raise 'You cannot provide both :compartmentOcid and :compartment_ocid' if attributes.key?(:'compartmentOcid') && attributes.key?(:'compartment_ocid') self.compartment_ocid = attributes[:'compartment_ocid'] if attributes[:'compartment_ocid'] self.tenancy_ocid = attributes[:'tenancyOcid'] if attributes[:'tenancyOcid'] raise 'You cannot provide both :tenancyOcid and :tenancy_ocid' if attributes.key?(:'tenancyOcid') && attributes.key?(:'tenancy_ocid') self.tenancy_ocid = attributes[:'tenancy_ocid'] if attributes[:'tenancy_ocid'] self.external_id = attributes[:'externalId'] if attributes[:'externalId'] raise 'You cannot provide both :externalId and :external_id' if attributes.key?(:'externalId') && attributes.key?(:'external_id') self.external_id = attributes[:'external_id'] if attributes[:'external_id'] self.password = attributes[:'password'] if attributes[:'password'] self.bypass_notification = attributes[:'bypassNotification'] unless attributes[:'bypassNotification'].nil? raise 'You cannot provide both :bypassNotification and :bypass_notification' if attributes.key?(:'bypassNotification') && attributes.key?(:'bypass_notification') self.bypass_notification = attributes[:'bypass_notification'] unless attributes[:'bypass_notification'].nil? self.notification_email_template_id = attributes[:'notificationEmailTemplateId'] if attributes[:'notificationEmailTemplateId'] raise 'You cannot provide both :notificationEmailTemplateId and :notification_email_template_id' if attributes.key?(:'notificationEmailTemplateId') && attributes.key?(:'notification_email_template_id') self.notification_email_template_id = attributes[:'notification_email_template_id'] if attributes[:'notification_email_template_id'] self.urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user = attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User'] if attributes[:'urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User'] raise 'You cannot provide both :urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User and :urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user' if attributes.key?(:'urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User') && attributes.key?(:'urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user') self.urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user = attributes[:'urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user'] if attributes[:'urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user'] end |
Instance Attribute Details
#bypass_notification ⇒ BOOLEAN
Indicates whether to send an email notification after a password is changed.
SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: immutable - required: false - returned: never - type: boolean - uniqueness: none
204 205 206 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 204 def bypass_notification @bypass_notification end |
#compartment_ocid ⇒ String
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
151 152 153 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 151 def compartment_ocid @compartment_ocid end |
#delete_in_progress ⇒ BOOLEAN
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
109 110 111 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 109 def delete_in_progress @delete_in_progress end |
#domain_ocid ⇒ String
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
137 138 139 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 137 def domain_ocid @domain_ocid end |
#external_id ⇒ String
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
177 178 179 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 177 def external_id @external_id end |
#id ⇒ String
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
31 32 33 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 31 def id @id end |
#idcs_created_by ⇒ OCI::IdentityDomains::Models::IdcsCreatedBy
65 66 67 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 65 def idcs_created_by @idcs_created_by end |
#idcs_last_modified_by ⇒ OCI::IdentityDomains::Models::IdcsLastModifiedBy
68 69 70 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 68 def idcs_last_modified_by @idcs_last_modified_by end |
#idcs_last_upgraded_in_release ⇒ String
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
123 124 125 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 123 def idcs_last_upgraded_in_release @idcs_last_upgraded_in_release end |
#idcs_prevented_operations ⇒ Array<String>
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
81 82 83 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 81 def idcs_prevented_operations @idcs_prevented_operations end |
#meta ⇒ OCI::IdentityDomains::Models::Meta
62 63 64 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 62 def @meta end |
#notification_email_template_id ⇒ String
Specifies the EmailTemplate to be used when sending a notification 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
218 219 220 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 218 def notification_email_template_id @notification_email_template_id end |
#ocid ⇒ String
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
45 46 47 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 45 def ocid @ocid end |
#password ⇒ String
[Required] The password attribute. The maximum length for the password is set in the password policy.
SCIM++ Properties: - type: string - multiValued: false - required: true - mutability: writeOnly - returned: never - uniqueness: none - idcsSensitive: none
190 191 192 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 190 def password @password end |
#schemas ⇒ Array<String>
[Required] 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
59 60 61 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 59 def schemas @schemas end |
#tags ⇒ Array<OCI::IdentityDomains::Models::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
95 96 97 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 95 def @tags end |
#tenancy_ocid ⇒ String
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
165 166 167 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 165 def tenancy_ocid @tenancy_ocid end |
#urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user ⇒ OCI::IdentityDomains::Models::ExtensionSelfChangeUser
221 222 223 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 221 def urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user @urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 224 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'ocid': :'ocid', 'schemas': :'schemas', 'meta': :'meta', 'idcs_created_by': :'idcsCreatedBy', 'idcs_last_modified_by': :'idcsLastModifiedBy', 'idcs_prevented_operations': :'idcsPreventedOperations', 'tags': :'tags', 'delete_in_progress': :'deleteInProgress', 'idcs_last_upgraded_in_release': :'idcsLastUpgradedInRelease', 'domain_ocid': :'domainOcid', 'compartment_ocid': :'compartmentOcid', 'tenancy_ocid': :'tenancyOcid', 'external_id': :'externalId', 'password': :'password', 'bypass_notification': :'bypassNotification', 'notification_email_template_id': :'notificationEmailTemplateId', 'urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user': :'urn:ietf:params:scim:schemas:oracle:idcs:extension:selfChange:User' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 250 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'ocid': :'String', 'schemas': :'Array<String>', 'meta': :'OCI::IdentityDomains::Models::Meta', 'idcs_created_by': :'OCI::IdentityDomains::Models::IdcsCreatedBy', 'idcs_last_modified_by': :'OCI::IdentityDomains::Models::IdcsLastModifiedBy', 'idcs_prevented_operations': :'Array<String>', 'tags': :'Array<OCI::IdentityDomains::Models::Tags>', 'delete_in_progress': :'BOOLEAN', 'idcs_last_upgraded_in_release': :'String', 'domain_ocid': :'String', 'compartment_ocid': :'String', 'tenancy_ocid': :'String', 'external_id': :'String', 'password': :'String', 'bypass_notification': :'BOOLEAN', 'notification_email_template_id': :'String', 'urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user': :'OCI::IdentityDomains::Models::ExtensionSelfChangeUser' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 417 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && ocid == other.ocid && schemas == other.schemas && == other. && idcs_created_by == other.idcs_created_by && idcs_last_modified_by == other.idcs_last_modified_by && idcs_prevented_operations == other.idcs_prevented_operations && == other. && delete_in_progress == other.delete_in_progress && idcs_last_upgraded_in_release == other.idcs_last_upgraded_in_release && domain_ocid == other.domain_ocid && compartment_ocid == other.compartment_ocid && tenancy_ocid == other.tenancy_ocid && external_id == other.external_id && password == other.password && bypass_notification == other.bypass_notification && notification_email_template_id == other.notification_email_template_id && urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user == other.urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 464 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
444 445 446 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 444 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
453 454 455 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 453 def hash [id, ocid, schemas, , idcs_created_by, idcs_last_modified_by, idcs_prevented_operations, , delete_in_progress, idcs_last_upgraded_in_release, domain_ocid, compartment_ocid, tenancy_ocid, external_id, password, bypass_notification, notification_email_template_id, urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
497 498 499 500 501 502 503 504 505 506 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 497 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
491 492 493 |
# File 'lib/oci/identity_domains/models/user_password_changer.rb', line 491 def to_s to_hash.to_s end |