Skip to main content

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

Organization user role identifier

name

string

query

Optional

Organization name to validate

orgId

integer

path

Required

Organization numeric identifier

max

integer

query

Optional

Pagination result max result

offset

integer

query

Optional

Pagination offset

search

string

query

Optional

Filter search parameter

memberId

integer

path

Required

Organization member numeric identifier

include

array

query

Optional

Optional list of quota names to include

Request body parameters

Name

Type

Req/Opt

Description

CreateOrganization

Create organization

organization

object

Optional

organization.id

integer

Optional

organization.name

string

Required

organization.fullName

string

Required

organization.description

string

Optional

organization.location

string

Optional

organization.website

string

Optional

organization.dateCreated

string

Optional

organization.lastUpdated

string

Optional

logoId

string

Optional

UpdateOrganization

Update organization

fullName

string

Optional

name

string

Optional

description

string

Optional

location

string

Optional

website

string

Optional

logoId

string

Optional

paying

boolean

Optional

type

object

Optional

CreateOrganizationMember

Add organization member

user

string

Optional

UpdateOrganizationMemberRole

Update member role

role

string

Optional