diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index a345a9b538869..c18e845b8a2ec 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -11394,6 +11394,54 @@ menu: unstable: - v2 order: 18 + - name: Get a team hierarchy link + url: '#get-a-team-hierarchy-link' + identifier: teams-get-a-team-hierarchy-link + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - GetTeamHierarchyLink + unstable: [] + order: 21 + - name: Remove a team hierarchy link + url: '#remove-a-team-hierarchy-link' + identifier: teams-remove-a-team-hierarchy-link + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - RemoveTeamHierarchyLink + unstable: [] + order: 23 + - name: Create a team hierarchy link + url: '#create-a-team-hierarchy-link' + identifier: teams-create-a-team-hierarchy-link + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - AddTeamHierarchyLink + unstable: [] + order: 22 + - name: Get team hierarchy links + url: '#get-team-hierarchy-links' + identifier: teams-get-team-hierarchy-links + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - ListTeamHierarchyLinks + unstable: [] + order: 20 - name: Create a team url: '#create-a-team' identifier: teams-create-a-team diff --git a/content/en/api/v2/teams/examples.json b/content/en/api/v2/teams/examples.json index e836d520e6816..cde0954d98fd8 100644 --- a/content/en/api/v2/teams/examples.json +++ b/content/en/api/v2/teams/examples.json @@ -12,6 +12,7 @@ "description": "string", "handle": "example-team", "hidden_modules": [], + "is_managed": false, "link_count": "integer", "modified_at": "2019-09-19T10:00:00.000Z", "name": "Example Team", @@ -118,7 +119,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Teams response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Team link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team link attributes

\n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The link's label

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int32

\n

The link's position, used to sort links for the team

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

ID of the team the link is associated with

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

The URL for the link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A user's permissions for a given team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

User team permission attributes

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Object of team permission actions and boolean values that a logged in user can perform on this team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user team permission's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Teams response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Team link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team link attributes

\n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The link's label

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int32

\n

The link's position, used to sort links for the team

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

ID of the team the link is associated with

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

The URL for the link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A user's permissions for a given team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

User team permission attributes

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Object of team permission actions and boolean values that a logged in user can perform on this team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user team permission's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -155,6 +156,7 @@ "description": "string", "handle": "example-team", "hidden_modules": [], + "is_managed": false, "link_count": "integer", "modified_at": "2019-09-19T10:00:00.000Z", "name": "Example Team", @@ -188,7 +190,7 @@ "type": "team" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -262,6 +264,399 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team create

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team creation attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships formed with the team on creation

\n
\n
\n
\n
\n
\n

