Configure account settings

Set up single sign-on, directory sync, domains, audit logs, log streams, and encryption keys.

Available

Connect your Organization to your company's identity and security systems: single sign-on, directory sync, verified domains, audit logs, log streams, and your own encryption keys. Spiral hosts an administration portal for all of these. Each spiral orgs command below opens the portal at one setting, and any change you make there applies to the Organization you are signed in to.

Prerequisites

  • You have the Organization owner role.
  • You signed in to the Organization that you configure. See Choose an Organization.

Open the portal

Run the command for the setting you want. If the CLI cannot open a browser, for example over SSH, pass --json and open the portal URL from the output yourself.

CLI commandConfigures
spiral orgs ssoSingle sign-on with your identity provider.
spiral orgs directoryDirectory sync, which adds and removes members from your directory.
spiral orgs domainsDomain verification records and their status.
spiral orgs audit-logsAudit logs of account activity.
spiral orgs log-streamsDelivery of operational events to a destination you choose.
spiral orgs keysEncryption with keys that you supply.
link = client.organization.create_portal_link(OrganizationPortalLinkRequest(intent="sso"))
print(f"open {link.url} in a browser")

Verify the change

After you configure single sign-on or directory sync, list the members. auth_method shows how each member signs in: sso, directory, or password. A member who has never signed in shows unknown.

spiral orgs users ls

Where next: manage members, or see the Organization CLI reference.

Found a problem? Edit this page or report an issue.

On this page