Skip to content

Commit f882882

Browse files
committed
docs(credentials): fix keyless setup instructions and copy
- AWS: enter the Role ARN before setting the trust policy, so it never carries the <AWS_ACCOUNT_ID> placeholder IAM rejects (dialog hint and docs). - Databricks: the federation-policy command needs an account-level CLI login. - Google: a valid sample pool ID, ID format hints, user-managed service accounts only, skip the pool command when the pool exists, and the API list from Google's guide (adds Resource Manager). - Bitbucket: workspace and project access tokens need Premium; repository tokens do not. - Snowflake: rename SIM_WORKFLOWS if it exists; USERADMIN runs the statement. - Microsoft keyless dialog says where the federated credential goes. - Server errors name the trust values for API and CLI callers too; Google Workspace and Account ID wording; AWS catalog hint mentions stsRegion; the CLI keyless example uses aws-service-account throughout. - Self-hosting env vars list every keyless provider.
1 parent 2206138 commit f882882

23 files changed

Lines changed: 55 additions & 41 deletions

‎apps/docs/content/docs/cli/credentials.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,9 @@ The proof expires after 24 hours and works only for the user who requested it, w
100100
**Examples**
101101

102102
```bash
103-
sim credentials keyless-subject <providerId> --output json > subject.json
103+
sim credentials keyless-subject aws-service-account --output json > subject.json
104104
jq '.keylessConfig + {"roleArn":"arn:aws:iam::123456789012:role/SimWorkflows"}' subject.json > keyless.json
105-
sim credentials create <providerId> --name "Keyless" --credentials @keyless.json
105+
sim credentials create aws-service-account --name "Keyless" --credentials @keyless.json
106106
```
107107

108108
API request and response schemas: [createServiceAccountCredential](/api-reference/credentials/createServiceAccountCredential).
@@ -373,9 +373,9 @@ The proof expires after 24 hours and works only for the user who requested it, w
373373
**Examples**
374374

375375
```bash
376-
sim credentials keyless-subject <providerId> --output json > subject.json
376+
sim credentials keyless-subject aws-service-account --output json > subject.json
377377
jq '.keylessConfig + {"roleArn":"arn:aws:iam::123456789012:role/SimWorkflows"}' subject.json > keyless.json
378-
sim credentials create <providerId> --name "Keyless" --credentials @keyless.json
378+
sim credentials create aws-service-account --name "Keyless" --credentials @keyless.json
379379
```
380380

381381
API request and response schemas: [createCredentialWorkloadIdentitySubject](/api-reference/credentials/createCredentialWorkloadIdentitySubject).

‎apps/docs/content/docs/cli/reference.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -786,9 +786,9 @@ The proof expires after 24 hours and works only for the user who requested it, w
786786
**Examples**
787787

788788
```bash
789-
sim credentials keyless-subject <providerId> --output json > subject.json
789+
sim credentials keyless-subject aws-service-account --output json > subject.json
790790
jq '.keylessConfig + {"roleArn":"arn:aws:iam::123456789012:role/SimWorkflows"}' subject.json > keyless.json
791-
sim credentials create <providerId> --name "Keyless" --credentials @keyless.json
791+
sim credentials create aws-service-account --name "Keyless" --credentials @keyless.json
792792
```
793793

794794
API request and response schemas: [createServiceAccountCredential](/api-reference/credentials/createServiceAccountCredential).
@@ -822,9 +822,9 @@ The proof expires after 24 hours and works only for the user who requested it, w
822822
**Examples**
823823

824824
```bash
825-
sim credentials keyless-subject <providerId> --output json > subject.json
825+
sim credentials keyless-subject aws-service-account --output json > subject.json
826826
jq '.keylessConfig + {"roleArn":"arn:aws:iam::123456789012:role/SimWorkflows"}' subject.json > keyless.json
827-
sim credentials create <providerId> --name "Keyless" --credentials @keyless.json
827+
sim credentials create aws-service-account --name "Keyless" --credentials @keyless.json
828828
```
829829

830830
API request and response schemas: [createCredentialWorkloadIdentitySubject](/api-reference/credentials/createCredentialWorkloadIdentitySubject).

