oracle / oracle.oci / 4.2.0 / module / oci_identity_user Manage an User resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_identity_user (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
This module allows the user to create, update and delete an User resource in Oracle Cloud Infrastructure
For I(state=present), creates a new user in your tenancy. For conceptual information about users, your tenancy, and other IAM Service components, see L(Overview of IAM,https://docs.cloud.oracle.com/Content/Identity/getstarted/identity-domains.htm).
You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see L(Resource Identifiers,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a *name* for the user, which must be unique across all users in your tenancy and cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods, underscores, +, and @. If you specify a name that's already in use, you'll get a 409 error. This name will be the user's login to the Console. You might want to pick a name that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses. If you delete a user and then create a new user with the same name, they'll be considered different users because they have different OCIDs.
You must also specify a *description* for the user (although it can be an empty string). It does not have to be unique, and you can change it anytime with L(UpdateUser,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/20160918/User/UpdateUser). You can use the field to provide the user's full name, a description, a nickname, or other information to generally identify the user.
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.
A new user has no permissions until you place the user in one or more groups (see L(AddUserToGroup,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/20160918/UserGroupMembership/AddUserToGroup)). If the user needs to access the Console, you need to provide the user a password (see L(CreateOrResetUIPassword,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/20160918/UIPassword/CreateOrResetUIPassword)). If the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a public API signing key for that user (see L(Required Keys and OCIDs,https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm) and also L(UploadApiKey,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/20160918/ApiKey/UploadApiKey)).
**Important:** Make sure to inform the new user which compartment(s) they have access to.
- name: Create user oci_identity_user: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example description: description_example # optional email: email_example freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update user oci_identity_user: # required user_id: "ocid1.user.oc1..xxxxxxEXAMPLExxxxxx" # optional description: description_example email: email_example db_user_name: db_user_name_example freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update user using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_identity_user: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example # optional description: description_example email: email_example db_user_name: db_user_name_example freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete user oci_identity_user: # required user_id: "ocid1.user.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete user using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_identity_user: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example state: absent
name: description: - The name you assign to the user during creation. This is the user's login for the Console. The name must be unique across all users in the tenancy and cannot be changed. - Required for create using I(state=present). - Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str wait: default: true description: Whether to wait for create or delete operation to complete. type: bool email: description: - The email you assign to the user during creation. The email must be unique across all users in the tenancy. - (For tenancies that support identity domains) You must provide an email for each user. - This parameter is updatable. type: str state: choices: - present - absent default: present description: - The state of the User. - Use I(state=present) to create or update an User. - Use I(state=absent) to delete an User. required: false type: str key_by: description: The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource. elements: str type: list region: description: - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str user_id: aliases: - id description: - The OCID of the user. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str api_user: description: - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(api_user_key_file)) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str cert_bundle: description: - The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used. type: str description: description: - The description you assign to the user during creation. Does not have to be unique, and it's changeable. - (For tenancies that support identity domains) You can have an empty description. - Required for create using I(state=present). - This parameter is updatable. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str db_user_name: description: - DB username of the DB credential. Has to be unique across the tenancy. - This parameter is updatable. type: str defined_tags: description: - 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`' - This parameter is updatable. type: dict force_create: default: false description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int freeform_tags: description: - '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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`' - This parameter is updatable. type: dict compartment_id: description: - The OCID of the tenancy containing the user. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str api_user_key_file: description: - Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(config_file_location). If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in C(config_file_location). type: str api_user_fingerprint: description: - Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See C(config_file_location)). type: str
user: contains: capabilities: contains: can_use_api_keys: description: - Indicates if the user can use API keys. returned: on success sample: true type: bool can_use_auth_tokens: description: - Indicates if the user can use SWIFT passwords / auth tokens. returned: on success sample: true type: bool can_use_console_password: description: - Indicates if the user can log in to the console. returned: on success sample: true type: bool can_use_customer_secret_keys: description: - Indicates if the user can use SigV4 symmetric keys. returned: on success sample: true type: bool can_use_db_credentials: description: - Indicates if the user can use DB passwords. returned: on success sample: true type: bool can_use_smtp_credentials: description: - Indicates if the user can use SMTP passwords. returned: on success sample: true type: bool description: - '' returned: on success type: complex compartment_id: description: - The OCID of the tenancy containing the user. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str db_user_name: description: - DB username of the DB credential. Has to be unique across the tenancy. returned: on success sample: db_user_name_example type: str defined_tags: description: - 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict description: description: - The description you assign to the user. Does not have to be unique, and it's changeable. - (For tenancies that support identity domains) You can have an empty description. returned: on success sample: description_example type: str email: description: - The email address you assign to the user. The email address must be unique across all users in the tenancy. - (For tenancies that support identity domains) The email address is required unless the requirement is disabled at the tenancy level. returned: on success sample: email_example type: str email_verified: description: - Whether the email address has been validated. returned: on success sample: true type: bool external_identifier: description: - Identifier of the user in the identity provider returned: on success sample: external_identifier_example type: str freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The OCID of the user. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str identity_provider_id: description: - The OCID of the `IdentityProvider` this user belongs to. returned: on success sample: ocid1.identityprovider.oc1..xxxxxxEXAMPLExxxxxx type: str inactive_status: description: - '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)' returned: on success sample: 56 type: int is_mfa_activated: description: - Flag indicates if MFA has been activated for the user. returned: on success sample: true type: bool last_successful_login_time: description: - The date and time of when the user most recently logged in the format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`). If there is no login history, this field is null. - For illustrative purposes, suppose we have a user who has logged in at July 1st, 2020 at 1200 PST and logged out 30 minutes later. They then login again on July 2nd, 2020 at 1500 PST. - Their previousSuccessfulLoginTime would be `2020-07-01:19:00.000Z`. - Their lastSuccessfulLoginTime would be `2020-07-02:22:00.000Z`. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str lifecycle_state: description: - The user's current state. After creating a user, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it. returned: on success sample: CREATING type: str name: description: - The name you assign to the user during creation. This is the user's login for the Console. The name must be unique across all users in the tenancy and cannot be changed. returned: on success sample: name_example type: str previous_successful_login_time: description: - The date and time of when the user most recently logged in the format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`). If there is no login history, this field is null. - For illustrative purposes, suppose we have a user who has logged in at July 1st, 2020 at 1200 PST and logged out 30 minutes later. They then login again on July 2nd, 2020 at 1500 PST. - Their previousSuccessfulLoginTime would be `2020-07-01:19:00.000Z`. - Their lastSuccessfulLoginTime would be `2020-07-02:22:00.000Z`. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_created: description: - Date and time the user was created, in the format defined by RFC3339. - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the User resource acted upon by the current operation returned: on success sample: capabilities: can_use_api_keys: true can_use_auth_tokens: true can_use_console_password: true can_use_customer_secret_keys: true can_use_db_credentials: true can_use_smtp_credentials: true compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx db_user_name: db_user_name_example defined_tags: Operations: CostCenter: US description: description_example email: email_example email_verified: true external_identifier: external_identifier_example freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx identity_provider_id: ocid1.identityprovider.oc1..xxxxxxEXAMPLExxxxxx inactive_status: 56 is_mfa_activated: true last_successful_login_time: '2013-10-20T19:20:30+01:00' lifecycle_state: CREATING name: name_example previous_successful_login_time: '2013-10-20T19:20:30+01:00' time_created: '2013-10-20T19:20:30+01:00' type: complex