Try SpotterFetches 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 community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches 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 L(Where to Get the Tenancy's OCID and User's OCID,https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
If I(user_id) is specified, the details of a single User will be returned.
- 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
name:
description:
- A filter to only return resources that match the given name exactly.
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 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.'
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 to get a specific user.
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
- security_token
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
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME
sort order is case sensitive.
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
compartment_id:
description:
- The OCID of the compartment (remember that the tenancy is simply the root compartment).
- Required to list multiple users.
type: str
lifecycle_state:
choices:
- CREATING
- ACTIVE
- INACTIVE
- DELETING
- DELETED
description:
- A filter to only return resources that match the given lifecycle state. The state
value is case-insensitive.
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
external_identifier:
description:
- The id of a user in the identity provider.
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
identity_provider_id:
description:
- The id of the identity provider.
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
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
users:
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:
- List of User resources
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