role_permissions

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

Overview

Name	role_permissions
Type	Resource
Id	ovh.dbaas_logs.role_permissions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
alias_id	string (uuid)	Associated Elasticsearch alias (wire: aliasId)
dashboard_id	string (uuid)	Associated Graylog dashboard (wire: dashboardId)
index_id	string (uuid)	Associated Elasticsearch index (wire: indexId)
osd_id	string (uuid)	Associated OpenSearch Dashboards instance (wire: osdId)
permission_id	string (uuid)	Permission ID (wire: permissionId)
stream_id	string (uuid)	Associated Graylog stream (wire: streamId)
permission_type	string	Permission type (READ_ONLY, READ_WRITE) (wire: permissionType)

list

Role permission

Name	Datatype	Description
alias_id	string (uuid)	Associated Elasticsearch alias (wire: aliasId)
dashboard_id	string (uuid)	Associated Graylog dashboard (wire: dashboardId)
index_id	string (uuid)	Associated Elasticsearch index (wire: indexId)
osd_id	string (uuid)	Associated OpenSearch Dashboards instance (wire: osdId)
permission_id	string (uuid)	Permission ID (wire: permissionId)
stream_id	string (uuid)	Associated Graylog stream (wire: streamId)
permission_type	string	Permission type (READ_ONLY, READ_WRITE) (wire: permissionType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	permission_id, role_id, service_name		Returns the role permission. (Deprecated, will be removed)
list	select	role_id, service_name	x_pagination_mode	Returns the role permissions of the Logs Data Platform service. (Deprecated, will be removed)
delete	delete	permission_id, role_id, service_name		Deletes the role permission. (Deprecated, will be removed)
alias	exec	roleId, serviceName, aliasId		Grants the role permission on an alias. (Deprecated, will be removed)
dashboard	exec	roleId, serviceName, dashboardId		Grants the role permission on a dashboard. (Deprecated, will be removed)
index	exec	roleId, serviceName, indexId		Grants the role permission on an index. (Deprecated, will be removed)
osd	exec	roleId, serviceName, osdId		Grants the role permission on an OpenSearch Dashboards instance. (Deprecated, will be removed)
stream	exec	roleId, serviceName, streamId		Grants the role permission on a data stream. (Deprecated, will be removed)

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"}})
permission_id	string (uuid)	Permission ID (wire: permissionId)
roleId	string (uuid)	Role ID
role_id	string (uuid)	Role ID (wire: roleId)
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
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

Returns the role permission. (Deprecated, will be removed)

SELECT
alias_id,
dashboard_id,
index_id,
osd_id,
permission_id,
stream_id,
permission_type
FROM ovh.dbaas_logs.role_permissions
WHERE permission_id = '{{ permission_id }}' -- required
AND role_id = '{{ role_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the role permissions of the Logs Data Platform service. (Deprecated, will be removed)

SELECT
alias_id,
dashboard_id,
index_id,
osd_id,
permission_id,
stream_id,
permission_type
FROM ovh.dbaas_logs.role_permissions
WHERE role_id = '{{ role_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Deletes the role permission. (Deprecated, will be removed)

DELETE FROM ovh.dbaas_logs.role_permissions
WHERE permission_id = '{{ permission_id }}' --required
AND role_id = '{{ role_id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

alias

Grants the role permission on an alias. (Deprecated, will be removed)

EXEC ovh.dbaas_logs.role_permissions.alias 
@roleId='{{ roleId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"aliasId": "{{ aliasId }}"
}'
;

dashboard

Grants the role permission on a dashboard. (Deprecated, will be removed)

EXEC ovh.dbaas_logs.role_permissions.dashboard 
@roleId='{{ roleId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"dashboardId": "{{ dashboardId }}", 
"permissionType": "{{ permissionType }}"
}'
;

index

Grants the role permission on an index. (Deprecated, will be removed)

EXEC ovh.dbaas_logs.role_permissions.index 
@roleId='{{ roleId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"indexId": "{{ indexId }}", 
"permissionType": "{{ permissionType }}"
}'
;

osd

Grants the role permission on an OpenSearch Dashboards instance. (Deprecated, will be removed)

EXEC ovh.dbaas_logs.role_permissions.osd 
@roleId='{{ roleId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"osdId": "{{ osdId }}", 
"permissionType": "{{ permissionType }}"
}'
;

stream

Grants the role permission on a data stream. (Deprecated, will be removed)

EXEC ovh.dbaas_logs.role_permissions.stream 
@roleId='{{ roleId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"streamId": "{{ streamId }}"
}'
;