Skip to content

Users

All operations require authentication.

16 operationsv1/dedicatedCloud/{serviceName}
View as Markdown (opens in a new tab)
Agent setup

List usersProduction

GET
/v1/dedicatedCloud/{serviceName}/user

Path parameters

serviceName
required
string

Domain of the service

Query parameters

name
string

Filter the value of name property (like)

Response

200integer[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a userProduction

GET
/v1/dedicatedCloud/{serviceName}/user/{userId}

Get a user. Returns the user: login, contact details, activation state, permissions and identity provider.

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200Usersuccessful operation
activationState
read-only
ActivationStateEnum

Activation state of the user account

ValuesdisableddisablingenabledenablingtoDisabletoEnable
activeDirectoryId
read-only
integer

Deprecated - Linked Federation Active Directory (if any)

activeDirectoryType
read-only
TypeEnum

Deprecated - Federation Active Directory User type (if any)

Valuesgroupuser
canManageIpFailOvers
read-only
boolean

Defines if the user can manage ip failovers

canManageNetwork
read-only
boolean

Defines if the user can manage the network

canManageRights
read-only
boolean

Defines if the user can manage users rights

email
read-only
string

Email address of the user

encryptionRight
read-only
boolean

Defines if the user can manage encryption / KMS configuration

firstName
read-only
string

First name of the user

fullAdminRo
read-only
boolean

Defines if the user is a full admin in readonly

identityProviderId
read-only
integer

Linked Identity Provider (if any), can be Federation Active Directory or IAM

identityProviderType
read-only
IdentityProviderTypeEnum

Linked Identity Provider type (if any), can be Federation Active Directory or IAM

Valuesfederationiam
isEnableManageable
read-only
boolean

Check if the given VMware on OVHcloud user can be enabled or disabled ?

isTokenValidator
read-only
boolean

Defines if the user can confirm security tokens (if a compatible option is enabled)

lastName
read-only
string

Last name of the user

login
read-only
string

Login of the user

name
read-only
string

Name of the user

nsxRight
read-only
boolean

Is this User able to access nsx interface (requires NSX option)

phoneNumber
read-only
string

Mobile phone number of the user

receiveAlerts
read-only
boolean

Defines if the user receives technical alerts

state
read-only
StateEnum

State of the user account

Valuescreatingdeletingdeliverederror
type
read-only
TypeEnum

User type (if any)

Valuesgroupuser
userId
read-only
integer
—

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "activationState": "disabled", "activeDirectoryId": 0, "activeDirectoryType": "group", "canManageIpFailOvers": true, "canManageNetwork": true, "canManageRights": true, "email": "string", "encryptionRight": true, "firstName": "string", "fullAdminRo": true, "identityProviderId": 0, "identityProviderType": "federation", "isEnableManageable": true, "isTokenValidator": true, "lastName": "string", "login": "string", "name": "string", "nsxRight": true, "phoneNumber": "string", "receiveAlerts": true, "state": "creating", "type": "group", "userId": 0}

List user object rightsProduction

GET
/v1/dedicatedCloud/{serviceName}/user/{userId}/objectRight

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200integer[]successful operation

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/objectRight \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a user object rightProduction

GET
/v1/dedicatedCloud/{serviceName}/user/{userId}/objectRight/{objectRightId}

Get a user object right. Returns the right of the user on a VMware object: object type, MoRef, access level and propagation.

Path parameters

objectRightId
required
integer
—
serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200ObjectRightsuccessful operation
name
read-only
string

Name of the object

objectRightId
read-only
integer
—
propagate
read-only
boolean

Right propagation on children objects

right
read-only
RightEnum

User access on the VMware object

Valuesadmindisabledreadonlyreadwrite
type
read-only
UserObjectRightTypeEnum

Type of the object

Valuesclusterdatastoredvportgroupfolderpoolvm
vmwareObjectId
read-only
string

The VMware MoRef of the object

