Organizations

Organizations are the top-level structure in Seqera Platform, containing workspaces, members, and teams. Organization owners can add or remove members from an organization or workspace, and can allocate specific access roles within workspaces.

Path and query parameters

Name	Type	Location	Req/Opt	Description
role	string	query	Optional	Filter results by organization role. One of owner or member.
name	string	query	Optional	The organization name to validate for availability and format compliance.
orgId	integer	path	Required	Organization identifier.
max	integer	query	Optional	Maximum number of results to return. Default: 50.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
search	string	query	Optional	Free-text search filter to match against user names and email addresses.
groupId	integer	path	Required	IdP group identifier.
memberId	integer	path	Required	Member identifier.
include	array	query	Optional	Optional array of specific quota names to include in the response. Omit to retrieve all quotas.
userId	integer	path	Required	User identifier.

Request body parameters

Name	Type	Req/Opt	Description
CreateOrganization			Create organization
organization	object	Optional	Organization details.
organization.id	integer	Optional	Organization identifier.
organization.name	string	Required	Unique organization name. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters.
organization.fullName	string	Required	Full display name for the organization. Maximum 100 characters.
organization.description	string	Optional	Optional description of the organization. Maximum 1000 characters.
organization.location	string	Optional	Optional location or address for the organization. Maximum 100 characters.
organization.website	string	Optional	Optional website URL for the organization.
organization.dateCreated	string	Optional	Timestamp when the organization was created.
organization.lastUpdated	string	Optional	Timestamp when the organization was last updated.
logoId	string	Optional	Logo image identifier for the organization. See Create avatar to upload images and obtain a logo ID.
UpdateOrganization			Update organization
fullName	string	Optional	Updated full display name for the organization.
name	string	Optional	Updated short organization name or handle. Must remain unique.
description	string	Optional	Updated organization description.
location	string	Optional	Updated organization location.
website	string	Optional	Updated organization website URL.
logoId	string	Optional	Updated logo image identifier for the organization. See Create avatar to upload images and obtain a logo ID.
paying	boolean	Optional	Deprecated legacy billing flag. Prefer type. When null, the current value is left unchanged.
type	object	Optional	Updated organization tier. When null, the current tier is left unchanged.
CreateOrganizationIdpGroup			Add organization IdP group
displayName	string	Optional	Group name, exactly as your identity provider sends it in the groups claim. Case-sensitive. Must be unique in the organization. Maximum length: 255 characters.
CreateOrganizationMember			Create organization member
user	string	Optional	Username or email address of the user to add as an organization member.
UpdateOrganizationMemberRole			Update organization member role
role	string	Optional	Organization member role determining access permissions and capabilities. One of owner, member, collaborator, or service_account.