acls

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

Overview

Name	acls
Type	Resource
Id	ovh.email_domain.acls

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

Email ACL

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, domain		Get an ACL. Returns the OVHcloud account ID (accountId) that has been given access to the email service of the domain.
list	select	domain	x_pagination_mode	List ACLs. Returns the OVHcloud account IDs (accountId) that have been given access to the email service of the domain.
create	insert	domain, account_id		Add an ACL. Gives the OVHcloud account accountId full management of the email domain, and returns the ACL.
delete	delete	account_id, domain		Remove an ACL. Withdraws from the OVHcloud account the access to the email service of the domain that it had been given.

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)
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 an ACL. Returns the OVHcloud account ID (accountId) that has been given access to the email service of the domain.

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

list

List ACLs. Returns the OVHcloud account IDs (accountId) that have been given access to the email service of the domain.

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

INSERT examples

create

Add an ACL. Gives the OVHcloud account accountId full management of the email domain, and returns the ACL.

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

Manifest

# Description fields are for documentation purposes
- name: acls
props:
  - name: domain
    value: "{{ domain }}"
    description: Required parameter for the acls resource.
  - name: account_id
    value: "{{ account_id }}"
    description: |
      Deleguates rights to

DELETE examples

delete

Remove an ACL. Withdraws from the OVHcloud account the access to the email service of the domain that it had been given.

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