Example uses objectRightId = 0, serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/objectRight/{objectRightId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "name": "string", "objectRightId": 0, "propagate": true, "right": "admin", "type": "cluster", "vmwareObjectId": "string"}

List user datacenter rightsProduction

GET
/v1/dedicatedCloud/{serviceName}/user/{userId}/right

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200integer[]successful operation

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/right \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a user datacenter rightProduction

GET
/v1/dedicatedCloud/{serviceName}/user/{userId}/right/{rightId}

Get a user datacenter right. Returns the access of the user on a datacenter: access level, network and VM network roles, and right to add resources.

Path parameters

rightId
required
integer
—
serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200Rightsuccessful operation
canAddRessource
boolean

Determine if the user can add ressources in your VMware on OVHcloud

datacenterId
read-only
integer
—
networkRole
NetworkRoleEnum

Determine how this user can interact with the VMware on OVHcloud V(x)Lans

ValuesadminmanagernoAccessreadonly
right
RightEnum

Determine what kind of access the User will have in this Datacenter of your VMware on OVHcloud

Valuesadmindisabledreadonlyreadwrite
rightId
read-only
integer
—
vmNetworkRole
VmNetworkRoleEnum

Determine how this user can interact with the VMware on OVHcloud VM Network

ValuesadminnoAccessreadonly

Example uses rightId = 0, serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/right/{rightId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "canAddRessource": true, "datacenterId": 0, "networkRole": "admin", "right": "admin", "rightId": 0, "vmNetworkRole": "admin"}

Create a userProduction

POST
/v1/dedicatedCloud/{serviceName}/user

Create a user. Creates a user. Its right applies to all datacenters and is disabled by default. Without a password, a random one is generated and sent by email.

Path parameters

serviceName
required
string

Domain of the service

Request body (required)

canAddRessource
boolean

Is this User able to add ressources in the Datacenter he has access ? (default is no right to add ressource)

canManageRights
boolean

Is this user able to manage the users rights

email
string

The user email. If this field is empty, user informations will be sent to the dedicatedCloud administrator contact.

encryptionRight
boolean

Defines if the user can manage encryption / KMS configuration

expirationDate
stringdate-time

Date of removal of the user.

firstName
string

First name of the user

lastName
string

Last name of the user

name
required
string

Name of the user (login)

networkRole
NetworkRoleEnum

Determine how this user will be able to act on this VMware on OVHcloud v(x)Lans

ValuesadminmanagernoAccessreadonly
nsxRight
boolean

Is this User able to access nsx interface (requires NSX option)

password
stringpassword

The user password. It must fits your VMware on OVHcloud password policy. If this field is empty, a random password will be generated and sent by email.

phoneNumber
string

Mobile phone number of the user

receiveAlerts
boolean

Defines if the user receives technical alerts

right
RightEnum

Determine what kind of access the User will have in all Datacenters of your VMware on OVHcloud (default is disabled)

Valuesadmindisabledreadonlyreadwrite
tokenValidator
boolean

Defines if the user can confirm security tokens (if a compatible option is enabled)

vmNetworkRole
VmNetworkRoleEnum

Determine how this user will be able to act on this VMware on OVHcloud VM Network

ValuesadminnoAccessreadonly

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Change a user passwordProduction

POST
/v1/dedicatedCloud/{serviceName}/user/{userId}/changePassword

Change a user password. Sets a new password that follows the password policy. Without a password, a random one is generated and sent by email. Returns a task to track progress.

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Request body (required)

password
stringpassword

New password for this VMware on OVHcloud user. It must fit your VMware on OVHcloud password policy. If this field is empty, a random password will be generated and sent by email.

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/changePassword \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Update a userProduction

POST
/v1/dedicatedCloud/{serviceName}/user/{userId}/changeProperties

Update a user. Updates the name, email address, phone number and permissions of the user. Returns a task to track progress.

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Request body (required)

canManageIpFailOvers
boolean

