oracle.oci.oci_data_safe_user_aggregation_facts – Fetches details about one or multiple UserAggregation resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_data_safe_user_aggregation_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple UserAggregation resources in Oracle Cloud Infrastructure

  • Gets a list of aggregated user details from the specified user assessment. This provides information about the overall state of database user security. For example, the user details include how many users have the DBA role and how many users are in the critical category. This data is especially useful content for dashboards or to support analytics.

  • When you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to “true,” and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment. If the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then “Not Authorized” is returned.

  • The parameter compartmentIdInSubtree applies when you perform ListUserAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned.

  • To use ListUserAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
access_level
string
    Choices:
  • RESTRICTED
  • ACCESSIBLE
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
account_status
string
A filter to return only items that match the specified account status.
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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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.
authentication_type
string
A filter to return only items that match the specified authentication type.
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_in_subtree
boolean
    Choices:
  • no
  • yes
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
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.
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
    Choices:
  • userName
  • userCategory
  • accountStatus
  • timeLastLogin
  • targetId
  • timeUserCreated
  • authenticationType
  • timePasswordChanged
The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (ASC) or descending (DESC).
target_id
string
A filter to return only items related to a specific target OCID.
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
time_last_login_greater_than_or_equal_to
string
A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
**Example:** 2016-12-19T16:39:57.600Z
time_last_login_less_than
string
A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. **Example:** 2016-12-19T16:39:57.600Z
time_password_last_changed_greater_than_or_equal_to
string
A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
**Example:** 2016-12-19T16:39:57.600Z
time_password_last_changed_less_than
string
A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.
**Example:** 2016-12-19T16:39:57.600Z
time_user_created_greater_than_or_equal_to
string
A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. **Example:** 2016-12-19T16:39:57.600Z
time_user_created_less_than
string
A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. **Example:** 2016-12-19T16:39:57.600Z
user_assessment_id
string / required
The OCID of the user assessment.
user_category
string
A filter to return only items that match the specified user category.
user_key
string
A filter to return only items that match the specified user key.
user_name
string
A filter to return only items that match the specified user name.

Examples

- name: List user_aggregations
  oci_data_safe_user_aggregation_facts:
    # required
    user_assessment_id: "ocid1.userassessment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id_in_subtree: true
    access_level: RESTRICTED
    user_category: user_category_example
    user_key: user_key_example
    account_status: account_status_example
    authentication_type: authentication_type_example
    user_name: user_name_example
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
    time_last_login_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_last_login_less_than: 2013-10-20T19:20:30+01:00
    time_user_created_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_user_created_less_than: 2013-10-20T19:20:30+01:00
    time_password_last_changed_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_password_last_changed_less_than: 2013-10-20T19:20:30+01:00
    sort_order: ASC
    sort_by: userName

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
user_aggregations
complex
on success
List of UserAggregation resources

Sample:
[{'items': []}]
 
items
list / elements=string
on success
The array of user aggregation data.



Authors

  • Oracle (@oracle)