‎apps/docs/content/docs/integrations/aws-credentials.mdx‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,13 @@ STS **Get Session Token** works only with an **Access keys** credential: AWS ref
3636
In the AWS IAM console, open **Identity providers → Add provider**, choose **OpenID Connect**, and enter the dialog's **Issuer** as the **Provider URL**, and its **Audience**. You only do this once per AWS account.
3737
</Step>
3838
<Step>
39-
Create a role (or edit an existing one) and set its trust policy to the **Role trust policy** shown in the dialog. It trusts only this credential's **Subject**, so no other Sim credential, workspace, or customer can assume the role.
39+
Enter the role's ARN (`arn:aws:iam::<account ID>:role/<role name>`) in the dialog first. The **Role trust policy** fills in its account ID; until then it shows `<AWS_ACCOUNT_ID>`, which IAM rejects.
4040
</Step>
4141
<Step>
42-
Attach the permissions your workflows need to the role, then paste its ARN into the dialog and save. Sim verifies the connection by assuming the role before saving it, and refuses a role that would also trust a different subject.
42+
Create the role with that name (or edit the existing one) and set its trust policy to the **Role trust policy** shown in the dialog. It trusts only this credential's **Subject**, so no other Sim credential, workspace, or customer can assume the role.
43+
</Step>
44+
<Step>
45+
Attach the permissions your workflows need to the role, then save. Sim verifies the connection by assuming the role before saving it, and refuses a role that would also trust a different subject.
4346
</Step>
4447
</Steps>
4548

‎apps/docs/content/docs/integrations/bitbucket-service-account.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Bitbucket shows actions taken with the token (comments, merges, pipeline runs) u
1212

1313
## Prerequisites
1414

15-
Admin access to the workspace, project, or repository the token is for. Workspace access tokens require a Bitbucket Cloud Premium plan; project and repository access tokens do not.
15+
Admin access to the workspace, project, or repository the token is for. Workspace and project access tokens require a Bitbucket Cloud Premium plan; repository access tokens do not.
1616

1717
## Create the access token [#creating-the-access-token]
1818

‎apps/docs/content/docs/integrations/databricks-credentials.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Every option resolves on Sim's servers at run time; tokens never appear in block
2929
In Sim, add a **Databricks connection**, choose **Service principal (keyless, via Sim OIDC)**, and enter the workspace host and the service principal's **application ID**.
3030
</Step>
3131
<Step>
32-
A Databricks account admin runs the **Federation policy** command from the dialog with the service principal's numeric ID (find it with `databricks account service-principals list --filter 'applicationId eq "<application ID>"'`, or on the service principal's page in the account console). The policy trusts Sim's issuer, the Sim audience, and this connection's subject only.
32+
A Databricks account admin runs the **Federation policy** command from the dialog with the service principal's numeric ID. First sign in to the account with `databricks auth login --host <account console URL> --account-id <account ID>` (not a workspace profile or the workspace web terminal). Find the numeric ID with `databricks account service-principals list --filter 'applicationId eq "<application ID>"'`, or on the service principal's page in the account console. The policy trusts Sim's issuer, the Sim audience, and this connection's subject only.
3333
</Step>
3434
<Step>
3535
Make sure the service principal can access the workspace and the resources your workflows use, then save. Sim verifies the connection by exchanging a token and reading the service principal's identity, and refuses a policy that would also trust a different subject, since every Sim workspace shares the issuer and audience.

‎apps/docs/content/docs/integrations/google-service-account.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,16 +185,16 @@ Keyless credentials work with Google Cloud APIs that the service account calls a
185185

