Organizations

These commands accept the global options.

Organizations and workspaces

List organizations

OAuth login or personal API key required.

Code

sim organizations list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the organization name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listOrganizations.

Get organization

OAuth login or personal API key required.

Code

sim organizations get <organizationId>

Arguments

Argument	Required	Description
`organizationId`	Yes	Organization identifier.

API request and response schemas: getOrganization.

List organization workspaces

OAuth login or personal API key required.

Code

sim organizations workspaces [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against the workspace name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `id`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listOrganizationWorkspaces.

Members and credit limits

List organization members

OAuth login or personal API key required.

Code

sim organizations members list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against member name or email.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `email`, `joinedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listOrganizationMembers.

Get organization member credit limit

OAuth login or personal API key required.

Code

sim organizations members usage-limit get <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User ID of an organization member or external collaborator with workspace access in this organization. Use List Organization Members or List Workspace Members to find it.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getOrganizationMemberUsageLimit.

Update organization member

OAuth login or personal API key required.

Code

sim organizations members update <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User identifier of the organization member.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--role <value>`	Yes	New organization role. Ownership transfers use a separate operation. Accepted values: `member`, `admin`.

API request and response schemas: updateOrganizationMember.

Update organization member credit limit

OAuth login or personal API key required.

Code

sim organizations members usage-limit update <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User ID of an organization member or external collaborator with workspace access in this organization. Use List Organization Members or List Workspace Members to find it.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--credit-limit <number\|null>`	Yes	Credit cap for this person. Send null to clear the cap or 0 to prevent further credit-consuming usage. Organization limits still apply.

API request and response schemas: updateOrganizationMemberUsageLimit.

Remove organization member

OAuth login or personal API key required.

This removes the member, revokes their organization workspace access, and ends their sessions.

Code

sim organizations members remove <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User identifier of the organization member.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: removeOrganizationMember.

Invitations

List organization invitations

OAuth login or personal API key required.

Code

sim organizations invitations list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against the invitee email.
`--status <value>`	No	Filter by current invitation status. Omit to include all statuses. Accepted values: `pending`, `accepted`, `rejected`, `cancelled`, `expired`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `email`, `createdAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

API request and response schemas: listOrganizationInvitations.

Get organization invitation

OAuth login or personal API key required.

Code

sim organizations invitations get <invitationId> [options]

Arguments

Argument	Required	Description
`invitationId`	Yes	Invitation identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getOrganizationInvitation.

Create organization invitation

OAuth login or personal API key required.

Code

sim organizations invitations create [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--email <value>`	Yes	Email address of the person to invite.
`--role <value>`	No	Organization role to offer. Defaults to member; grants no workspace-specific permissions. Accepted values: `member`, `admin`.

API request and response schemas: createOrganizationInvitation.

Resend organization invitation

OAuth login or personal API key required.

Code

sim organizations invitations resend <invitationId> [options]

Arguments

Argument	Required	Description
`invitationId`	Yes	Invitation identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: resendOrganizationInvitation.

Revoke organization invitation

OAuth login or personal API key required.

This cancels the invitation and all its workspace grants, preventing acceptance.

Code

sim organizations invitations revoke <invitationId> [options]

Arguments

Argument	Required	Description
`invitationId`	Yes	Invitation identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: revokeOrganizationInvitation.

List organization invitation workspaces

OAuth login or personal API key required.

Code

sim organizations invitations workspaces <invitationId> [options]

Arguments

Argument	Required	Description
`invitationId`	Yes	Invitation identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against the workspace name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `id`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

API request and response schemas: listOrganizationInvitationWorkspaces.

Usage

Get organization usage summary

OAuth login or personal API key required.

Code

sim organizations usage summary [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--preset <value>`	No	Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Defaults to "30d". Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`.
`--start-date <value>`	No	First calendar date included, in the selected timezone. Requires preset=custom.
`--end-date <value>`	No	Last calendar date included, in the selected timezone. Requires preset=custom.
`--timezone <value>`	No	IANA timezone for calendar boundaries; defaults to UTC.

API request and response schemas: getOrganizationUsageSummary.

Get organization usage breakdown

OAuth login or personal API key required.

Code

sim organizations usage breakdown [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--preset <value>`	No	Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Defaults to "30d". Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`.
`--start-date <value>`	No	First calendar date included, in the selected timezone. Requires preset=custom.
`--end-date <value>`	No	Last calendar date included, in the selected timezone. Requires preset=custom.
`--timezone <value>`	No	IANA timezone for calendar boundaries; defaults to UTC.
`--dimension <value>`	Yes	Usage grouping dimension. Accepted values: `member`, `workspace`, `workflow`, `model`, `byok`, `source`.
`--limit <value>`	No	Maximum ranked groups to return. Remaining usage is summarized in other. Must be a whole number from 1 to 100. Defaults to 50.

API request and response schemas: getOrganizationUsageBreakdown.

List organization usage events

OAuth login or personal API key required.

Code

sim organizations usage events [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--preset <value>`	No	Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Defaults to "30d". Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`.
`--start-date <value>`	No	First calendar date included, in the selected timezone. Requires preset=custom.
`--end-date <value>`	No	Last calendar date included, in the selected timezone. Requires preset=custom.
`--timezone <value>`	No	IANA timezone for calendar boundaries; defaults to UTC.
`--source <value>`	No	Restrict events to one product surface. Accepted values: `workflow`, `wand`, `sim-chat`, `mcp_copilot`, `mothership_block`, `knowledge-base`, `voice-input`, `enrichment`, `voice-output`, `api-tool`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `createdAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.

API request and response schemas: listOrganizationUsageEvents.

Access requests

Discover organization access requests

OAuth login or personal API key required.

Code

sim organizations access-requests discover [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against the access item label.
`--target-kind <value>`	No	Category of access to discover. Accepted values: `feature`, `integration`, `provider`, `model`, `tool`, `knowledge_connector`, `file_share_auth`, `chat_deploy_auth`, `usage_limit`.
`--state <value>`	No	Filter by the acting user’s current access. Requestable items can be submitted for review. Accepted values: `allowed`, `requestable`, `unavailable`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "label". Accepted values: `label`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

API request and response schemas: discoverOrganizationAccessRequests.

Create organization access request

OAuth login or personal API key required.

Code

sim organizations access-requests create [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--target <json\|@file>`	Yes	Target returned by Discover Workspace Access Requests or Discover Organization Access Requests. The target must currently be requestable. (JSON, or @path / @- to read a file or stdin).
`--reason <value>`	No	Why the acting user needs this access. Defaults to "".

API request and response schemas: createOrganizationAccessRequest.

List my organization access requests

OAuth login or personal API key required.

Code

sim organizations access-requests mine [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--status <value>`	No	Filter by request status; omit to include all statuses. Accepted values: `pending`, `fulfilled`, `declined`, `cancelled`, `closed`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `createdAt`, `targetLabel`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

API request and response schemas: listMyOrganizationAccessRequests.

Cancel organization access request

OAuth login or personal API key required.

Code

sim organizations access-requests cancel <requestId> [options]

Arguments

Argument	Required	Description
`requestId`	Yes	Access request identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: cancelOrganizationAccessRequest.

List organization access requests

OAuth login or personal API key required.

Code

sim organizations access-requests list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--status <value>`	No	Filter by request status; omit to include all statuses. Accepted values: `pending`, `fulfilled`, `declined`, `cancelled`, `closed`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `createdAt`, `targetLabel`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--search <value>`	No	Case-insensitive substring match against the target label or requester name or email.

API request and response schemas: listOrganizationAccessRequests.

Preview organization access request

OAuth login or personal API key required.

Code

sim organizations access-requests preview <requestId> [options]

Arguments

Argument	Required	Description
`requestId`	Yes	Access request identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: previewOrganizationAccessRequest.

Resolve organization access request

OAuth login or personal API key required.

Code

sim organizations access-requests resolve <requestId> [options]

Arguments

Argument	Required	Description
`requestId`	Yes	Access request identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--action <value>`	Yes	apply: Apply the reviewed change to the governing group or member credit cap. decline: Decline the request without changing permissions or credit limits. Accepted values: `apply`, `decline`.
`--expected-fingerprint <value>`	Conditional	Fingerprint from Preview Organization Access Request. Review its changes and impact before applying; a stale preview returns a conflict. Available when action is apply. Required when action is apply.
`--new-limit-credits <value>`	Conditional	Required only for a usage-limit request: a whole-number credit cap greater than the current cap. Omit for permission requests. Available when action is apply.
`--reason <value>`	Conditional	Required explanation for declining this request. Available when action is decline. Required when action is decline.

API request and response schemas: resolveOrganizationAccessRequest.

Get organization access request settings

OAuth login or personal API key required.

Code

sim organizations access-requests settings get [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getOrganizationAccessRequestSettings.

Update organization access request settings

OAuth login or personal API key required.

Code

sim organizations access-requests settings update [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--allow-requests <true\|false>`	Yes	Allow new requests and approvals. Disabling requests preserves history and still allows cancellation and decline. Accepted values: `true`, `false`.

API request and response schemas: updateOrganizationAccessRequestSettings.

Verified domains

List organization domains

OAuth login or personal API key required.

Code

sim organizations domains list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "domain". Accepted values: `domain`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listOrganizationDomains.

Add organization domain

OAuth login or personal API key required.

Code

sim organizations domains add [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--domain <value>`	Yes	Domain to claim and verify through a DNS TXT record.

API request and response schemas: addOrganizationDomain.

Verify organization domain

OAuth login or personal API key required.

Code

sim organizations domains verify <domainId> [options]

Arguments

Argument	Required	Description
`domainId`	Yes	Domain claim owned by this organization.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: verifyOrganizationDomain.

Remove organization domain

OAuth login or personal API key required.

This removes the domain claim and revokes verified SSO authority for its providers.

Code

sim organizations domains remove <domainId> [options]

Arguments

Argument	Required	Description
`domainId`	Yes	Domain claim owned by this organization.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: removeOrganizationDomain.

SSO providers and policy

List SSO providers

OAuth login or personal API key required.

Code

sim organizations sso providers list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "providerId". Accepted values: `providerId`, `domain`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listSsoProviders.

Get SSO provider

OAuth login or personal API key required.

Code

sim organizations sso providers get <providerId> [options]

Arguments

Argument	Required	Description
`providerId`	Yes	Identity provider identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getSsoProvider.

Save SSO provider

OAuth login or personal API key required.

Choose --provider-type oidc or saml. OIDC requires --client-id and --client-secret; SAML requires --entry-point and --cert. Both require an organization-verified domain. The option descriptions state which omitted fields are preserved or cleared.

Code

sim organizations sso providers save [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--provider-type <value>`	Yes	oidc: Configure an OpenID Connect identity provider. saml: Configure a SAML identity provider. Accepted values: `oidc`, `saml`.
`--provider-id <value>`	Yes	Globally unique provider ID; saving an existing provider replaces its supplied configuration.
`--issuer <value>`	Yes	Identity provider issuer URL.
`--domain <value>`	Yes	Email domain already verified by this organization.
`--jit-provisioning-enabled`	No	Allow SSO sign-in to provision organization membership, subject to eligibility and available seats. Defaults to true.
`--no-jit-provisioning-enabled`	No	Send --jit-provisioning-enabled as false.
`--mapping <json\|@file>`	No	Identity-provider claims mapped to user fields. Defaults to {"id":"sub","email":"email","name":"name","image":"picture"}. (JSON, or @path / @- to read a file or stdin).
`--client-id <value>`	Conditional	Identity provider client identifier. Available when providerType is oidc. Required when providerType is oidc.
`--client-secret <value\|@file>`	Conditional	Write-only OIDC client secret; the redacted marker from providers get preserves an existing secret. Passing it inline exposes it to shell history and process listings. Required when --provider-type is oidc (@path / @- reads a file or stdin verbatim, including trailing newlines; @@value for a literal leading @).
`--scopes <json\|@file>`	No	OIDC scopes; offline_access is omitted. Available when providerType is oidc. Defaults to ["openid","profile","email"]. (JSON, or @path / @- to read a file or stdin).
`--pkce`	No	Use PKCE for the authorization flow. Available when providerType is oidc. Defaults to true.
`--no-pkce`	No	Send --pkce as false.
`--authorization-endpoint <value>`	No	Optional authorization endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc.
`--token-endpoint <value>`	No	Optional token endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc.
`--user-info-endpoint <value>`	No	Optional UserInfo endpoint. Available when providerType is oidc.
`--skip-user-info-endpoint`	No	Read identity claims from the ID token instead of calling UserInfo. Available when providerType is oidc. Defaults to false.
`--no-skip-user-info-endpoint`	No	Send --skip-user-info-endpoint as false.
`--jwks-endpoint <value>`	No	Optional signing-key endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc.
`--entry-point <value>`	Conditional	Identity provider SAML sign-in endpoint. Available when providerType is saml. Required when providerType is saml.
`--cert <value>`	Conditional	Identity provider signing certificate. Available when providerType is saml. Required when providerType is saml.
`--callback-url <value>`	No	SAML callback URL; defaults to this provider’s Sim callback. Available when providerType is saml.
`--audience <value>`	No	SAML audience; omission preserves the saved value. Available when providerType is saml.
`--want-assertions-signed`	No	Require signed assertions; omission preserves the saved value. Available when providerType is saml.
`--no-want-assertions-signed`	No	Send --want-assertions-signed as false.
`--signature-algorithm <value>`	No	Signature algorithm accepted by the SAML configuration validator; omission preserves the saved value. Available when providerType is saml.
`--digest-algorithm <value>`	No	Digest algorithm accepted by the SAML configuration validator; omission preserves the saved value. Available when providerType is saml.
`--identifier-format <value>`	No	SAML NameID format; omission clears the saved value. Available when providerType is saml.
`--idp-metadata <value>`	No	Identity provider metadata XML; omission clears the saved document. Available when providerType is saml.

API request and response schemas: saveSsoProvider.

Set primary SSO provider

OAuth login or personal API key required.

Code

sim organizations sso providers primary <providerId> [options]

Arguments

Argument	Required	Description
`providerId`	Yes	Identity provider identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: setPrimarySsoProvider.

Delete SSO provider

OAuth login or personal API key required.

This removes the identity provider used for SSO sign-in; linked accounts remain.

Code

sim organizations sso providers delete <providerId> [options]

Arguments

Argument	Required	Description
`providerId`	Yes	Identity provider identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteSsoProvider.

Get SSO policy

OAuth login or personal API key required.

Code

sim organizations sso policy get [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getSsoPolicy.

Update SSO policy

OAuth login or personal API key required.

Code

sim organizations sso policy update [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--require-sso <true\|false>`	Yes	Require organization SSO on future sign-ins; existing sessions remain active. Accepted values: `true`, `false`.

API request and response schemas: updateSsoPolicy.

Organizations and workspaces

List organizations

Get organization

List organization workspaces

Members and credit limits

List organization members

Get organization member credit limit

Update organization member

Update organization member credit limit

Remove organization member

Invitations

List organization invitations

Get organization invitation

Create organization invitation

Resend organization invitation

Revoke organization invitation

List organization invitation workspaces

Usage

Get organization usage summary

Get organization usage breakdown

List organization usage events

Access requests

Discover organization access requests

Create organization access request

List my organization access requests

Cancel organization access request

List organization access requests

Preview organization access request

Resolve organization access request

Get organization access request settings

Update organization access request settings

Verified domains

List organization domains

Add organization domain

Verify organization domain

Remove organization domain

SSO providers and policy

List SSO providers

Get SSO provider

Save SSO provider

Set primary SSO provider

Delete SSO provider

Get SSO policy

Update SSO policy

Related docs