oci_idp_group_mapping - Create, update and delete Identity Provider (IdP) group mappings.

New in version 2.5.

Synopsis

  • Create, update and delete IdP group mappings.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
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
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
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
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_type
    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
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
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.
group_id
str
The identifier of the IAM Service group that is mapped to the IdP group.
identity_provider_id
str

required
The identifier of the identity provider the IdP group mapping belongs to.
idp_group_name
str
The IdP group name.
mapping_id
str
The identifier of the IdpGroupMapping to update or delete.

aliases: id
region
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, update or delete an IdP group mapping. For state=present, if the mapping does not exist, it gets created. If it does exist, it gets updated. For state=absent, the mapping gets deleted.
tenancy
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

Examples

- name: Create IdP group mapping
  oci_idp_group_mapping:
    identity_provider_id: 'ocid1.saml2idp.oc1..xxxxxEXAMPLExxxxxbn4q4eq'
    group_id: 'ocid1.group.oc1..xxxxxEXAMPLExxxxxsdxbsfda'
    idp_group_name: IdPGroupName

- name: Update IdP group name of an IdP group mapping
  oci_idp_group_mapping:
    identity_provider_id: 'ocid1.saml2idp.oc1..xxxxxEXAMPLExxxxxbn4q4eq'
    mapping_id: 'ocid1.idpgroupmapping.oc1..xxxxxEXAMPLExxxxxbnmfuwba'
    idp_group_name: IdPGroupName
    group_id: 'ocid1.group.oc1..xxxxxEXAMPLExxxxxsdxbsfda'

- name: Deletes an IdP group mapping
  oci_idp_group_mapping:
    identity_provider_id: 'ocid1.saml2idp.oc1..xxxxxEXAMPLExxxxxbn4q4eq'
    mapping_id: 'ocid1.idpgroupmapping.oc1..xxxxxEXAMPLExxxxxbnmfuwba'
    state: "absent"

Return Values

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

Key Returned Description
idp_group_mapping
complex
on success
Attributes of the created / updated IdP group mapping

Sample:
{'idp_id': 'ocid1.saml2idp.oc1..xxxxxEXAMPLExxxxxbn4q4eq', 'inactive_status': None, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx..6glmkwq', 'lifecycle_state': 'ACTIVE', 'time_created': '2016-08-25T21:10:29.600Z', 'idp_group_name': 'IdPGroupName', 'group_id': 'ocid1.group.oc1..xxxxxEXAMPLExxxxxsdxbsfda', 'id': 'ocid1.idpgroupmapping.oc1..xxxxxEXAMPLExxxxxbnmfuwba'}
  idp_id
string
always
The identifier of the Identity Provider this mapping belongs to.

Sample:
ocid1.saml2idp.oc1..xxxxxEXAMPLExxxxxbn4q4eq
  inactive_status
int
always
The detailed status of INACTIVE lifecycle_state.

  compartment_id
string
always
The identifier of the tenancy containing the Identity Provider.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx..6glmkwq
  lifecycle_state
string
always
The mapping's current state. After creating a mapping object, make sure its lifecycle_state changes from CREATING to ACTIVE before using it.

Sample:
ACTIVE
  time_created
datetime
always
Date and time the mapping was created.

Sample:
2016-08-25 21:10:29.600000
  idp_group_name
string
always
The name of the IdP group that is mapped to the IAM Service group.

Sample:
IdPGroupName
  group_id
string
always
The identifier of the IAM Service group that is mapped to the IdP group.

Sample:
ocid1.group.oc1..xxxxxEXAMPLExxxxxsdxbsfda
  id
string
always
The identifier of the IdpGroupMapping.

Sample:
ocid1.idpgroupmapping.oc1..xxxxxEXAMPLExxxxxbnmfuwba


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Mike Ross (@mikeross)

Hint

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