Cloud Workload Identity and Delegated Entities
On this page
Note
This is a Preview feature.
Cloud Workload Identity and delegated entities are currently only available for workspaces deployed on AWS.
Cloud Workload Identity represents a set of additional components (or resources) that are provisioned for each workspace.
Note
Cloud workload identity is unique to a workspace group.
Delegated entities are customer-owned AWS IAM roles that a workspace's cloud workload entity is allowed to assume.
Configure Delegated Entities
To access cloud resources using cloud workload identity, perform the following tasks:
Note
You can configure a maximum of 20 delegated entities for each workspace group.
You can get the cloud workload identity and configure delegated entities using either the Cloud Portal or the Management API.
Get the Cloud Workload Identity ARN for your Workspace
The cloud workload identity value is the IAM role ARN of your workspace, for example: arn:aws:iam::0000000000:role/xxxxxxxxxxxxxx.
Using the Cloud Portal
-
Log in to the Cloud Portal.
-
Select <your_
deployment> > Security. -
Copy the cloud workload identity ARN of your SingleStore workspace specified under Delegated Entities > Configure trust relationship.
Using the Management API
Use the Identity path (/v1/workspaces/{workspaceID}/identity endpoint) in the Management API to obtain the cloud workload identity ARN of your SingleStore workspace.
curl -X 'GET' \'https://api.singlestore.com/v1/workspaces/xxxx/identity/' \-H 'accept: application/json'
Refer to Management API and Management API Reference for related information.
Configure an IAM Role in your AWS Account
To use delegated entities, configure an IAM role in your AWS account that the workspace's cloud workload identity can assume.
-
Create an IAM role in your AWS account with the necessary privileges.
You can also use an existing IAM role. -
Update the IAM role's trust policy to allow the workspace's cloud workload identity to assume the role.
Specify the cloud workload identity ARN of your workspace copied earlier. For example: {"Version": "2012-10-17","Statement": [{"Effect": "Allow","Principal": {"AWS": "<workspace_cloud_workload_identity_arn>"},"Action": "sts:AssumeRole"}]}
Add Delegated Entities
Add delegated entities to your workspace.
Using the Cloud Portal
-
Log in to the Cloud Portal.
-
Select <your_
deployment> > Security. -
Under the Delegated Entities section, select Add Entity.
-
Add the ARN of your IAM role to the delegated entities list.
You can also enter a role ARN pattern to match multiple roles that share a common naming pattern, such as arn:aws:iam::987654321098:role/singlestore-*.Patterns provide a flexible mechanism to configure delegated entities. -
Save the configuration.
Using the Management API
Use the Delegated Entities path (/v1/workspaces/{workspaceID}/delegatedEntities endpoint) in the Management API to add one or more delegated entities (ARN of your IAM role) to the workspace.
Note
Adding delegated entities at the workspace level also updates the delegated entities for the workspace group that contains it.
You can also view and delete the delegated entities for a workspace.
Last modified: January 28, 2026