Gitea · Schema

User

User represents a user

GitSource ControlDevOpsCI/CDCode HostingOpen SourceSelf HostedPackage RegistryIssue TrackingPull Requests

Properties

Name Type Description
active boolean Is user active
avatar_url string URL to the user's avatar
created string
description string the user's description
email string
followers_count integer user counts
following_count integer
full_name string the user's full name
html_url string URL to the user's gitea page
id integer the user's id
is_admin boolean Is the user an administrator
language string User locale
last_login string
location string the user's location
login string login of the user, same as `username`
login_name string identifier of the user, provided by the external authenticator (if configured)
prohibit_login boolean Is user login prohibited
restricted boolean Is user restricted
source_id integer The ID of the user's Authentication Source
starred_repos_count integer
visibility string User visibility level option: public, limited, private
website string the user's website
View JSON Schema on GitHub

JSON Schema

gitea-rest-api-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gitea/main/json-schema/gitea-rest-api-user-schema.json",
  "title": "User",
  "description": "User represents a user",
  "type": "object",
  "properties": {
    "active": {
      "description": "Is user active",
      "type": "boolean",
      "x-go-name": "IsActive"
    },
    "avatar_url": {
      "description": "URL to the user's avatar",
      "type": "string",
      "x-go-name": "AvatarURL"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "x-go-name": "Created"
    },
    "description": {
      "description": "the user's description",
      "type": "string",
      "x-go-name": "Description"
    },
    "email": {
      "type": "string",
      "format": "email",
      "x-go-name": "Email"
    },
    "followers_count": {
      "description": "user counts",
      "type": "integer",
      "format": "int64",
      "x-go-name": "Followers"
    },
    "following_count": {
      "type": "integer",
      "format": "int64",
      "x-go-name": "Following"
    },
    "full_name": {
      "description": "the user's full name",
      "type": "string",
      "x-go-name": "FullName"
    },
    "html_url": {
      "description": "URL to the user's gitea page",
      "type": "string",
      "x-go-name": "HTMLURL"
    },
    "id": {
      "description": "the user's id",
      "type": "integer",
      "format": "int64",
      "x-go-name": "ID"
    },
    "is_admin": {
      "description": "Is the user an administrator",
      "type": "boolean",
      "x-go-name": "IsAdmin"
    },
    "language": {
      "description": "User locale",
      "type": "string",
      "x-go-name": "Language"
    },
    "last_login": {
      "type": "string",
      "format": "date-time",
      "x-go-name": "LastLogin"
    },
    "location": {
      "description": "the user's location",
      "type": "string",
      "x-go-name": "Location"
    },
    "login": {
      "description": "login of the user, same as `username`",
      "type": "string",
      "x-go-name": "UserName"
    },
    "login_name": {
      "description": "identifier of the user, provided by the external authenticator (if configured)",
      "type": "string",
      "default": "empty",
      "x-go-name": "LoginName"
    },
    "prohibit_login": {
      "description": "Is user login prohibited",
      "type": "boolean",
      "x-go-name": "ProhibitLogin"
    },
    "restricted": {
      "description": "Is user restricted",
      "type": "boolean",
      "x-go-name": "Restricted"
    },
    "source_id": {
      "description": "The ID of the user's Authentication Source",
      "type": "integer",
      "format": "int64",
      "x-go-name": "SourceID"
    },
    "starred_repos_count": {
      "type": "integer",
      "format": "int64",
      "x-go-name": "StarredRepos"
    },
    "visibility": {
      "description": "User visibility level option: public, limited, private",
      "type": "string",
      "x-go-name": "Visibility"
    },
    "website": {
      "description": "the user's website",
      "type": "string",
      "x-go-name": "Website"
    }
  },
  "x-go-package": "code.gitea.io/gitea/modules/structs"
}