account_delegations

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

Overview

Name	account_delegations
Type	Resource
Id	ovh.email_domain.account_delegations

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
account_id	string	OVH customer unique identifier (wire: accountId)

list

Delegation List

Name	Datatype	Description
account_id	string	OVH customer unique identifier (wire: accountId)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, account_name, domain		Get a delegation. Returns the OVHcloud account ID (accountId) that has been delegated the management of the email account.
list	select	account_name, domain	x_pagination_mode	List delegations. Returns the OVHcloud account IDs (accountId) that have been delegated the management of the email account.
create	insert	account_name, domain, account_id		Create a delegation. Gives the OVHcloud account accountId the management of the email account, from its own control panel.
delete	delete	account_id, account_name, domain		Remove a delegation. Withdraws from the OVHcloud account the management of the email account that it had been delegated.

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
account_id	string	OVH customer unique identifier (wire: accountId)
account_name	string	Name of account (wire: accountName)
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"}})
domain	string	Name of your domain name
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a delegation. Returns the OVHcloud account ID (accountId) that has been delegated the management of the email account.

SELECT
account_id
FROM ovh.email_domain.account_delegations
WHERE account_id = '{{ account_id }}' -- required
AND account_name = '{{ account_name }}' -- required
AND domain = '{{ domain }}' -- required
;

list

List delegations. Returns the OVHcloud account IDs (accountId) that have been delegated the management of the email account.

SELECT
account_id
FROM ovh.email_domain.account_delegations
WHERE account_name = '{{ account_name }}' -- required
AND domain = '{{ domain }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a delegation. Gives the OVHcloud account accountId the management of the email account, from its own control panel.

INSERT INTO ovh.email_domain.account_delegations (
account_id,
account_name,
domain
)
SELECT 
'{{ account_id }}' /* required */,
'{{ account_name }}',
'{{ domain }}'
;

Manifest

# Description fields are for documentation purposes
- name: account_delegations
props:
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the account_delegations resource.
  - name: domain
    value: "{{ domain }}"
    description: Required parameter for the account_delegations resource.
  - name: account_id
    value: "{{ account_id }}"
    description: |
      OVH customer unique identifier

DELETE examples

delete

Remove a delegation. Withdraws from the OVHcloud account the management of the email account that it had been delegated.

DELETE FROM ovh.email_domain.account_delegations
WHERE account_id = '{{ account_id }}' --required
AND account_name = '{{ account_name }}' --required
AND domain = '{{ domain }}' --required
;