middleware_automation.keycloak/1.2.0/searchindex.js

Search.setIndex({"docnames": ["CHANGELOG", "README", "developing", "index", "plugins/index", "plugins/keycloak_client", "plugins/keycloak_role", "plugins/keycloak_user_federation", "plugins/version_sort", "releasing", "roles/index", "roles/keycloak", "roles/keycloak_quarkus", "roles/keycloak_realm", "testing"], "filenames": ["CHANGELOG.rst", "README.md", "developing.md", "index.rst", "plugins/index.rst", "plugins/keycloak_client.rst", "plugins/keycloak_role.rst", "plugins/keycloak_user_federation.rst", "plugins/version_sort.rst", "releasing.md", "roles/index.rst", "roles/keycloak.md", "roles/keycloak_quarkus.md", "roles/keycloak_realm.md", "testing.md"], "titles": ["middleware_automation.keycloak Release Notes", "Ansible Collection - middleware_automation.keycloak", "Contributor\u2019s Guidelines", "Welcome to Keycloak Collection documentation", "Plugin Index", "keycloak_client \u2013 Allows administration of Keycloak clients via Keycloak API", "keycloak_role \u2013 Allows administration of Keycloak roles via Keycloak API", "keycloak_user_federation \u2013 Allows administration of Keycloak user federations via Keycloak API", "version_sort \u2013 Sort a list according to version order instead of pure alphabetical one", "Collection Versioning Strategy", "Role Index", "keycloak", "keycloak_quarkus", "keycloak_realm", "Testing"], "terms": {"thi": [0, 1, 5, 6, 7, 8, 9, 11], "changelog": [0, 3], "describ": [0, 1, 8], "after": [0, 5, 6, 7, 9, 14], "version": [0, 3, 4, 5, 6, 7, 10, 12], "provid": [0, 1, 5, 6, 7, 13, 14], "config": [0, 5, 7, 13], "multipl": [0, 1], "modclust": [0, 11], "proxi": [0, 11, 12], "60": 0, "allow": [0, 1, 3, 4, 9, 13], "configur": [0, 3, 5, 6, 7, 8, 11, 12, 13], "tcpping": [0, 11], "cluster": [0, 1, 5, 11, 12, 14], "discoveri": [0, 11], "62": 0, "drop": [0, 5], "commun": [0, 11], "gener": [0, 5, 7, 9], "from": [0, 2, 3, 5, 7, 11], "depend": [0, 1, 5, 7, 10, 14], "61": 0, "switch": 0, "redhat_csp_download": 0, "common": [0, 5, 6, 7, 11], "63": 0, "rh": [0, 1, 11], "sso": [0, 1, 11], "patch": [0, 9, 10], "64": 0, "quarku": [0, 1, 12], "fix": [0, 3], "cach": [0, 1, 7, 11, 12, 14], "file": [0, 1, 2, 7, 11, 12], "path": [0, 1, 2, 11, 12, 13], "conf": [0, 12], "j2": 0, "templat": [0, 5, 11], "53": 0, "updat": [0, 1, 5, 6, 7, 9], "18": [0, 11], "46": 0, "variabl": [0, 1, 2, 8, 10], "keycloak_no_log": 0, "control": [0, 5, 6, 7, 11], "ansibl": [0, 2, 3, 5, 6, 7, 8, 9, 11, 14], "no_log": 0, "paramet": [0, 4, 8, 9], "debug": [0, 7], "purpos": 0, "47": 0, "overrid": [0, 2, 5, 8], "servic": [0, 1, 5, 7, 11, 12, 13], "start": [0, 2, 12], "retri": 0, "delai": 0, "51": 0, "keycloak_quarku": [0, 1, 3, 10], "enabl": [0, 5, 7, 11, 12], "develop": [0, 9, 12], "mode": [0, 5, 6, 7, 12], "45": 0, "renam": 0, "infinispan_": 0, "prefix": 0, "keycloak_infinispan_": 0, "42": 0, "var": [0, 2, 11, 13], "log": [0, 7, 12], "symlink": 0, "directori": [0, 1, 2, 7, 11, 12, 14], "44": 0, "us": [0, 1, 2, 5, 6, 7, 8, 11, 12, 13], "absolut": 0, "certif": [0, 5, 6, 7, 11, 12], "39": 0, "becom": [0, 7], "task": [0, 1, 2, 11, 13], "otherwis": [0, 5], "fail": 0, "38": 0, "add": [0, 6, 7], "select": [0, 11], "java": [0, 7, 11, 12], "systemd": [0, 14], "unit": 0, "34": 0, "set": [0, 1, 5, 6, 11, 12, 13], "logfil": 0, "correctli": 0, "under": [0, 2, 5, 6, 7], "home": [0, 12], "35": 0, "option": [0, 5, 6, 7, 11, 12, 13], "32": 0, "new": [0, 3, 6, 7, 8], "role": [0, 2, 3, 4, 5, 7, 14], "instal": [0, 3, 5, 6, 7, 8, 11, 12, 14], "17": [0, 1, 12], "29": 0, "keycloak_config_override_templ": [0, 11], "pass": [0, 6, 11, 12], "custom": [0, 6, 11], "xml": [0, 5, 7, 11], "30": [0, 11], "make": [0, 1, 9, 11, 13], "sure": 0, "jvm": [0, 11, 12], "31": 0, "keycloak_admin_password": [0, 1, 11, 13], "default": [0, 2, 5, 6, 7, 9, 10], "assert": [0, 5], "wa": [0, 3, 5, 6, 7], "26": 0, "simplifi": 0, "logic": 0, "reduc": 0, "plai": [0, 2], "execut": [0, 1, 5, 6, 7], "time": [0, 5, 9], "19": 0, "keycloak_frontend_url": [0, 11], "accord": [0, 3, 4], "other": [0, 2, 5, 7, 14], "25": 0, "enhanc": 0, "bug": [0, 3], "document": [0, 5, 6, 7], "appli": [0, 7, 11], "latest": [0, 11], "cumul": [0, 11], "automat": [0, 7, 11, 14], "when": [0, 1, 2, 5, 6, 7, 9, 11], "keycloak_rhsso_apply_patch": [0, 11], "i": [0, 1, 3, 5, 6, 7, 8, 11, 12, 13, 14], "true": [0, 1, 5, 6, 7, 11, 12, 13], "now": 0, "perform": [0, 11, 12], "databas": [0, 7, 11, 12], "initi": [0, 7], "first": [0, 7, 9], "node": [0, 5, 11], "avoid": [0, 2], "lock": 0, "issu": [0, 1, 5], "stabl": 0, "collect": [0, 5, 6, 7, 8, 11, 13, 14], "red": [1, 3, 7, 11, 13], "hat": [1, 3, 7, 11, 13], "singl": [1, 3, 5, 6, 7, 11, 13], "sign": [1, 3, 5, 11, 13], "On": [1, 3, 5, 6, 7, 11, 13], "ha": [1, 5, 6, 7, 11], "been": [1, 5, 6, 7], "test": [1, 3, 5, 6, 9], "against": [1, 7], "follow": [1, 2, 5, 6, 7, 9, 11, 13, 14], "2": [1, 2, 3, 7, 8, 9, 11, 12, 13, 14], "9": [1, 8, 11, 12, 14], "10": [1, 5, 6, 7, 8], "plugin": [1, 3, 8], "modul": [1, 5, 6, 7, 9], "within": [1, 3, 7], "mai": [1, 5, 6, 7, 9], "onli": [1, 5, 7, 9, 11], "specif": [1, 2, 5, 12], "A": [1, 3, 5, 6, 7, 8, 14], "contain": [1, 2, 5, 7, 9, 13], "metadata": [1, 9], "identifi": [1, 7], "befor": [1, 5, 7, 8], "you": [1, 5, 6, 7], "need": [1, 2, 5, 6, 7, 9], "cli": [1, 5, 6, 7, 11, 12, 13], "can": [1, 5, 6, 7], "also": [1, 7], "requir": [1, 2, 5, 6, 7, 8, 9, 10, 12, 13, 14], "yml": [1, 2, 11, 14], "via": [1, 3, 4, 11], "r": [1, 11, 14], "format": [1, 5, 9, 10, 12], "name": [1, 2, 5, 6, 7, 8, 9, 11, 12, 13], "The": [1, 5, 6, 7, 8, 9, 11, 12, 13, 14], "python": [1, 14], "packag": [1, 11, 12], "present": [1, 5, 6, 7], "host": [1, 7, 11, 13], "netaddr": [1, 11], "pip": [1, 11, 14], "txt": [1, 11, 14], "keycloak_realm": [1, 3, 10], "realm": [1, 5, 6, 7, 11, 12, 13], "user": [1, 2, 4, 5, 6, 9, 11, 12, 13], "feder": [1, 3, 4, 13], "": [1, 3, 5, 7, 12], "client": [1, 3, 4, 6, 7, 11, 12, 13], "an": [1, 3, 5, 6, 7, 11, 12, 13], "variant": 1, "0": [1, 3, 5, 6, 7, 8, 9, 11, 12, 13], "upstream": 1, "base": [1, 5, 11], "defin": [1, 2, 5, 7], "rhsso": 1, "both": [1, 5], "differ": [1, 5, 7], "section": [1, 5, 9], "For": [1, 5, 7, 8, 13], "full": [1, 5, 6, 7], "detail": [1, 5, 6, 7], "refer": [1, 5, 13], "readm": [1, 9], "zip": [1, 11, 12], "archiv": [1, 11, 12], "avail": [1, 5, 9, 13, 14], "repositori": [1, 14], "root": [1, 5, 11, 12], "keycloak_offline_instal": [1, 11], "skip": 1, "download": [1, 3, 11, 12], "match": 1, "so": [1, 5, 7], "ar": [1, 2, 5, 6, 7, 9, 11, 13, 14], "provis": [1, 7], "And": 1, "keycloak_rhsso_en": 1, "x": 1, "y": 1, "z": 1, "server": [1, 5, 7, 11, 12], "dist": 1, "fals": [1, 5, 6, 7, 11, 12, 13], "sso_download_url": 1, "http": [1, 5, 6, 7, 9, 11, 12, 13, 14], "intern": [1, 2, 5], "privat": [1, 5, 12], "net": [1, 7], "keycloak_download_url": [1, 11], "ansible_host": 1, "e": [1, 2, 5, 6, 12], "rhn": 1, "cred": 1, "changem": [1, 13], "password": [1, 5, 6, 7, 11, 12, 13], "administr": [1, 3, 4, 11, 12, 13], "consol": [1, 5, 7, 11, 12, 13], "account": [1, 5, 11, 12, 13], "inventori": [1, 9, 14], "below": [1, 5, 7, 9], "deploi": 1, "localhost": [1, 5, 6, 11, 12, 13, 14], "ansible_connect": [1, 14], "creat": [1, 5, 6, 7, 9, 13, 14], "v1": [1, 3], "beta": 1, "releas": [1, 3, 11, 12, 14], "technic": 1, "preview": 1, "If": [1, 5, 6, 7, 12], "have": [1, 2, 5, 6, 7, 8], "ani": [1, 3, 5, 7], "question": 1, "relat": 1, "pleas": [1, 5, 9], "don": [1, 2, 7], "t": [1, 2, 7, 12], "hesit": 1, "contact": 1, "u": 1, "middlewar": [1, 14], "core": [1, 14], "redhat": 1, "com": [1, 5, 6, 7, 11, 12, 14], "open": [1, 11], "github": [1, 9, 11, 12, 14], "apach": [1, 11, 12, 13], "v2": [1, 5], "later": 1, "see": [1, 5, 7, 9], "view": 1, "text": 1, "all": [2, 5, 6, 7, 9, 11, 14], "yaml": 2, "extens": [2, 5, 9], "space": [2, 7], "around": 2, "jinja": 2, "over": 2, "should": [2, 5, 7, 9, 11, 12, 13], "lowercas": 2, "keep": 2, "self": 2, "includ": [2, 5, 7, 9, 11, 13, 14], "possibl": [2, 5, 7], "do": [2, 5, 6, 7], "noth": 2, "more": [2, 7, 12], "than": [2, 5], "list": [2, 3, 4, 5, 6, 7, 11, 12, 13], "except": 2, "where": [2, 5, 7], "pre_task": 2, "post_task": 2, "separ": [2, 5, 6, 7, 12], "valid": [2, 5, 7], "ie": 2, "underscor": 2, "g": [2, 5, 6], "my_rol": 2, "my_playbook": 2, "dash": 2, "my": [2, 6, 7], "trail": 2, "slash": 2, "my_path": 2, "foo": [2, 7], "concaten": 2, "same": [2, 5, 7], "convent": 2, "bar": 2, "indent": 2, "each": [2, 8, 9], "v": 2, "interpol": 2, "chang": [2, 3, 5, 6, 7, 14], "overridden": 2, "go": [2, 5], "those": [2, 7], "would": [2, 5, 6, 7, 9], "like": 2, "argument": 2, "meta": 2, "argument_spec": 2, "playbook": [2, 3, 5, 6, 7, 8, 9, 10], "focus": 2, "compat": [2, 3], "autom": [2, 3], "platform": 2, "middleware_autom": [3, 5, 6, 7, 8, 11, 13, 14], "usag": 3, "support": [3, 5, 6, 7, 9, 13], "licens": [3, 10], "index": [3, 5, 6, 7], "version_sort": [3, 4], "sort": [3, 4], "order": [3, 4, 14], "instead": [3, 4, 5, 7], "pure": [3, 4], "alphabet": [3, 4], "one": [3, 4, 5, 7, 12], "keycloak_cli": [3, 4, 13], "api": [3, 4, 9], "keycloak_rol": [3, 4], "keycloak_user_feder": [3, 4, 13], "continu": 3, "integr": 3, "contributor": 3, "guidelin": 3, "strategi": 3, "content": [3, 5, 7], "ad": [3, 5, 6, 7], "exist": [3, 5, 6, 7, 11, 12], "featur": [3, 5], "backward": 3, "secur": 3, "break": [3, 14], "remov": [3, 5, 6, 7, 11, 12], "typograph": 3, "error": 3, "modifi": [3, 5, 6, 7], "1": [3, 5, 7, 8, 9, 11, 12], "7": [3, 5, 7, 11], "6": [3, 11], "5": [3, 5, 6, 7, 11, 14], "4": [3, 5, 6, 7, 11, 12], "3": [3, 5, 6, 7, 11, 14], "infinispan": [3, 11, 12, 14], "data": [3, 5, 7, 12], "grid": 3, "wildfli": [3, 14], "jboss": [3, 11], "eap": [3, 11], "tomcat": 3, "jw": 3, "activemq": 3, "amq": 3, "broker": 3, "kafka": 3, "stream": 3, "csp": 3, "jcliff": 3, "synopsi": 4, "input": [4, 5], "exampl": [4, 9, 10], "return": [4, 9], "valu": [4, 13], "author": [4, 10], "keycloak": [4, 8, 10, 12, 13, 14], "attribut": 4, "part": [5, 6, 7, 8], "To": [5, 6, 7, 8, 11], "galaxi": [5, 6, 7, 8, 9, 11, 14], "specifi": [5, 6, 7, 8, 11, 12], "rest": [5, 6, 7, 11, 12, 13], "It": [5, 6, 7], "access": [5, 6, 7], "openid": [5, 6, 7], "connect": [5, 6, 7, 9, 11, 12], "being": [5, 6, 7], "must": [5, 6, 7], "requisit": [5, 6, 7], "right": [5, 6, 7], "In": [5, 6, 7, 14], "admin": [5, 6, 7, 11, 12, 13], "work": [5, 6, 7, 11, 12], "definit": [5, 6, 7], "scope": [5, 6, 7], "tailor": [5, 6, 7], "your": [5, 6, 7], "expect": [5, 6, 7], "snake_cas": [5, 6, 7], "camelcas": [5, 6, 7], "ones": [5, 6, 7], "found": [5, 6, 7], "its": [5, 6, 7], "www": [5, 6, 7], "org": [5, 6, 7, 9, 11, 12, 13], "doc": [5, 6, 7, 13], "8": [5, 6, 11], "html": [5, 6, 7], "alias": [5, 6, 7], "well": 5, "doe": [5, 6, 7, 9], "alwai": [5, 6, 7], "saniti": 5, "check": [5, 7, 12], "saml": 5, "instanc": [5, 6, 7], "vice": 5, "versa": 5, "Be": 5, "care": 5, "usual": [5, 7], "sensibl": 5, "chosen": [5, 7], "comment": [5, 6, 7, 8], "admin_url": 5, "adminurl": 5, "string": [5, 6, 7, 8], "url": [5, 6, 7, 11, 12, 13], "interfac": 5, "always_display_in_consol": 5, "alwaysdisplayinconsol": 5, "boolean": [5, 6, 7], "whether": [5, 7, 12], "displai": [5, 7], "even": [5, 7], "activ": [5, 7], "session": 5, "choic": [5, 6, 7], "entri": [5, 6, 7, 8, 9, 12], "dictionari": [5, 6, 7, 8, 13], "dict": [5, 6, 7, 11], "further": 5, "variou": 5, "given": [5, 7, 9], "while": [5, 9], "exhaust": 5, "permiss": 5, "appropri": 5, "protocol": [5, 7, 11], "anywai": 5, "simpli": 5, "jwk": 5, "kei": [5, 6, 7, 8, 12], "store": [5, 7], "jwt": 5, "credenti": [5, 6, 7], "base64": 5, "encod": 5, "request": [5, 7], "object": [5, 7], "signatur": 5, "alg": 5, "jwa": 5, "algorithm": 5, "which": [5, 6, 7, 13, 14], "send": 5, "oidc": 5, "One": 5, "none": [5, 7, 11, 12], "rs256": 5, "authnstat": 5, "statement": 5, "method": [5, 7], "timestamp": 5, "login": [5, 7], "respons": 5, "encrypt": [5, 7], "public": [5, 12, 13], "forc": 5, "post": 5, "bind": [5, 7, 11, 12], "onetimeus": 5, "condit": 5, "keyinfo": 5, "ext": 5, "redirect": 5, "lookup": [5, 7], "optim": 5, "through": [5, 7], "inclus": 5, "id": [5, 6, 7, 13], "element": [5, 7, 8], "rsa_sha256": 5, "rsa_sha1": 5, "rsa_sha512": 5, "dsa_sha1": 5, "saml_assertion_consumer_url_post": 5, "consum": 5, "saml_assertion_consumer_url_redirect": 5, "saml_force_name_id_format": 5, "ignor": 5, "nameid": 5, "subject": 5, "saml_name_id_format": 5, "usernam": [5, 6, 7, 11, 12, 13], "email": [5, 7, 13], "transient": 5, "persist": 5, "saml_signature_canonicalization_method": 5, "canonic": 5, "four": 5, "w3": 5, "2001": 5, "exc": 5, "c14n": 5, "exclus": 5, "withcom": 5, "exclusive_with_com": 5, "tr": 5, "rec": 5, "20010315": 5, "inclusive_with_com": 5, "saml_single_logout_service_url_post": 5, "logout": 5, "saml_single_logout_service_url_redirect": 5, "obtain": [5, 7], "info": [5, 12], "userinfo": 5, "endpoint": [5, 11, 12], "unsign": 5, "auth_client_id": [5, 6, 7], "client_id": [5, 6, 7, 13], "authent": [5, 6, 7, 11, 12, 13], "auth_client_secret": [5, 6, 7], "secret": [5, 6, 7], "conjunct": [5, 6, 7], "auth_keycloak_url": [5, 6, 7], "auth_password": [5, 6, 7], "auth_realm": [5, 6, 7], "auth_usernam": [5, 6, 7], "authentication_flow_binding_overrid": 5, "authenticationflowbindingoverrid": 5, "flow": 5, "authorization_services_en": 5, "authorizationservicesen": 5, "authorization_set": 5, "authorizationset": 5, "structur": [5, 9], "_resourceserverrepresent": 5, "base_url": 5, "baseurl": 5, "auth": [5, 6, 7, 12, 13], "link": [5, 7], "back": [5, 7], "bearer_onli": 5, "beareronli": 5, "type": [5, 7, 8, 11, 13], "bearer": 5, "client_authenticator_typ": 5, "clientauthenticatortyp": 5, "how": [5, 9], "either": [5, 9, 13], "behavior": 5, "clientid": 5, "alphanumer": 5, "take": 5, "preced": 5, "client_templ": 5, "clienttempl": 5, "field": [5, 6, 7], "silent": 5, "connection_timeout": [5, 6, 7], "integ": [5, 6, 7], "timeout": [5, 6, 7], "period": [5, 6, 7], "second": [5, 6, 7], "consent_requir": 5, "consentrequir": 5, "consent": 5, "default_client_scop": 5, "defaultclientscop": 5, "default_rol": 5, "defaultrol": 5, "referenc": 5, "yet": [5, 6, 7], "thei": [5, 7], "descript": [5, 6, 7, 8, 11, 12, 13], "direct_access_grants_en": 5, "directaccessgrantsen": 5, "direct": 5, "grant": 5, "frontchannel_logout": 5, "frontchannellogout": 5, "frontchannel": 5, "full_scope_allow": 5, "fullscopeallow": 5, "http_agent": [5, 6, 7], "agent": [5, 6, 7], "header": [5, 6, 7], "uuid": [5, 7], "implicit_flow_en": 5, "implicitflowen": 5, "implicit": 5, "node_re_registration_timeout": 5, "nodereregistrationtimeout": 5, "re": 5, "registr": [5, 7], "not_befor": 5, "notbefor": 5, "revok": 5, "token": [5, 6, 7], "date": [5, 11], "unix": 5, "optional_client_scop": 5, "optionalclientscop": 5, "protocol_mapp": 5, "protocolmapp": 5, "mapper": [5, 7, 13], "sourc": 5, "parent": [5, 7], "class": [5, 7], "easiest": [5, 7], "dump": [5, 7], "alreadi": [5, 7], "consenttext": 5, "human": 5, "readabl": 5, "accept": [5, 7], "imposs": 5, "sinc": [5, 7], "extend": [5, 7], "spi": [5, 7], "ship": 5, "least": 5, "docker": [5, 14], "address": [5, 11, 12], "group": [5, 11, 12], "membership": 5, "hardcod": [5, 7], "claim": 5, "script": 5, "sha256": 5, "pairwis": 5, "sub": 5, "usermodel": 5, "properti": [5, 7], "usersessionmodel": 5, "note": [5, 7, 9, 11], "look": 5, "public_cli": [5, 13], "publiccli": 5, "master": [5, 6, 7, 11, 12, 13], "redirect_uri": 5, "redirecturi": 5, "uri": 5, "registered_nod": 5, "registerednod": 5, "regist": 5, "nodenam": 5, "last": 5, "registration_access_token": 5, "registrationaccesstoken": 5, "root_url": 5, "rooturl": 5, "append": 5, "rel": [5, 12], "here": [5, 6, 7], "exit": 5, "current": [5, 9], "save": 5, "service_accounts_en": 5, "serviceaccountsen": 5, "standard_flow_en": 5, "standardflowen": 5, "standard": [5, 7], "state": [5, 6, 7, 9], "absent": [5, 6, 7], "surrogate_auth_requir": 5, "surrogateauthrequir": 5, "surrog": 5, "use_template_config": 5, "usetemplateconfig": 5, "use_template_mapp": 5, "usetemplatemapp": 5, "use_template_scop": 5, "usetemplatescop": 5, "validate_cert": [5, 6, 7], "verifi": [5, 6, 7, 14], "tl": [5, 6, 7, 11, 12, 13], "disabl": [5, 6, 7], "product": [5, 6, 7], "web_origin": [5, 13], "weborigin": 5, "cor": 5, "origin": [5, 13], "check_mod": [5, 6, 7], "run": [5, 6, 7, 11, 12, 14], "statu": [5, 6, 7], "predict": [5, 6, 7], "without": [5, 6, 7], "target": [5, 6, 7], "diff_mod": [5, 6, 7], "Will": [5, 6, 7], "what": [5, 6, 7], "possibli": [5, 6, 7], "diff": [5, 6, 7], "minim": 5, "delegate_to": [5, 6], "delet": [5, 6, 7, 9], "bell": 5, "whistl": 5, "d8b127a3": 5, "31f6": 5, "44c8": 5, "a7e4": 5, "4ab9a3e78d95": 5, "this_is_a_test": 5, "wonder": 5, "basepath": 5, "reallywellkeptsecret": 5, "8888": 5, "1507825725": 5, "node01": 5, "1507828202": 5, "eyjwt_token": 5, "test01": 5, "test02": 5, "browser": 5, "4c90336b": 5, "bf1d": 5, "4b87": 5, "916d": 5, "3677ba4e5fbb": 5, "family_nam": 5, "jsontyp": 5, "label": [5, 9], "lastnam": [5, 13], "familynam": 5, "famili": 5, "nameformat": 5, "basic": 5, "certificateher": 5, "privatekeyher": 5, "jwks_url_for_client_auth_jwt": 5, "jwt_credential_certificate_for_client_auth": 5, "uniqu": [5, 6, 7], "end_stat": [5, 6, 7], "represent": [5, 6, 7], "sampl": [5, 6, 7, 14], "truncat": [5, 6], "success": [5, 6, 7, 8], "rv": [5, 6, 7], "_url": 5, "msg": [5, 6, 7], "messag": [5, 6, 7], "action": [5, 6, 7], "taken": [5, 6, 7], "testclient": 5, "propos": [5, 6, 7], "eik": 5, "frost": 5, "eikef": 5, "multi": [6, 14], "individu": [6, 12], "wai": 6, "call": [6, 11, 12, 13], "translat": 6, "suitabl": 6, "pair": 6, "resid": [6, 7], "consid": [6, 9], "kc": 6, "mycustomrealm": 6, "myclient": 6, "some": [6, 7], "attrib1": 6, "value1": 6, "attrib2": 6, "value2": 6, "attrib3": 6, "numer": 6, "item": 6, "clientrol": 6, "composit": 6, "containerid": 6, "9f03eb61": 6, "a826": 6, "4771": 6, "a9fd": 6, "930e06d2d36a": 6, "561703dd": 6, "0f38": 6, "45ff": 6, "9a5a": 6, "0c978f794547": 6, "myrol": 6, "laurent": [6, 7], "paumier": [6, 7], "laurpaum": [6, 7], "20": [7, 11], "provider_id": [7, 13], "ldap": 7, "kerbero": 7, "sssd": 7, "allowkerberosauthent": 7, "spnego": 7, "about": 7, "allowpasswordauthent": 7, "authtyp": 7, "dure": 7, "oper": 7, "most": 7, "sent": 7, "simpl": 7, "batchsizeforsync": 7, "count": 7, "import": 7, "transact": 7, "1000": 7, "bindcredenti": 7, "binddn": 7, "dn": 7, "cachepolici": 7, "polici": 7, "storag": [7, 13], "evict": 7, "_daili": 7, "_weekli": 7, "max": 7, "_lifespan": 7, "NO": 7, "_cach": 7, "changedsyncperiod": 7, "synchron": 7, "newli": [7, 9], "connectionpool": 7, "determin": 7, "pool": 7, "connectionpoolingauthent": 7, "digest": 7, "md5": 7, "connectionpoolingdebug": 7, "indic": [7, 9], "level": [7, 12], "output": 7, "produc": 7, "fine": 7, "trace": 7, "creation": 7, "inform": [7, 10], "connectionpoolinginits": 7, "number": [7, 9], "per": 7, "ident": 7, "connectionpoolingmaxs": 7, "maximum": 7, "maintain": [7, 9], "concurr": 7, "connectionpoolingprefs": 7, "prefer": [7, 11], "connectionpoolingprotocol": 7, "plain": 7, "ssl": 7, "connectionpoolingtimeout": 7, "millisecond": 7, "idl": 7, "remain": 7, "close": 7, "connectiontimeout": 7, "connectionurl": 7, "customusersearchfilt": 7, "addit": [7, 9, 11, 12], "filter": [7, 8, 9], "search": 7, "leav": [7, 11, 12], "empti": [7, 11, 12], "krb5loginmodul": 7, "editmod": 7, "read_onli": 7, "read": 7, "writabl": 7, "mean": 7, "sync": 7, "demand": 7, "unsync": 7, "_onli": 7, "evictiondai": 7, "dai": 7, "week": 7, "invalid": 7, "evictionhour": 7, "hour": 7, "evictionminut": 7, "minut": 7, "fullsyncperiod": 7, "importen": 7, "db": [7, 11], "kerberosrealm": 7, "keytab": 7, "locat": 7, "princip": 7, "etc": [7, 11, 12], "krb5": 7, "maxlifespan": 7, "lifespan": 7, "pagin": 7, "prioriti": [7, 8], "lowest": 7, "rdnldapattribut": 7, "rdn": 7, "top": 7, "typic": 7, "howev": 7, "cn": 7, "might": 7, "samaccountnam": 7, "readtimeout": 7, "searchscop": 7, "subtre": 7, "whole": 7, "serverprincip": 7, "domain": 7, "starttl": 7, "syncregistr": 7, "effect": 7, "trustemail": 7, "verif": 7, "updateprofilefirstlogin": 7, "profil": 7, "usekerberosforpasswordauthent": 7, "usepasswordmodifyextendedop": 7, "ldapv3": 7, "rfc": 7, "3062": 7, "good": 7, "randomli": 7, "usernameldapattribut": 7, "map": [7, 13], "mani": 7, "vendor": 7, "uid": 7, "fill": 7, "record": 7, "want": 7, "userobjectclass": 7, "objectclass": 7, "divid": 7, "comma": [7, 12], "inetorgperson": 7, "organizationalperson": 7, "written": 7, "just": 7, "usersdn": 7, "tree": 7, "usetruststorespi": 7, "truststor": [7, 11], "standalon": [7, 11], "never": 7, "cacert": [7, 11, 12], "javax": 7, "ldapsonli": 7, "uuidldapattribut": 7, "entryuuid": 7, "objectguid": 7, "notion": 7, "suppos": 7, "among": 7, "validatepasswordpolici": 7, "short": 7, "write": 7, "rhd": 7, "left": 7, "associ": 7, "identityprovidermapp": 7, "parentid": 7, "blank": 7, "providerid": 7, "providertyp": 7, "compon": 7, "ldapstoragemapp": 7, "parent_id": 7, "provider_typ": [7, 13], "userstorageprovid": [7, 13], "636": 7, "ou": 7, "dc": 7, "reader": 7, "cf52ae4f": 7, "4471": 7, "4435": 7, "a0cf": 7, "bb620cadc122": 7, "myrealm": 7, "01122837": 7, "9047": 7, "4ae4": 7, "8ca0": 7, "6e2e891a765f": 7, "mandatori": 7, "mail": 7, "model": 7, "17d60ce2": 7, "2d44": 7, "4c2c": 7, "8b1f": 7, "1fba601b9a9f": 7, "myfe": 7, "No": 7, "164bb483": 7, "c613": 7, "482e": 7, "80fe": 7, "7f1431308799": 7, "convert": 8, "tupl": 8, "builtin": 8, "set_fact": 8, "result": 8, "eric": 8, "l": 8, "ericzolf": 8, "low": 8, "high": 8, "lower": 8, "higher": 8, "up": 8, "semant": 9, "semver": 9, "major": 9, "minor": 9, "increment": 9, "incompat": 9, "scenario": 9, "function": [9, 14], "manner": 9, "matrix": 9, "deprec": [9, 11], "strict": 9, "pre": [9, 11, 12], "build": 9, "hub": 9, "shall": 9, "By": 9, "begin": 9, "smaller": 9, "therefor": 9, "explicitli": 9, "assum": 9, "readi": 9, "made": 9, "we": [9, 13], "prior": 9, "next": 9, "nor": 9, "elimin": 9, "dedic": 9, "introduc": 9, "limit": 9, "argspec": 9, "shape": 9, "inbound": 9, "payload": 9, "cfg": 9, "outcom": 9, "previou": 9, "correct": [9, 14], "abov": 9, "increas": 9, "revis": 9, "trigger": 9, "annot": 9, "git": [9, 14], "tag": 9, "publish": 9, "built": 9, "artifact": 9, "page": 9, "python3": 11, "librari": 11, "yum": 11, "dnf": 11, "posix": [11, 12], "ga": 11, "septemb": 11, "2021": 11, "15": 11, "june": 11, "2022": 11, "cp": 11, "januari": 11, "novemb": 11, "11": [11, 12], "keycloak_ha_en": 11, "auto": [11, 12], "backend": [11, 12], "remot": [11, 12, 14], "keycloak_ha_discoveri": 11, "member": 11, "jdbc_ping": 11, "keycloak_db_en": 11, "els": [11, 12], "keycloak_admin_us": [11, 13], "keycloak_bind_address": 11, "port": [11, 12, 13], "keycloak_management_port_bind_address": 11, "manag": [11, 12, 13], "127": 11, "keycloak_host": [11, 13], "hostnam": [11, 12, 13], "keycloak_http_port": [11, 12, 13], "8080": [11, 12, 13], "keycloak_https_port": [11, 13], "8443": [11, 12, 13], "keycloak_ajp_port": 11, "ajp": [11, 12], "8009": [11, 12], "keycloak_jgroups_port": 11, "jgroup": [11, 12], "tcp": [11, 12], "7600": [11, 12], "keycloak_management_http_port": [11, 12, 13], "9990": [11, 13], "keycloak_management_https_port": 11, "9993": 11, "keycloak_prefer_ipv4": 11, "ipv4": 11, "stack": 11, "keycloak_config_standalone_xml": 11, "filenam": [11, 12], "keycloak_service_us": 11, "keycloak_service_group": 11, "keycloak_service_pidfil": 11, "pid": [11, 12], "keycloak_jvm_packag": 11, "rhel": [11, 12, 14], "runtim": [11, 12], "openjdk": [11, 12], "headless": [11, 12], "keycloak_java_hom": 11, "java_hom": [11, 12], "jre": [11, 12], "rpm": [11, 12], "keycloak_java_opt": 11, "xms1024m": [11, 12], "xmx2048m": [11, 12], "offlin": [11, 12], "keycloak_vers": 11, "keycloak_dest": 11, "opt": [11, 12], "keycloak_arch": 11, "keycloak_configure_firewalld": 11, "ensur": [11, 12, 14], "firewalld": [11, 12], "miscellan": [11, 12], "legaci": 11, "keycloak_download_url_9x": 11, "keycloak_installdir": 11, "keycloak_jboss_hom": 11, "keycloak_rhsso_installdir": 11, "keycloak_config_dir": 11, "keycloak_config_path_to_standalone_xml": 11, "keycloak_auth_realm": [11, 13], "keycloak_auth_cli": [11, 12, 13], "keycloak_force_instal": [11, 12], "keycloak_url": [11, 12, 13], "keycloak_management_url": [11, 12, 13], "minimum": 11, "12": 11, "charact": 11, "frontend": 11, "keycloak_modcluster_en": 11, "subsystem": 11, "keycloak_modcluster_url": 11, "revers": [11, 12], "keycloak_modcluster_port": 11, "6666": 11, "keycloak_jdbc_engin": 11, "engin": [11, 12], "postgr": [11, 12], "mariadb": [11, 12], "keycloak_infinispan_url": 11, "11122": 11, "keycloak_infinispan_us": 11, "supervisor": [11, 12], "keycloak_infinispan_pass": 11, "keycloak_infinispan_sasl_mechan": 11, "scram": [11, 12], "sha": [11, 12], "512": [11, 12], "keycloak_infinispan_use_ssl": 11, "hotrod": 11, "keycloak_infinispan_trust_store_path": 11, "pki": [11, 12], "keycloak_infinispan_trust_store_password": 11, "changeit": [11, 12], "keycloak_jdbc_url": 11, "jdbc": [11, 12], "postgresql": [11, 12], "5432": [11, 12], "keycloak_jdbc_driver_vers": 11, "driver": [11, 12], "1212": [11, 12], "keycloak_db_us": 11, "keycloak_db_pass": 11, "remembertochangem": 11, "include_rol": [11, 13], "16": 11, "guido": [11, 12, 13], "grazioli": [11, 12, 13], "romain": [11, 13], "peliss": [11, 13], "pavan": 11, "kumar": 11, "motaparthi": 11, "keycloak_quarkus_vers": 12, "keycloak_quarkus_ha_en": 12, "keycloak_quarkus_db_en": 12, "keycloak_quarkus_admin_us": 12, "keycloak_quarkus_bind_address": 12, "keycloak_quarkus_host": 12, "keycloak_quarkus_http_port": 12, "keycloak_quarkus_https_port": 12, "keycloak_quarkus_ajp_port": 12, "keycloak_quarkus_jgroups_port": 12, "keycloak_quarkus_service_us": 12, "keycloak_quarkus_service_group": 12, "keycloak_quarkus_service_pidfil": 12, "keycloak_quarkus_jvm_packag": 12, "keycloak_quarkus_java_hom": 12, "keycloak_quarkus_java_opt": 12, "keycloak_quarkus_frontend_url": 12, "keycloak_quarkus_http_relative_path": 12, "context": [12, 13], "keycloak_quarkus_http_en": 12, "listen": 12, "keycloak_quarkus_https_en": 12, "keycloak_quarkus_key_fil": 12, "pem": 12, "keycloak_quarkus_cert_fil": 12, "chain": 12, "crt": 12, "keycloak_quarkus_jdbc_engin": 12, "postr": 12, "keycloak_quarkus_db_us": 12, "keycloak_quarkus_db_pass": 12, "keycloak_quarkus_jdbc_url": 12, "keycloak_quarkus_jdbc_driver_vers": 12, "keycloak_quarkus_ispn_us": 12, "keycloak_quarkus_ispn_pass": 12, "keycloak_quarkus_ispn_url": 12, "keycloak_quarkus_ispn_sasl_mechan": 12, "mechan": 12, "keycloak_quarkus_ispn_use_ssl": 12, "keycloak_quarkus_ispn_trust_store_path": 12, "trust": 12, "keycloak_quarkus_ispn_trust_store_password": 12, "keystor": 12, "keycloak_quarkus_offline_instal": 12, "keycloak_quarkus_download_url": 12, "keycloak_quarkus_dest": 12, "keycloak_quarkus_arch": 12, "keycloak_quarkus_configure_firewalld": 12, "keycloak_quarkus_metrics_en": 12, "metric": 12, "keycloak_quarkus_health_en": 12, "expos": 12, "health": 12, "keycloak_quarkus_installdir": 12, "keycloak_quarkus_hom": 12, "keycloak_quarkus_config_dir": 12, "keycloak_quarkus_master_realm": 12, "keycloak_quarkus_log": 12, "handler": 12, "keycloak_quarkus_log_level": 12, "categori": 12, "keycloak_quarkus_log_fil": 12, "keycloak_quarkus_log_format": 12, "d": 12, "yyyi": 12, "mm": 12, "dd": 12, "hh": 12, "ss": 12, "sss": 12, "5p": 12, "c": 12, "n": 12, "keycloak_quarkus_proxy_mod": 12, "forward": 12, "behind": 12, "edg": 12, "keycloak_quarkus_start_dev": 12, "dev": 12, "keycloak_quarkus_admin_pass": 12, "ye": 12, "keycloak_context": 13, "main": 13, "keycloak_client_publ": 13, "keycloak_client_web_origin": 13, "web": 13, "declar": 13, "keycloak_client_default_rol": 13, "keycloak_client_us": 13, "confidenti": 13, "firstnam": 13, "client_rol": 13, "comprehens": 13, "testrealm": 13, "molecul": 14, "setup": 14, "cover": 14, "idempot": 14, "local": 14, "clone": 14, "yamllint": 14, "flake8": 14, "lint": 14, "voluptu": 14, "demo": 14, "aggreg": 14, "rebuilt": 14, "everi": 14, "non": 14, "consist": 14, "behaviour": 14, "flang": 14, "deploy": 14, "crossdc": 14, "region": 14, "system": 14, "step": 14, "environ": 14, "cd": 14, "dep": 14, "cat": 14, "eof": 14}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"middleware_autom": [0, 1], "keycloak": [0, 1, 3, 5, 6, 7, 11], "releas": [0, 9], "note": 0, "topic": 0, "v1": 0, "2": 0, "0": 0, "major": 0, "chang": [0, 9], "minor": 0, "1": 0, "bugfix": 0, "break": [0, 9], "port": 0, "guid": 0, "7": 0, "6": 0, "5": 0, "4": 0, "3": 0, "summari": 0, "ansibl": 1, "collect": [1, 3, 9], "version": [1, 8, 9, 11], "compat": [1, 9], "instal": 1, "from": [1, 9], "galaxi": 1, "includ": 1, "role": [1, 6, 9, 10, 11, 12, 13], "usag": 1, "playbook": [1, 11, 13, 14], "control": 1, "node": 1, "local": 1, "sourc": 1, "altern": 1, "like": 1, "corpor": 1, "nexu": 1, "artifactori": 1, "proxi": 1, "etc": 1, "exampl": [1, 5, 6, 7, 8, 11, 13], "command": 1, "configur": 1, "config": 1, "support": 1, "licens": [1, 11, 12, 13], "contributor": 2, "": 2, "guidelin": 2, "welcom": 3, "document": [3, 9], "user": [3, 7], "develop": 3, "gener": 3, "middlewar": 3, "plugin": [4, 9], "index": [4, 10], "filter": 4, "modul": 4, "keycloak_cli": 5, "allow": [5, 6, 7], "administr": [5, 6, 7], "client": 5, "via": [5, 6, 7], "api": [5, 6, 7], "synopsi": [5, 6, 7, 8], "paramet": [5, 6, 7], "attribut": [5, 6, 7], "return": [5, 6, 7, 8], "valu": [5, 6, 7, 8], "author": [5, 6, 7, 8, 11, 12, 13], "keycloak_rol": 6, "keycloak_user_feder": 7, "feder": 7, "version_sort": 8, "sort": 8, "list": 8, "accord": 8, "order": 8, "instead": 8, "pure": 8, "alphabet": 8, "one": 8, "input": 8, "strategi": 9, "new": 9, "content": 9, "i": 9, "ad": 9, "an": 9, "exist": 9, "featur": 9, "within": 9, "backward": 9, "bug": 9, "fix": 9, "secur": 9, "ani": 9, "remov": 9, "A": 9, "typograph": 9, "error": 9, "wa": 9, "modifi": 9, "autom": 9, "requir": 11, "depend": 11, "patch": 11, "default": [11, 12, 13], "variabl": [11, 12, 13], "inform": [11, 12, 13], "keycloak_quarku": 12, "keycloak_realm": 13, "format": 13, "test": 14, "continu": 14, "integr": 14}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"middleware_automation.keycloak Release Notes": [[0, "middleware-automation-keycloak-release-notes"]], "Topics": [[0, "topics"]], "v1.2.0": [[0, "v1-2-0"]], "Major Changes": [[0, "major-changes"], [0, "id24"], [0, "id35"]], "Minor Changes": [[0, "minor-changes"], [0, "id7"], [0, "id22"], [0, "id26"], [0, "id30"], [0, "id37"]], "v1.1.1": [[0, "v1-1-1"]], "Bugfixes": [[0, "bugfixes"], [0, "id13"], [0, "id17"], [0, "id19"], [0, "id28"], [0, "id33"]], "v1.1.0": [[0, "v1-1-0"]], "Breaking Changes / Porting Guide": [[0, "breaking-changes-porting-guide"], [0, "id15"]], "v1.0.7": [[0, "v1-0-7"]], "v1.0.6": [[0, "v1-0-6"]], "v1.0.5": [[0, "v1-0-5"]], "v1.0.4": [[0, "v1-0-4"]], "v1.0.3": [[0, "v1-0-3"]], "v1.0.2": [[0, "v1-0-2"]], "v1.0.1": [[0, "v1-0-1"]], "Release Summary": [[0, "release-summary"], [0, "id39"]], "v1.0.0": [[0, "v1-0-0"]], "Ansible Collection - middleware_automation.keycloak": [[1, "ansible-collection-middleware-automation-keycloak"]], "Ansible version compatibility": [[1, "ansible-version-compatibility"]], "Installation": [[1, "installation"]], "Installing the Collection from Ansible Galaxy": [[1, "installing-the-collection-from-ansible-galaxy"]], "Included roles": [[1, "included-roles"]], "Usage": [[1, "usage"]], "Install Playbook": [[1, "install-playbook"]], "Install from controller node (local source)": [[1, "install-from-controller-node-local-source"]], "Install from alternate sources (like corporate Nexus, artifactory, proxy, etc)": [[1, "install-from-alternate-sources-like-corporate-nexus-artifactory-proxy-etc"]], "Example installation command": [[1, "example-installation-command"]], "Configuration": [[1, "configuration"]], "Config Playbook": [[1, "config-playbook"]], "Example configuration command": [[1, "example-configuration-command"]], "Support": [[1, "support"]], "License": [[1, "license"], [11, "license"], [12, "license"], [13, "license"]], "Contributor\u2019s Guidelines": [[2, "contributor-s-guidelines"]], "Welcome to Keycloak Collection documentation": [[3, "welcome-to-keycloak-collection-documentation"]], "User documentation": [[3, null]], "Developer documentation": [[3, null]], "General": [[3, null]], "Middleware collections": [[3, null]], "Plugin Index": [[4, "plugin-index"]], "filter plugins": [[4, null]], "modules plugins": [[4, null]], "keycloak_client \u2013 Allows administration of Keycloak clients via Keycloak API": [[5, "keycloak-client-allows-administration-of-keycloak-clients-via-keycloak-api"]], "Synopsis": [[5, "synopsis"], [6, "synopsis"], [7, "synopsis"], [8, "synopsis"]], "Parameters": [[5, "parameters"], [6, "parameters"], [7, "parameters"]], "Attributes": [[5, "attributes"], [6, "attributes"], [7, "attributes"]], "Examples": [[5, "examples"], [6, "examples"], [7, "examples"], [8, "examples"]], "Return Values": [[5, "return-values"], [6, "return-values"], [7, "return-values"]], "Authors": [[5, "authors"], [6, "authors"], [7, "authors"], [8, "authors"]], "keycloak_role \u2013 Allows administration of Keycloak roles via Keycloak API": [[6, "keycloak-role-allows-administration-of-keycloak-roles-via-keycloak-api"]], "keycloak_user_federation \u2013 Allows administration of Keycloak user federations via Keycloak API": [[7, "keycloak-user-federation-allows-administration-of-keycloak-user-federations-via-keycloak-api"]], "version_sort \u2013 Sort a list according to version order instead of pure alphabetical one": [[8, "version-sort-sort-a-list-according-to-version-order-instead-of-pure-alphabetical-one"]], "Input": [[8, "input"]], "Return Value": [[8, "return-value"]], "Collection Versioning Strategy": [[9, "collection-versioning-strategy"]], "New content is added to an existing collection": [[9, "new-content-is-added-to-an-existing-collection"]], "New feature to existing plugin or role within a collection (backwards compatible)": [[9, "new-feature-to-existing-plugin-or-role-within-a-collection-backwards-compatible"]], "Bug fix or security fix to existing content within a collection": [[9, "bug-fix-or-security-fix-to-existing-content-within-a-collection"]], "Breaking change to any content within a collection": [[9, "breaking-change-to-any-content-within-a-collection"]], "Content removed from a collection": [[9, "content-removed-from-a-collection"]], "A typographical error was fixed in the documentation for a collection": [[9, "a-typographical-error-was-fixed-in-the-documentation-for-a-collection"]], "Documentation added/removed/modified within a collection": [[9, "documentation-added-removed-modified-within-a-collection"]], "Release automation": [[9, "release-automation"]], "Role Index": [[10, "role-index"]], "keycloak": [[11, "keycloak"]], "Requirements": [[11, "requirements"]], "Dependencies": [[11, "dependencies"]], "Versions": [[11, "versions"]], "Patching": [[11, "patching"]], "Role Defaults": [[11, "role-defaults"], [12, "role-defaults"], [13, "role-defaults"]], "Role Variables": [[11, "role-variables"], [12, "role-variables"], [13, "role-variables"]], "Example Playbook": [[11, "example-playbook"], [13, "example-playbook"]], "Author Information": [[11, "author-information"], [12, "author-information"], [13, "author-information"]], "keycloak_quarkus": [[12, "keycloak-quarkus"]], "keycloak_realm": [[13, "keycloak-realm"]], "Variable formats": [[13, "variable-formats"]], "Testing": [[14, "testing"]], "Continuous integration": [[14, "continuous-integration"]], "Integration testing": [[14, "integration-testing"]], "Test playbooks": [[14, "test-playbooks"]]}, "indexentries": {}})