open_id_connects

Creates, updates, deletes, gets or lists an open_id_connects resource.

Overview

Name	open_id_connects
Type	Resource
Id	ovh.cloud_container_registry.open_id_connects

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	The OIDC Configuration ID
name	string	The OIDC Configuration Name
client_id	string	The OIDC Configuration ClientID (wire: clientId)
admin_group	string	The OIDC Configuration AdminGroup (wire: adminGroup)
auto_onboard	boolean	The OIDC Configuration AutoOnboard (wire: autoOnboard)
client_secret	string (password)	The OIDC Configuration Client Secret (wire: clientSecret)
created_at	string (date-time)	The OIDC Configuration creation date (wire: createdAt)
endpoint	string	The OIDC Configuration Endpoint
group_filter	string	The OIDC Configuration GroupFilter (wire: groupFilter)
groups_claim	string	The OIDC Configuration GroupsClaim (wire: groupsClaim)
scope	string	The OIDC Configuration comma-separated list of Scopes
status	string	The OIDC Configuration status (DELETING, ERROR, INSTALLING, PATCHING, READY, UPDATING)
updated_at	string (date-time)	The OIDC Configuration last update date (wire: updatedAt)
user_claim	string	The OIDC Configuration UserClaim (wire: userClaim)
verify_cert	boolean	The OIDC Configuration VerifyCert (wire: verifyCert)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	registry_id, service_name		Get the registry's OIDC configuration
create	insert	registry_id, service_name, provider		Add or replace the registry's OIDC configuration
update	update	registry_id, service_name		Edit the registry's OIDC configuration
delete	delete	registry_id, service_name		Delete the registry's OIDC Configuration

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
registry_id	string	RegistryID (wire: registryID)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Get the registry's OIDC configuration

SELECT
id,
name,
client_id,
admin_group,
auto_onboard,
client_secret,
created_at,
endpoint,
group_filter,
groups_claim,
scope,
status,
updated_at,
user_claim,
verify_cert
FROM ovh.cloud_container_registry.open_id_connects
WHERE registry_id = '{{ registry_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Add or replace the registry's OIDC configuration

INSERT INTO ovh.cloud_container_registry.open_id_connects (
delete_users,
provider,
registry_id,
service_name
)
SELECT 
{{ delete_users }},
'{{ provider }}' /* required */,
'{{ registry_id }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: open_id_connects
props:
  - name: registry_id
    value: "{{ registry_id }}"
    description: Required parameter for the open_id_connects resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the open_id_connects resource.
  - name: delete_users
    value: {{ delete_users }}
    description: |
      Delete all previously created users to allow OIDC configuration
  - name: provider
    description: |
      The OIDC provider configuration
    value:
      adminGroup: "{{ adminGroup }}"
      autoOnboard: {{ autoOnboard }}
      clientId: "{{ clientId }}"
      clientSecret: "{{ clientSecret }}"
      createdAt: "{{ createdAt }}"
      endpoint: "{{ endpoint }}"
      groupFilter: "{{ groupFilter }}"
      groupsClaim: "{{ groupsClaim }}"
      id: "{{ id }}"
      name: "{{ name }}"
      scope: "{{ scope }}"
      status: "{{ status }}"
      updatedAt: "{{ updatedAt }}"
      userClaim: "{{ userClaim }}"
      verifyCert: {{ verifyCert }}

UPDATE examples

update

Edit the registry's OIDC configuration

UPDATE ovh.cloud_container_registry.open_id_connects
SET 
admin_group = '{{ admin_group }}',
auto_onboard = {{ auto_onboard }},
client_id = '{{ client_id }}',
client_secret = '{{ client_secret }}',
endpoint = '{{ endpoint }}',
group_filter = '{{ group_filter }}',
groups_claim = '{{ groups_claim }}',
name = '{{ name }}',
scope = '{{ scope }}',
user_claim = '{{ user_claim }}',
verify_cert = {{ verify_cert }}
WHERE 
registry_id = '{{ registry_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set;

DELETE examples

delete

Delete the registry's OIDC Configuration

DELETE FROM ovh.cloud_container_registry.open_id_connects
WHERE registry_id = '{{ registry_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;