Edit a team

PATCH

/teams/{id}

const url = 'https://gitea.example.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"}}'
};

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.example.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" } }'

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

boolean

description

string

includes_all_repositories

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"
}

Responses

200

Team

application/json

Team represents a team in an organization

object

can_create_org_repo

boolean

description

string

integer format: int64

includes_all_repositories

boolean

name

string

organization

Organization represents an organization

object

avatar_url

string

description

string

email

string

full_name

string

integer format: int64

location

string

name

string

repo_admin_change_team_access

boolean

username

Deprecated

string

visibility

string

website

string

permission

string

Allowed values: none read write admin owner

units

Array<string>

units_map

object

key

additional properties

string

Example

{
  "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"
  }
}

404

APINotFound is a not found empty response

application/json