oracle.oci.oci_identity_user_facts – Fetches details about one or multiple User resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_identity_user_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple User resources in Oracle Cloud Infrastructure
Lists the users in your tenancy. You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.
If user_id is specified, the details of a single User will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_user
string
|
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
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_fingerprint
string
|
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
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_key_file
string
|
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
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
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 config_file_location ). |
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see 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 auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
cert_bundle
string
|
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.
|
|
compartment_id
string
|
The OCID of the compartment (remember that the tenancy is simply the root compartment).
Required to list multiple users.
|
|
config_file_location
string
|
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.
|
|
config_profile_name
string
|
The profile to load from the config file referenced by
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 config_file_location . |
|
external_identifier
string
|
The id of a user in the identity provider.
|
|
identity_provider_id
string
|
The id of the identity provider.
|
|
lifecycle_state
string
|
|
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
|
name
string
|
A filter to only return resources that match the given name exactly.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
region
string
|
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
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
sort_by
string
|
|
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order is case sensitive.
|
tenancy
string
|
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
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|
user_id
string
|
The OCID of the user.
Required to get a specific user.
aliases: id |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific user
oci_identity_user_facts:
# required
user_id: "ocid1.user.oc1..xxxxxxEXAMPLExxxxxx"
- name: List users
oci_identity_user_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
identity_provider_id: "ocid1.identityprovider.oc1..xxxxxxEXAMPLExxxxxx"
external_identifier: external_identifier_example
name: name_example
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: CREATING
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
users
complex
|
on success |
List of User resources
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'}]
|
||
capabilities
complex
|
on success |
|
||
can_use_api_keys
boolean
|
on success |
Indicates if the user can use API keys.
Sample:
True
|
||
can_use_auth_tokens
boolean
|
on success |
Indicates if the user can use SWIFT passwords / auth tokens.
Sample:
True
|
||
can_use_console_password
boolean
|
on success |
Indicates if the user can log in to the console.
Sample:
True
|
||
can_use_customer_secret_keys
boolean
|
on success |
Indicates if the user can use SigV4 symmetric keys.
Sample:
True
|
||
can_use_db_credentials
boolean
|
on success |
Indicates if the user can use DB passwords.
Sample:
True
|
||
can_use_smtp_credentials
boolean
|
on success |
Indicates if the user can use SMTP passwords.
Sample:
True
|
||
compartment_id
string
|
on success |
The OCID of the tenancy containing the user.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
db_user_name
string
|
on success |
DB username of the DB credential. Has to be unique across the tenancy.
Sample:
db_user_name_example
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
description
string
|
on success |
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.
Sample:
description_example
|
||
email
string
|
on success |
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.
Sample:
email_example
|
||
email_verified
boolean
|
on success |
Whether the email address has been validated.
Sample:
True
|
||
external_identifier
string
|
on success |
Identifier of the user in the identity provider
Sample:
external_identifier_example
|
||
freeform_tags
dictionary
|
on success |
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"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The OCID of the user.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
identity_provider_id
string
|
on success |
The OCID of the `IdentityProvider` this user belongs to.
Sample:
ocid1.identityprovider.oc1..xxxxxxEXAMPLExxxxxx
|
||
inactive_status
integer
|
on success |
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)
Sample:
56
|
||
is_mfa_activated
boolean
|
on success |
Flag indicates if MFA has been activated for the user.
Sample:
True
|
||
last_successful_login_time
string
|
on success |
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`.
Sample:
2013-10-20T19:20:30+01:00
|
||
lifecycle_state
string
|
on success |
The user's current state. After creating a user, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.
Sample:
CREATING
|
||
name
string
|
on success |
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.
Sample:
name_example
|
||
previous_successful_login_time
string
|
on success |
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`.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_created
string
|
on success |
Date and time the user was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)