oci_auth_token – Manage auth tokens in OCI Identity and Access Management service

New in version 2.5.

Synopsis

  • This module allows the user to perform create, delete & update operations on auth tokens in OCI Identity and Access Management service.

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_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
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_token_id
-
The OCID of the auth token. Required to update an auth token with state=present and delete an auth token with state=absent

aliases: id
auth_type
string
    Choices:
  • api_key ←
  • instance_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.
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.
description
-
The description you assign to the auth token during creation. Does not have to be unique, and it's changeable. Required when creating an auth token with state=present
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
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
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
-
    Choices:
  • present ←
  • absent
Create or update an auth token with state=present. Delete an auth token with state=absent.
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_id
- / required
The OCID of the user.

Examples

- name: Create an auth token
  oci_auth_token:
    user_id: ocid1.user.oc1..xxxxxEXAMPLExxxxx...h5hq
    description: "My test auth token"

- name: Update an auth token
  oci_auth_token:
    user_id: ocid1.user.oc1..xxxxxEXAMPLExxxxx...h5hq
    id: ocid1.credential.oc1..xxxxxEXAMPLExxxxx...l5aq
    description: "My old test auth token"

- name: Delete an auth token
  oci_auth_token:
    user_id: ocid1.user.oc1..xxxxxEXAMPLExxxxx...h5hq
    id: ocid1.credential.oc1..xxxxxEXAMPLExxxxx...l5aq
    state: 'absent'

Return Values

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

Key Returned Description
auth_token
complex
On successful operation
Information about the Auth token

Sample:
{'time-created': '2018-11-08T02:40:25.118000+00:00', 'lifecycle-state': 'ACTIVE', 'time-expires': None, 'description': 'test auth token 1', 'token': None, 'inactive-status': None, 'user-id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx...h5hq', 'id': 'ocid1.credential.oc1..xxxxxEXAMPLExxxxx...l5aq'}
  description
string
always
The description you assign to the auth token. Does not have to be unique, and it's changeable.

Sample:
My test auth token
  id
string
always
The OCID of the auth token.

Sample:
ocid1.credential.oc1..xxxxxEXAMPLExxxxx...l5aq
  time_created
string
always
Date and time the AuthToken object was created, in the format defined by RFC3339.

Sample:
2018-11-08T02:40:25.118000+00:00
  time_expires
string
always
Date and time when this auth token will expire, in the format defined by RFC3339. Null if it never expires.

  token
string
always
The Auth token. The value is available only in the response for CreateAuthToken, and not for ListAuthTokens or UpdateAuthToken.

Sample:
Dmmtd<{DXkH1VJ46.F6X
  user_id
string
always
The OCID of the user the auth token belongs to.

Sample:
ocid1.user.oc1..xxxxxEXAMPLExxxxx...h5hq


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.