Files
elasticsearch-js/docs/reference/api/SecurityRoleDescriptorRead.md
2025-05-28 10:02:30 -05:00

1.8 KiB

SecurityRoleDescriptorRead [interface-SecurityRoleDescriptorRead]

Name Type Description
applications SecurityApplicationPrivileges[] A list of application privilege entries
cluster SecurityClusterPrivilege[] A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.
description string An optional description of the role descriptor.
global SecurityGlobalPrivilege[] SecurityGlobalPrivilege
index SecurityIndicesPrivileges[] A list of indices permissions entries. indices
indices SecurityIndicesPrivileges[] A list of indices permissions entries.
metadata Metadata Optional meta-data. Within the metadata object, keys that begin with _ are reserved for system usage.
remote_cluster SecurityRemoteClusterPrivileges[] A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions.
remote_indices SecurityRemoteIndicesPrivileges[] A list of indices permissions for remote clusters.
restriction SecurityRestriction A restriction for when the role descriptor is allowed to be effective.
run_as string[] A list of users that the API keys can impersonate.
transient_metadata Record<string, any>