identity_group_users
Creates, updates, deletes, gets or lists an identity_group_users resource.
Overview​
| Name | identity_group_users |
| Type | Resource |
| Id | ovh.me.identity_group_users |
Fields​
The following fields are returned by SELECT queries:
- list
| Name | Datatype | Description |
|---|---|---|
value | string |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | group | List the users of this group | |
create | insert | group | Add a user to the group | |
delete | delete | group, user | Remove a user from the 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 |
user | string | User |
SELECT examples​
- list
List the users of this group
SELECT
value
FROM ovh.me.identity_group_users
WHERE group = '{{ group }}' -- required
;
INSERT examples​
- create
- Manifest
Add a user to the group
INSERT INTO ovh.me.identity_group_users (
user,
group
)
SELECT
'{{ user }}',
'{{ group }}'
;
# Description fields are for documentation purposes
- name: identity_group_users
props:
- name: group
value: "{{ group }}"
description: Required parameter for the identity_group_users resource.
- name: user
value: "{{ user }}"
description: |
Username to add to the group
DELETE examples​
- delete
Remove a user from the group
DELETE FROM ovh.me.identity_group_users
WHERE group = '{{ group }}' --required
AND user = '{{ user }}' --required
;