identity_users

Creates, updates, deletes, gets or lists an identity_users resource.

Overview

Name	identity_users
Type	Resource
Id	ovh.me.identity_users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
creation	string (date-time)	Creation date of this user
description	string	User's description
email	string	User's email
group	string	User's main group
groups	array	User's groups
last_update	string (date-time)	User's last update date (wire: lastUpdate)
login	string	User's login suffix
password_last_update	string (date-time)	User's password last update date (wire: passwordLastUpdate)
status	string	Current user's status (DISABLED, OK, PASSWORD_CHANGE_REQUIRED)
type	string	Type of user (ROOT, SERVICE, USER)
urn	string	IAM identity URN of the user

list

An IAM User

Name	Datatype	Description
creation	string (date-time)	Creation date of this user
description	string	User's description
email	string	User's email
group	string	User's main group
groups	array	User's groups
last_update	string (date-time)	User's last update date (wire: lastUpdate)
login	string	User's login suffix
password_last_update	string (date-time)	User's password last update date (wire: passwordLastUpdate)
status	string	Current user's status (DISABLED, OK, PASSWORD_CHANGE_REQUIRED)
type	string	Type of user (ROOT, SERVICE, USER)
urn	string	IAM identity URN of the user

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user		Get an IAM user
list	select		x_pagination_mode	Retrieve all IAM users of this account
create	insert	login		Create a new IAM user
update	update	user		Alter an IAM user
delete	delete	user		Delete an IAM user
disable	exec	user		Disable this user
enable	exec	user		Enable this 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"}})
user	string	User
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 IAM user

SELECT
creation,
description,
email,
group,
groups,
last_update,
login,
password_last_update,
status,
type,
urn
FROM ovh.me.identity_users
WHERE user = '{{ user }}' -- required
;

list

Retrieve all IAM users of this account

SELECT
creation,
description,
email,
group,
groups,
last_update,
login,
password_last_update,
status,
type,
urn
FROM ovh.me.identity_users
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a new IAM user

INSERT INTO ovh.me.identity_users (
description,
email,
group,
login,
password,
type
)
SELECT 
'{{ description }}',
'{{ email }}',
'{{ group }}',
'{{ login }}' /* required */,
'{{ password }}',
'{{ type }}'
;

Manifest

# Description fields are for documentation purposes
- name: identity_users
props:
  - name: description
    value: "{{ description }}"
    description: |
      User's description
  - name: email
    value: "{{ email }}"
    description: |
      User's email
  - name: group
    value: "{{ group }}"
    description: |
      User's group
  - name: login
    value: "{{ login }}"
    description: |
      User's login
  - name: password
    value: "{{ password }}"
    description: |
      User's password
  - name: type
    value: "{{ type }}"
    description: |
      Type of user to create
    valid_values: ['ROOT', 'SERVICE', 'USER']

UPDATE examples

update

Alter an IAM user

UPDATE ovh.me.identity_users
SET 
description = '{{ description }}',
email = '{{ email }}',
group = '{{ group }}'
WHERE 
user = '{{ user }}' --required;

DELETE examples

delete

Delete an IAM user

DELETE FROM ovh.me.identity_users
WHERE user = '{{ user }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

disable

Disable this user

EXEC ovh.me.identity_users.disable 
@user='{{ user }}' --required
;

enable

Enable this user

EXEC ovh.me.identity_users.enable 
@user='{{ user }}' --required
;