service_resource_account_delegates

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

Overview

Name	service_resource_account_delegates
Type	Resource
Id	ovh.email_exchange.service_resource_account_delegates

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
allowed_account_id	integer	delegate's account id (wire: allowedAccountId)
task_pending_id	integer	task pending id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)
delegate_email_address	string	Delegate account primaryEmailAddress (wire: delegateEmailAddress)

list

Resource accounts delegates

Name	Datatype	Description
allowed_account_id	integer	delegate's account id (wire: allowedAccountId)
task_pending_id	integer	task pending id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)
delegate_email_address	string	Delegate account primaryEmailAddress (wire: delegateEmailAddress)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	allowed_account_id, exchange_service, organization_name, resource_email_address		Get a resource account delegate. Returns the ID and the email address of the account that manages the bookings of the resource.
list	select	exchange_service, organization_name, resource_email_address	x_pagination_mode	List resource account delegates. Returns the IDs of the accounts that are delegates of the resource account.
create	insert	exchange_service, organization_name, resource_email_address, allowed_account_id		Add a resource account delegate. Adds the account given by allowedAccountId as a delegate of the resource account, and returns the task.
delete	delete	allowed_account_id, exchange_service, organization_name, resource_email_address		Remove a resource account delegate. Withdraws from the email account the management of the bookings of the resource, and returns the task.

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
allowed_account_id	integer	delegate's account id (wire: allowedAccountId)
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"}})
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organization_name	string	The internal name of your exchange organization (wire: organizationName)
resource_email_address	string	resource as email (wire: resourceEmailAddress)
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 resource account delegate. Returns the ID and the email address of the account that manages the bookings of the resource.

SELECT
allowed_account_id,
task_pending_id,
creation_date,
delegate_email_address
FROM ovh.email_exchange.service_resource_account_delegates
WHERE allowed_account_id = '{{ allowed_account_id }}' -- required
AND exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND resource_email_address = '{{ resource_email_address }}' -- required
;

list

List resource account delegates. Returns the IDs of the accounts that are delegates of the resource account.

SELECT
allowed_account_id,
task_pending_id,
creation_date,
delegate_email_address
FROM ovh.email_exchange.service_resource_account_delegates
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND resource_email_address = '{{ resource_email_address }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add a resource account delegate. Adds the account given by allowedAccountId as a delegate of the resource account, and returns the task.

INSERT INTO ovh.email_exchange.service_resource_account_delegates (
allowed_account_id,
exchange_service,
organization_name,
resource_email_address
)
SELECT 
{{ allowed_account_id }} /* required */,
'{{ exchange_service }}',
'{{ organization_name }}',
'{{ resource_email_address }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_resource_account_delegates
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_resource_account_delegates resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_resource_account_delegates resource.
  - name: resource_email_address
    value: "{{ resource_email_address }}"
    description: Required parameter for the service_resource_account_delegates resource.
  - name: allowed_account_id
    value: {{ allowed_account_id }}
    description: |
      delegate's account id

DELETE examples

delete

Remove a resource account delegate. Withdraws from the email account the management of the bookings of the resource, and returns the task.

DELETE FROM ovh.email_exchange.service_resource_account_delegates
WHERE allowed_account_id = '{{ allowed_account_id }}' --required
AND exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND resource_email_address = '{{ resource_email_address }}' --required
;