Edit a team

PATCH

/teams/{id}

const url = 'https://gitea.com/api/v1/teams/1';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"can_create_org_repo":true,"description":"example","includes_all_repositories":true,"name":"example","permission":"read","units":["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.projects","repo.ext_wiki"],"units_map":{"repo.code":"read","repo.ext_issues":"none","repo.ext_wiki":"none","repo.issues":"write","repo.projects":"none","repo.pulls":"owner","repo.releases":"none","repo.wiki":"admin"},"visibility":"public"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://gitea.com/api/v1/teams/1 \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "can_create_org_repo": true, "description": "example", "includes_all_repositories": true, "name": "example", "permission": "read", "units": [ "repo.code", "repo.issues", "repo.ext_issues", "repo.wiki", "repo.pulls", "repo.releases", "repo.projects", "repo.ext_wiki" ], "units_map": { "repo.code": "read", "repo.ext_issues": "none", "repo.ext_wiki": "none", "repo.issues": "write", "repo.projects": "none", "repo.pulls": "owner", "repo.releases": "none", "repo.wiki": "admin" }, "visibility": "public" }'

Authorizations

Parameters

Path Parameters

required

integer

Id of the team to edit

Request Body

application/json

EditTeamOption options for editing a team

object

can_create_org_repo

Whether the team can create repositories in the organization

boolean

description

The description of the team

string

includes_all_repositories

Whether the team has access to all repositories in the organization

boolean

name

required

string

permission

string

Allowed values: read write admin

units

Array<string>

Example

[
  "repo.code",
  "repo.issues",
  "repo.ext_issues",
  "repo.wiki",
  "repo.pulls",
  "repo.releases",
  "repo.projects",
  "repo.ext_wiki"
]

units_map

object

key

additional properties

string

Example

{
  "repo.code": "read",
  "repo.ext_issues": "none",
  "repo.ext_wiki": "none",
  "repo.issues": "write",
  "repo.projects": "none",
  "repo.pulls": "owner",
  "repo.releases": "none",
  "repo.wiki": "admin"
}

visibility

Team visibility within the organization. When omitted, visibility is left unchanged. public TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate

string

Allowed values: public limited private

Responses

200

Team

application/json

Team represents a team in an organization

object

can_create_org_repo

Whether the team can create repositories in the organization

boolean

description

The description of the team

string

The unique identifier of the team

integer format: int64

includes_all_repositories

Whether the team has access to all repositories in the organization

boolean

name

The name of the team

string

organization

Organization represents an organization

object

avatar_url

The URL of the organization’s avatar

string format: uri

description

The description of the organization

string

email

The email address of the organization

string

full_name

The full display name of the organization

string

The unique identifier of the organization

integer format: int64

location

The location of the organization

string

name

The name of the organization

string

repo_admin_change_team_access

Whether repository administrators can change team access

boolean

username

Username of the organization deprecated

string

visibility

The visibility level of the organization (public, limited, private) public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate

string

Allowed values: public limited private

website

The website URL of the organization

string

permission

string

Allowed values: none read write admin owner

units

Array<string>

units_map

object

key

additional properties

string

visibility

Team visibility within the organization. “private” teams are only listable by members and org owners; “limited” teams are listable by any organization member; “public” teams are listable by any signed-in user. public TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate

string

Allowed values: public limited private

Example

{
  "organization": {
    "visibility": "public"
  },
  "permission": "none",
  "units": [
    "repo.code",
    "repo.issues",
    "repo.ext_issues",
    "repo.wiki",
    "repo.pulls",
    "repo.releases",
    "repo.projects",
    "repo.ext_wiki"
  ],
  "units_map": {
    "repo.code": "read",
    "repo.ext_issues": "none",
    "repo.ext_wiki": "none",
    "repo.issues": "write",
    "repo.projects": "none",
    "repo.pulls": "owner",
    "repo.releases": "none",
    "repo.wiki": "admin"
  },
  "visibility": "public"
}

404

APINotFound is a not found empty response