gitea-rs/crates/gitea-client/docs/AdminApi.md

\AdminApi

All URIs are relative to /api/v1

Method	HTTP request	Description
admin_add_user_badges	POST /admin/users/{username}/badges	Add a badge to a user
admin_adopt_repository	POST /admin/unadopted/{owner}/{repo}	Adopt unadopted files as a repository
admin_create_hook	POST /admin/hooks	Create a hook
admin_create_org	POST /admin/users/{username}/orgs	Create an organization
admin_create_public_key	POST /admin/users/{username}/keys	Add a public key on behalf of a user
admin_create_repo	POST /admin/users/{username}/repos	Create a repository on behalf of a user
admin_create_runner_registration_token	POST /admin/actions/runners/registration-token	Get an global actions runner registration token
admin_create_user	POST /admin/users	Create a user
admin_cron_list	GET /admin/cron	List cron tasks
admin_cron_run	POST /admin/cron/{task}	Run cron task
admin_delete_hook	DELETE /admin/hooks/{id}	Delete a hook
admin_delete_unadopted_repository	DELETE /admin/unadopted/{owner}/{repo}	Delete unadopted files
admin_delete_user	DELETE /admin/users/{username}	Delete a user
admin_delete_user_badges	DELETE /admin/users/{username}/badges	Remove a badge from a user
admin_delete_user_public_key	DELETE /admin/users/{username}/keys/{id}	Delete a user's public key
admin_edit_hook	PATCH /admin/hooks/{id}	Update a hook
admin_edit_user	PATCH /admin/users/{username}	Edit an existing user
admin_get_all_emails	GET /admin/emails	List all emails
admin_get_all_orgs	GET /admin/orgs	List all organizations
admin_get_hook	GET /admin/hooks/{id}	Get a hook
admin_get_runner_registration_token	GET /admin/runners/registration-token	Get an global actions runner registration token
admin_list_hooks	GET /admin/hooks	List system's webhooks
admin_list_user_badges	GET /admin/users/{username}/badges	List a user's badges
admin_rename_user	POST /admin/users/{username}/rename	Rename a user
admin_search_emails	GET /admin/emails/search	Search all emails
admin_search_users	GET /admin/users	Search users according filter conditions
admin_unadopted_list	GET /admin/unadopted	List unadopted repositories
delete_admin_runner	DELETE /admin/actions/runners/{runner_id}	Delete an global runner
get_admin_runner	GET /admin/actions/runners/{runner_id}	Get an global runner
get_admin_runners	GET /admin/actions/runners	Get all runners
list_admin_workflow_jobs	GET /admin/actions/jobs	Lists all jobs
list_admin_workflow_runs	GET /admin/actions/runs	Lists all runs

admin_add_user_badges

admin_add_user_badges(username, body) Add a badge to a user

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user to whom a badge is to be added	[required]
body	Option<UserBadgeOption>

Return type

(empty response body)

Authorization

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

HTTP request headers

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

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

admin_adopt_repository

admin_adopt_repository(owner, repo) Adopt unadopted files as a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_create_hook

models::Hook admin_create_hook(body) Create a hook

Parameters

Name	Type	Description	Required	Notes
body	CreateHookOption		[required]

Return type

models::Hook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_create_org

models::Organization admin_create_org(username, organization) Create an organization

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user who will own the created organization	[required]
organization	CreateOrgOption		[required]

Return type

models::Organization

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_create_public_key

models::PublicKey admin_create_public_key(username, key) Add a public key on behalf of a user

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user who is to receive a public key	[required]
key	Option<CreateKeyOption>

Return type

models::PublicKey

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_create_repo

models::Repository admin_create_repo(username, repository) Create a repository on behalf of a user

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user who will own the created repository	[required]
repository	CreateRepoOption		[required]

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_create_runner_registration_token

admin_create_runner_registration_token() Get an global actions runner registration token

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_create_user

models::User admin_create_user(body) Create a user

Parameters

Name	Type	Description	Required	Notes
body	Option<CreateUserOption>

Return type

models::User

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_cron_list

Vecmodels::Cron admin_cron_list(page, limit) List cron tasks

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

Vecmodels::Cron

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_cron_run

