octopush/crates/gitea_raw_client/docs/OrganizationApi.md
2022-11-27 12:16:44 +01:00

47 KiB

\OrganizationApi

All URIs are relative to /api/v1

Method HTTP request Description
create_org_repo POST /orgs/{org}/repos Create a repository in an organization
create_org_repo_deprecated POST /org/{org}/repos Create a repository in an organization
org_add_team_member PUT /teams/{id}/members/{username} Add a team member
org_add_team_repository PUT /teams/{id}/repos/{org}/{repo} Add a repository to a team
org_conceal_member DELETE /orgs/{org}/public_members/{username} Conceal a user's membership
org_create POST /orgs Create an organization
org_create_hook POST /orgs/{org}/hooks/ Create a hook
org_create_label POST /orgs/{org}/labels Create a label for an organization
org_create_team POST /orgs/{org}/teams Create a team
org_delete DELETE /orgs/{org} Delete an organization
org_delete_hook DELETE /orgs/{org}/hooks/{id} Delete a hook
org_delete_label DELETE /orgs/{org}/labels/{id} Delete a label
org_delete_member DELETE /orgs/{org}/members/{username} Remove a member from an organization
org_delete_team DELETE /teams/{id} Delete a team
org_edit PATCH /orgs/{org} Edit an organization
org_edit_hook PATCH /orgs/{org}/hooks/{id} Update a hook
org_edit_label PATCH /orgs/{org}/labels/{id} Update a label
org_edit_team PATCH /teams/{id} Edit a team
org_get GET /orgs/{org} Get an organization
org_get_all GET /orgs Get list of organizations
org_get_hook GET /orgs/{org}/hooks/{id} Get a hook
org_get_label GET /orgs/{org}/labels/{id} Get a single label
org_get_team GET /teams/{id} Get a team
org_get_user_permissions GET /users/{username}/orgs/{org}/permissions Get user permissions in organization
org_is_member GET /orgs/{org}/members/{username} Check if a user is a member of an organization
org_is_public_member GET /orgs/{org}/public_members/{username} Check if a user is a public member of an organization
org_list_current_user_orgs GET /user/orgs List the current user's organizations
org_list_hooks GET /orgs/{org}/hooks List an organization's webhooks
org_list_labels GET /orgs/{org}/labels List an organization's labels
org_list_members GET /orgs/{org}/members List an organization's members
org_list_public_members GET /orgs/{org}/public_members List an organization's public members
org_list_repos GET /orgs/{org}/repos List an organization's repos
org_list_team_member GET /teams/{id}/members/{username} List a particular member of team
org_list_team_members GET /teams/{id}/members List a team's members
org_list_team_repo GET /teams/{id}/repos/{org}/{repo} List a particular repo of team
org_list_team_repos GET /teams/{id}/repos List a team's repos
org_list_teams GET /orgs/{org}/teams List an organization's teams
org_list_user_orgs GET /users/{username}/orgs List a user's organizations
org_publicize_member PUT /orgs/{org}/public_members/{username} Publicize a user's membership
org_remove_team_member DELETE /teams/{id}/members/{username} Remove a team member
org_remove_team_repository DELETE /teams/{id}/repos/{org}/{repo} Remove a repository from a team
team_search GET /orgs/{org}/teams/search Search for teams within an organization

create_org_repo

crate::models::Repository create_org_repo(org, body) Create a repository in an organization

Parameters

Name Type Description Required Notes
org String name of organization [required]
body Option<CreateRepoOption>

Return type

crate::models::Repository

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_org_repo_deprecated

crate::models::Repository create_org_repo_deprecated(org, body) Create a repository in an organization

Parameters

Name Type Description Required Notes
org String name of organization [required]
body Option<CreateRepoOption>

Return type

crate::models::Repository

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_add_team_member

org_add_team_member(id, username) Add a team member

Parameters

