identity_groups

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

Overview

Name	identity_groups
Type	Resource
Id	ovh.me.identity_groups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Group's name
creation	string (date-time)	Creation date of this group
default_group	boolean	Whether it is a default group. This kind of group can't be edited or deleted (wire: defaultGroup)
description	string	Group's description
last_update	string (date-time)	Last update of this group (wire: lastUpdate)
role	string	Group's role (ADMIN, NONE, REGULAR, UNPRIVILEGED)
urn	string	IAM identity URN of the group

list

An IAM Group

Name	Datatype	Description
name	string	Group's name
creation	string (date-time)	Creation date of this group
default_group	boolean	Whether it is a default group. This kind of group can't be edited or deleted (wire: defaultGroup)
description	string	Group's description
last_update	string (date-time)	Last update of this group (wire: lastUpdate)
role	string	Group's role (ADMIN, NONE, REGULAR, UNPRIVILEGED)
urn	string	IAM identity URN of the group

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	group		Get an IAM group
list	select		x_pagination_mode	Retrieve all IAM groups of this account
create	insert	name		Create a new IAM group
update	update	group		Alter an IAM group
delete	delete	group		Delete an IAM group

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"}})
group	string	Group
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 group

SELECT
name,
creation,
default_group,
description,
last_update,
role,
urn
FROM ovh.me.identity_groups
WHERE group = '{{ group }}' -- required
;

list

Retrieve all IAM groups of this account

SELECT
name,
creation,
default_group,
description,
last_update,
role,
urn
FROM ovh.me.identity_groups
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a new IAM group

INSERT INTO ovh.me.identity_groups (
description,
name,
role
)
SELECT 
'{{ description }}',
'{{ name }}' /* required */,
'{{ role }}'
RETURNING
name,
creation,
default_group,
description,
last_update,
role,
urn
;

Manifest

# Description fields are for documentation purposes
- name: identity_groups
props:
  - name: description
    value: "{{ description }}"
    description: |
      Group's description
  - name: name
    value: "{{ name }}"
    description: |
      Group's name
  - name: role
    value: "{{ role }}"
    description: |
      Group's role
    valid_values: ['ADMIN', 'NONE', 'REGULAR', 'UNPRIVILEGED']

UPDATE examples

update

Alter an IAM group

UPDATE ovh.me.identity_groups
SET 
description = '{{ description }}',
role = '{{ role }}'
WHERE 
group = '{{ group }}' --required;

DELETE examples

delete

Delete an IAM group

DELETE FROM ovh.me.identity_groups
WHERE group = '{{ group }}' --required
;