opensearch_users

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

Overview

Name	opensearch_users
Type	Resource
Id	ovh.public_cloud_analytics.opensearch_users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the user
acls	array	ACL entries granted to the user
admin	boolean	Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the user was created (wire: createdAt)
credentials_last_updated_at	string (date-time)	Date at which the user credentials were last updated (wire: credentialsLastUpdatedAt)
password	string (password)	Password of the user. Returned only on creation or password reset.
status	string	Current readiness status of the user (CREATING, DELETING, ERROR, READY, UPDATING)
username	string	Login name of the user

list

A user account on a managed OpenSearch service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the user
acls	array	ACL entries granted to the user
admin	boolean	Whether this is the service administrator, the user created automatically at provisioning time, which cannot be deleted
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the user was created (wire: createdAt)
credentials_last_updated_at	string (date-time)	Date at which the user credentials were last updated (wire: credentialsLastUpdatedAt)
password	string (password)	Password of the user. Returned only on creation or password reset.
status	string	Current readiness status of the user (CREATING, DELETING, ERROR, READY, UPDATING)
username	string	Login name of the user

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_id, user_id, project_id		Returns the user, its ACL entries and its status. The password is not returned. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the users of the service with their ACL entries and status. Passwords are not returned. (Beta version)
create	insert	service_id, project_id, name		Creates a user with ACL entries, each granting a permission on an index pattern. The generated password is returned only on creation and on password reset. (Beta version)
update	update	service_id, user_id, project_id		Partially updates the ACL entries of the user. The ACL list replaces the current entries. Setting credentialsLastUpdatedAt resets the password and returns the new one. (Beta version)
delete	delete	service_id, user_id, project_id		Permanently deletes the user. (Beta version)
replace	exec	serviceId, userId, project_id, acls		Updates the ACL entries of the user. The ACL list replaces the current entries. To reset the password, use the resetPassword route of the user or a partial update with credentialsLastUpdatedAt. (Beta version)
reset_password	exec	serviceId, userId, project_id		Generates a new password for the user and returns it in the response. Reading the user never returns it. The previous password stops working once the new one is applied, and credentialsLastUpdatedAt becomes the date of this reset. This is the same reset as a partial update of the user that sets credentialsLastUpdatedAt. (Beta version)

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"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
serviceId	string (uuid)	Service ID
service_id	string (uuid)	Service ID (wire: serviceId)
userId	string (uuid)	User ID
user_id	string (uuid)	User ID (wire: userId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the user, its ACL entries and its status. The password is not returned. (Beta version)

SELECT
id,
acls,
admin,
checksum,
created_at,
credentials_last_updated_at,
password,
status,
username
FROM ovh.public_cloud_analytics.opensearch_users
WHERE service_id = '{{ service_id }}' -- required
AND user_id = '{{ user_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the users of the service with their ACL entries and status. Passwords are not returned. (Beta version)

SELECT
id,
acls,
admin,
checksum,
created_at,
credentials_last_updated_at,
password,
status,
username
FROM ovh.public_cloud_analytics.opensearch_users
WHERE service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Creates a user with ACL entries, each granting a permission on an index pattern. The generated password is returned only on creation and on password reset. (Beta version)

INSERT INTO ovh.public_cloud_analytics.opensearch_users (
acls,
name,
service_id,
project_id
)
SELECT 
'{{ acls }}',
'{{ name }}' /* required */,
'{{ service_id }}',
'{{ project_id }}'
RETURNING
id,
acls,
admin,
checksum,
created_at,
credentials_last_updated_at,
password,
status,
username
;

Manifest

# Description fields are for documentation purposes
- name: opensearch_users
props:
  - name: service_id
    value: "{{ service_id }}"
    description: Required parameter for the opensearch_users resource.
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the opensearch_users resource.
  - name: acls
    description: |
      ACL entries to grant to the user
    value:
      - pattern: "{{ pattern }}"
        permission: "{{ permission }}"
  - name: name
    value: "{{ name }}"
    description: |
      Login name of the new user

UPDATE examples

update

Partially updates the ACL entries of the user. The ACL list replaces the current entries. Setting credentialsLastUpdatedAt resets the password and returns the new one. (Beta version)

UPDATE ovh.public_cloud_analytics.opensearch_users
SET 
acls = '{{ acls }}',
credentials_last_updated_at = '{{ credentials_last_updated_at }}'
WHERE 
service_id = '{{ service_id }}' --required
AND user_id = '{{ user_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
RETURNING
id,
acls,
admin,
checksum,
created_at,
credentials_last_updated_at,
password,
status,
username;

DELETE examples

delete

Permanently deletes the user. (Beta version)

DELETE FROM ovh.public_cloud_analytics.opensearch_users
WHERE service_id = '{{ service_id }}' --required
AND user_id = '{{ user_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

replace

Updates the ACL entries of the user. The ACL list replaces the current entries. To reset the password, use the resetPassword route of the user or a partial update with credentialsLastUpdatedAt. (Beta version)

EXEC ovh.public_cloud_analytics.opensearch_users.replace 
@serviceId='{{ serviceId }}' --required, 
@userId='{{ userId }}' --required, 
@project_id='{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"acls": "{{ acls }}"
}'
;

reset_password

Generates a new password for the user and returns it in the response. Reading the user never returns it. The previous password stops working once the new one is applied, and credentialsLastUpdatedAt becomes the date of this reset. This is the same reset as a partial update of the user that sets credentialsLastUpdatedAt. (Beta version)

EXEC ovh.public_cloud_analytics.opensearch_users.reset_password 
@serviceId='{{ serviceId }}' --required, 
@userId='{{ userId }}' --required, 
@project_id='{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;