Defines if the user can manage ip failovers

canManageNetwork
boolean

Defines if the user can manage the network

canManageRights
boolean

Defines if the user can manage the users rights

email
string

Email address of the user

encryptionRight
boolean

Defines if the user can manage encryption / KMS configuration

firstName
string

First name of the user

fullAdminRo
boolean

Defines if the user is a full admin in readonly

lastName
string

Last name of the user

nsxRight
boolean

Is this User able to access nsx interface (requires NSX option)

phoneNumber
string

Mobile phone number of the user in international format (+prefix.number)

receiveAlerts
boolean

Defines if the user receives technical alerts

tokenValidator
boolean

Defines if the user can confirm security tokens (if a compatible option is enabled)

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/changeProperties \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Confirm a user phone numberProduction

POST
/v1/dedicatedCloud/{serviceName}/user/{userId}/confirmPhoneNumber

Confirm a user phone number. Confirms the phone number with the token sent by SMS. Returns a task to track progress.

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Request body (required)

token
required
stringpassword

Token sent by SMS

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/confirmPhoneNumber \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Disable a userProduction

POST
/v1/dedicatedCloud/{serviceName}/user/{userId}/disable

Disable a user. Disables the user account. Check isEnableManageable on the user first. Returns a task to track progress.

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/disable \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Enable a userProduction

POST
/v1/dedicatedCloud/{serviceName}/user/{userId}/enable

Enable a user. Enables the user account. Check isEnableManageable on the user first. Returns a task to track progress.

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/enable \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Create a user object rightProduction

POST
/v1/dedicatedCloud/{serviceName}/user/{userId}/objectRight

Create a user object right. Gives the user a right on a VMware object, given by its MoRef: cluster, datastore, portgroup, folder, pool or virtual machine. The right can propagate to child objects. Returns a task to track progress.

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Request body (required)

propagate
boolean

Right propagation on children objects

right
required
RightEnum

User access on the VMware object

Valuesadmindisabledreadonlyreadwrite
type
required
UserObjectRightTypeEnum

Type of the object

Valuesclusterdatastoredvportgroupfolderpoolvm
vmwareObjectId
required
string

The VMware MoRef of the object

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/objectRight \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Delete a userProduction

DELETE
/v1/dedicatedCloud/{serviceName}/user/{userId}

Delete a user. Deletes the user. To block its access without deleting it, use disable instead. Returns a task to track progress.

Path parameters

serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Delete a user object rightProduction

DELETE
/v1/dedicatedCloud/{serviceName}/user/{userId}/objectRight/{objectRightId}

Delete a user object right. Removes the right of the user on the VMware object. Returns a task to track progress.

Path parameters

objectRightId
required
integer
—
serviceName
required
string

Domain of the service

userId
required
integer
—

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses objectRightId = 0, serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/objectRight/{objectRightId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Update a user datacenter rightProduction

PUT
/v1/dedicatedCloud/{serviceName}/user/{userId}/right/{rightId}

Update a user datacenter right. Updates the access level, the network and VM network roles, and the right to add resources. Returns a task to track progress.

Path parameters

rightId
required
integer
—
serviceName
required
string

Domain of the service

userId
required
integer
—

Request body (required)

canAddRessource
boolean

Determine if the user can add ressources in your VMware on OVHcloud

datacenterId
read-only
integer
—
networkRole
NetworkRoleEnum

Determine how this user can interact with the VMware on OVHcloud V(x)Lans

ValuesadminmanagernoAccessreadonly
right
RightEnum

Determine what kind of access the User will have in this Datacenter of your VMware on OVHcloud

Valuesadmindisabledreadonlyreadwrite
rightId
read-only
integer
—
vmNetworkRole
VmNetworkRoleEnum

Determine how this user can interact with the VMware on OVHcloud VM Network

ValuesadminnoAccessreadonly

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses rightId = 0, serviceName = string, userId = 0

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/user/{userId}/right/{rightId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}