oracle.oci.oci_oda_authentication_provider – Manage an AuthenticationProvider 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_oda_authentication_provider.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete an AuthenticationProvider resource in Oracle Cloud Infrastructure

  • For state=present, creates a new Authentication Provider

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
  • 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.
authentication_provider_id
string
Unique Authentication Provider identifier.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
authorization_endpoint_url
string
The IDPs URL for the page that users authenticate with by entering the user name and password.
Required for create using state=present.
This parameter is updatable.
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.
client_id
string
The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID.
Required for create using state=present.
This parameter is updatable.
client_secret
string
The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application secret.
Required for create using state=present.
This parameter is updatable.
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.
defined_tags
dictionary
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
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.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}`
This parameter is updatable.
grant_type
string
    Choices:
  • CLIENT_CREDENTIALS
  • AUTHORIZATION_CODE
The grant type for the Authentication Provider.
Required for create using state=present.
identity_provider
string
    Choices:
  • GENERIC
  • OAM
  • GOOGLE
  • MICROSOFT
Which type of Identity Provider (IDP) you are using.
Required for create using state=present.
is_visible
boolean
    Choices:
  • no
  • yes
Whether this Authentication Provider is visible in the ODA UI.
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.
name
string
A name to identify the Authentication Provider.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
oda_instance_id
string / required
Unique Digital Assistant instance identifier.
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.
redirect_url
string
The OAuth Redirect URL.
This parameter is updatable.
refresh_token_retention_period_in_days
integer
The number of days to keep the refresh token in the Digital Assistant cache.
This parameter is updatable.
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.
revoke_token_endpoint_url
string
If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service.
This parameter is updatable.
scopes
string
A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that???s necessary to get the refresh token (typically offline_access).
Required for create using state=present.
This parameter is updatable.
short_authorization_code_request_url
string
A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the AuthenticationProvider.
Use state=present to create or update an AuthenticationProvider.
Use state=absent to delete an AuthenticationProvider.
subject_claim
string
The access-token profile claim to use to identify the user.
Required for create using state=present.
This parameter is updatable.
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
token_endpoint_url
string
The IDPs URL for requesting access tokens.
Required for create using state=present.
This parameter is updatable.
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 authentication_provider
  oci_oda_authentication_provider:
    # required
    grant_type: CLIENT_CREDENTIALS
    identity_provider: GENERIC
    name: name_example
    token_endpoint_url: token_endpoint_url_example
    authorization_endpoint_url: authorization_endpoint_url_example
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    client_secret: client_secret_example
    scopes: scopes_example
    subject_claim: subject_claim_example
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    is_visible: true
    short_authorization_code_request_url: short_authorization_code_request_url_example
    revoke_token_endpoint_url: revoke_token_endpoint_url_example
    refresh_token_retention_period_in_days: 56
    redirect_url: redirect_url_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update authentication_provider
  oci_oda_authentication_provider:
    # required
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
    authentication_provider_id: "ocid1.authenticationprovider.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    token_endpoint_url: token_endpoint_url_example
    authorization_endpoint_url: authorization_endpoint_url_example
    short_authorization_code_request_url: short_authorization_code_request_url_example
    revoke_token_endpoint_url: revoke_token_endpoint_url_example
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    client_secret: client_secret_example
    scopes: scopes_example
    subject_claim: subject_claim_example
    refresh_token_retention_period_in_days: 56
    redirect_url: redirect_url_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update authentication_provider using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_oda_authentication_provider:
    # required
    name: name_example
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    token_endpoint_url: token_endpoint_url_example
    authorization_endpoint_url: authorization_endpoint_url_example
    short_authorization_code_request_url: short_authorization_code_request_url_example
    revoke_token_endpoint_url: revoke_token_endpoint_url_example
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    client_secret: client_secret_example
    scopes: scopes_example
    subject_claim: subject_claim_example
    refresh_token_retention_period_in_days: 56
    redirect_url: redirect_url_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete authentication_provider
  oci_oda_authentication_provider:
    # required
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
    authentication_provider_id: "ocid1.authenticationprovider.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete authentication_provider using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_oda_authentication_provider:
    # required
    name: name_example
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
authentication_provider
complex
on success
Details of the AuthenticationProvider resource acted upon by the current operation

Sample:
{'authorization_endpoint_url': 'authorization_endpoint_url_example', 'client_id': 'ocid1.client.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'grant_type': 'CLIENT_CREDENTIALS', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'identity_provider': 'GENERIC', 'is_visible': True, 'lifecycle_state': 'CREATING', 'name': 'name_example', 'redirect_url': 'redirect_url_example', 'refresh_token_retention_period_in_days': 56, 'revoke_token_endpoint_url': 'revoke_token_endpoint_url_example', 'scopes': 'scopes_example', 'short_authorization_code_request_url': 'short_authorization_code_request_url_example', 'subject_claim': 'subject_claim_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'token_endpoint_url': 'token_endpoint_url_example'}
 
authorization_endpoint_url
string
on success
The IDPs URL for the page that users authenticate with by entering the user name and password.

Sample:
authorization_endpoint_url_example
 
client_id
string
on success
The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID.

Sample:
ocid1.client.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
grant_type
string
on success
The grant type for the Authentication Provider.

Sample:
CLIENT_CREDENTIALS
 
id
string
on success
Unique immutable identifier that was assigned when the Authentication Provider was created.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
identity_provider
string
on success
Which type of Identity Provider (IDP) you are using.

Sample:
GENERIC
 
is_visible
boolean
on success
Whether this Authentication Provider is visible in the ODA UI.

Sample:
True
 
lifecycle_state
string
on success
The Authentication Provider's current state.

Sample:
CREATING
 
name
string
on success
A name to identify the Authentication Provider.

Sample:
name_example
 
redirect_url
string
on success
The OAuth Redirect URL.

Sample:
redirect_url_example
 
refresh_token_retention_period_in_days
integer
on success
The number of days to keep the refresh token in the Digital Assistant cache.

Sample:
56
 
revoke_token_endpoint_url
string
on success
If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service.

Sample:
revoke_token_endpoint_url_example
 
scopes
string
on success
A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that???s necessary to get the refresh token (typically offline_access).

Sample:
scopes_example
 
short_authorization_code_request_url
string
on success
A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones.

Sample:
short_authorization_code_request_url_example
 
subject_claim
string
on success
The access-token profile claim to use to identify the user.

Sample:
subject_claim_example
 
time_created
string
on success
When the resource was created. A date-time string as described in RFC 3339, section 14.29.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

Sample:
2013-10-20T19:20:30+01:00
 
token_endpoint_url
string
on success
The IDPs URL for requesting access tokens.

Sample:
token_endpoint_url_example


Authors

  • Oracle (@oracle)