users

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

Overview

Name	users
Type	Resource
Id	ovh.cloud.users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	User id
openstack_id	string	User id on openstack (wire: openstackId)
creation_date	string (date-time)	User creation date (wire: creationDate)
description	string	User description
roles	array	User roles
status	string	User status (creating, deleted, deleting, disabled, ok, updating)
username	string	Username

list

User

Name	Datatype	Description
id	integer	User id
openstack_id	string	User id on openstack (wire: openstackId)
creation_date	string (date-time)	User creation date (wire: creationDate)
description	string	User description
roles	array	User roles
status	string	User status (creating, deleted, deleting, disabled, ok, updating)
username	string	Username

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, service_name		Get user details
list	select	service_name		Get all users
create	insert	service_name		Create user
delete	delete	user_id, service_name		Delete user
regenerate_password	exec	userId, service_name		Regenerate user password
token	exec	userId, service_name, password		Get token for user

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"}})
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
userId	integer	User ID
user_id	integer	User ID (wire: userId)

SELECT examples

get

Get user details

SELECT
id,
openstack_id,
creation_date,
description,
roles,
status,
username
FROM ovh.cloud.users
WHERE user_id = '{{ user_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Get all users

SELECT
id,
openstack_id,
creation_date,
description,
roles,
status,
username
FROM ovh.cloud.users
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create user

INSERT INTO ovh.cloud.users (
description,
role,
roles,
service_name
)
SELECT 
'{{ description }}',
'{{ role }}',
'{{ roles }}',
'{{ service_name }}'
RETURNING
id,
openstack_id,
creation_date,
description,
password,
roles,
status,
username
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the users resource.
  - name: description
    value: "{{ description }}"
    description: |
      User description
  - name: role
    value: "{{ role }}"
    description: |
      Openstack keystone role name
    valid_values: ['administrator', 'ai_training_operator', 'ai_training_read', 'authentication', 'backup_operator', 'compute_operator', 'image_operator', 'infrastructure_supervisor', 'key-manager_operator', 'key-manager_read', 'load-balancer_operator', 'network_operator', 'network_security_operator', 'objectstore_operator', 'quantum_operator', 'quantum_reader', 'share_operator', 'volume_operator']
  - name: roles
    value:
      - "{{ roles }}"
    description: |
      Openstack keystone roles names

DELETE examples

delete

Delete user

DELETE FROM ovh.cloud.users
WHERE user_id = '{{ user_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

regenerate_password

Regenerate user password

EXEC ovh.cloud.users.regenerate_password 
@userId='{{ userId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

token

Get token for user

EXEC ovh.cloud.users.token 
@userId='{{ userId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"password": "{{ password }}"
}'
;