Team

Unique ID for the team.

If the team allows members with the right SSO (single sign-on) domain and provider, information about it.

The team's billing address details.

The team's billing email address. Invoices are sent to this address in addition to any admins on the team.

Whether the team's billing email address has been verified by one of its owners receiving a verification email and clicking through to confirm their ownership of it. Invoices aren't sent to billing email addresses until they've been verified successfully.

Time at which the team was created.

The default type for newly created roles in a team. If omitted, new roles within the team will default to a read-only role. Valid options are read and write.

Enum read, or write.

If true, access to the team is only allowed for accounts that have MFA (multi-factor authentication) enabled.

If true, access to the team is only allowed if authenticated with SSO (single sign-on) from a provider like Azure or Google.

The team specific note to include on all newly generated invoices.

Whether this is the authenticated account's default team.

Name of the team.

The payment method for the team.

Contains the role that the authenticated acccount is assigned for the team.

If this is a personal team, role is null. The user automatically has all privileges.

Enum admin, manager, or member.

The support tier for the team.

Enum business, premium, or standard.

The team's technical email address. Email notifications on technical events (e.g. failovers, upgrades) are sent to this address in addition to any admins on the team.

Whether the team's technical email address has been verified by one of its owners receiving a verification email and clicking through to confirm their ownership of it. Notifications aren't sent to technical email addresses until they've been verified successfully.

Time at which the team was last updated.

The default access group that a new member will be assigned to when they join automatically by SSO.

The default role that will be assigned to a member that joins automatically by SSO.

Deprecated: Use the more specific default_access_group_id instead.

Enum admin, manager, or member.

SSO domain allowed to join automatically.

SSO identity provider allowed to join automatically.

SSOIdentityProviderUserFacingName contains a human-friendly name for the provider allowed to join automatically.

For big providers like Azure and Google, the name will be populated like Google instead of google. For a custom OpenID Connect provider, includes a client ID.

The city, district, suburb, town, or village.

The two-letter country code.

The first address line (e.g., street, PO Box, or company name).

The second address line (e.g., apartment, suite, unit, or building).

The billing contact or organization name.

The ZIP or postal code.

The state, county, province, or region.

List teams that can be joined automatically with the domain and identity provider that user is currently signed into with SSO (single sign-on). SSO is required to use this parameter.

Return only items starting after this cursor ID. When paginating, pass the value of next_cursor from the last page into this field to get the next one.

Cursor values depend on the field in order_field. Cursors will often be the primary IDs of object, but when ordering on another field like name, they'll be names (or another value) instead.

The maximum number of items to return on the page. Defaults to 100 with a minimum of 1 and a maximum of 200.

The order of pagination. asc for ascending or desc for descending. Defaults to asc.

Enum asc, or desc.

The name of the field on which to paginate like id or name. Supported fields are specific to each endpoint, and it's not possible to specify any arbitrary name. See the documentation for each specific list endpoint to see which fields it supports. Defaults to id for most resources.

Enum id, or name.

Indicates whether or not there are more resources to page through in the collection.

A cursor value to pass to the endpoint to get the next page.

Teams is the list of teams that a user is a member of.

Name of the team.

When automatic team joining SSO (single sign-on) is enabled, the default role that new users will be assigned. Defaults to manager.

Deprecated: Roles have been superseded by access groups and may be removed longer term. It's more advisable to create a team first, then update it to include a default_access_group_id with the identifier of an arbitrary access group, but which may also include a built-in system access group equivalent to a role.

Enum admin, manager, or member.

When set, allows accounts who are authenticated via SSO (single sign-on) on the same provider and domain as the admin is currently logged in with to join this team automatically, without needing to be invited by an existing team member.

Set to false to disable automatic SSO joining.

The default type for newly created roles in a team. If omitted, new roles within the team will default to a read-only role. Valid options are read and write.

Enum read, or write.

When automatic team joining SSO (single sign-on) is enabled, the default access group ID that new users will be assigned. May be excluded, defaulting to the system "Manage" group.

When automatic team joining SSO (single sign-on) is enabled, the default role that new users will be assigned. Defaults to manager.

Deprecated: Prefer the more specific allow_automatic_sso_join_default_access_group_id instead.

Enum admin, manager, or member.

When set, allows accounts who are authenticated via SSO (single sign-on) on the same provider and domain as the admin is currently logged in with to join this team automatically, without needing to be invited by an existing team member.

Set to false to disable automatic SSO joining.

Sets the team's billing address.

Sets the team's billing email address. Invoices are sent to this address in addition to any admins on the team.

The default type for newly created roles in a team. If omitted, new roles within the team will default to a read-only role. Valid options are read and write.

Enum read, or write.

Sets the team's MFA (multi-factor authentication) enforcement setting.

Sets the team's SSO enforcement setting.

Sets note to be included on team invoices. A note is an arbitrary text field that a team would like to be rendered on their future invoices. e.g. Company name, address or any additional context that might be helpful to the association of the invoice to the team.

Set's the team's name.

Sets the team's support tier.

Enum business, premium, or standard.

Sets the team's technical email address. Email notifications on technical events (e.g. failovers, upgrades) are sent to this address in addition to any admins on the team.