oci identity user

Overview

An individual employee or system that needs to manage or use your company’s Oracle Cloud Infrastructure resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users have one or more IAM Service credentials ({ApiKey}, {UIPassword}, {SwiftPassword} and {AuthToken}). For more information, see User Credentials). End users of your application are not typically IAM Service users. For conceptual information about users and other IAM Service components, see Overview of the IAM Service.

These users are created directly within the Oracle Cloud Infrastructure system, via the IAM service. They are different from federated users, who authenticate themselves to the Oracle Cloud Infrastructure Console via an identity provider. For more information, see Identity Providers and Federation.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Here is an example on how to use this:

oci_identity_user { 'tenant (root)/my_user':
  ensure          => 'present',
  description     => 'my user',
}

This documentation is generated from the Ruby OCI SDK.

Attributes

absent_states

The OCI states, puppet will detect as the resource being absent.

Back to overview of oci_identity_user

capabilities

Properties indicating how the user is allowed to authenticate.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

compartment

The Puppet® name of the resource identified by compartment_id.

See the documentation of compartment_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

compartment_id

The OCID of the compartment that contains the object.

Rather use the property compartment instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

defined_tags

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

description

The description you assign to the user during creation. Does not have to be unique, and it’s changeable.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

disable_corrective_change

Disable the modification of a resource when Puppet® decides it is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet® Server, Puppet® knows about adaptive and corrective changes. A corrective change is when Puppet® notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet® is managing. The normal Puppet® process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet® cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ...
  disable_corrective_change => true,
  ...
}

When a corrective ensure does happen on the resource Puppet® will not modify the resource and signal an error:

    Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)

Back to overview of oci_identity_user

disable_corrective_ensure

Disable the creation or removal of a resource when Puppet® decides is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet® Server, Puppet® knows about adaptive and corrective changes. A corrective change is when Puppet® notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet® is managing. The normal Puppet® process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet® cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ensure                    => 'present',
  ...
  disable_corrective_ensure => true,
  ...
}

When a corrective ensure does happen on the resource Puppet® will not create or remove the resource and signal an error:

    Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)

Back to overview of oci_identity_user

email

The email you assign to the user. Has to be unique across the tenancy.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of oci_identity_user

external_identifier

Identifier of the user in the identity provider

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

freeform_tags

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

id

The OCID of the resource. This is a read-only property.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

identity_provider

The Puppet® name of the resource identified by identity_provider_id.

See the documentation of identity_provider_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

identity_provider_id

The OCID of the IdentityProvider this user belongs to. Rather use the property identity_provider instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

inactive_status

Returned only if the user’s lifecycleState is INACTIVE. A 16-bit value showing the reason why the user is inactive:

• bit 0: SUSPENDED (reserved for future use)
• bit 1: DISABLED (reserved for future use)

• bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Console)

  This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

is_mfa_activated

Flag indicates if MFA has been activated for the user.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

lifecycle_state

The user’s current state. After creating a user, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

name

The full name of the object.

Back to overview of oci_identity_user

oci_timeout

The maximum time to wait for the OCI resource to be in the ready state.

Back to overview of oci_identity_user

oci_wait_interval

The interval beween calls to OCI to check if a resource is in the ready state.

Back to overview of oci_identity_user

present_states

The OCI states, puppet will detect as the resource being present.

Back to overview of oci_identity_user

provider

The specific backend to use for this oci_identity_user resource. You will seldom need to specify this — Puppet® will usually discover the appropriate provider for your platform.Available providers are:

sdk

This provider uses the Oracle Ruby OCI SDK to do its work.

Back to overview of oci_identity_user

synchronized

Specifies if Puppet® waits for OCI actions to be ready before moving on to an other resource.

Back to overview of oci_identity_user

tenant

The tenant for this resource.

Back to overview of oci_identity_user

time_created

Date and time the user was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_identity_user

user_name

The name of the user.

Back to overview of oci_identity_user