Credentials
sim credentials is also spelled sim credential.
Every command below also accepts the global options.
Disconnect credential
sim credentials delete <credentialId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Credential to disconnect. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
List credential providers
sim credentials providers list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the credential provider name. |
List credentials
sim credentials list [options]Options
| Option | Required | Description |
|---|---|---|
--type <value> | No | Restrict results to this credential type. Accepted values: oauth, service_account. |
--provider-id <value> | No | Restrict results to credentials for this integration provider. |
--search <value> | No | Case-insensitive substring match against the credential display name. |
--sort-by <value> | No | Field used to sort the result. Accepted values: displayName, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
Create a service-account credential using its discovered provider schema
sim credentials create <providerId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
providerId | Yes | Service-account provider to create a credential for |
Options
| Option | Required | Description |
|---|---|---|
--name <displayName> | Yes | Name shown for the credential in Sim. |
--credentials <json|@file> | Yes | Provider credentials as JSON (or @path / @- to read a file or stdin). |
--description <description> | No | Optional credential description. |
--id <credentialId> | No | Client-generated credential ID when provider discovery requires it. |
Create a short-lived link for connecting an OAuth provider
sim credentials connect <providerId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
providerId | Yes | OAuth provider to connect |
Options
| Option | Required | Description |
|---|---|---|
--name <displayName> | Yes | Name shown for the new credential in Sim. |
Create a short-lived link for reconnecting an OAuth credential
sim credentials reconnect <credentialId>Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Existing OAuth credential to re-authorize |