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

\UserApi

All URIs are relative to /api/v1

Method	HTTP request	Description
create_current_user_repo	POST /user/repos	Create a repository
create_user_variable	POST /user/actions/variables/{variablename}	Create a user-level variable
delete_user_secret	DELETE /user/actions/secrets/{secretname}	Delete a secret in a user scope
delete_user_variable	DELETE /user/actions/variables/{variablename}	Delete a user-level variable which is created by current doer
get_user_settings	GET /user/settings	Get user settings
get_user_variable	GET /user/actions/variables/{variablename}	Get a user-level variable which is created by current doer
get_user_variables_list	GET /user/actions/variables	Get the user-level list of variables which is created by current doer
get_verification_token	GET /user/gpg_key_token	Get a Token to verify
update_user_secret	PUT /user/actions/secrets/{secretname}	Create or Update a secret value in a user scope
update_user_settings	PATCH /user/settings	Update user settings
update_user_variable	PUT /user/actions/variables/{variablename}	Update a user-level variable which is created by current doer
user_add_email	POST /user/emails	Add email addresses
user_block_user	PUT /user/blocks/{username}	Block a user
user_check_following	GET /users/{username}/following/{target}	Check if one user is following another user
user_check_user_block	GET /user/blocks/{username}	Check if a user is blocked by the authenticated user
user_create_hook	POST /user/hooks	Create a hook
user_create_o_auth2_application	POST /user/applications/oauth2	creates a new OAuth2 application
user_create_token	POST /users/{username}/tokens	Create an access token
user_current_check_following	GET /user/following/{username}	Check whether a user is followed by the authenticated user
user_current_check_starring	GET /user/starred/{owner}/{repo}	Whether the authenticated is starring the repo
user_current_delete_follow	DELETE /user/following/{username}	Unfollow a user
user_current_delete_gpg_key	DELETE /user/gpg_keys/{id}	Remove a GPG key
user_current_delete_key	DELETE /user/keys/{id}	Delete a public key
user_current_delete_star	DELETE /user/starred/{owner}/{repo}	Unstar the given repo
user_current_get_gpg_key	GET /user/gpg_keys/{id}	Get a GPG key
user_current_get_key	GET /user/keys/{id}	Get a public key
user_current_list_followers	GET /user/followers	List the authenticated user's followers
user_current_list_following	GET /user/following	List the users that the authenticated user is following
user_current_list_gpg_keys	GET /user/gpg_keys	List the authenticated user's GPG keys
user_current_list_keys	GET /user/keys	List the authenticated user's public keys
user_current_list_repos	GET /user/repos	List the repos that the authenticated user owns
user_current_list_starred	GET /user/starred	The repos that the authenticated user has starred
user_current_list_subscriptions	GET /user/subscriptions	List repositories watched by the authenticated user
user_current_post_gpg_key	POST /user/gpg_keys	Create a GPG key
user_current_post_key	POST /user/keys	Create a public key
user_current_put_follow	PUT /user/following/{username}	Follow a user
user_current_put_star	PUT /user/starred/{owner}/{repo}	Star the given repo
user_current_tracked_times	GET /user/times	List the current user's tracked times
user_delete_access_token	DELETE /users/{username}/tokens/{token}	delete an access token
user_delete_avatar	DELETE /user/avatar	Delete Avatar
user_delete_email	DELETE /user/emails	Delete email addresses
user_delete_hook	DELETE /user/hooks/{id}	Delete a hook
user_delete_o_auth2_application	DELETE /user/applications/oauth2/{id}	delete an OAuth2 Application
user_edit_hook	PATCH /user/hooks/{id}	Update a hook
user_get	GET /users/{username}	Get a user
user_get_current	GET /user	Get the authenticated user
user_get_heatmap_data	GET /users/{username}/heatmap	Get a user's heatmap
user_get_hook	GET /user/hooks/{id}	Get a hook
user_get_o_auth2_application	GET /user/applications/oauth2/{id}	get an OAuth2 Application
user_get_oauth2_application	GET /user/applications/oauth2	List the authenticated user's oauth2 applications
user_get_runner_registration_token	GET /user/actions/runners/registration-token	Get an user's actions runner registration token
user_get_stop_watches	GET /user/stopwatches	Get list of all existing stopwatches
user_get_tokens	GET /users/{username}/tokens	List the authenticated user's access tokens
user_list_activity_feeds	GET /users/{username}/activities/feeds	List a user's activity feeds
user_list_blocks	GET /user/blocks	List users blocked by the authenticated user
user_list_emails	GET /user/emails	List the authenticated user's email addresses
user_list_followers	GET /users/{username}/followers	List the given user's followers
user_list_following	GET /users/{username}/following	List the users that the given user is following
user_list_gpg_keys	GET /users/{username}/gpg_keys	List the given user's GPG keys
user_list_hooks	GET /user/hooks	List the authenticated user's webhooks
user_list_keys	GET /users/{username}/keys	List the given user's public keys
user_list_repos	GET /users/{username}/repos	List the repos owned by the given user
user_list_starred	GET /users/{username}/starred	The repos that the given user has starred
user_list_subscriptions	GET /users/{username}/subscriptions	List the repositories watched by a user
user_list_teams	GET /user/teams	List all the teams a user belongs to
user_search	GET /users/search	Search for users
user_unblock_user	DELETE /user/blocks/{username}	Unblock a user
user_update_avatar	POST /user/avatar	Update Avatar
user_update_o_auth2_application	PATCH /user/applications/oauth2/{id}	update an OAuth2 Application, this includes regenerating the client secret
user_verify_gpg_key	POST /user/gpg_key_verify	Verify a GPG key

