scale_computing.hypercore.oidc_config module – Handles openID connect configuration.

Note

This module is part of the scale_computing.hypercore collection (version 1.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install scale_computing.hypercore.

To use it in a playbook, specify: scale_computing.hypercore.oidc_config.

New in scale_computing.hypercore 1.1.0

Synopsis

  • Can create or update openID connect configuration.

Parameters

Parameter

Comments

certificate

string

Plain text of the X.509 PEM-encode certificate.

client_id

string / required

Provided by authentication server when configuring a new client.

cluster_instance

dictionary

Scale Computing HyperCore instance information.

auth_method

string

Select login method. If not set, the value of the SC_AUTH_METHOD environment variable will be used.

Value local - username/password is verified by the HyperCore server (the local users).

Value oidc - username/password is verified by the configured OIDC provider.

Choices:

  • "local" ← (default)

  • "oidc"

host

string / required

The HyperCore instance URL.

If not set, the value of the SC_HOST environment variable will be used.

For example “https://10.1.2.3:443”.

password

string / required

Password used for authentication.

If not set, the value of the SC_PASSWORD environment variable will be used.

timeout

float

Timeout in seconds for the connection with the Scale Computing HyperCore API instance.

If not set, the value of the SC_TIMEOUT environment variable will be used.

username

string / required

Username used for authentication.

If not set, the value of the SC_USERNAME environment variable will be used.

config_url

string / required

The openID connect provider configuration information endpoint.

scopes

string / required

Scopes required to obtain necessary claims.

shared_secret

string

Provided by authentication server for client authentication.

Write only.

Notes

Note

  • Module is not idempotent, it will always report changed=True.

  • check_mode is not supported.

Examples

- name: New OIDC config
  scale_computing.hypercore.oidc_config:
    client_id: 12345
    shared_secret: secret_stuff
    certificate: plain_text_from_x509
    config_url: https://login.microsoftonline.com/your_uuid/v2.0/.well-known/openid-configuration
    scopes: "openid+profile"

Return Values

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

Key

Description

record

dictionary

OIDC config record.

Returned: success

client_id

string

Provided by authentication server when configuring a new client

Returned: success

Sample: "d2298ec0-0596-49d2-9554-840a2fe20603"

config_url

string

The OpenID Connect Provider Configuration Information endpoint

Returned: success

Sample: "https://login.microsoftonline.com/your_uuid/v2.0/.well-known/openid-configuration"

scopes

string

Scopes required to obtain necessary claims

Returned: success

Sample: "openid+profile"

Authors

  • Domen Dobnikar (@domen_dobnikar)