oci_user_facts - Fetches details of all the OCI users of a tenancy and their group memberships¶
New in version 2.5.
Synopsis¶
- Fetches details of all the OCI users of a tenancy and the group memberships.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_user |
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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 |
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 |
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 |
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_type |
|
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. |
| config_file_location |
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 |
Default: DEFAULT
|
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. |
| name |
Use name along with the other options to return only resources that match the given name exactly.
|
|
| region |
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. |
|
| tenancy |
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 |
Identifier of the user id whose details should be fetched
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¶
#Fetch users filtered by user id
- name: List user filtered by user id
oci_user_facts:
user_id: 'ocid1.user.oc1..xxxxxEXAMPLExxxxx'
#Fetch all existing users
- name: List all existing users
oci_user_facts:
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
users
complex
|
success |
Attributes of the existing users.
Sample:
[{'lifecycle_state': 'ACTIVE', 'inactive_status': 'None', 'name': 'ansible_user', 'compartment_id': 'ocidv1:tenancy:oc1:arz:1461274726633:aa', 'defined_tags': {'department': {'division': 'engineering'}}, 'freeform_tags': {'user_type': 'admin'}, 'time_created': '2017-11-04T14:45:27.358000+00:00', 'member_of_groups': [{'lifecycle_state': 'ACTIVE', 'inactive_status': 'None', 'description': 'Group Two', 'compartment_id': 'ocidv1:tenancy:oc1:arz:146:aaa', 'defined_tags': {'product': {'type': 'server'}}, 'freeform_tags': {'group_name': 'designer'}, 'time_created': '2017-06-22T13:55:21.077000+00:00', 'id': 'ocid1.group.oc1..xxxxxEXAMPLExxxxx', 'name': 'group_two'}, {'lifecycle_state': 'ACTIVE', 'inactive_status': 'None', 'description': 'Group One', 'compartment_id': 'ocidv1:tenancy:oc1:arz:145', 'defined_tags': {'product': {'type': 'server'}}, 'freeform_tags': {'group_name': 'documentation'}, 'time_created': '2016-12-20T20:29:12.093000+00:00', 'id': 'ocid1.group.oc1..xxxxxEXAMPLExxxxx', 'name': 'group_one'}], 'id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'description': 'Ansible User'}]
|
|
|
lifecycle_state
string
|
always |
The current state of the user
Sample:
ACTIVE
|
|
|
inactive_status
string
|
when user's lifecycle_state is INACTIVE |
The detailed status of INACTIVE life cycle state
Sample:
None
|
|
|
description
string
|
always |
The description assigned to the user
Sample:
Ansible User
|
|
|
compartment_id
string
|
always |
The identifier of the tenancy containing the user
Sample:
ocid1.tenancy.oc1.xzvf..oifds
|
|
|
time_created
datetime
|
always |
Date and time when the user was created, in the format defined by RFC3339
Sample:
2016-08-25 21:10:29.600000
|
|
|
member_of_groups
string
|
always |
The details of the groups the user has memberships in
Sample:
[{'lifecycle_state': 'ACTIVE', 'inactive_status': 'None', 'description': 'Group Two', 'compartment_id': 'ocidv1:tenancy:oc1:arz:146:aaa', 'id': 'ocid1.group.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2017-06-22T13:55:21.077000+00:00', 'name': 'group_two'}]
|
|
|
id
string
|
always |
Identifier of the user
Sample:
ocid1.user.oc1.axdf
|
|
|
name
string
|
always |
Name assigned to the user during creation
Sample:
ansible_user
|
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author¶
- Debayan Gupta(@debayan_gupta)
Hint
If you notice any issues in this documentation you can edit this document to improve it.