Name Type Description Required Notes
id i64 id of the team [required]
username String username of the user to add [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_add_team_repository

org_add_team_repository(id, org, repo) Add a repository to a team

Parameters

Name Type Description Required Notes
id i64 id of the team [required]
org String organization that owns the repo to add [required]
repo String name of the repo to add [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_conceal_member

org_conceal_member(org, username) Conceal a user's membership

Parameters

Name Type Description Required Notes
org String name of the organization [required]
username String username of the user [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_create

crate::models::Organization org_create(organization) Create an organization

Parameters

Name Type Description Required Notes
organization CreateOrgOption [required]

Return type

crate::models::Organization

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_create_hook

crate::models::Hook org_create_hook(org, body) Create a hook

Parameters

Name Type Description Required Notes
org String name of the organization [required]
body CreateHookOption [required]

Return type

crate::models::Hook

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_create_label

crate::models::Label org_create_label(org, body) Create a label for an organization

Parameters

Name Type Description Required Notes
org String name of the organization [required]
body Option<CreateLabelOption>

Return type

crate::models::Label

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_create_team

crate::models::Team org_create_team(org, body) Create a team

Parameters

Name Type Description Required Notes
org String name of the organization [required]
body Option<CreateTeamOption>

Return type

crate::models::Team

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_delete

org_delete(org) Delete an organization

Parameters

Name Type Description Required Notes
org String organization that is to be deleted [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_delete_hook

org_delete_hook(org, id) Delete a hook

Parameters

Name Type Description Required Notes
org String name of the organization [required]
id i64 id of the hook to delete [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_delete_label

org_delete_label(org, id) Delete a label

Parameters

Name Type Description Required Notes
org String name of the organization [required]
id i64 id of the label to delete [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_delete_member

org_delete_member(org, username) Remove a member from an organization

Parameters

Name Type Description Required Notes
org String name of the organization [required]
username String username of the user [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_delete_team

org_delete_team(id) Delete a team

Parameters

Name Type Description Required Notes
id i64 id of the team to delete [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_edit

crate::models::Organization org_edit(org, body) Edit an organization

Parameters

Name Type Description Required Notes
org String name of the organization to edit [required]
body EditOrgOption [required]

Return type

crate::models::Organization

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_edit_hook

crate::models::Hook org_edit_hook(org, id, body) Update a hook

Parameters

Name Type Description Required Notes
org String name of the organization [required]
id i64 id of the hook to update [required]
body Option<EditHookOption>

Return type

crate::models::Hook

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_edit_label

crate::models::Label org_edit_label(org, id, body) Update a label

Parameters

Name Type Description Required Notes
org String name of the organization [required]
id i64 id of the label to edit [required]
body Option<EditLabelOption>

Return type

crate::models::Label

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_edit_team

crate::models::Team org_edit_team(id, body) Edit a team

Parameters

Name Type Description Required Notes
id i32 id of the team to edit [required]
body Option<EditTeamOption>

Return type

crate::models::Team

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_get

crate::models::Organization org_get(org) Get an organization

Parameters

Name Type Description Required Notes
org String name of the organization to get [required]

Return type

crate::models::Organization

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_get_all

Veccrate::models::Organization org_get_all(page, limit) Get list of organizations

Parameters

Name Type Description Required Notes
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::Organization

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_get_hook

crate::models::Hook org_get_hook(org, id) Get a hook

Parameters

Name Type Description Required Notes
org String name of the organization [required]
id i64 id of the hook to get [required]

Return type

crate::models::Hook

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_get_label

crate::models::Label org_get_label(org, id) Get a single label

Parameters

Name Type Description Required Notes
org String name of the organization [required]
id i64 id of the label to get [required]

Return type

crate::models::Label

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_get_team

crate::models::Team org_get_team(id) Get a team

Parameters

Name Type Description Required Notes
id i64 id of the team to get [required]

Return type

crate::models::Team

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_get_user_permissions

crate::models::OrganizationPermissions org_get_user_permissions(username, org) Get user permissions in organization

Parameters

Name Type Description Required Notes
username String username of user [required]
org String name of the organization [required]

Return type

crate::models::OrganizationPermissions

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_is_member

org_is_member(org, username) Check if a user is a member of an organization

Parameters

Name Type Description Required Notes
org String name of the organization [required]
username String username of the user [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_is_public_member

org_is_public_member(org, username) Check if a user is a public member of an organization

Parameters

Name Type Description Required Notes
org String name of the organization [required]
username String username of the user [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_current_user_orgs

Veccrate::models::Organization org_list_current_user_orgs(page, limit) List the current user's organizations

Parameters

Name Type Description Required Notes
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::Organization

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_hooks

Veccrate::models::Hook org_list_hooks(org, page, limit) List an organization's webhooks

Parameters

Name Type Description Required Notes
org String name of the organization [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::Hook

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_labels

Veccrate::models::Label org_list_labels(org, page, limit) List an organization's labels

Parameters

Name Type Description Required Notes
org String name of the organization [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::Label

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_members

Veccrate::models::User org_list_members(org, page, limit) List an organization's members

Parameters

Name Type Description Required Notes
org String name of the organization [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::User

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_public_members

Veccrate::models::User org_list_public_members(org, page, limit) List an organization's public members

Parameters

Name Type Description Required Notes
org String name of the organization [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::User

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_repos

Veccrate::models::Repository org_list_repos(org, page, limit) List an organization's repos

Parameters

Name Type Description Required Notes
org String name of the organization [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::Repository

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_team_member

crate::models::User org_list_team_member(id, username) List a particular member of team

Parameters

Name Type Description Required Notes
id i64 id of the team [required]
username String username of the member to list [required]

Return type

crate::models::User

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_team_members

Veccrate::models::User org_list_team_members(id, page, limit) List a team's members

Parameters

Name Type Description Required Notes
id i64 id of the team [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::User

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_team_repo

crate::models::Repository org_list_team_repo(id, org, repo) List a particular repo of team

Parameters

Name Type Description Required Notes
id i64 id of the team [required]
org String organization that owns the repo to list [required]
repo String name of the repo to list [required]

Return type

crate::models::Repository

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_team_repos

Veccrate::models::Repository org_list_team_repos(id, page, limit) List a team's repos

Parameters

Name Type Description Required Notes
id i64 id of the team [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::Repository

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_teams

Veccrate::models::Team org_list_teams(org, page, limit) List an organization's teams

Parameters

Name Type Description Required Notes
org String name of the organization [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::Team

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_list_user_orgs

Veccrate::models::Organization org_list_user_orgs(username, page, limit) List a user's organizations

Parameters

Name Type Description Required Notes
username String username of user [required]
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

Veccrate::models::Organization

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_publicize_member

org_publicize_member(org, username) Publicize a user's membership

Parameters

Name Type Description Required Notes
org String name of the organization [required]
username String username of the user [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_remove_team_member

org_remove_team_member(id, username) Remove a team member

Parameters

Name Type Description Required Notes
id i64 id of the team [required]
username String username of the user to remove [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

org_remove_team_repository

org_remove_team_repository(id, org, repo) Remove a repository from a team

This does not delete the repository, it only removes the repository from the team.

Parameters

Name Type Description Required Notes
id i64 id of the team [required]
org String organization that owns the repo to remove [required]
repo String name of the repo to remove [required]

Return type

(empty response body)

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

crate::models::TeamSearch200Response team_search(org, q, include_desc, page, limit) Search for teams within an organization

Parameters

Name Type Description Required Notes
org String name of the organization [required]
q Option<String> keywords to search
include_desc Option<bool> include search within team description (defaults to true)
page Option<i32> page number of results to return (1-based)
limit Option<i32> page size of results

Return type

crate::models::TeamSearch200Response

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]