admin_cron_run(task) Run cron task

Parameters

Name	Type	Description	Required	Notes
task	String	task to run	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_delete_hook

admin_delete_hook(id) Delete a hook

Parameters

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

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_delete_unadopted_repository

admin_delete_unadopted_repository(owner, repo) Delete unadopted files

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_delete_user

admin_delete_user(username, purge) Delete a user

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user to delete	[required]
purge	Option<bool>	purge the user from the system completely

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_delete_user_badges

admin_delete_user_badges(username, body) Remove a badge from a user

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user whose badge is to be deleted	[required]
body	Option<UserBadgeOption>

Return type

(empty response body)

Authorization

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

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

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

admin_delete_user_public_key

admin_delete_user_public_key(username, id) Delete a user's public key

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user whose public key is to be deleted	[required]
id	i64	id of the key to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_edit_hook

models::Hook admin_edit_hook(id, body) Update a hook

Parameters

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

Return type

models::Hook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_edit_user

models::User admin_edit_user(username, body) Edit an existing user

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user whose data is to be edited	[required]
body	Option<EditUserOption>

Return type

models::User

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_get_all_emails

Vecmodels::Email admin_get_all_emails(page, limit) List all emails

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

Vecmodels::Email

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_get_all_orgs

Vecmodels::Organization admin_get_all_orgs(page, limit) List all 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

Vecmodels::Organization

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_get_hook

models::Hook admin_get_hook(id) Get a hook

Parameters

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

Return type

models::Hook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_get_runner_registration_token

admin_get_runner_registration_token() Get an global actions runner registration token

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_list_hooks

Vecmodels::Hook admin_list_hooks(page, limit, r#type) List system's webhooks

Parameters

Name	Type	Description	Required	Notes
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results
r#type	Option<String>	system, default or both kinds of webhooks		[default to system]

Return type

Vecmodels::Hook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_list_user_badges

Vecmodels::Badge admin_list_user_badges(username) List a user's badges

Parameters

Name	Type	Description	Required	Notes
username	String	username of the user whose badges are to be listed	[required]

Return type

Vecmodels::Badge

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_rename_user

admin_rename_user(username, body) Rename a user

Parameters

Name	Type	Description	Required	Notes
username	String	current username of the user	[required]
body	RenameUserOption		[required]

Return type

(empty response body)

Authorization

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

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

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

admin_search_emails

Vecmodels::Email admin_search_emails(q, page, limit) Search all emails

Parameters

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

Return type

Vecmodels::Email

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_search_users

Vecmodels::User admin_search_users(source_id, login_name, page, limit) Search users according filter conditions

Parameters

Name	Type	Description	Required	Notes
source_id	Option<i64>	ID of the user's login source to search for
login_name	Option<String>	identifier of the user, provided by the external authenticator
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::User

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

admin_unadopted_list

Vec admin_unadopted_list(page, limit, pattern) List unadopted repositories

Parameters

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

Return type

Vec

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

delete_admin_runner

delete_admin_runner(runner_id) Delete an global runner

Parameters

Name	Type	Description	Required	Notes
runner_id	String	id of the runner	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

get_admin_runner

get_admin_runner(runner_id) Get an global runner

Parameters

Name	Type	Description	Required	Notes
runner_id	String	id of the runner	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

get_admin_runners

get_admin_runners() Get all runners

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

list_admin_workflow_jobs

models::ActionWorkflowJobsResponse list_admin_workflow_jobs(status, page, limit) Lists all jobs

Parameters

Name	Type	Description	Required	Notes
status	Option<String>	workflow status (pending, queued, in_progress, failure, success, skipped)
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

models::ActionWorkflowJobsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]

list_admin_workflow_runs

models::ActionWorkflowRunsResponse list_admin_workflow_runs(event, branch, status, actor, head_sha, page, limit) Lists all runs

Parameters

Name	Type	Description	Required	Notes
event	Option<String>	workflow event name
branch	Option<String>	workflow branch
status	Option<String>	workflow status (pending, queued, in_progress, failure, success, skipped)
actor	Option<String>	triggered by user
head_sha	Option<String>	triggering sha of the workflow run
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

models::ActionWorkflowRunsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, 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]