service_impersonated_users

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

Overview

Name	service_impersonated_users
Type	Resource
Id	ovh.email_exchange.service_impersonated_users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_pending_id	integer	Pending task id (wire: taskPendingId)
creation_date	string (date-time)	Creation date (wire: creationDate)
last_password_change	string (date-time)	Last password update date (wire: lastPasswordChange)
state	string	User state (creating, deleting, internalMigration, ok, reopening, suspended, suspending)
upn	string	User Principal Name

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, organization_name		Get the impersonated user. Returns the UPN, state, creation date and last password change of the user with impersonation rights on all mailboxes.
create	insert	exchange_service, organization_name, password		Create the impersonated user. Creates a user with impersonation rights on all mailboxes of the service, with the given password, and returns the task.
delete	delete	exchange_service, organization_name		Delete the impersonated user. Deletes the user with impersonation rights on all mailboxes, and returns the task.
change_password	exec	exchangeService, organizationName, password		Change the impersonated user password. Sets the new password of the impersonated user of the service, 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
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"}})
exchangeService	string	The internal name of your exchange service
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organizationName	string	The internal name of your exchange organization
organization_name	string	The internal name of your exchange organization (wire: organizationName)

SELECT examples

get

Get the impersonated user. Returns the UPN, state, creation date and last password change of the user with impersonation rights on all mailboxes.

SELECT
task_pending_id,
creation_date,
last_password_change,
state,
upn
FROM ovh.email_exchange.service_impersonated_users
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

INSERT examples

create

Create the impersonated user. Creates a user with impersonation rights on all mailboxes of the service, with the given password, and returns the task.

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

Manifest

# Description fields are for documentation purposes
- name: service_impersonated_users
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_impersonated_users resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_impersonated_users resource.
  - name: password
    value: "{{ password }}"
    description: |
      password for the user

DELETE examples

delete

Delete the impersonated user. Deletes the user with impersonation rights on all mailboxes, and returns the task.

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

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change the impersonated user password. Sets the new password of the impersonated user of the service, and returns the task.

EXEC ovh.email_exchange.service_impersonated_users.change_password 
@exchangeService='{{ exchangeService }}' --required, 
@organizationName='{{ organizationName }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;