--- updatedAt: 2025-09-02T07:17:19.000Z agentTools: projectIndex: https://jamaibase.readme.io/llms.txt --- # Register with email and password. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "JamAI Base API", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "0.1.0", "x-logo": { "url": "https://www.jamaibase.com/favicon.svg" } }, "servers": [ { "url": "https://api.jamaibase.com" } ], "paths": { "/api/v2/auth/register/password": { "post": { "tags": [ "Authentication (Internal API)" ], "summary": "Register with email and password.", "operationId": "register_password_api_v2_auth_register_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserReadObscured" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "OrgMember_": { "properties": { "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Creation datetime (UTC)." }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Update datetime (UTC)." }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta", "description": "Metadata.", "default": {} }, "role": { "$ref": "#/components/schemas/Role", "description": "Organization role." }, "user_id": { "type": "string", "title": "User Id", "description": "User ID." }, "organization_id": { "type": "string", "title": "Organization Id", "description": "Organization ID." } }, "type": "object", "required": [ "created_at", "updated_at", "role", "user_id", "organization_id" ], "title": "OrgMember_" }, "Organization_": { "properties": { "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Creation datetime (UTC)." }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Update datetime (UTC)." }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta", "description": "Metadata.", "default": {} }, "name": { "type": "string", "maxLength": 255, "title": "Name", "description": "Organization name." }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ], "maxLength": 3, "minLength": 3, "title": "Currency", "description": "Currency of the organization.", "default": "USD" }, "timezone": { "anyOf": [ { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Factory", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "localtime" ], "minLength": 1 }, { "type": "null" } ], "title": "Timezone", "description": "Timezone specifier." }, "external_keys": { "additionalProperties": { "type": "string" }, "type": "object", "title": "External Keys", "description": "Mapping of external service provider to its API key.", "default": {} }, "id": { "type": "string", "title": "Id", "description": "Organization ID." }, "created_by": { "type": "string", "title": "Created By", "description": "ID of the user that created this organization." }, "owner": { "type": "string", "title": "Owner", "description": "ID of the user that owns this organization." }, "stripe_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Id", "description": "Stripe Customer ID." }, "price_plan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Price Plan Id", "description": "Price plan ID." }, "payment_state": { "$ref": "#/components/schemas/PaymentState", "description": "Payment state of the organization." }, "last_subscription_payment_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Subscription Payment At", "description": "Datetime of the last successful subscription payment (UTC)." }, "quota_reset_at": { "type": "string", "format": "date-time", "title": "Quota Reset At", "description": "Quota reset datetime (UTC)." }, "credit": { "type": "number", "title": "Credit", "description": "Credit paid by the customer. Unused credit will be carried forward to the next billing cycle." }, "credit_grant": { "type": "number", "title": "Credit Grant", "description": "Credit granted to the customer. Unused credit will NOT be carried forward." }, "llm_tokens_quota_mtok": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Llm Tokens Quota Mtok", "description": "LLM token quota in millions of tokens." }, "llm_tokens_usage_mtok": { "type": "number", "title": "Llm Tokens Usage Mtok", "description": "LLM token usage in millions of tokens." }, "embedding_tokens_quota_mtok": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Embedding Tokens Quota Mtok", "description": "Embedding token quota in millions of tokens." }, "embedding_tokens_usage_mtok": { "type": "number", "title": "Embedding Tokens Usage Mtok", "description": "Embedding token quota in millions of tokens." }, "reranker_quota_ksearch": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Reranker Quota Ksearch", "description": "Reranker quota for every thousand searches." }, "reranker_usage_ksearch": { "type": "number", "title": "Reranker Usage Ksearch", "description": "Reranker usage for every thousand searches." }, "db_quota_gib": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Db Quota Gib", "description": "DB storage quota in GiB." }, "db_usage_gib": { "type": "number", "title": "Db Usage Gib", "description": "DB storage usage in GiB." }, "db_usage_updated_at": { "type": "string", "format": "date-time", "title": "Db Usage Updated At", "description": "Datetime of the last successful DB usage update (UTC)." }, "file_quota_gib": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "File Quota Gib", "description": "File storage quota in GiB." }, "file_usage_gib": { "type": "number", "title": "File Usage Gib", "description": "File storage usage in GiB." }, "file_usage_updated_at": { "type": "string", "format": "date-time", "title": "File Usage Updated At", "description": "Datetime of the last successful File usage update (UTC)." }, "egress_quota_gib": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Egress Quota Gib", "description": "Egress quota in GiB." }, "egress_usage_gib": { "type": "number", "title": "Egress Usage Gib", "description": "Egress usage in GiB." }, "active": { "type": "boolean", "title": "Active", "description": "Whether the organization's quota is active (paid)." }, "quotas": { "additionalProperties": { "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "object" }, "type": "object", "title": "Quotas", "description": "Quota snapshot." } }, "type": "object", "required": [ "created_at", "updated_at", "name", "id", "created_by", "owner", "stripe_id", "price_plan_id", "payment_state", "last_subscription_payment_at", "quota_reset_at", "credit", "credit_grant", "llm_tokens_quota_mtok", "llm_tokens_usage_mtok", "embedding_tokens_quota_mtok", "embedding_tokens_usage_mtok", "reranker_quota_ksearch", "reranker_usage_ksearch", "db_quota_gib", "db_usage_gib", "db_usage_updated_at", "file_quota_gib", "file_usage_gib", "file_usage_updated_at", "egress_quota_gib", "egress_usage_gib", "active", "quotas" ], "title": "Organization_" }, "PaymentState": { "type": "string", "enum": [ "NONE", "SUCCESS", "PROCESSING", "FAILED" ], "title": "PaymentState" }, "ProjectMember_": { "properties": { "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Creation datetime (UTC)." }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Update datetime (UTC)." }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta", "description": "Metadata.", "default": {} }, "role": { "$ref": "#/components/schemas/Role", "description": "Project role." }, "user_id": { "type": "string", "title": "User Id", "description": "User ID." }, "project_id": { "type": "string", "title": "Project Id", "description": "Project ID." } }, "type": "object", "required": [ "created_at", "updated_at", "role", "user_id", "project_id" ], "title": "ProjectMember_" }, "Project_": { "properties": { "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Creation datetime (UTC)." }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Update datetime (UTC)." }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta", "description": "Metadata.", "default": {} }, "name": { "type": "string", "maxLength": 255, "title": "Name", "description": "Project name." }, "quotas": { "additionalProperties": true, "type": "object", "title": "Quotas", "description": "Quotas allotted to this project.", "default": {} }, "organization_id": { "type": "string", "title": "Organization Id", "description": "Organization ID." }, "id": { "type": "string", "title": "Id", "description": "Project ID." }, "created_by": { "type": "string", "title": "Created By", "description": "ID of the user that created this project." }, "owner": { "type": "string", "title": "Owner", "description": "ID of the user that owns this project." } }, "type": "object", "required": [ "created_at", "updated_at", "name", "organization_id", "id", "created_by", "owner" ], "title": "Project_" }, "Role": { "type": "string", "enum": [ "ADMIN", "MEMBER", "GUEST" ], "title": "Role" }, "UserCreate": { "properties": { "meta": { "additionalProperties": true, "type": "object", "title": "Meta", "description": "Metadata.", "default": {} }, "name": { "type": "string", "maxLength": 255, "title": "Name", "description": "User's preferred name." }, "email": { "type": "string", "format": "email", "title": "Email", "description": "User's email." }, "picture_url": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Picture Url", "description": "User picture URL." }, "google_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Google Id", "description": "Google user ID." }, "google_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Google Name", "description": "Google user's preferred name." }, "google_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Google Username", "description": "Google username." }, "google_email": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ], "title": "Google Email", "description": "Google email." }, "google_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Google Picture Url", "description": "Google user picture URL." }, "google_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Google Updated At", "description": "Google user info update datetime (UTC)." }, "github_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Id", "description": "GitHub user ID." }, "github_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Name", "description": "GitHub user's preferred name." }, "github_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Username", "description": "GitHub username." }, "github_email": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ], "title": "Github Email", "description": "GitHub email." }, "github_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Picture Url", "description": "GitHub user picture URL." }, "github_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Github Updated At", "description": "GitHub user info update datetime (UTC)." }, "password": { "type": "string", "maxLength": 72, "title": "Password", "description": "Password in plain text.", "default": "" }, "id": { "type": "string", "title": "Id", "description": "User ID." } }, "type": "object", "required": [ "name", "email" ], "title": "UserCreate" }, "UserReadObscured": { "properties": { "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Creation datetime (UTC)." }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Update datetime (UTC)." }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta", "description": "Metadata.", "default": {} }, "name": { "type": "string", "maxLength": 255, "title": "Name", "description": "User's preferred name.", "default": "" }, "email": { "type": "string", "format": "email", "title": "Email", "description": "User's email.", "default": "" }, "picture_url": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Picture Url", "description": "User picture URL." }, "google_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Google Id", "description": "Google user ID." }, "google_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Google Name", "description": "Google user's preferred name." }, "google_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Google Username", "description": "Google username." }, "google_email": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ], "title": "Google Email", "description": "Google email." }, "google_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Google Picture Url", "description": "Google user picture URL." }, "google_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Google Updated At", "description": "Google user info update datetime (UTC)." }, "github_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Id", "description": "GitHub user ID." }, "github_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Name", "description": "GitHub user's preferred name." }, "github_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Username", "description": "GitHub username." }, "github_email": { "anyOf": [ { "type": "string", "format": "email" }, { "type": "null" } ], "title": "Github Email", "description": "GitHub email." }, "github_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Picture Url", "description": "GitHub user picture URL." }, "github_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Github Updated At", "description": "GitHub user info update datetime (UTC)." }, "id": { "type": "string", "title": "Id", "description": "User ID." }, "email_verified": { "type": "boolean", "title": "Email Verified", "description": "Whether the email address is verified." }, "password_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password Hash", "description": "Password hash." }, "refresh_counter": { "type": "integer", "title": "Refresh Counter", "description": "Counter used as refresh token version for invalidation.", "default": 0 }, "preferred_name": { "type": "string", "title": "Preferred Name", "description": "Name for display.", "default": "" }, "preferred_email": { "type": "string", "title": "Preferred Email", "description": "Email for display.", "default": "" }, "preferred_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preferred Picture Url", "description": "Picture URL for display." }, "preferred_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preferred Username", "description": "Username for display." }, "org_memberships": { "items": { "$ref": "#/components/schemas/OrgMember_" }, "type": "array", "title": "Org Memberships", "description": "List of organization memberships." }, "proj_memberships": { "items": { "$ref": "#/components/schemas/ProjectMember_" }, "type": "array", "title": "Proj Memberships", "description": "List of project memberships." }, "organizations": { "items": { "$ref": "#/components/schemas/Organization_" }, "type": "array", "title": "Organizations", "description": "List of organizations that this user is a member of." }, "projects": { "items": { "$ref": "#/components/schemas/Project_" }, "type": "array", "title": "Projects", "description": "List of projects that this user is a member of." } }, "type": "object", "required": [ "created_at", "updated_at", "email_verified", "password_hash", "org_memberships", "proj_memberships", "organizations", "projects" ], "title": "UserReadObscured" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "Authentication": { "type": "http", "scheme": "bearer" } } }, "security": [ { "Authentication": [] } ] } ```