mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-29 19:50:25 -07:00
[PR #9391/49ed3d4a backport][stable-10] k*.py: normalize docs (#9407)
k*.py: normalize docs (#9391)
* k*.py: normalize docs
* Update plugins/modules/keycloak_realm_keys_metadata_info.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/kibana_plugin.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 49ed3d4acf)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot]
GitHub
parent
d3badc6d43
commit
11ba71c802
34 changed files with 4402 additions and 4882 deletions
|
|
@ -8,166 +8,151 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_clientscope
|
||||
|
||||
short_description: Allows administration of Keycloak client_scopes via Keycloak API
|
||||
short_description: Allows administration of Keycloak client_scopes using Keycloak API
|
||||
|
||||
version_added: 3.4.0
|
||||
|
||||
description:
|
||||
- This module allows you to add, remove or modify Keycloak client_scopes via the Keycloak REST API.
|
||||
It requires access to the REST API via OpenID Connect; the user connecting and the client being
|
||||
used must have the requisite access rights. In a default Keycloak installation, admin-cli
|
||||
and an admin user would work, as would a separate client definition with the scope tailored
|
||||
to your needs and a user having the expected roles.
|
||||
|
||||
- The names of module options are snake_cased versions of the camelCase ones found in the
|
||||
Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/8.0/rest-api/index.html).
|
||||
|
||||
- Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will
|
||||
be returned that way by this module. You may pass single values for attributes when calling the module,
|
||||
and this will be translated into a list suitable for the API.
|
||||
|
||||
- When updating a client_scope, where possible provide the client_scope ID to the module. This removes a lookup
|
||||
to the API to translate the name into the client_scope ID.
|
||||
|
||||
- This module allows you to add, remove or modify Keycloak client_scopes using the Keycloak REST API. It requires access to the REST API using OpenID
|
||||
Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli
|
||||
and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
|
||||
- The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at
|
||||
U(https://www.keycloak.org/docs-api/8.0/rest-api/index.html).
|
||||
- Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module.
|
||||
You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API.
|
||||
- When updating a client_scope, where possible provide the client_scope ID to the module. This removes a lookup to the API to translate the
|
||||
name into the client_scope ID.
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: full
|
||||
action_group:
|
||||
version_added: 10.2.0
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: full
|
||||
action_group:
|
||||
version_added: 10.2.0
|
||||
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- State of the client_scope.
|
||||
- On V(present), the client_scope will be created if it does not yet exist, or updated with the parameters you provide.
|
||||
- On V(absent), the client_scope will be removed if it exists.
|
||||
default: 'present'
|
||||
type: str
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- Name of the client_scope.
|
||||
- This parameter is required only when creating or updating the client_scope.
|
||||
|
||||
realm:
|
||||
type: str
|
||||
description:
|
||||
- They Keycloak realm under which this client_scope resides.
|
||||
default: 'master'
|
||||
|
||||
id:
|
||||
type: str
|
||||
description:
|
||||
- The unique identifier for this client_scope.
|
||||
- This parameter is not required for updating or deleting a client_scope but
|
||||
providing it will reduce the number of API calls required.
|
||||
|
||||
state:
|
||||
description:
|
||||
type: str
|
||||
description:
|
||||
- Description for this client_scope.
|
||||
- This parameter is not required for updating or deleting a client_scope.
|
||||
- State of the client_scope.
|
||||
- On V(present), the client_scope will be created if it does not yet exist, or updated with the parameters you provide.
|
||||
- On V(absent), the client_scope will be removed if it exists.
|
||||
default: 'present'
|
||||
type: str
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
|
||||
protocol:
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- Name of the client_scope.
|
||||
- This parameter is required only when creating or updating the client_scope.
|
||||
realm:
|
||||
type: str
|
||||
description:
|
||||
- They Keycloak realm under which this client_scope resides.
|
||||
default: 'master'
|
||||
|
||||
id:
|
||||
type: str
|
||||
description:
|
||||
- The unique identifier for this client_scope.
|
||||
- This parameter is not required for updating or deleting a client_scope but providing it will reduce the number of API calls required.
|
||||
description:
|
||||
type: str
|
||||
description:
|
||||
- Description for this client_scope.
|
||||
- This parameter is not required for updating or deleting a client_scope.
|
||||
protocol:
|
||||
description:
|
||||
- Type of client.
|
||||
- The V(docker-v2) value was added in community.general 8.6.0.
|
||||
choices: ['openid-connect', 'saml', 'wsfed', 'docker-v2']
|
||||
type: str
|
||||
|
||||
protocol_mappers:
|
||||
description:
|
||||
- A list of dicts defining protocol mappers for this client.
|
||||
- This is C(protocolMappers) in the Keycloak REST API.
|
||||
aliases:
|
||||
- protocolMappers
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
protocol:
|
||||
description:
|
||||
- Type of client.
|
||||
- The V(docker-v2) value was added in community.general 8.6.0.
|
||||
- This specifies for which protocol this protocol mapper.
|
||||
- Is active.
|
||||
choices: ['openid-connect', 'saml', 'wsfed', 'docker-v2']
|
||||
type: str
|
||||
|
||||
protocol_mappers:
|
||||
protocolMapper:
|
||||
description:
|
||||
- A list of dicts defining protocol mappers for this client.
|
||||
- This is 'protocolMappers' in the Keycloak REST API.
|
||||
aliases:
|
||||
- protocolMappers
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
protocol:
|
||||
description:
|
||||
- This specifies for which protocol this protocol mapper.
|
||||
- is active.
|
||||
choices: ['openid-connect', 'saml', 'wsfed', 'docker-v2']
|
||||
type: str
|
||||
- 'The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is impossible to provide since this may
|
||||
be extended through SPIs by the user of Keycloak, by default Keycloak as of 3.4 ships with at least:'
|
||||
- V(docker-v2-allow-all-mapper).
|
||||
- V(oidc-address-mapper).
|
||||
- V(oidc-full-name-mapper).
|
||||
- V(oidc-group-membership-mapper).
|
||||
- V(oidc-hardcoded-claim-mapper).
|
||||
- V(oidc-hardcoded-role-mapper).
|
||||
- V(oidc-role-name-mapper).
|
||||
- V(oidc-script-based-protocol-mapper).
|
||||
- V(oidc-sha256-pairwise-sub-mapper).
|
||||
- V(oidc-usermodel-attribute-mapper).
|
||||
- V(oidc-usermodel-client-role-mapper).
|
||||
- V(oidc-usermodel-property-mapper).
|
||||
- V(oidc-usermodel-realm-role-mapper).
|
||||
- V(oidc-usersessionmodel-note-mapper).
|
||||
- V(saml-group-membership-mapper).
|
||||
- V(saml-hardcode-attribute-mapper).
|
||||
- V(saml-hardcode-role-mapper).
|
||||
- V(saml-role-list-mapper).
|
||||
- V(saml-role-name-mapper).
|
||||
- V(saml-user-attribute-mapper).
|
||||
- V(saml-user-property-mapper).
|
||||
- V(saml-user-session-note-mapper).
|
||||
- An exhaustive list of available mappers on your installation can be obtained on the admin console by going to Server Info -> Providers
|
||||
and looking under 'protocol-mapper'.
|
||||
type: str
|
||||
|
||||
protocolMapper:
|
||||
description:
|
||||
- "The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is
|
||||
impossible to provide since this may be extended through SPIs by the user of Keycloak,
|
||||
by default Keycloak as of 3.4 ships with at least:"
|
||||
- V(docker-v2-allow-all-mapper)
|
||||
- V(oidc-address-mapper)
|
||||
- V(oidc-full-name-mapper)
|
||||
- V(oidc-group-membership-mapper)
|
||||
- V(oidc-hardcoded-claim-mapper)
|
||||
- V(oidc-hardcoded-role-mapper)
|
||||
- V(oidc-role-name-mapper)
|
||||
- V(oidc-script-based-protocol-mapper)
|
||||
- V(oidc-sha256-pairwise-sub-mapper)
|
||||
- V(oidc-usermodel-attribute-mapper)
|
||||
- V(oidc-usermodel-client-role-mapper)
|
||||
- V(oidc-usermodel-property-mapper)
|
||||
- V(oidc-usermodel-realm-role-mapper)
|
||||
- V(oidc-usersessionmodel-note-mapper)
|
||||
- V(saml-group-membership-mapper)
|
||||
- V(saml-hardcode-attribute-mapper)
|
||||
- V(saml-hardcode-role-mapper)
|
||||
- V(saml-role-list-mapper)
|
||||
- V(saml-role-name-mapper)
|
||||
- V(saml-user-attribute-mapper)
|
||||
- V(saml-user-property-mapper)
|
||||
- V(saml-user-session-note-mapper)
|
||||
- An exhaustive list of available mappers on your installation can be obtained on
|
||||
the admin console by going to Server Info -> Providers and looking under
|
||||
'protocol-mapper'.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name of this protocol mapper.
|
||||
type: str
|
||||
|
||||
name:
|
||||
description:
|
||||
- The name of this protocol mapper.
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- Usually a UUID specifying the internal ID of this protocol mapper instance.
|
||||
type: str
|
||||
|
||||
id:
|
||||
description:
|
||||
- Usually a UUID specifying the internal ID of this protocol mapper instance.
|
||||
type: str
|
||||
|
||||
config:
|
||||
description:
|
||||
- Dict specifying the configuration options for the protocol mapper; the
|
||||
contents differ depending on the value of O(protocol_mappers[].protocolMapper) and are not documented
|
||||
other than by the source of the mappers and its parent class(es). An example is given
|
||||
below. It is easiest to obtain valid config values by dumping an already-existing
|
||||
protocol mapper configuration through check-mode in the RV(existing) return value.
|
||||
type: dict
|
||||
|
||||
attributes:
|
||||
config:
|
||||
description:
|
||||
- Dict specifying the configuration options for the protocol mapper; the contents differ depending on the value of
|
||||
O(protocol_mappers[].protocolMapper)
|
||||
and are not documented other than by the source of the mappers and its parent class(es). An example is given below. It is easiest
|
||||
to obtain valid config values by dumping an already-existing protocol mapper configuration through check-mode in the RV(existing)
|
||||
return value.
|
||||
type: dict
|
||||
description:
|
||||
- A dict of key/value pairs to set as custom attributes for the client_scope.
|
||||
- Values may be single values (for example a string) or a list of strings.
|
||||
|
||||
attributes:
|
||||
type: dict
|
||||
description:
|
||||
- A dict of key/value pairs to set as custom attributes for the client_scope.
|
||||
- Values may be single values (for example a string) or a list of strings.
|
||||
extends_documentation_fragment:
|
||||
- community.general.keycloak
|
||||
- community.general.keycloak.actiongroup_keycloak
|
||||
- community.general.attributes
|
||||
- community.general.keycloak
|
||||
- community.general.keycloak.actiongroup_keycloak
|
||||
- community.general.attributes
|
||||
|
||||
author:
|
||||
- Gaëtan Daubresse (@Gaetan2907)
|
||||
'''
|
||||
- Gaëtan Daubresse (@Gaetan2907)
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create a Keycloak client_scopes, authentication with credentials
|
||||
community.general.keycloak_clientscope:
|
||||
name: my-new-kc-clientscope
|
||||
|
|
@ -254,54 +239,42 @@ EXAMPLES = '''
|
|||
protocol: saml
|
||||
protocolMapper: saml-role-list-mapper
|
||||
attributes:
|
||||
attrib1: value1
|
||||
attrib2: value2
|
||||
attrib3:
|
||||
- with
|
||||
- numerous
|
||||
- individual
|
||||
- list
|
||||
- items
|
||||
attrib1: value1
|
||||
attrib2: value2
|
||||
attrib3:
|
||||
- with
|
||||
- numerous
|
||||
- individual
|
||||
- list
|
||||
- items
|
||||
delegate_to: localhost
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: Message as to what action was taken.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Client_scope testclientscope has been updated"
|
||||
description: Message as to what action was taken.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Client_scope testclientscope has been updated"
|
||||
|
||||
proposed:
|
||||
description: Representation of proposed client scope.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {
|
||||
clientId: "test"
|
||||
}
|
||||
description: Representation of proposed client scope.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {clientId: "test"}
|
||||
|
||||
existing:
|
||||
description: Representation of existing client scope (sample is truncated).
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {
|
||||
"adminUrl": "http://www.example.com/admin_url",
|
||||
"attributes": {
|
||||
"request.object.signature.alg": "RS256",
|
||||
}
|
||||
}
|
||||
description: Representation of existing client scope (sample is truncated).
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}
|
||||
|
||||
end_state:
|
||||
description: Representation of client scope after module execution (sample is truncated).
|
||||
returned: on success
|
||||
type: dict
|
||||
sample: {
|
||||
"adminUrl": "http://www.example.com/admin_url",
|
||||
"attributes": {
|
||||
"request.object.signature.alg": "RS256",
|
||||
}
|
||||
}
|
||||
'''
|
||||
description: Representation of client scope after module execution (sample is truncated).
|
||||
returned: on success
|
||||
type: dict
|
||||
sample: {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}
|
||||
"""
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \
|
||||
keycloak_argument_spec, get_token, KeycloakError, is_struct_included
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue