Skip to content
Try for free
On this page

Commands

Credentials

Discover providers, connect accounts, and manage credential access.

Run sim --output json credentials providers list to inspect the provider’s fields and authentication requirements before creating a service-account credential. OAuth connection commands return a link that a person must open to authorize the connection.

sim credentials is also spelled sim credential.

These commands accept the global options.

Provider discovery and connections

List credential providers

Code
sim credentials providers list [options]

Options

OptionRequiredDescription
--search <value>NoCase-insensitive substring match against the credential provider name.

API request and response schemas: listCredentialProviders.

List credentials

Code
sim credentials list [options]

Options

OptionRequiredDescription
--type <value>NoRestrict results to this credential type. Accepted values: oauth, service_account.
--provider-id <value>NoRestrict results to credentials for this integration provider.
--search <value>NoCase-insensitive substring match against the credential display name.
--sort-by <value>NoField used to sort the result. Defaults to "createdAt". Accepted values: displayName, createdAt, updatedAt.
--sort-order <value>NoSort direction. Defaults to "desc". Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 0.

API request and response schemas: listCredentials.

Create a service-account credential using its discovered provider schema

OAuth login or personal API key required.

Code
sim credentials create <providerId> [options]

Arguments

ArgumentRequiredDescription
providerIdYesService-account provider to create a credential for

Options

OptionRequiredDescription
--name <displayName>YesName shown for the credential in Sim.
--credentials <json|@file>YesProvider credentials as JSON (or @path / @- to read a file or stdin).
--description <description>NoOptional credential description.
--id <credentialId>NoClient-generated credential ID when provider discovery requires it.

API request and response schemas: createServiceAccountCredential.

Create a short-lived link for connecting an OAuth provider

OAuth login or personal API key required.

Code
sim credentials connect <providerId> [options]

Arguments

ArgumentRequiredDescription
providerIdYesOAuth provider to connect

Options

OptionRequiredDescription
--name <displayName>YesName shown for the new credential in Sim.

API request and response schemas: createCredentialConnection.

Create a short-lived link for reconnecting an OAuth credential

OAuth login or personal API key required.

Code
sim credentials reconnect <credentialId>

Arguments

ArgumentRequiredDescription
credentialIdYesExisting OAuth credential to re-authorize

API request and response schemas: createCredentialConnection.

Update credential

OAuth login or personal API key required.

Code
sim credentials update <credentialId> [options]

Arguments

ArgumentRequiredDescription
credentialIdYesCredential to update.

Options

OptionRequiredDescription
--display-name <value>NoNew name shown for the credential in Sim.
--description <value>NoNew credential description. Send null to clear the stored one. (--description null sends the word, not JSON null).
--service-account-json <value>NoWrite-only provider service-account JSON configuration, including Oracle Database connection fields.
--api-token <value>NoWrite-only provider API token.
--domain <value>NoProvider account domain.
--atlassian-product <value>NoAtlassian product to verify; defaults to Jira on create and preserves the saved product on reconnect. Accepted values: jira, confluence.
--signing-secret <value>NoWrite-only webhook signing secret.
--bot-token <value>NoWrite-only bot token.
--client-id <value>NoOAuth client identifier.
--client-secret <value>NoWrite-only OAuth client secret.
--certificate-id <value>NoProvider certificate mapping identifier.
--org-id <value>NoProvider organization ID.
--data-center <value>NoProvider data center.
--scope <value>NoProvider permissions; preserved on reconnect when omitted.
--auth-method <value>NoProvider authentication method.
--private-key <value>NoWrite-only PEM private key.
--username <value>NoProvider run-as username.
--tenancy-ocid <value>NoOCI tenancy OCID.
--user-ocid <value>NoOCI user OCID.
--fingerprint <value>NoOCI API-key fingerprint.
--private-key-passphrase <value>NoWrite-only OCI private-key passphrase.
--region <value>NoOCI home region.
--name <displayName>NoAlias for --display-name.

API request and response schemas: updateCredential.

Credential members

List credential members

OAuth login or personal API key required.

Code
sim credentials members list <credentialId> [options]

Arguments

ArgumentRequiredDescription
credentialIdYesCredential whose sharing grants are managed.

Options

OptionRequiredDescription
--limit <n>NoMaximum items to return (0 for everything). Defaults to 0.
--sort-by <value>NoField used to sort the result. Do not rely on case-insensitive ordering when sorting by name. Defaults to "email". Accepted values: email, name.
--sort-order <value>NoSort direction. Defaults to "asc". Accepted values: asc, desc.

API request and response schemas: listCredentialMembers.

Upsert credential member

OAuth login or personal API key required.

Code
sim credentials members upsert <credentialId> [options]

Arguments

ArgumentRequiredDescription
credentialIdYesCredential whose sharing grants are managed.

Options

OptionRequiredDescription
--user <value>YesExisting workspace member to grant or change access for.
--role <value>YesCredential role to grant; workspace administrators cannot be demoted. Accepted values: admin, member.

API request and response schemas: upsertCredentialMember.

Remove credential member

OAuth login or personal API key required.

This revokes the selected user’s explicit credential grant.

Code
sim credentials members remove <credentialId> <userId> [options]

Arguments

ArgumentRequiredDescription
credentialIdYesCredential whose sharing grants are managed.
userIdYesUser whose explicit grant will be revoked.

Options

OptionRequiredDescription
-y, --yesYesConfirm this operation.

API request and response schemas: removeCredentialMember.

Disconnect credentials

Disconnect credential

OAuth login or personal API key required.

This disconnects the credential and removes its stored authentication.

Code
sim credentials delete <credentialId> [options]

Arguments

ArgumentRequiredDescription
credentialIdYesCredential to disconnect.

Options

OptionRequiredDescription
-y, --yesYesConfirm this operation.

API request and response schemas: deleteCredential.

Related docs

Was this helpful?
Suggest an edit