oracle.oci.oci_lockbox_access_request – Manage an AccessRequest resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create an AccessRequest resource in Oracle Cloud Infrastructure

  • For state=present, creates a new access request.

  • This resource has the following action operations in the oracle.oci.oci_lockbox_access_request_actions module: approve, deny, revoke, cancel.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
access_duration
string / required
The maximum amount of time operator has access to associated resources.
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
  • security_token
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.
context
dictionary
The context object containing the access request specific details.
description
string / required
The rationale for requesting the access request.
display_name
string
The name of the access request.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
lockbox_id
string / required
The unique identifier (OCID) of the lockbox box that the access request is associated with which is immutable.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
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.
state
string
    Choices:
  • present ←
The state of the AccessRequest.
Use state=present to create an AccessRequest.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create access_request
  oci_lockbox_access_request:
    # required
    lockbox_id: "ocid1.lockbox.oc1..xxxxxxEXAMPLExxxxxx"
    description: description_example
    access_duration: access_duration_example

    # optional
    display_name: display_name_example
    context: null

Return Values

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

Key Returned Description
access_request
complex
on success
Details of the AccessRequest resource acted upon by the current operation

Sample:
{'access_duration': 'access_duration_example', 'activity_logs': [{'action': 'APPROVE', 'message': 'message_example', 'time_updated': '2013-10-20T19:20:30+01:00', 'user_id': 'ocid1.user.oc1..xxxxxxEXAMPLExxxxxx', 'user_level': 'LEVEL1'}], 'context': {}, 'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'IN_PROGRESS', 'lifecycle_state_details': 'PROCESSING', 'lockbox_id': 'ocid1.lockbox.oc1..xxxxxxEXAMPLExxxxxx', 'requestor_id': 'ocid1.requestor.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_expired': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
access_duration
string
on success
The maximum amount of time operator has access to associated resources.

Sample:
access_duration_example
 
activity_logs
complex
on success
The actions taken by different persona on the access request, e.g. approve/deny/revoke
   
action
string
on success
The action take by persona

Sample:
APPROVE
   
message
string
on success
The action justification or details.

Sample:
message_example
   
time_updated
string
on success
The time the action was taken. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
   
user_id
string
on success
User OCID of the persona

Sample:
ocid1.user.oc1..xxxxxxEXAMPLExxxxxx
   
user_level
string
on success
Level of the persona

Sample:
LEVEL1
 
context
dictionary
on success
The context object containing the access request specific details.
 
description
string
on success
The rationale for requesting the access request and any other related details..

Sample:
description_example
 
display_name
string
on success
The name of the access request.

Sample:
display_name_example
 
id
string
on success
The unique identifier (OCID) of the access request, which can't be changed after creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
Possible access request lifecycle states.

Sample:
IN_PROGRESS
 
lifecycle_state_details
string
on success
Details of access request lifecycle state.

Sample:
PROCESSING
 
lockbox_id
string
on success
The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation.

Sample:
ocid1.lockbox.oc1..xxxxxxEXAMPLExxxxxx
 
requestor_id
string
on success
The unique identifier of the requestor.

Sample:
ocid1.requestor.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The time the access request was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_expired
string
on success
The time the access request expired. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the access request was last updated. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)