oracle.oci.oci_data_safe_grant_facts – Fetches details about one or multiple Grant 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_grant_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets a list of grants for a particular user in the specified user assessment. A user grant contains details such as the privilege name, type, category, and depth level. The depth level indicates how deep in the hierarchy of roles granted to roles a privilege grant is. The userKey in this operation is a system-generated identifier. Perform the operation ListUsers to get the userKey for a particular user.

Requirements

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

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
    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.
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.
depth_level
integer
A filter to return only items that match the specified user grant depth level.
depth_level_greater_than_or_equal_to
integer
A filter to return only items that are at a level greater than or equal to the specified user grant depth level.
depth_level_less_than
integer
A filter to return only items that are at a level less than the specified user grant depth level.
grant_key
string
A filter to return only items that match the specified user grant key.
grant_name
string
A filter to return only items that match the specified user grant name.
privilege_category
string
A filter to return only items that match the specified user privilege category.
privilege_type
string
A filter to return only items that match the specified privilege grant type.
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:
  • grantName
  • grantType
  • privilegeCategory
  • depthLevel
  • key
The field to sort by. You can specify only one sort order (sortOrder). The default order for grantName is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (ASC) or descending (DESC).
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_assessment_id
string / required
The OCID of the user assessment.
user_key
string / required
The unique user key. This is a system-generated identifier. ListUsers gets the user key for a user.

Examples

- name: List grants
  oci_data_safe_grant_facts:
    # required
    user_assessment_id: "ocid1.userassessment.oc1..xxxxxxEXAMPLExxxxxx"
    user_key: user_key_example

    # optional
    grant_key: grant_key_example
    grant_name: grant_name_example
    privilege_type: privilege_type_example
    privilege_category: privilege_category_example
    depth_level: 56
    depth_level_greater_than_or_equal_to: 56
    depth_level_less_than: 56
    sort_order: ASC
    sort_by: grantName

Return Values

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

Key Returned Description
grants
complex
on success
List of Grant resources

Sample:
[{'depth_level': 56, 'grant_name': 'grant_name_example', 'key': 'key_example', 'privilege_category': 'CRITICAL', 'privilege_type': 'SYSTEM_PRIVILEGE'}]
 
depth_level
integer
on success
The grant depth level of the indirect grant. An indirectly granted role/privilege is granted to the user through another role. The depth level indicates how deep a privilege is within the grant hierarchy.

Sample:
56
 
grant_name
string
on success
The name of a user grant.

Sample:
grant_name_example
 
key
string
on success
The unique key of a user grant.

Sample:
key_example
 
privilege_category
string
on success
The privilege category.

Sample:
CRITICAL
 
privilege_type
string
on success
The type of a user grant.

Sample:
SYSTEM_PRIVILEGE


Authors

  • Oracle (@oracle)