account_full_accesses

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

Overview

Name	account_full_accesses
Type	Resource
Id	ovh.email_mxplan.account_full_accesses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
allowed_account_id	integer	Account id to give full access (wire: allowedAccountId)
task_pending_id	integer	Pending task id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)

list

Users having full access on this mailbox

Name	Datatype	Description
allowed_account_id	integer	Account id to give full access (wire: allowedAccountId)
task_pending_id	integer	Pending task id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	allowed_account_id, email, service		Get a full access permission. Returns the ID of the account that has full access to the email account, and the creation date of the permission.
list	select	email, service	x_pagination_mode	List full access permissions. Returns the IDs of the accounts that have full access to the email account.
create	insert	email, service, allowed_account_id		Add a full access permission. Gives the account allowedAccountId full access to the email account, and returns the task.
delete	delete	allowed_account_id, email, service		Remove a full access permission. Withdraws the access of the allowed account to the mailbox of this email account, 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	Account id to give full access (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"}})
email	string	Default email for this mailbox
service	string	The internal name of your mxplan organization
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 full access permission. Returns the ID of the account that has full access to the email account, and the creation date of the permission.

SELECT
allowed_account_id,
task_pending_id,
creation_date
FROM ovh.email_mxplan.account_full_accesses
WHERE allowed_account_id = '{{ allowed_account_id }}' -- required
AND email = '{{ email }}' -- required
AND service = '{{ service }}' -- required
;

list

List full access permissions. Returns the IDs of the accounts that have full access to the email account.

SELECT
allowed_account_id,
task_pending_id,
creation_date
FROM ovh.email_mxplan.account_full_accesses
WHERE email = '{{ email }}' -- required
AND service = '{{ service }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add a full access permission. Gives the account allowedAccountId full access to the email account, and returns the task.

INSERT INTO ovh.email_mxplan.account_full_accesses (
allowed_account_id,
email,
service
)
SELECT 
{{ allowed_account_id }} /* required */,
'{{ email }}',
'{{ service }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: account_full_accesses
props:
  - name: email
    value: "{{ email }}"
    description: Required parameter for the account_full_accesses resource.
  - name: service
    value: "{{ service }}"
    description: Required parameter for the account_full_accesses resource.
  - name: allowed_account_id
    value: {{ allowed_account_id }}
    description: |
      User to give full access

DELETE examples

delete

Remove a full access permission. Withdraws the access of the allowed account to the mailbox of this email account, and returns the task.

DELETE FROM ovh.email_mxplan.account_full_accesses
WHERE allowed_account_id = '{{ allowed_account_id }}' --required
AND email = '{{ email }}' --required
AND service = '{{ service }}' --required
;