create_current_user_repo

models::Repository create_current_user_repo(body) Create a repository

Parameters

Name	Type	Description	Required	Notes
body	Option<CreateRepoOption>

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]

create_user_variable

create_user_variable(variablename, body) Create a user-level variable

Parameters

Name	Type	Description	Required	Notes
variablename	String	name of the variable	[required]
body	Option<CreateVariableOption>

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]

delete_user_secret

delete_user_secret(secretname) Delete a secret in a user scope

Parameters

Name	Type	Description	Required	Notes
secretname	String	name of the secret	[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]

delete_user_variable

delete_user_variable(variablename) Delete a user-level variable which is created by current doer

Parameters

Name	Type	Description	Required	Notes
variablename	String	name of the variable	[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_user_settings

Vecmodels::UserSettings get_user_settings() Get user settings

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::UserSettings

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]

get_user_variable

models::ActionVariable get_user_variable(variablename) Get a user-level variable which is created by current doer

Parameters

Name	Type	Description	Required	Notes
variablename	String	name of the variable	[required]

Return type

models::ActionVariable

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]

get_user_variables_list

Vecmodels::ActionVariable get_user_variables_list(page, limit) Get the user-level list of variables which is created by current doer

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::ActionVariable

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]

get_verification_token

String get_verification_token() Get a Token to verify

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

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

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

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

update_user_secret

update_user_secret(secretname, body) Create or Update a secret value in a user scope

Parameters

Name	Type	Description	Required	Notes
secretname	String	name of the secret	[required]
body	Option<CreateOrUpdateSecretOption>

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]

update_user_settings

Vecmodels::UserSettings update_user_settings(body) Update user settings

Parameters

Name	Type	Description	Required	Notes
body	Option<UserSettingsOptions>

Return type

Vecmodels::UserSettings

Authorization

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

HTTP request headers

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

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

update_user_variable

update_user_variable(variablename, body) Update a user-level variable which is created by current doer

Parameters

Name	Type	Description	Required	Notes
variablename	String	name of the variable	[required]
body	Option<UpdateVariableOption>

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]

user_add_email

Vecmodels::Email user_add_email(body) Add email addresses

Parameters

Name	Type	Description	Required	Notes
body	Option<CreateEmailOption>

Return type

Vecmodels::Email

Authorization

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

HTTP request headers

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

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

user_block_user

user_block_user(username, note) Block a user

Parameters

Name	Type	Description	Required	Notes
username	String	user to block	[required]
note	Option<String>	optional note for the block

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]

user_check_following

user_check_following(username, target) Check if one user is following another user

Parameters

Name	Type	Description	Required	Notes
username	String	username of following user	[required]
target	String	username of followed user	[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]

user_check_user_block

user_check_user_block(username) Check if a user is blocked by the authenticated user

Parameters

Name	Type	Description	Required	Notes
username	String	user to check	[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]

user_create_hook

models::Hook user_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]

user_create_o_auth2_application

models::OAuth2Application user_create_o_auth2_application(body) creates a new OAuth2 application

Parameters

Name	Type	Description	Required	Notes
body	CreateOAuth2ApplicationOptions		[required]

Return type

models::OAuth2Application

Authorization

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

