sim credentials is also spelled sim credential.
Every command below also accepts the global options.
Disconnect credential
sim credentials delete <credentialId> [options]Disconnect Credential (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Credential to disconnect. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
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 0. |
Update credential
sim credentials update <credentialId> [options]Update Credential (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Credential to update. |
Options
| Option | Required | Description |
|---|---|---|
--display-name <value> | No | New name shown for the credential in Sim. |
--description <value> | No | New credential description. Send null to clear the stored one. (--description null sends the word, not JSON null). |
--service-account-json <value> | No | Write-only Google service-account JSON key. |
--api-token <value> | No | Write-only provider API token. |
--domain <value> | No | Provider account domain. |
--atlassian-product <value> | No | Atlassian product to verify; defaults to Jira on create and preserves the saved product on reconnect. Accepted values: jira, confluence. |
--signing-secret <value> | No | Write-only webhook signing secret. |
--bot-token <value> | No | Write-only bot token. |
--client-id <value> | No | OAuth client identifier. |
--client-secret <value> | No | Write-only OAuth client secret. |
--certificate-id <value> | No | Provider certificate mapping identifier. |
--org-id <value> | No | Provider organization ID. |
--data-center <value> | No | Provider data center. |
--auth-method <value> | No | Provider authentication method. |
--private-key <value> | No | Write-only PEM private key. |
--username <value> | No | Provider run-as username. |
--name <displayName> | No | Alias for --display-name. |
Create a service-account credential using its discovered provider schema
sim credentials create <providerId> [options]Create a service-account credential using its discovered provider schema (OAuth login or personal API key required)
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]Create a short-lived link for connecting an OAuth provider (OAuth login or personal API key required)
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>Create a short-lived link for reconnecting an OAuth credential (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Existing OAuth credential to re-authorize |