service_authentication_policies

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

Overview

Name	service_authentication_policies
Type	Resource
Id	ovh.email_exchange.service_authentication_policies

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Authentication policy id
block_legacy_auth_active_sync	boolean	Block legacy authentication on ActiveSync (wire: blockLegacyAuthActiveSync)
block_legacy_auth_autodiscover	boolean	Block legacy authentication on Autodiscover (wire: blockLegacyAuthAutodiscover)
block_legacy_auth_imap	boolean	Block legacy authentication on Imap (wire: blockLegacyAuthImap)
block_legacy_auth_mapi	boolean	Block legacy authentication on Mapi (wire: blockLegacyAuthMapi)
block_legacy_auth_offline_address_book	boolean	Block legacy authentication on Offline Address Book (wire: blockLegacyAuthOfflineAddressBook)
block_legacy_auth_pop	boolean	Block legacy authentication on Pop (wire: blockLegacyAuthPop)
block_legacy_auth_web_services	boolean	Block legacy authentication on Web Services (wire: blockLegacyAuthWebServices)
block_modern_auth_active_sync	boolean	Block modern authentication on ActiveSync (wire: blockModernAuthActiveSync)
block_modern_auth_autodiscover	boolean	Block modern authentication on Autodiscover (wire: blockModernAuthAutodiscover)
block_modern_auth_imap	boolean	Block modern authentication on Imap (wire: blockModernAuthImap)
block_modern_auth_mapi	boolean	Block modern authentication on Mapi (wire: blockModernAuthMapi)
block_modern_auth_offline_address_book	boolean	Block modern authentication on Offline Address Book (wire: blockModernAuthOfflineAddressBook)
block_modern_auth_pop	boolean	Block modern authentication on Pop (wire: blockModernAuthPop)
block_modern_auth_web_services	boolean	Block modern authentication on Web Services (wire: blockModernAuthWebServices)

list

Get authentication policy for protocols

Name	Datatype	Description
id	integer	Authentication policy id
block_legacy_auth_active_sync	boolean	Block legacy authentication on ActiveSync (wire: blockLegacyAuthActiveSync)
block_legacy_auth_autodiscover	boolean	Block legacy authentication on Autodiscover (wire: blockLegacyAuthAutodiscover)
block_legacy_auth_imap	boolean	Block legacy authentication on Imap (wire: blockLegacyAuthImap)
block_legacy_auth_mapi	boolean	Block legacy authentication on Mapi (wire: blockLegacyAuthMapi)
block_legacy_auth_offline_address_book	boolean	Block legacy authentication on Offline Address Book (wire: blockLegacyAuthOfflineAddressBook)
block_legacy_auth_pop	boolean	Block legacy authentication on Pop (wire: blockLegacyAuthPop)
block_legacy_auth_web_services	boolean	Block legacy authentication on Web Services (wire: blockLegacyAuthWebServices)
block_modern_auth_active_sync	boolean	Block modern authentication on ActiveSync (wire: blockModernAuthActiveSync)
block_modern_auth_autodiscover	boolean	Block modern authentication on Autodiscover (wire: blockModernAuthAutodiscover)
block_modern_auth_imap	boolean	Block modern authentication on Imap (wire: blockModernAuthImap)
block_modern_auth_mapi	boolean	Block modern authentication on Mapi (wire: blockModernAuthMapi)
block_modern_auth_offline_address_book	boolean	Block modern authentication on Offline Address Book (wire: blockModernAuthOfflineAddressBook)
block_modern_auth_pop	boolean	Block modern authentication on Pop (wire: blockModernAuthPop)
block_modern_auth_web_services	boolean	Block modern authentication on Web Services (wire: blockModernAuthWebServices)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, id, organization_name		Get an authentication policy. Returns, for each protocol, whether legacy and modern authentication are blocked: ActiveSync, Autodiscover, IMAP, MAPI, offline address book, POP and web services.
list	select	exchange_service, organization_name	block_legacy_auth_active_sync, block_legacy_auth_autodiscover, block_legacy_auth_imap, block_legacy_auth_mapi, block_legacy_auth_offline_address_book, block_legacy_auth_pop, block_legacy_auth_web_services, block_modern_auth_active_sync, block_modern_auth_autodiscover, block_modern_auth_imap, block_modern_auth_mapi, block_modern_auth_offline_address_book, block_modern_auth_pop, block_modern_auth_web_services, x_pagination_mode	List authentication policies. Returns the IDs of the authentication policies. Filter them by the legacy or modern authentication blocked on a protocol, such as blockLegacyAuthImap.

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
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)
id	integer	Authentication policy id
organization_name	string	The internal name of your exchange organization (wire: organizationName)
block_legacy_auth_active_sync	boolean	Filter the value of blockLegacyAuthActiveSync property (=) (wire: blockLegacyAuthActiveSync)
block_legacy_auth_autodiscover	boolean	Filter the value of blockLegacyAuthAutodiscover property (=) (wire: blockLegacyAuthAutodiscover)
block_legacy_auth_imap	boolean	Filter the value of blockLegacyAuthImap property (=) (wire: blockLegacyAuthImap)
block_legacy_auth_mapi	boolean	Filter the value of blockLegacyAuthMapi property (=) (wire: blockLegacyAuthMapi)
block_legacy_auth_offline_address_book	boolean	Filter the value of blockLegacyAuthOfflineAddressBook property (=) (wire: blockLegacyAuthOfflineAddressBook)
block_legacy_auth_pop	boolean	Filter the value of blockLegacyAuthPop property (=) (wire: blockLegacyAuthPop)
block_legacy_auth_web_services	boolean	Filter the value of blockLegacyAuthWebServices property (=) (wire: blockLegacyAuthWebServices)
block_modern_auth_active_sync	boolean	Filter the value of blockModernAuthActiveSync property (=) (wire: blockModernAuthActiveSync)
block_modern_auth_autodiscover	boolean	Filter the value of blockModernAuthAutodiscover property (=) (wire: blockModernAuthAutodiscover)
block_modern_auth_imap	boolean	Filter the value of blockModernAuthImap property (=) (wire: blockModernAuthImap)
block_modern_auth_mapi	boolean	Filter the value of blockModernAuthMapi property (=) (wire: blockModernAuthMapi)
block_modern_auth_offline_address_book	boolean	Filter the value of blockModernAuthOfflineAddressBook property (=) (wire: blockModernAuthOfflineAddressBook)
block_modern_auth_pop	boolean	Filter the value of blockModernAuthPop property (=) (wire: blockModernAuthPop)
block_modern_auth_web_services	boolean	Filter the value of blockModernAuthWebServices property (=) (wire: blockModernAuthWebServices)
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 authentication policy. Returns, for each protocol, whether legacy and modern authentication are blocked: ActiveSync, Autodiscover, IMAP, MAPI, offline address book, POP and web services.

