Skip to content

Create a team

Create a team in an organization. Initial members must already belong to the organization. By default, team members have SSH and website access to Computers the team owns.

Parameters

#
namestringRequired
Team name, 1 to 100 bytes on one line without @. It must be unique within the organization regardless of case.
usersstring[]
An organization member to add to the team, by email address or user ID.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
An organization team, its members, owned Computers and shared access.
Show 8 attributesHide attributes
computersstring[] | nullAlways present
Computers owned by the team.
full_namestringAlways present
Team name qualified by its organization.
idstringAlways present
Team ID.
member_accessstringAlways present
Access team members receive to Computers the team owns.
membersobject[] | nullAlways present
Team's members and their team roles.
Show 1 attributeHide attributes
itemsobject
A person's membership in an organization team.
Show 5 attributesHide attributes
emailstring | nullAlways present
Their email address, or null without one.
namestring
Their display name, when set. May be omitted.
picturestring
Their profile picture URL. May be omitted.
rolestringAlways present
Their role within this team.
user_idstringAlways present
Person's user ID.
namestringAlways present
Team's name within its organization.
poolsobject[] | nullAlways present
Pools shared with the team by other accounts.
Show 1 attributeHide attributes
itemsobject
A pool another account shares with the team.
Show 5 attributesHide attributes
accountstringAlways present
Account providing the pool.
commandsstring[]
Additional commands the share grants. May be omitted.
poolstringAlways present
Shared pool's name.
pool_idstringAlways present
Shared pool's ID.
rolestringAlways present
Pool share's role.
sharesobject[] | nullAlways present
Computer access granted to the team.
Show 1 attributeHide attributes
itemsobject
Access to a Computer shared with a team.
Show 3 attributesHide attributes
commandsstring[]
Additional commands granted to the team. May be omitted.
computerstringAlways present
Shared Computer's name.
rolestringAlways present
Share's access role.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.