Sx5 868 pr keycloak identity provider

[elfelip]

SUMMARY

Add Keycloak Identity provider module

ISSUE TYPE

• New Module Pull Request

COMPONENT NAME

keycloak_identity_provider

ADDITIONAL INFORMATION

module: keycloak_identity_provider
short_description: Configure an identity provider in Keycloak
description:

• This module creates, removes or update Keycloak identity provider.
  version_added: "2.9"
  options:
  realm:
  description:
  • The name of the realm in which is the identity provider.
    default: master
    alias:
    description:
  • The alias of the identity provider.
    required: true
    displayName:
    description:
  • The display name of the realm.
    required: false
    providerId:
    description:
  • Type of identity provider.
    required: false
    enabled:
    description:
  • enabled.
    required: false
    default: true
    updateProfileFirstLoginMode:
    description:
  • update Profile First Login Mode.
    required: false
    trustEmail:
    description:
  • trust Email.
    required: false
    storeToken:
    description:
  • store Token.
    required: false
    default: true
    addReadTokenRoleOnCreate:
    description:
  • add Read Token Role On Create.
    required: false
    authenticateByDefault:
    description:
  • authenticate By Default.
    required: false
    firstBrokerLoginFlowAlias:
    description:
  • first Broker Login Flow Alias.
    required: false
    postBrokerLoginFlowAlias:
    description:
  • post Broker Login Flow Alias.
    required: false
    linkOnly:
    description:
  • Link only option for identity provider
    default: False
    config:
    description:
  • Detailed configuration of the identity provider.
    required: false
    type: dict
    suboptions:
    openIdConfigurationUrl:
    description:
    - Open ID configuration URL of the IdP to configure. Will be used to configure IdP endpoints.
    type: str
    clientId:
    description:
    - Client ID used to authenticate Keycloak on this IdP
    type: str
    clientSecret:
    description:
    - Client secret to authenticate client on the IdP.
    type: str
    disableUserInfo:
    description:
    - Do we need to disable user info endpoint query. Default value is False.
    - Must be set to true when IdP is Microsoft ADFS.
    type: str
    choices:
    - true
    - false
    default: false
    defaultScope:
    description:
    - Default scope supported with this IdP
    type: str
    guiOrder:
    description:
    - Order to display the IdP button on login screen. Lower's first.
    type: int
    backchannelSupported:
    description:
    - Is back channel logout is supported by the IdP.
    type: str
    choices:
    - true
    - false
    default: true
    mappers:
    description:
  • List of mappers for the Identity provider.
    required: false
    type: list
    suboptions:
    name:
    description:
    - Name of the mapper
    type: str
    identityProviderMapper:
    description:
    - Type of identity provider mapper.
    type: str
    choices:
    - oidc-user-attribute-idp-mapper
    - oidc-role-idp-mapper
    config:
    description:
    - Configuration for this mapper.
    type: dict
    suboptions:
    claim:
    description:
    - Name of the claim to map.
    type: str
    user.attribute:
    description:
    - This option is for oidc-user-attribute-idp-mapper
    - User attribute to copy the claim value to.
    type: str
    claim.value:
    description:
    - This option is for oidc-role-idp-mapper
    - Role will be granted to the user only if the claim match this value.
    type: str
    role:
    description:
    - This option is for oidc-role-idp-mapper
    - Role to be granted to the user if the claim match claim.value.
    type: str
    state:
    description:
  • Control if the realm exists.
    choices: [ "present", "absent" ]
    default: present
    force:
    description:
  • If true, allows to remove realm and recreate it.
    type: bool
    default: false
    extends_documentation_fragment:
  • keycloak
    notes:
• module does not modify identity provider alias.
  author:
  • Philippe Gauthier (@elfelip

[ansibot]

@elfelip this PR contains the following merge commits:

• ebb12af
• e81937d
• 4d3d010
• e4548f6
• 287bff7
• 8750d32
• 94a675a

Please rebase your branch to remove these commits.

click here for bot help

[ansibot]

@adamgoossens @eikef

As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add shipit if you would like to see it merged.

click here for bot help

[ansibot]

cc @eikef
click here for bot help

[ansibot]

cc @ndclt
click here for bot help

[Akasurde]

Hi @elfelip, Thank you very much for your interest in Ansible. This plugin/module is no longer maintained in this repository and has been migrated to https://github.com/ansible-collections/community.general

If you have further questions please stop by IRC or the mailing list:

* IRC: #ansible on irc.freenode.net
* mailing list: https://groups.google.com/forum/#!forum/ansible-project

needs_info