oracle / oracle.oci / 4.2.0 / module / oci_database_management_user_facts Fetches details about one or multiple User resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_user_facts (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
Fetches details about one or multiple User resources in Oracle Cloud Infrastructure
Gets the list of users for the specified managedDatabaseId.
If I(user_name) is specified, the details of a single User will be returned.
- name: Get a specific user oci_database_management_user_facts: # required user_name: user_name_example managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
- name: List users oci_database_management_user_facts: # required managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx" # optional name: name_example sort_by: TIMECREATED sort_order: ASC
name: description: - A filter to return only resources that match the entire name. type: str 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 sort_by: choices: - TIMECREATED - NAME description: - The field to sort information by. Only one sortOrder can be used. The default sort order for 'TIMECREATED' is descending and the default sort order for 'NAME' is ascending. The 'NAME' sort order is case-sensitive. 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 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 user_name: description: - The name of the user whose details are to be viewed. - Required to get a specific user. type: str sort_order: choices: - ASC - DESC description: - The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending order is the default order. 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 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 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 managed_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database. required: true 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
users: contains: all_shared: description: - In a sharded database, indicates whether the user is created with shard DDL enabled (YES) or not (NO). - Returned for get operation returned: on success sample: true type: str authentication: description: - The authentication mechanism for the user. - Returned for get operation returned: on success sample: NONE type: str common: description: - Indicates whether a given user is common(Y) or local(N). - Returned for get operation returned: on success sample: true type: str consumer_group: description: - The initial resource consumer group for the User. - Returned for get operation returned: on success sample: consumer_group_example type: str default_collation: description: - The default collation for the user schema. - Returned for get operation returned: on success sample: default_collation_example type: str default_tablespace: description: - The default tablespace for data. returned: on success sample: default_tablespace_example type: str editions_enabled: description: - Indicates whether editions have been enabled for the corresponding user (Y) or not (N). - Returned for get operation returned: on success sample: true type: str external_name: description: - The external name of the user. - Returned for get operation returned: on success sample: external_name_example type: str external_shared: description: - In a federated sharded database, indicates whether the user is an external shard user (YES) or not (NO). - Returned for get operation returned: on success sample: true type: str implicit: description: - Indicates whether the user is a common user created by an implicit application (YES) or not (NO). - Returned for get operation returned: on success sample: true type: str inherited: description: - Indicates whether the user definition is inherited from another container (YES) or not (NO). - Returned for get operation returned: on success sample: true type: str local_temp_tablespace: description: - The default local temporary tablespace for the user. - Returned for get operation returned: on success sample: local_temp_tablespace_example type: str name: description: - The name of the User. returned: on success sample: name_example type: str oracle_maintained: description: - Indicates whether the user was created and is maintained by Oracle-supplied scripts (such as catalog.sql or catproc.sql). - Returned for get operation returned: on success sample: true type: str password_versions: description: - The list of existing versions of the password hashes (also known as "verifiers") for the account. - Returned for get operation returned: on success sample: password_versions_example type: str profile: description: - The profile name of the user. returned: on success sample: profile_example type: str proxy_connect: description: - Indicates whether a user can connect directly (N) or whether the account can only be proxied (Y) by users who have proxy privileges for this account (that is, by users who have been granted the "connect through" privilege for this account). - Returned for get operation returned: on success sample: true type: str status: description: - The status of the user account. returned: on success sample: OPEN type: str temp_tablespace: description: - The name of the default tablespace for temporary tables or the name of a tablespace group. returned: on success sample: temp_tablespace_example type: str time_created: description: - The date and time the user was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_expiring: description: - The date and time of the expiration of the user account. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_last_login: description: - The date and time of the last user login. This column is not populated when a user connects to the database with administrative privileges, that is, AS { SYSASM | SYSBACKUP | SYSDBA | SYSDG | SYSOPER | SYSRAC | SYSKM }. - Returned for get operation returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_locked: description: - The date the account was locked, if the status of the account is LOCKED. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_password_changed: description: - The date and time when the user password was last set. This column is populated only when the value of the AUTHENTICATION_TYPE column is PASSWORD. Otherwise, this column is null. - Returned for get operation returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - List of User resources returned: on success sample: - all_shared: 'YES' authentication: NONE common: 'YES' consumer_group: consumer_group_example default_collation: default_collation_example default_tablespace: default_tablespace_example editions_enabled: 'YES' external_name: external_name_example external_shared: 'YES' implicit: 'YES' inherited: 'YES' local_temp_tablespace: local_temp_tablespace_example name: name_example oracle_maintained: 'YES' password_versions: password_versions_example profile: profile_example proxy_connect: 'YES' status: OPEN temp_tablespace: temp_tablespace_example time_created: '2013-10-20T19:20:30+01:00' time_expiring: '2013-10-20T19:20:30+01:00' time_last_login: '2013-10-20T19:20:30+01:00' time_locked: '2013-10-20T19:20:30+01:00' time_password_changed: '2013-10-20T19:20:30+01:00' type: complex