186186
<Steps>
187187
<Step>
188-
In the [Google Cloud Console](https://console.cloud.google.com/), enable the IAM, Service Account Credentials, and Security Token Service APIs in the project that will hold the workload identity pool, and note its **project number** (on the project's Dashboard; it's numeric, not the project ID).
188+
In the [Google Cloud Console](https://console.cloud.google.com/), enable the IAM, Resource Manager, Service Account Credentials, and Security Token Service APIs in the project that will hold the workload identity pool, and note its **project number** (on the project's Dashboard; it's numeric, not the project ID).
189189
</Step>
190190
<Step>
191191
Create or pick a service account, and grant it the roles your workflows need (for example, BigQuery Data Viewer and BigQuery Job User, or Vertex AI User). No key is needed.
192192
</Step>
193193
<Step>
194-
In Sim, open the **Google BigQuery** integration, choose **Add service account**, and set **Authentication** to **Workload Identity Federation (keyless, via Sim OIDC)**. Enter the project number, a pool ID and provider ID (4 to 32 lowercase letters, digits, or hyphens, not starting with `gcp-`), and the service account email (`name@project-id.iam.gserviceaccount.com`).
194+
In Sim, open the **Google BigQuery** integration, choose **Add service account**, and set **Authentication** to **Workload Identity Federation (keyless, via Sim OIDC)**. Enter the project number, a pool ID and provider ID (4 to 32 lowercase letters, digits, or hyphens, not starting with `gcp-`), and the service account email (`name@project-id.iam.gserviceaccount.com`; user-managed service account only, so default accounts such as `…@developer.gserviceaccount.com` are refused).
195195
</Step>
196196
<Step>
197-
The dialog shows the **Issuer**, **Audience**, and **Subject**, and three `gcloud` commands with your values filled in. Run them in that project. They run against the project number you entered and create the pool, an OIDC provider for Sim's issuer with the attribute mapping `google.subject=assertion.sub` and an attribute condition that accepts only this credential's subject, and grant that subject `roles/iam.workloadIdentityUser` on the service account:
197+
The dialog shows the **Issuer**, **Audience**, and **Subject**, and three `gcloud` commands with your values filled in. Run them in that project. They run against the project number you entered and create the pool, an OIDC provider for Sim's issuer with the attribute mapping `google.subject=assertion.sub` and an attribute condition that accepts only this credential's subject, and grant that subject `roles/iam.workloadIdentityUser` on the service account. If the pool already exists, skip the first command:
198198

199199
```bash
200200
gcloud iam workload-identity-pools create POOL_ID \

‎apps/docs/content/docs/integrations/snowflake-service-account.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Snowflake's [workload identity federation](https://docs.snowflake.com/en/user-gu
2424
In Sim, add a **Snowflake** connection, choose **Service user (keyless, via Sim OIDC)**, and enter the account host (`myorg-myaccount.snowflakecomputing.com`). The dialog shows the issuer, audience, and subject for this connection, and the statement to run.
2525
</Step>
2626
<Step>
27-
A user whose role can create users (and has `OWNERSHIP` or `MODIFY PROGRAMMATIC AUTHENTICATION METHODS` on the user) runs the statement from the dialog. It looks like this:
27+
A user whose role can create users (for example USERADMIN) runs the statement from the dialog. Rename the user if SIM_WORKFLOWS already exists. It looks like this:
2828

2929
```sql
3030
CREATE USER SIM_WORKFLOWS

‎apps/docs/content/docs/platform/self-hosting/environment-variables.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ OAuth integrations require a provider application and its credentials on a self-
162162

163163
### Keyless cloud credentials [#workload-identity]
164164

165-
Saved AWS and Databricks credentials can trust Sim through OpenID Connect instead of storing keys. Leave these unset to offer only key- and secret-based credentials.
165+
Saved AWS, Databricks, Snowflake, Microsoft app, and Google Cloud credentials can trust Sim through OpenID Connect instead of storing keys. Leave these unset to offer only key- and secret-based credentials.
166166

167167
| Variable | Description |
168168
| --- | --- |

‎apps/docs/scripts/fixtures/content-baseline.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3016,7 +3016,7 @@
30163016
{
30173017
"lang": "bash",
30183018
"meta": null,
3019-
"sha256": "e7dfe3c54d5966f79a4c8fcc7287fe9c29e893326977e4264a7cdc35822c076f",
3019+
"sha256": "48d4019bc1905094aec776873af1d5a4e94ec2f52d043c51bbbb559b6a876944",
30203020
"bytes": 262,
30213021
"line": 102
30223022
},
@@ -3079,7 +3079,7 @@
30793079
{
30803080
"lang": "bash",
30813081
"meta": null,
3082-
"sha256": "e7dfe3c54d5966f79a4c8fcc7287fe9c29e893326977e4264a7cdc35822c076f",
3082+
"sha256": "48d4019bc1905094aec776873af1d5a4e94ec2f52d043c51bbbb559b6a876944",
30833083
"bytes": 262,
30843084
"line": 375
30853085
}
@@ -11190,7 +11190,7 @@
1119011190
{
1119111191
"lang": "bash",
1119211192
"meta": null,
11193-
"sha256": "e7dfe3c54d5966f79a4c8fcc7287fe9c29e893326977e4264a7cdc35822c076f",
11193+
"sha256": "48d4019bc1905094aec776873af1d5a4e94ec2f52d043c51bbbb559b6a876944",
1119411194
"bytes": 262,
1119511195
"line": 788
1119611196
},
@@ -11204,7 +11204,7 @@
1120411204
{
1120511205
"lang": "bash",
1120611206
"meta": null,
11207-
"sha256": "e7dfe3c54d5966f79a4c8fcc7287fe9c29e893326977e4264a7cdc35822c076f",
11207+
"sha256": "48d4019bc1905094aec776873af1d5a4e94ec2f52d043c51bbbb559b6a876944",
1120811208
"bytes": 262,
1120911209
"line": 824
1121011210
},

‎apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/aws-account-modal.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ function AwsAccountForm({
259259
<ChipModalField
260260
type='custom'
261261
title='Role trust policy'
262-
hint='Add the issuer and audience above as an IAM identity provider (once per AWS account), set this as the role’s trust policy, then grant the role the permissions your workflows need.'
262+
hint='Enter the Role ARN first; the policy fills in its account ID. Add the issuer and audience above as an IAM identity provider (once per AWS account), set this as the role’s trust policy, then grant the role the permissions your workflows need.'
263263
>
264264
{(aria) => (
265265
<ChipTextarea

0 commit comments

Comments
 (0)