users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
" } }, + "ListTeamHierarchyLinks": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created_at": "", + "provisioned_by": "system" + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "relationships": { + "parent_team": { + "data": { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + }, + "sub_team": { + "data": { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + } + }, + "type": "team_hierarchy_links" + } + ], + "included": [ + { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + ], + "links": { + "first": "string", + "last": "string", + "next": "string", + "prev": "string", + "self": "string" + }, + "meta": { + "page": { + "first_number": "integer", + "last_number": "integer", + "next_number": "integer", + "number": "integer", + "prev_number": "integer", + "size": "integer", + "total": "integer", + "type": "number_size" + } + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team hierarchy links response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team hierarchy link attributes

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the team hierarchy link was created

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by [required]

\n
\n

string

\n

The provisioner of the team hierarchy link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team hierarchy link's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Team hierarchy link relationships

\n
\n
\n
\n
\n
\n

parent_team [required]

\n
\n

object

\n

Team hierarchy link team relationship

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team information in hierarchy link context

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sub_team [required]

\n
\n

object

\n

Team hierarchy link team relationship

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team information in hierarchy link context

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team hierarchy link type \nAllowed enum values: team_hierarchy_links

default: team_hierarchy_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included teams

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams hierarchy links response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current object.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Team hierarchy links response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Teams hierarchy links response page metadata.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

First page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

Last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

Next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

Page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

Previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total number of results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "AddTeamHierarchyLink": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "", + "provisioned_by": "system" + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "relationships": { + "parent_team": { + "data": { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + }, + "sub_team": { + "data": { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + } + }, + "type": "team_hierarchy_links" + }, + "included": [ + { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + ], + "links": { + "first": "string", + "last": "string", + "next": "string", + "prev": "string", + "self": "string" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Team hierarchy link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team hierarchy link attributes

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the team hierarchy link was created

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by [required]

\n
\n

string

\n

The provisioner of the team hierarchy link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team hierarchy link's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Team hierarchy link relationships

\n
\n
\n
\n
\n
\n

parent_team [required]

\n
\n

object

\n

Team hierarchy link team relationship

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team information in hierarchy link context

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sub_team [required]

\n
\n

object

\n

Team hierarchy link team relationship

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team information in hierarchy link context

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team hierarchy link type \nAllowed enum values: team_hierarchy_links

default: team_hierarchy_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included teams

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams hierarchy links response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current object.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "409": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "relationships": { + "parent_team": { + "data": { + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + }, + "sub_team": { + "data": { + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + } + }, + "type": "team_hierarchy_links" + } + }, + "json": { + "data": { + "relationships": { + "parent_team": { + "data": { + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + }, + "sub_team": { + "data": { + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + } + }, + "type": "team_hierarchy_links" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team hierarchy link creation

\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Team hierarchy link creation relationships

\n
\n
\n
\n
\n
\n

parent_team [required]

\n
\n

object

\n

Team relationship for hierarchy link creation

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team reference for hierarchy link creation

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sub_team [required]

\n
\n

object

\n

Team relationship for hierarchy link creation

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team reference for hierarchy link creation

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team hierarchy link type \nAllowed enum values: team_hierarchy_links

default: team_hierarchy_links

\n
\n \n
\n
\n
\n
" + } + }, + "RemoveTeamHierarchyLink": { + "responses": { + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetTeamHierarchyLink": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "", + "provisioned_by": "system" + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "relationships": { + "parent_team": { + "data": { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + }, + "sub_team": { + "data": { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + } + }, + "type": "team_hierarchy_links" + }, + "included": [ + { + "attributes": { + "avatar": "string", + "banner": "integer", + "handle": "team-handle", + "is_managed": false, + "is_open_membership": false, + "link_count": "integer", + "name": "Team Name", + "summary": "string", + "user_count": "integer" + }, + "id": "692e8073-12c4-4c71-8408-5090bd44c9c8", + "type": "team" + } + ], + "links": { + "first": "string", + "last": "string", + "next": "string", + "prev": "string", + "self": "string" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Team hierarchy link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team hierarchy link attributes

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the team hierarchy link was created

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by [required]

\n
\n

string

\n

The provisioner of the team hierarchy link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team hierarchy link's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Team hierarchy link relationships

\n
\n
\n
\n
\n
\n

parent_team [required]

\n
\n

object

\n

Team hierarchy link team relationship

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team information in hierarchy link context

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sub_team [required]

\n
\n

object

\n

Team hierarchy link team relationship

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team information in hierarchy link context

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team hierarchy link type \nAllowed enum values: team_hierarchy_links

default: team_hierarchy_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Included teams

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team attributes in hierarchy link context

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

The team's avatar

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

The team's banner

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's handle

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed

\n
\n \n
\n
\n
\n
\n
\n

is_open_membership

\n
\n

boolean

\n

Whether the team has open membership

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int64

\n

The number of links for the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The team's name

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

The team's summary

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

The number of users in the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams hierarchy links response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to the first page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to the last page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link to the next page.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link to the previous page.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to the current object.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, "GetTeamSync": { "responses": { "200": { @@ -377,6 +772,7 @@ "description": "string", "handle": "example-team", "hidden_modules": [], + "is_managed": false, "link_count": "integer", "modified_at": "2019-09-19T10:00:00.000Z", "name": "Example Team", @@ -483,7 +879,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Teams response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Team link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team link attributes

\n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The link's label

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int32

\n

The link's position, used to sort links for the team

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

ID of the team the link is associated with

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

The URL for the link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A user's permissions for a given team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

User team permission attributes

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Object of team permission actions and boolean values that a logged in user can perform on this team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user team permission's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Teams response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Team link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team link attributes

\n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The link's label

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int32

\n

The link's position, used to sort links for the team

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

ID of the team the link is associated with

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

The URL for the link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A user's permissions for a given team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

User team permission attributes

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Object of team permission actions and boolean values that a logged in user can perform on this team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user team permission's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -637,6 +1033,7 @@ "description": "string", "handle": "example-team", "hidden_modules": [], + "is_managed": false, "link_count": "integer", "modified_at": "2019-09-19T10:00:00.000Z", "name": "Example Team", @@ -670,7 +1067,7 @@ "type": "team" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -715,6 +1112,7 @@ "description": "string", "handle": "example-team", "hidden_modules": [], + "is_managed": false, "link_count": "integer", "modified_at": "2019-09-19T10:00:00.000Z", "name": "Example Team", @@ -748,7 +1146,7 @@ "type": "team" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1212,7 +1610,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team memberships response data

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team memberships response data

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -1326,7 +1724,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -1520,7 +1918,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -1777,7 +2175,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team memberships response data

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team memberships response data

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

is_managed

\n
\n

boolean

\n

Whether the team is managed from an external source

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "404": { "json": { diff --git a/content/en/api/v2/teams/request.AddTeamHierarchyLink.json b/content/en/api/v2/teams/request.AddTeamHierarchyLink.json new file mode 100644 index 0000000000000..c09f4fe0f46d8 --- /dev/null +++ b/content/en/api/v2/teams/request.AddTeamHierarchyLink.json @@ -0,0 +1,19 @@ +{ + "data": { + "relationships": { + "parent_team": { + "data": { + "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "team" + } + }, + "sub_team": { + "data": { + "id": "7c47c39d-7740-6408-d686-7870a744701c", + "type": "team" + } + } + }, + "type": "team_hierarchy_links" + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index 53a4675259617..a529ef554a87d 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -1822,6 +1822,13 @@ "description": "Save new value for on-demand concurrency cap returns \"OK\" response" } ], + "AddTeamHierarchyLink": [ + { + "group": "teams", + "suffix": "", + "description": "Create a team hierarchy link returns \"OK\" response" + } + ], "CreateTeamLink": [ { "group": "teams", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 86def950cf6bb..8a8e57531a056 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -41674,6 +41674,7 @@ components: type: object RelationshipToUserTeamPermissionData: description: Related user team permission data + nullable: true properties: id: description: The ID of the user team permission @@ -52237,7 +52238,11 @@ components: items: description: String identifier of the module type: string + nullable: true type: array + is_managed: + description: Whether the team is managed from an external source + type: boolean link_count: description: The number of links belonging to the team format: int32 @@ -52269,6 +52274,7 @@ components: items: description: String identifier of the module type: string + nullable: true type: array required: - handle @@ -52449,6 +52455,206 @@ components: required: - data type: object + TeamHierarchyLink: + description: Team hierarchy link + properties: + attributes: + $ref: '#/components/schemas/TeamHierarchyLinkAttributes' + id: + description: The team hierarchy link's identifier + example: b8626d7e-cedd-11eb-abf5-da7ad0900001 + type: string + relationships: + $ref: '#/components/schemas/TeamHierarchyLinkRelationships' + type: + $ref: '#/components/schemas/TeamHierarchyLinkType' + required: + - attributes + - id + - type + type: object + TeamHierarchyLinkAttributes: + description: Team hierarchy link attributes + properties: + created_at: + description: Timestamp when the team hierarchy link was created + example: '' + format: date-time + type: string + provisioned_by: + description: The provisioner of the team hierarchy link + example: system + type: string + required: + - provisioned_by + - created_at + type: object + TeamHierarchyLinkCreate: + description: Team hierarchy link creation + properties: + relationships: + $ref: '#/components/schemas/TeamHierarchyLinkCreateRelationships' + type: + $ref: '#/components/schemas/TeamHierarchyLinkType' + required: + - relationships + - type + type: object + TeamHierarchyLinkCreateRelationships: + description: Team hierarchy link creation relationships + properties: + parent_team: + $ref: '#/components/schemas/TeamHierarchyLinkCreateTeamRelationship' + sub_team: + $ref: '#/components/schemas/TeamHierarchyLinkCreateTeamRelationship' + required: + - parent_team + - sub_team + type: object + TeamHierarchyLinkCreateRequest: + description: Request to create a team hierarchy link + properties: + data: + $ref: '#/components/schemas/TeamHierarchyLinkCreate' + required: + - data + type: object + TeamHierarchyLinkCreateTeam: + description: Team reference for hierarchy link creation + properties: + id: + description: The team's identifier + example: 692e8073-12c4-4c71-8408-5090bd44c9c8 + type: string + type: + $ref: '#/components/schemas/TeamType' + required: + - id + - type + type: object + TeamHierarchyLinkCreateTeamRelationship: + description: Team relationship for hierarchy link creation + properties: + data: + $ref: '#/components/schemas/TeamHierarchyLinkCreateTeam' + required: + - data + type: object + TeamHierarchyLinkRelationships: + description: Team hierarchy link relationships + properties: + parent_team: + $ref: '#/components/schemas/TeamHierarchyLinkTeamRelationship' + sub_team: + $ref: '#/components/schemas/TeamHierarchyLinkTeamRelationship' + required: + - parent_team + - sub_team + type: object + TeamHierarchyLinkResponse: + description: Team hierarchy link response + properties: + data: + $ref: '#/components/schemas/TeamHierarchyLink' + included: + description: Included teams + items: + $ref: '#/components/schemas/TeamHierarchyLinkTeam' + type: array + links: + $ref: '#/components/schemas/TeamsHierarchyLinksResponseLinks' + type: object + TeamHierarchyLinkTeam: + description: Team information in hierarchy link context + properties: + attributes: + $ref: '#/components/schemas/TeamHierarchyLinkTeamAttributes' + id: + description: The team's identifier + example: 692e8073-12c4-4c71-8408-5090bd44c9c8 + type: string + type: + $ref: '#/components/schemas/TeamType' + required: + - id + - type + type: object + TeamHierarchyLinkTeamAttributes: + description: Team attributes in hierarchy link context + properties: + avatar: + description: The team's avatar + nullable: true + type: string + banner: + description: The team's banner + format: int64 + type: integer + handle: + description: The team's handle + example: team-handle + type: string + is_managed: + description: Whether the team is managed + type: boolean + is_open_membership: + description: Whether the team has open membership + type: boolean + link_count: + description: The number of links for the team + format: int64 + type: integer + name: + description: The team's name + example: Team Name + type: string + summary: + description: The team's summary + nullable: true + type: string + user_count: + description: The number of users in the team + format: int64 + type: integer + required: + - handle + - name + type: object + TeamHierarchyLinkTeamRelationship: + description: Team hierarchy link team relationship + properties: + data: + $ref: '#/components/schemas/TeamHierarchyLinkTeam' + required: + - data + type: object + TeamHierarchyLinkType: + default: team_hierarchy_links + description: Team hierarchy link type + enum: + - team_hierarchy_links + example: team_hierarchy_links + type: string + x-enum-varnames: + - TEAM_HIERARCHY_LINKS + TeamHierarchyLinksResponse: + description: Team hierarchy links response + properties: + data: + description: Team hierarchy links response data + items: + $ref: '#/components/schemas/TeamHierarchyLink' + type: array + included: + description: Included teams + items: + $ref: '#/components/schemas/TeamHierarchyLinkTeam' + type: array + links: + $ref: '#/components/schemas/TeamsHierarchyLinksResponseLinks' + meta: + $ref: '#/components/schemas/TeamsHierarchyLinksResponseMeta' + type: object TeamIncluded: description: Included resources related to the team oneOf: @@ -53328,6 +53534,73 @@ components: - LINK_COUNT - TEAM_LINKS - USER_TEAM_PERMISSIONS + TeamsHierarchyLinksResponseLinks: + description: Teams hierarchy links response links. + properties: + first: + description: Link to the first page. + nullable: true + type: string + last: + description: Link to the last page. + nullable: true + type: string + next: + description: Link to the next page. + nullable: true + type: string + prev: + description: Link to the previous page. + nullable: true + type: string + self: + description: Link to the current object. + type: string + type: object + TeamsHierarchyLinksResponseMeta: + description: Team hierarchy links response metadata. + properties: + page: + $ref: '#/components/schemas/TeamsHierarchyLinksResponseMetaPage' + type: object + TeamsHierarchyLinksResponseMetaPage: + description: Teams hierarchy links response page metadata. + properties: + first_number: + description: First page number. + format: int64 + type: integer + last_number: + description: Last page number. + format: int64 + type: integer + next_number: + description: Next page number. + format: int64 + nullable: true + type: integer + number: + description: Page number. + format: int64 + type: integer + prev_number: + description: Previous page number. + format: int64 + nullable: true + type: integer + size: + description: Page size. + format: int64 + type: integer + total: + description: Total number of results. + format: int64 + type: integer + type: + description: Pagination type. + example: number_size + type: string + type: object TeamsResponse: description: Response with multiple teams properties: @@ -83870,6 +84143,174 @@ paths: permissions: - teams_read - teams_manage + /api/v2/team-hierarchy-links: + get: + description: List all team hierarchy links that match the provided filters. + operationId: ListTeamHierarchyLinks + parameters: + - $ref: '#/components/parameters/PageNumber' + - $ref: '#/components/parameters/PageSize' + - description: Filter by parent team ID + in: query + name: filter[parent_team] + required: false + schema: + type: string + - description: Filter by sub team ID + in: query + name: filter[sub_team] + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamHierarchyLinksResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Get team hierarchy links + tags: + - Teams + x-menu-order: 20 + x-pagination: + limitParam: page[size] + pageParam: page[number] + resultsPath: data + x-permission: + operator: OR + permissions: + - teams_read + post: + description: Create a new team hierarchy link between a parent team and a sub + team. + operationId: AddTeamHierarchyLink + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamHierarchyLinkCreateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamHierarchyLinkResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Conflict + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + - teams_manage + summary: Create a team hierarchy link + tags: + - Teams + x-menu-order: 22 + x-permission: + operator: AND + permissions: + - teams_read + - teams_manage + /api/v2/team-hierarchy-links/{link_id}: + delete: + description: Remove a team hierarchy link by the given link_id. + operationId: RemoveTeamHierarchyLink + parameters: + - description: The team hierarchy link's identifier + in: path + name: link_id + required: true + schema: + type: string + responses: + '204': + description: No Content + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + - teams_manage + summary: Remove a team hierarchy link + tags: + - Teams + x-menu-order: 23 + x-permission: + operator: AND + permissions: + - teams_read + - teams_manage + get: + description: Get a single team hierarchy link for the given link_id. + operationId: GetTeamHierarchyLink + parameters: + - description: The team hierarchy link's identifier + in: path + name: link_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamHierarchyLinkResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Get a team hierarchy link + tags: + - Teams + x-menu-order: 21 + x-permission: + operator: OR + permissions: + - teams_read /api/v2/team/connections: delete: description: Delete multiple team connections. @@ -84149,7 +84590,13 @@ paths: If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/team/{super_team_id}/member_teams: get: - description: Get all member teams. + deprecated: true + description: 'Get all member teams. + + + **Note**: This API is deprecated. For team hierarchy relationships (parent-child + + teams), use the team hierarchy links API: `GET /api/v2/team-hierarchy-links`.' operationId: ListMemberTeams parameters: - description: None @@ -84203,14 +84650,20 @@ paths: operator: OR permissions: - teams_read + x-sunset: '2026-06-01' x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' post: + deprecated: true description: 'Add a member team. Adds the team given by the `id` in the body as a member team of the super - team.' + team. + + + **Note**: This API is deprecated. For creating team hierarchy links, use the + team hierarchy links API: `POST /api/v2/team-hierarchy-links`.' operationId: AddMemberTeam parameters: - description: None @@ -84251,12 +84704,18 @@ paths: operator: OR permissions: - teams_read + x-sunset: '2026-06-01' x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/team/{super_team_id}/member_teams/{member_team_id}: delete: - description: Remove a super team's member team identified by `member_team_id`. + deprecated: true + description: 'Remove a super team''s member team identified by `member_team_id`. + + + **Note**: This API is deprecated. For deleting team hierarchy links, use the + team hierarchy links API: `DELETE /api/v2/team-hierarchy-links/{link_id}`.' operationId: RemoveMemberTeam parameters: - description: None @@ -84297,6 +84756,7 @@ paths: operator: OR permissions: - teams_read + x-sunset: '2026-06-01' x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index d009a396a564f..214e40cd107da 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -3108,6 +3108,24 @@ "request_description": "", "request_schema_description": "Request to create a team" }, + "ListTeamHierarchyLinks": { + "description": "List all team hierarchy links that match the provided filters.", + "summary": "Get team hierarchy links" + }, + "AddTeamHierarchyLink": { + "description": "Create a new team hierarchy link between a parent team and a sub team.", + "summary": "Create a team hierarchy link", + "request_description": "", + "request_schema_description": "Request to create a team hierarchy link" + }, + "RemoveTeamHierarchyLink": { + "description": "Remove a team hierarchy link by the given link_id.", + "summary": "Remove a team hierarchy link" + }, + "GetTeamHierarchyLink": { + "description": "Get a single team hierarchy link for the given link_id.", + "summary": "Get a team hierarchy link" + }, "DeleteTeamConnections": { "description": "Delete multiple team connections.", "summary": "Delete team connections", @@ -3135,17 +3153,17 @@ "request_schema_description": "Team sync request." }, "ListMemberTeams": { - "description": "Get all member teams.", + "description": "Get all member teams.\n\n**Note**: This API is deprecated. For team hierarchy relationships (parent-child\nteams), use the team hierarchy links API: `GET /api/v2/team-hierarchy-links`.", "summary": "Get all member teams" }, "AddMemberTeam": { - "description": "Add a member team.\nAdds the team given by the `id` in the body as a member team of the super team.", + "description": "Add a member team.\nAdds the team given by the `id` in the body as a member team of the super team.\n\n**Note**: This API is deprecated. For creating team hierarchy links, use the team hierarchy links API: `POST /api/v2/team-hierarchy-links`.", "summary": "Add a member team", "request_description": "", "request_schema_description": "Request to add a member team to super team's hierarchy" }, "RemoveMemberTeam": { - "description": "Remove a super team's member team identified by `member_team_id`.", + "description": "Remove a super team's member team identified by `member_team_id`.\n\n**Note**: This API is deprecated. For deleting team hierarchy links, use the team hierarchy links API: `DELETE /api/v2/team-hierarchy-links/{link_id}`.", "summary": "Remove a member team" }, "DeleteTeam": {