service_public_folder_permissions

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

Overview

Name	service_public_folder_permissions
Type	Resource
Id	ovh.email_exchange.service_public_folder_permissions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
allowed_account_id	integer	Account id (wire: allowedAccountId)
task_pending_id	integer	task pending id (wire: taskPendingId)
access_rights	string	Access right set for the account (editor, none, reviewer) (wire: accessRights)
creation_date	string (date-time)	Creation date (wire: creationDate)
state	string	Current object state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)

list

Exchange organization public folder permission

Name	Datatype	Description
allowed_account_id	integer	Account id (wire: allowedAccountId)
task_pending_id	integer	task pending id (wire: taskPendingId)
access_rights	string	Access right set for the account (editor, none, reviewer) (wire: accessRights)
creation_date	string (date-time)	Creation date (wire: creationDate)
state	string	Current object state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)

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, path		Get a public folder permission. Returns the ID of the account given access to the public folder, its access rights and its state.
list	select	exchange_service, organization_name, path	x_pagination_mode	List public folder permissions. Returns the IDs of the accounts that have a permission on the public folder.
create	insert	exchange_service, organization_name, path, access_rights, allowed_account_id		Add a public folder permission. Gives the account given by allowedAccountId the editor, reviewer or none access right on the public folder, and returns the task.
update	update	allowed_account_id, exchange_service, organization_name, path		Update a public folder permission. Sets the access right of the account on the public folder: editor, reviewer or none.
delete	delete	allowed_account_id, exchange_service, organization_name, path		Remove a public folder permission. Withdraws the access of the account to the public folder, 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 (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)
path	string	Path for public folder
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 public folder permission. Returns the ID of the account given access to the public folder, its access rights and its state.

SELECT
allowed_account_id,
task_pending_id,
access_rights,
creation_date,
state
FROM ovh.email_exchange.service_public_folder_permissions
WHERE allowed_account_id = '{{ allowed_account_id }}' -- required
AND exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND path = '{{ path }}' -- required
;

list

List public folder permissions. Returns the IDs of the accounts that have a permission on the public folder.

SELECT
allowed_account_id,
task_pending_id,
access_rights,
creation_date,
state
FROM ovh.email_exchange.service_public_folder_permissions
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND path = '{{ path }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add a public folder permission. Gives the account given by allowedAccountId the editor, reviewer or none access right on the public folder, and returns the task.

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

Manifest

# Description fields are for documentation purposes
- name: service_public_folder_permissions
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_public_folder_permissions resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_public_folder_permissions resource.
  - name: path
    value: "{{ path }}"
    description: Required parameter for the service_public_folder_permissions resource.
  - name: access_rights
    value: "{{ access_rights }}"
    description: |
      Access rights to be set for the account
    valid_values: ['editor', 'none', 'reviewer']
  - name: allowed_account_id
    value: {{ allowed_account_id }}
    description: |
      Account id to have access to public folder

UPDATE examples

update

Update a public folder permission. Sets the access right of the account on the public folder: editor, reviewer or none.

UPDATE ovh.email_exchange.service_public_folder_permissions
SET 
access_rights = '{{ access_rights }}'
WHERE 
allowed_account_id = '{{ allowed_account_id }}' --required
AND exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND path = '{{ path }}' --required;

DELETE examples

delete

Remove a public folder permission. Withdraws the access of the account to the public folder, and returns the task.

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