credentials

Creates, updates, deletes, gets or lists a credentials resource.

Overview

Name	credentials
Type	Resource
Id	ovh.auth.credentials

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	access_rules		Request a new credential for your application

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

INSERT examples

create

Request a new credential for your application

INSERT INTO ovh.auth.credentials (
access_rules,
allowed_ips,
redirection
)
SELECT 
'{{ access_rules }}' /* required */,
'{{ allowed_ips }}',
'{{ redirection }}'
RETURNING
consumer_key,
state,
validation_url
;

Manifest

# Description fields are for documentation purposes
- name: credentials
props:
  - name: access_rules
    description: |
      Wanted API routes
    value:
      - method: "{{ method }}"
        path: "{{ path }}"
  - name: allowed_ips
    value:
      - "{{ allowed_ips }}"
    description: |
      If defined, list of IP blocks that can use the credential
  - name: redirection
    value: "{{ redirection }}"
    description: |
      Address where the customer will be redirected after authentication