Skip to main content
An organization owns projects and their billing, and the people who can reach them. Members belong to it, invitations bring them in. Every command below also takes -h, --help.

list

List all organizations
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization ls

describe

Describe an organization
string
Organization ID
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization view, xata organization show

create

Create a new organization
string
required
Organization Name
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

delete

Delete an organization
string
Organization ID
boolean
default:"false"
Do not ask for confirmation, assume yes.
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

get

Get a field from an organization description
string
Organization ID
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
string
Organization name and/or field to get

members

Manage organization members

members list

List all members of an organization
string
Organization ID
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization members ls

members invite

Send an invitation to join an organization
string
Organization ID
string
Email address to invite
admin | editor
Role the new member holds once they accept
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization members add

members remove

Remove a member from an organization
string
Organization ID
string
ID of the user to remove
boolean
default:"false"
Skip confirmation prompt
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization members delete, xata organization members rm

members set-role

Set the role of an organization member
string
Organization ID
string
ID of the member
admin | editor
Role to grant
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

invitations

Manage organization invitations

invitations list

List all invitations for an organization
string
Organization ID
string
Filter by invitation status (pending or expired)
string
Filter by email address
string
Search invitations by email or name
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization invitations ls

invitations get

Get details of a specific invitation
string
Organization ID
string
ID of the invitation to view
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization invitations show

invitations create

Create and send an invitation to join an organization
string
Organization ID
string
Email address to invite
admin | editor
Role the new member holds once they accept
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization invitations add, xata organization invitations invite

invitations delete

Delete an invitation
string
Organization ID
string
ID of the invitation to delete
boolean
default:"false"
Skip confirmation prompt
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization invitations rm, xata organization invitations remove

invitations resend

Resend an invitation
string
Organization ID
string
ID of the invitation to resend
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

sso

Configure single sign-on for an organization Claim an email domain, prove you own it with a DNS record, connect the identity provider its members sign in through, and then require it. Each verified domain has its own provider, so an organization can have several. See https://xata.io/docs/platform/sso.

sso show

Show the domains and identity providers configured for an organization
string
Organization ID
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization sso get

sso domains

Claim and verify the email domains that sign in through your identity providers

sso domains add

Claim an email domain and print the DNS record that proves you own it
string
Organization ID
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
string
Domain to claim, such as acme.com
Aliases: xata organization sso domains claim

sso domains verify

Check the DNS record for a claimed domain and mark it verified
string
Organization ID
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
string
Domain to verify, such as acme.com

sso domains remove

Remove a claimed domain from an organization
string
Organization ID
boolean
default:"false"
Do not ask for confirmation, assume yes.
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
string
Domain to remove, such as acme.com
Aliases: xata organization sso domains delete

sso providers

Connect the identity providers that sign in each verified domain

sso providers add

Connect an identity provider to a verified domain Reads the client secret from —client-secret, the XATA_SSO_CLIENT_SECRET environment variable, or a prompt, so it need not appear in shell history. Provider types: google (Google Workspace), microsoft (Microsoft Entra ID), oidc (OpenID Connect). Every type except google needs —issuer-url.
string
Organization ID
google | microsoft | oidc
Provider type
string
Verified domain this provider signs in
string
Issuer URL, required for every type except google
string
Client ID issued by the identity provider
string
Client secret issued by the identity provider
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
Aliases: xata organization sso providers connect

sso providers remove

Disconnect an identity provider from an organization
string
Organization ID
boolean
default:"false"
Do not ask for confirmation, assume yes.
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
string
Provider alias, as shown by xata organization sso show
Aliases: xata organization sso providers delete

sso providers enforce

Require members on a domain to sign in through its identity provider Members on the domain lose the password form and the shared Google and GitHub buttons, so check the provider works with xata organization sso providers test before requiring it. Pass —disable to lift the requirement.
string
Organization ID
boolean
default:"false"
Stop requiring SSO instead of requiring it
boolean
default:"false"
Do not ask for confirmation, assume yes.
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
string
Provider alias, as shown by xata organization sso show

sso providers test

Print a link that tests sign-in through an identity provider Members are only sent to a provider once SSO is required on its domain. The link signs in through the provider directly, so you can check it works before running xata organization sso providers enforce. Open it in a private window, since it signs that browser in as the account you test with.
string
Organization ID
string
The profile to use
boolean
Print where each resolved value came from
boolean
Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.
string
Provider alias, as shown by xata organization sso show