SELECT
id,
block_legacy_auth_active_sync,
block_legacy_auth_autodiscover,
block_legacy_auth_imap,
block_legacy_auth_mapi,
block_legacy_auth_offline_address_book,
block_legacy_auth_pop,
block_legacy_auth_web_services,
block_modern_auth_active_sync,
block_modern_auth_autodiscover,
block_modern_auth_imap,
block_modern_auth_mapi,
block_modern_auth_offline_address_book,
block_modern_auth_pop,
block_modern_auth_web_services
FROM ovh.email_exchange.service_authentication_policies
WHERE exchange_service = '{{ exchange_service }}' -- required
AND id = '{{ id }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

list

List authentication policies. Returns the IDs of the authentication policies. Filter them by the legacy or modern authentication blocked on a protocol, such as blockLegacyAuthImap.

SELECT
id,
block_legacy_auth_active_sync,
block_legacy_auth_autodiscover,
block_legacy_auth_imap,
block_legacy_auth_mapi,
block_legacy_auth_offline_address_book,
block_legacy_auth_pop,
block_legacy_auth_web_services,
block_modern_auth_active_sync,
block_modern_auth_autodiscover,
block_modern_auth_imap,
block_modern_auth_mapi,
block_modern_auth_offline_address_book,
block_modern_auth_pop,
block_modern_auth_web_services
FROM ovh.email_exchange.service_authentication_policies
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND block_legacy_auth_active_sync = '{{ block_legacy_auth_active_sync }}'
AND block_legacy_auth_autodiscover = '{{ block_legacy_auth_autodiscover }}'
AND block_legacy_auth_imap = '{{ block_legacy_auth_imap }}'
AND block_legacy_auth_mapi = '{{ block_legacy_auth_mapi }}'
AND block_legacy_auth_offline_address_book = '{{ block_legacy_auth_offline_address_book }}'
AND block_legacy_auth_pop = '{{ block_legacy_auth_pop }}'
AND block_legacy_auth_web_services = '{{ block_legacy_auth_web_services }}'
AND block_modern_auth_active_sync = '{{ block_modern_auth_active_sync }}'
AND block_modern_auth_autodiscover = '{{ block_modern_auth_autodiscover }}'
AND block_modern_auth_imap = '{{ block_modern_auth_imap }}'
AND block_modern_auth_mapi = '{{ block_modern_auth_mapi }}'
AND block_modern_auth_offline_address_book = '{{ block_modern_auth_offline_address_book }}'
AND block_modern_auth_pop = '{{ block_modern_auth_pop }}'
AND block_modern_auth_web_services = '{{ block_modern_auth_web_services }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;