HTTP request headers

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

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

user_create_token

models::AccessToken user_create_token(username, body) Create an access token

Parameters

Name	Type	Description	Required	Notes
username	String	username of user	[required]
body	Option<CreateAccessTokenOption>

Return type

models::AccessToken

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]

user_current_check_following

user_current_check_following(username) Check whether a user is followed by the authenticated user

Parameters

Name	Type	Description	Required	Notes
username	String	username of followed user	[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]

user_current_check_starring

user_current_check_starring(owner, repo) Whether the authenticated is starring the repo

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]

user_current_delete_follow

user_current_delete_follow(username) Unfollow a user

Parameters

Name	Type	Description	Required	Notes
username	String	username of user to unfollow	[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]

user_current_delete_gpg_key

user_current_delete_gpg_key(id) Remove a GPG key

Parameters

Name	Type	Description	Required	Notes
id	i64	id of 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]

user_current_delete_key

user_current_delete_key(id) Delete a public key

Parameters

Name	Type	Description	Required	Notes
id	i64	id of 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]

user_current_delete_star

user_current_delete_star(owner, repo) Unstar the given repo

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to unstar	[required]
repo	String	name of the repo to unstar	[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]

user_current_get_gpg_key

models::GpgKey user_current_get_gpg_key(id) Get a GPG key

Parameters

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

Return type

models::GpgKey

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]

user_current_get_key

models::PublicKey user_current_get_key(id) Get a public key

Parameters

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

Return type

models::PublicKey

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]

user_current_list_followers

Vecmodels::User user_current_list_followers(page, limit) List the authenticated user's followers

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::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]

user_current_list_following

Vecmodels::User user_current_list_following(page, limit) List the users that the authenticated user is following

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::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]

user_current_list_gpg_keys

Vecmodels::GpgKey user_current_list_gpg_keys(page, limit) List the authenticated user's GPG keys

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::GpgKey

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]

user_current_list_keys

Vecmodels::PublicKey user_current_list_keys(fingerprint, page, limit) List the authenticated user's public keys

Parameters

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

Return type

Vecmodels::PublicKey

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]

user_current_list_repos

Vecmodels::Repository user_current_list_repos(page, limit) List the repos that the authenticated user owns

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::Repository

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]

user_current_list_starred

Vecmodels::Repository user_current_list_starred(page, limit) The repos that the authenticated user has starred

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::Repository

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]

user_current_list_subscriptions

Vecmodels::Repository user_current_list_subscriptions(page, limit) List repositories watched by the authenticated user

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::Repository

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]

user_current_post_gpg_key

models::GpgKey user_current_post_gpg_key(form) Create a GPG key

Parameters

Name	Type	Description	Required	Notes
form	Option<CreateGpgKeyOption>

Return type

models::GpgKey

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]

user_current_post_key

models::PublicKey user_current_post_key(body) Create a public key

Parameters

Name	Type	Description	Required	Notes
body	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]

user_current_put_follow

user_current_put_follow(username) Follow a user

Parameters

Name	Type	Description	Required	Notes
username	String	username of user to follow	[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]

user_current_put_star

user_current_put_star(owner, repo) Star the given repo

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to star	[required]
repo	String	name of the repo to star	[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]

user_current_tracked_times

Vecmodels::TrackedTime user_current_tracked_times(page, limit, since, before) List the current user's tracked times

Parameters

Name	Type	Description	Required	Notes
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results
since	Option<String>	Only show times updated after the given time. This is a timestamp in RFC 3339 format
before	Option<String>	Only show times updated before the given time. This is a timestamp in RFC 3339 format

Return type

Vecmodels::TrackedTime

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]

user_delete_access_token

user_delete_access_token(username, token) delete an access token

Parameters

Name	Type	Description	Required	Notes
username	String	username of user	[required]
token	String	token to be deleted, identified by ID and if not available by name	[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]

user_delete_avatar

user_delete_avatar() Delete Avatar

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]

user_delete_email

user_delete_email(body) Delete email addresses

Parameters

Name	Type	Description	Required	Notes
body	Option<DeleteEmailOption>

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]

user_delete_hook

user_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]

user_delete_o_auth2_application

user_delete_o_auth2_application(id) delete an OAuth2 Application

Parameters

Name	Type	Description	Required	Notes
id	i64	token to be deleted	[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]

user_edit_hook

models::Hook user_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]

user_get

models::User user_get(username) Get a user

Parameters

