oracle.oci.oci_data_safe_user_assessment_facts – Fetches details about one or multiple UserAssessment resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets a list of user assessments.

  • The ListUserAssessments operation returns only the assessments in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed.

  • The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

  • The parameter compartmentIdInSubtree applies when you perform ListUserAssessments on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

  • If user_assessment_id is specified, the details of a single UserAssessment will be returned.

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.
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.
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
A filter to return only resources that match the specified compartment OCID.
Required to list multiple user_assessments.
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.
display_name
string
A filter to return only resources that match the specified display name.

aliases: name
is_baseline
boolean
    Choices:
  • no
  • yes
A filter to return only user assessments that are set as baseline.
is_schedule_assessment
boolean
    Choices:
  • no
  • yes
A filter to return only user assessments of type SAVE_SCHEDULE.
lifecycle_state
string
    Choices:
  • CREATING
  • SUCCEEDED
  • UPDATING
  • DELETING
  • DELETED
  • FAILED
The current state of the user assessment.
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.
schedule_user_assessment_id
string
The OCID of the user assessment of type SAVE_SCHEDULE.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. You can specify only one sort order (sortOrder). The default order for timeCreated is descending.
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_created_greater_than_or_equal_to
string
A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339. Using timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date.
**Example:** 2016-12-19T16:39:57.600Z
time_created_less_than
string
Search for resources that were created before a specific date. Specifying this parameter corresponding `timeCreatedLessThan` parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
**Example:** 2016-12-19T16:39:57.600Z
triggered_by
string
    Choices:
  • USER
  • SYSTEM
A filter to return user assessments that were created by either the system or by a user only.
type
string
    Choices:
  • LATEST
  • SAVED
  • COMPARTMENT
  • SAVE_SCHEDULE
A filter to return only items that match the specified assessment type.
user_assessment_id
string
The OCID of the user assessment.
Required to get a specific user_assessment.

aliases: id

Examples

- name: Get a specific user_assessment
  oci_data_safe_user_assessment_facts:
    # required
    user_assessment_id: "ocid1.userassessment.oc1..xxxxxxEXAMPLExxxxxx"

- name: List user_assessments
  oci_data_safe_user_assessment_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id_in_subtree: true
    access_level: RESTRICTED
    display_name: display_name_example
    schedule_user_assessment_id: "ocid1.scheduleuserassessment.oc1..xxxxxxEXAMPLExxxxxx"
    is_schedule_assessment: true
    is_baseline: true
    target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx"
    type: LATEST
    triggered_by: USER
    time_created_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_created_less_than: 2013-10-20T19:20:30+01:00
    lifecycle_state: CREATING
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
user_assessments
complex
on success
List of UserAssessment resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ignored_assessment_ids': [], 'ignored_targets': [], 'is_baseline': True, 'is_deviated_from_baseline': True, 'last_compared_baseline_id': 'ocid1.lastcomparedbaseline.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'schedule': 'schedule_example', 'schedule_assessment_id': 'ocid1.scheduleassessment.oc1..xxxxxxEXAMPLExxxxxx', 'statistics': {}, 'system_tags': {}, 'target_ids': [], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'triggered_by': 'USER', 'type': 'LATEST'}]
 
compartment_id
string
on success
The OCID of the compartment that contains the user assessment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
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 of the user assessment.

Sample:
description_example
 
display_name
string
on success
The display name of the user assessment.

Sample:
display_name_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 assessment.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
ignored_assessment_ids
list / elements=string
on success
List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }`

 
ignored_targets
list / elements=string
on success
List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }`

 
is_baseline
boolean
on success
Indicates if the user assessment is set as a baseline. This is applicable only to saved user assessments.

Sample:
True
 
is_deviated_from_baseline
boolean
on success
Indicates if the user assessment deviates from the baseline.

Sample:
True
 
last_compared_baseline_id
string
on success
The OCID of the last user assessment baseline against which the latest assessment was compared.

Sample:
ocid1.lastcomparedbaseline.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Details about the current state of the user assessment.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the user assessment.

Sample:
CREATING
 
schedule
string
on success
Schedule of the assessment that runs periodically in this specified format: <version-string>;<version-specific-schedule>
Allowed version strings - "v1" v1's version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) <day-of-week> can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is '*'. When not, day of week must equal the given value <day-of-month> can be either '*' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is '*'. When not, day of month must equal the given value

Sample:
schedule_example
 
schedule_assessment_id
string
on success
The OCID of the user assessment that is responsible for creating this scheduled save assessment.

Sample:
ocid1.scheduleassessment.oc1..xxxxxxEXAMPLExxxxxx
 
statistics
dictionary
on success
Map that contains maps of values. Example: `{"Operations": {"CostCenter": "42"}}`

 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
Returned for get operation

 
target_ids
list / elements=string
on success
Array of database target OCIDs.

 
time_created
string
on success
The date and time the user assessment was created, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the user assessment was last updated, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
triggered_by
string
on success
Indicates whether the user assessment was created by system or user.

Sample:
USER
 
type
string
on success
Type of user assessment. Type can be:
LATEST: The most up-to-date assessment that is running automatically for a target. It is system generated. SAVED: A saved user assessment. LATEST assessments will always be saved to maintain the history of runs. A SAVED assessment is also generated by a 'refresh' action (triggered by the user). SAVE_SCHEDULE: A schedule to periodically save LATEST assessments. COMPARTMENT: An automatic managed assessment type that stores all details of targets in one compartment. This will keep an up-to-date status of all potential risks identified in the compartment. It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or moved to a different compartment.

Sample:
LATEST


Authors

  • Oracle (@oracle)