sensu.sensu_go.oidc_auth_provider – Manage Sensu OIDC authentication provider

Note

This plugin is part of the sensu.sensu_go collection (version 1.12.0).

To install it use: ansible-galaxy collection install sensu.sensu_go.

To use it in a playbook, specify: sensu.sensu_go.oidc_auth_provider.

New in version 1.10.0: of sensu.sensu_go

Synopsis

Requirements

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

  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments
additional_scopes
list / elements=string
Default:
"openid"
Scopes to include in the claims.
auth
dictionary
Authentication parameters. Can define each of them with ENV as well.
api_key
string
added in 1.3.0 of sensu.sensu_go
The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked.
This replaces auth.user and auth.password parameters.
For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path
path
added in 1.5.0 of sensu.sensu_go
Path to the CA bundle that should be used to validate the backend certificate.
If this parameter is not set, module will use the CA bundle that python is using.
It is also possible to set this parameter via the SENSU_CA_PATH environment variable.
password
string
Default:
The Sensu user's password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked.
This parameter is ignored if the auth.api_key parameter is set.
url
string
Default:
"http://localhost:8080"
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.
user
string
Default:
"admin"
The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked.
This parameter is ignored if the auth.api_key parameter is set.
verify
boolean
added in 1.5.0 of sensu.sensu_go
    Choices:
  • no
  • yes ←
Flag that controls the certificate validation.
If you are using self-signed certificates, you can set this parameter to false.
ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.
It is also possible to set this parameter via the SENSU_VERIFY environment variable.
client_id
string
The OIDC provider application Client ID.
Required if state is present.
client_secret
string
The OIDC provider application Client Secret.
Required if state is present.
disable_offline_access
boolean
    Choices:
  • no ←
  • yes
If true, the OIDC provider cannot include the offline_access scope in the authentication request. Otherwise, false.
groups_claim
string
The claim to use to form the associated RBAC groups.
groups_prefix
string
The prefix added to all OIDC groups.
name
string / required
The Sensu resource's name. This name (in combination with the namespace where applicable) uniquely identifies the resource that Ansible operates on.
If the resource with selected name already exists, Ansible module will update it to match the specification in the task.
Consult the name metadata attribute specification in the upstream docs on https://docs.sensu.io/sensu-go/latest/reference/ for more details about valid names and other restrictions.
redirect_uri
string
Redirect URL to provide to the OIDC provider.
server
string
The location of the OIDC server you wish to authenticate against.
Required if state is present.
state
string
    Choices:
  • present ←
  • absent
Target state of the Sensu object.
username_claim
string
The claim to use to form the final RBAC user name.
Required if state is present.
username_prefix
string
The prefix added to all OIDC usernames.

Notes

Note

  • Supported only on Sensu Go versions >= 6.

See Also

See also

sensu.sensu_go.auth_provider_info

The official documentation on the sensu.sensu_go.auth_provider_info module.

sensu.sensu_go.ldap_auth_provider

The official documentation on the sensu.sensu_go.ldap_auth_provider module.

sensu.sensu_go.ad_auth_provider

The official documentation on the sensu.sensu_go.ad_auth_provider module.

Examples

- name: Create a OIDC auth provider
  sensu.sensu_go.oidc_auth_provider:
    state: present
    name: oidc_name
    additional_scopes:
        - groups
        - email
    client_id: a8e43af034e7f2608780
    client_secret: b63968394be6ed2edb61c93847ee792f31bf6216
    disable_offline_access: false
    redirect_uri: http://127.0.0.1:8080/api/enterprise/authentication/v2/oidc/callback
    server: https://oidc.example.com:9031
    groups_claim: groups
    groups_prefix: 'oidc:'
    username_claim: email
    username_prefix: 'oidc:'

- name: Delete a OIDC auth provider
  sensu.sensu_go.oidc_auth_provider:
    name: oidc_name
    state: absent

Return Values

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

Key Returned Description
object
dictionary
success
Object representing Sensu OIDC authentication provider.

Sample:
{'additional_scopes': ['groups', 'email'], 'client_id': 'a8e43af034e7f2608780', 'disable_offline_access': False, 'groups_claim': 'groups', 'groups_prefix': 'oidc:', 'metadata': {'created_by': 'admin', 'name': 'oidc_name'}, 'redirect_uri': 'http://sensu-backend.example.com:8080/api/enterprise/authentication/v2/oidc/callback', 'server': 'https://oidc.example.com:9031', 'username_claim': 'email', 'username_prefix': 'oidc:'}


Authors

  • Aljaz Kosir (@aljazkosir)

  • Manca Bizjak (@mancabizjak)

  • Miha Dolinar (@mdolin)

  • Tadej Borovsak (@tadeboro)