Name	Type	Description	Required	Notes
username	String	username of user to get	[required]

Return type

models::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]

user_get_current

models::User user_get_current() Get the authenticated user

Parameters

This endpoint does not need any parameter.

Return type

models::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]

user_get_heatmap_data

Vecmodels::UserHeatmapData user_get_heatmap_data(username) Get a user's heatmap

Parameters

Name	Type	Description	Required	Notes
username	String	username of user to get	[required]

Return type

Vecmodels::UserHeatmapData

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]

user_get_hook

models::Hook user_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]

user_get_o_auth2_application

models::OAuth2Application user_get_o_auth2_application(id) get an OAuth2 Application

Parameters

Name	Type	Description	Required	Notes
id	i64	Application ID to be found	[required]

Return type

models::OAuth2Application

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]

user_get_oauth2_application

Vecmodels::OAuth2Application user_get_oauth2_application(page, limit) List the authenticated user's oauth2 applications

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::OAuth2Application

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]

user_get_runner_registration_token

user_get_runner_registration_token() Get an user's 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]

user_get_stop_watches

Vecmodels::StopWatch user_get_stop_watches(page, limit) Get list of all existing stopwatches

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::StopWatch

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]

user_get_tokens

Vecmodels::AccessToken user_get_tokens(username, page, limit) List the authenticated user's access tokens

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

Vecmodels::AccessToken

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]

user_list_activity_feeds

Vecmodels::Activity user_list_activity_feeds(username, only_performed_by, date, page, limit) List a user's activity feeds

Parameters

Name	Type	Description	Required	Notes
username	String	username of user	[required]
only_performed_by	Option<bool>	if true, only show actions performed by the requested user
date	Option<String>	the date of the activities to be found
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::Activity

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]

user_list_blocks

Vecmodels::User user_list_blocks(page, limit) List users blocked by the authenticated user

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::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]

user_list_emails

Vecmodels::Email user_list_emails() List the authenticated user's email addresses

Parameters

This endpoint does not need any parameter.

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]

user_list_followers

Vecmodels::User user_list_followers(username, page, limit) List the given user's followers

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

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]

user_list_following

Vecmodels::User user_list_following(username, page, limit) List the users that the given user is following

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

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]

user_list_gpg_keys

Vecmodels::GpgKey user_list_gpg_keys(username, page, limit) List the given user's GPG keys

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

Vecmodels::GpgKey

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]

user_list_hooks

Vecmodels::Hook user_list_hooks(page, limit) List the authenticated user'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

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]

user_list_keys

Vecmodels::PublicKey user_list_keys(username, fingerprint, page, limit) List the given user's public keys

Parameters

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

Return type

Vecmodels::PublicKey

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]

user_list_repos

Vecmodels::Repository user_list_repos(username, page, limit) List the repos owned by the given user

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

Vecmodels::Repository

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]

user_list_starred

Vecmodels::Repository user_list_starred(username, page, limit) The repos that the given user has starred

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

Vecmodels::Repository

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]

user_list_subscriptions

Vecmodels::Repository user_list_subscriptions(username, page, limit) List the repositories watched by a user

Parameters

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

Return type

Vecmodels::Repository

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]

user_list_teams

Vecmodels::Team user_list_teams(page, limit) List all the teams a user belongs to

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::Team

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]

user_search

models::UserSearch200Response user_search(q, uid, page, limit) Search for users

Parameters

Name	Type	Description	Required	Notes
q	Option<String>	keyword
uid	Option<i64>	ID of the user to search for
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

models::UserSearch200Response

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]

user_unblock_user

user_unblock_user(username) Unblock a user

Parameters

Name	Type	Description	Required	Notes
username	String	user to unblock	[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]

user_update_avatar

user_update_avatar(body) Update Avatar

Parameters

Name	Type	Description	Required	Notes
body	Option<UpdateUserAvatarOption>

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]

user_update_o_auth2_application

models::OAuth2Application user_update_o_auth2_application(id, body) update an OAuth2 Application, this includes regenerating the client secret

Parameters

Name	Type	Description	Required	Notes
id	i64	application to be updated	[required]
body	CreateOAuth2ApplicationOptions		[required]

Return type

models::OAuth2Application

Authorization

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

HTTP request headers

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

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

user_verify_gpg_key

models::GpgKey user_verify_gpg_key() Verify a GPG key

Parameters

This endpoint does not need any parameter.

Return type

models::GpgKey

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]