identity_providers

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

Overview

Name	identity_providers
Type	Resource
Id	ovh.me.identity_providers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
group_attribute_name	string	SAML Group attribute name (wire: groupAttributeName)
user_attribute_name	string	SAML User attribute name (wire: userAttributeName)
creation	string (date-time)	Creation date of the identity provider
disable_users	boolean	Whether account users should still be usable as a login method or not (wire: disableUsers)
extensions	object	SAML Extensions to embed inside the SAML requests
idp_signing_certificates	array	IdP's signing certificate (wire: idpSigningCertificates)
last_update	string (date-time)	Last update of the identity provider (wire: lastUpdate)
sign_requests	boolean	Whether SAML Authn Requests should be signed (wire: signRequests)
sso_service_url	string	IdP's Single Sign On Service Url (wire: ssoServiceUrl)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Get the identity provider linked to this account
create	insert	metadata		Define an identity provider (SAML 2.0)
update	update			Alter the provider
delete	delete			Remove the identity provider

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"}})

SELECT examples

get

Get the identity provider linked to this account

SELECT
group_attribute_name,
user_attribute_name,
creation,
disable_users,
extensions,
idp_signing_certificates,
last_update,
sign_requests,
sso_service_url
FROM ovh.me.identity_providers
;

INSERT examples

create

Define an identity provider (SAML 2.0)

INSERT INTO ovh.me.identity_providers (
disable_users,
extensions,
group_attribute_name,
metadata,
sign_requests,
user_attribute_name
)
SELECT 
{{ disable_users }},
'{{ extensions }}',
'{{ group_attribute_name }}',
'{{ metadata }}' /* required */,
{{ sign_requests }},
'{{ user_attribute_name }}'
RETURNING
group_attribute_name,
user_attribute_name,
creation,
disable_users,
extensions,
idp_signing_certificates,
last_update,
sign_requests,
sso_service_url
;

Manifest

# Description fields are for documentation purposes
- name: identity_providers
props:
  - name: disable_users
    value: {{ disable_users }}
    description: |
      Whether account users should still be usable as a login method or not
  - name: extensions
    description: |
      SAML Extensions to embed inside the SAML requests
    value:
      requestedAttributes:
        - isRequired: {{ isRequired }}
          name: "{{ name }}"
          nameFormat: "{{ nameFormat }}"
          values: "{{ values }}"
  - name: group_attribute_name
    value: "{{ group_attribute_name }}"
    description: |
      SAML Group attribute name
  - name: metadata
    value: "{{ metadata }}"
    description: |
      IdP's signing certificate
  - name: sign_requests
    value: {{ sign_requests }}
    description: |
      Whether SAML Authn Requests should be signed
  - name: user_attribute_name
    value: "{{ user_attribute_name }}"
    description: |
      SAML User attribute name

UPDATE examples

update

Alter the provider

UPDATE ovh.me.identity_providers
SET 
disable_users = {{ disable_users }},
extensions = '{{ extensions }}',
group_attribute_name = '{{ group_attribute_name }}',
sign_requests = {{ sign_requests }},
user_attribute_name = '{{ user_attribute_name }}';

DELETE examples

delete

Remove the identity provider

DELETE FROM ovh.me.identity_providers
;