Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat: update mgmt api docs (#47382)

supabase-supabase-autofixer[bot]eb21ae25f795
diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json
index 1af817aed15..df2dd7683e4 100644
--- a/apps/docs/spec/api_v1_openapi.json
+++ b/apps/docs/spec/api_v1_openapi.json
@@ -4442,8 +4442,9 @@
},
"/v1/projects/{ref}/analytics/endpoints/logs.all": {
"get": {
- "description": "Executes a SQL query on the project's logs.\n\nEither the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n\nNote: Unless the `sql` parameter is provided, only edge_logs will be queried. See the [log query docs](/docs/guides/telemetry/logs?queryGroups=product&product=postgres&queryGroups=source&source=edge_logs#querying-with-the-logs-explorer:~:text=logs%20from%20the-,Sources,-drop%2Ddown%3A) for all available sources. \n",
- "operationId": "v1-get-project-logs",
+ "deprecated": true,
+ "description": "Executes a SQL query on the project's logs.\n\nEither the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n\nNote: Unless the `sql` parameter is provided, only edge_logs will be queried. See the [log query docs](/docs/guides/telemetry/logs?queryGroups=product&product=postgres&queryGroups=source&source=edge_logs#querying-with-the-logs-explorer:~:text=logs%20from%20the-,Sources,-drop%2Ddown%3A) for all available sources.\n",
+ "operationId": "v1-get-project-logs-all",
"parameters": [
{
"name": "ref",
@@ -4486,6 +4487,7 @@
}
},
"401": { "description": "Unauthorized" },
+ "402": { "description": "Usage exceeded. Enable additional usage to continue querying" },
"403": { "description": "Forbidden action" },
"429": { "description": "Rate limit exceeded" }
},
@@ -4497,6 +4499,65 @@
"x-oauth-scope": "analytics:read"
}
},
+ "/v1/projects/{ref}/analytics/endpoints/logs": {
+ "get": {
+ "deprecated": false,
+ "description": "Executes an SQL or LQL query on the project's unified logs stream.\n\nEither the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n\nFilter by the `source` column to specify specific log sources, such as edge_logs, postgres_logs, etc.\n\nNote: SQL must be written in **ClickHouse SQL dialect**.\n",
+ "operationId": "v1-get-project-logs",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ },
+ {
+ "name": "sql",
+ "required": false,
+ "in": "query",
+ "description": "Custom SQL query to execute on the logs. See [querying logs](/docs/guides/telemetry/logs?queryGroups=product&product=postgres&queryGroups=source&source=edge_logs#querying-with-the-logs-explorer) for more details.",
+ "schema": { "type": "string" }
+ },
+ {
+ "name": "iso_timestamp_start",
+ "required": false,
+ "in": "query",
+ "schema": { "format": "date-time", "example": "2025-03-01T00:00:00Z", "type": "string" }
+ },
+ {
+ "name": "iso_timestamp_end",
+ "required": false,
+ "in": "query",
+ "schema": { "format": "date-time", "example": "2025-03-01T23:59:59Z", "type": "string" }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse" } }
+ }
+ },
+ "401": { "description": "Unauthorized" },
+ "402": { "description": "Usage exceeded. Enable additional usage to continue querying" },
+ "403": { "description": "Forbidden action" },
+ "429": { "description": "Rate limit exceeded" }
+ },
+ "security": [{ "bearer": [] }, { "fga_permissions": ["analytics_logs_read"] }],
+ "summary": "Gets all project's logs in a single log stream",
+ "tags": ["Analytics"],
+ "x-badges": [{ "name": "OAuth scope: analytics:read", "position": "after" }],
+ "x-endpoint-owners": ["analytics"],
+ "x-oauth-scope": "analytics:read"
+ }
+ },
"/v1/projects/{ref}/analytics/endpoints/usage.api-counts": {
"get": {
"operationId": "v1-get-project-usage-api-count",
@@ -5310,7 +5371,7 @@
"401": { "description": "Unauthorized" },
"403": { "description": "Forbidden action" },
"429": { "description": "Rate limit exceeded" },
- "500": { "description": "Failed to upsert database migration" }
+ "500": { "description": "Failed to update JIT access" }
},
"security": [{ "bearer": [] }, { "fga_permissions": ["database_jit_write"] }],
"summary": "Updates a user mapping for JIT access",
@@ -5357,6 +5418,137 @@
"x-endpoint-owners": ["security"]
}
},
+ "/v1/projects/{ref}/database/jit/invite": {
+ "post": {
+ "description": "Invites the external user and sets initial roles that can be assumed and for how long",
+ "operationId": "v1-invite-external-jit-access",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/InviteExternalUserJitAccessBody" }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/InviteExternalUserJitResponse" }
+ }
+ }
+ },
+ "401": { "description": "Unauthorized" },
+ "403": { "description": "Forbidden action" },
+ "429": { "description": "Rate limit exceeded" },
+ "500": { "description": "Failed to invite external user" }
+ },
+ "security": [{ "bearer": [] }, { "fga_permissions": ["database_jit_write"] }],
+ "summary": "Invites an external user to a database for JIT access",
+ "tags": ["Database"],
+ "x-endpoint-owners": ["security"]
+ }
+ },
+ "/v1/projects/{ref}/database/jit/invite/accept": {
+ "post": {
+ "description": "Accepts the invitation to JIT database access",
+ "operationId": "v1-accept-invite-external-jit-access",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/AcceptInviteExternalUserJitAccessBody" }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/JitAccessResponse" } }
+ }
+ },
+ "500": { "description": "Failed to accept invitation" }
+ },
+ "security": [{ "bearer": [] }],
+ "summary": "Accepts invitation for JIT database access",
+ "tags": ["Database"],
+ "x-endpoint-owners": ["security"]
+ }
+ },
+ "/v1/projects/{ref}/database/jit/invite/{invite_id}": {
+ "delete": {
+ "description": "Revokes and deletes the invitation",
+ "operationId": "v1-delete-invite-external-jit-access",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ },
+ {
+ "name": "invite_id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "format": "uuid",
+ "example": "55555555-5555-4555-8555-555555555555",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": { "description": "" },
+ "401": { "description": "Unauthorized" },
+ "403": { "description": "Forbidden action" },
+ "429": { "description": "Rate limit exceeded" },
+ "500": { "description": "Failed to revoke invite for external user" }
+ },
+ "security": [{ "bearer": [] }, { "fga_permissions": ["database_jit_write"] }],
+ "summary": "Deletes the invite for an external user to a database for JIT access",
+ "tags": ["Database"],
+ "x-endpoint-owners": ["security"]
+ }
+ },
"/v1/projects/{ref}/database/jit/{user_id}": {
"delete": {
"description": "Remove JIT mappings of a user, revoking all JIT database access",
@@ -8553,11 +8745,7 @@
"state": { "type": "string", "enum": ["unavailable"] },
"unavailableReason": {
"type": "string",
- "enum": [
- "manual_migration_required",
- "postgres_upgrade_required",
- "temporarily_unavailable"
- ]
+ "enum": ["postgres_upgrade_required", "temporarily_unavailable"]
}
},
"required": ["state", "unavailableReason"]
@@ -10976,7 +11164,7 @@
}
}
},
- "required": ["user_id", "user_roles"]
+ "required": ["user_roles"]
},
"AuthorizeJitAccessBody": {
"type": "object",
@@ -11030,44 +11218,94 @@
"items": {
"type": "array",
"items": {
- "type": "object",
- "properties": {
- "user_id": { "type": "string", "format": "uuid" },
- "user_roles": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "role": { "type": "string", "minLength": 1 },
- "expires_at": { "type": "number" },
- "allowed_networks": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "user_id": { "type": "string", "format": "uuid" },
+ "primary_email": { "type": "string", "nullable": true },
+ "invite_id": { "type": "null" },
+ "expires_at": { "type": "null" },
+ "user_roles": {
+ "type": "array",
+ "items": {
"type": "object",
"properties": {
- "allowed_cidrs": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": { "cidr": { "type": "string" } },
- "required": ["cidr"]
+ "role": { "type": "string", "minLength": 1 },
+ "expires_at": { "type": "number" },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "cidr": { "type": "string" } },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "cidr": { "type": "string" } },
+ "required": ["cidr"]
+ }
+ }
}
},
- "allowed_cidrs_v6": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": { "cidr": { "type": "string" } },
- "required": ["cidr"]
+ "branches_only": { "type": "boolean" }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["user_id", "primary_email", "invite_id", "expires_at", "user_roles"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "user_id": { "type": "null" },
+ "primary_email": { "type": "string" },
+ "invite_id": { "type": "string", "format": "uuid" },
+ "expires_at": { "type": "string" },
+ "user_roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": { "type": "string", "minLength": 1 },
+ "expires_at": { "type": "number" },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "cidr": { "type": "string" } },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "cidr": { "type": "string" } },
+ "required": ["cidr"]
+ }
+ }
}
- }
- }
- },
- "branches_only": { "type": "boolean" }
- },
- "required": ["role"]
- }
+ },
+ "branches_only": { "type": "boolean" }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["user_id", "primary_email", "invite_id", "expires_at", "user_roles"]
}
- },
- "required": ["user_id", "user_roles"]
+ ]
}
}
},
@@ -11124,6 +11362,107 @@
]
}
},
+ "InviteExternalUserJitAccessBody": {
+ "type": "object",
+ "properties": {
+ "email": { "type": "string", "format": "email", "minLength": 1 },
+ "roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": { "type": "string", "minLength": 1 },
+ "expires_at": { "type": "number" },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "cidr": { "type": "string" } },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "cidr": { "type": "string" } },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": { "type": "boolean" }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["email", "roles"],
+ "example": {
+ "email": "[email protected]",
+ "roles": [
+ {
+ "role": "postgres",
+ "expires_at": 1740787200,
+ "allowed_networks": { "allowed_cidrs": [{ "cidr": "203.0.113.0/24" }] },
+ "branches_only": false
+ }
+ ]
+ }
+ },
+ "InviteExternalUserJitResponse": {
+ "type": "object",
+ "properties": {
+ "email": { "type": "string", "format": "email" },
+ "invite_id": { "type": "string", "format": "uuid" },
+ "user_roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": { "type": "string", "minLength": 1 },
+ "expires_at": { "type": "number" },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "cidr": { "type": "string" } },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "cidr": { "type": "string" } },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": { "type": "boolean" }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["email", "invite_id", "user_roles"]
+ },
+ "AcceptInviteExternalUserJitAccessBody": {
+ "type": "object",
+ "properties": {
+ "email": { "type": "string", "format": "email", "minLength": 1 },
+ "token": { "type": "string", "minLength": 1 }
+ },
+ "required": ["email", "token"],
+ "example": { "email": "[email protected]", "token": "" }
+ },
"FunctionResponse": {
"type": "object",
"properties": {
@@ -12542,9 +12881,10 @@
"user_name": { "type": "string" },
"email": { "type": "string" },
"role_name": { "type": "string" },
- "mfa_enabled": { "type": "boolean" }
+ "mfa_enabled": { "type": "boolean" },
+ "avatar_url": { "type": "string", "nullable": true }
},
- "required": ["user_id", "user_name", "role_name", "mfa_enabled"]
+ "required": ["user_id", "user_name", "role_name", "mfa_enabled", "avatar_url"]
},
"V1OrganizationSlugResponse": {
"type": "object",
diff --git a/apps/docs/spec/api_v2_openapi.json b/apps/docs/spec/api_v2_openapi.json
index a576b8f8cf3..b65f8d3facf 100644
--- a/apps/docs/spec/api_v2_openapi.json
+++ b/apps/docs/spec/api_v2_openapi.json
@@ -1058,6 +1058,11 @@
"type": "boolean",
"description": "Whether this member is a Single Sign-On user"
},
+ "avatar_url": {
+ "type": "string",
+ "nullable": true,
+ "description": "Member's avatar URL"
+ },
"roles": {
"type": "array",
"items": {
@@ -1092,7 +1097,14 @@
"description": "Roles assigned to this member. Includes both org-level and project-scoped roles."
}
},
- "required": ["username", "primary_email", "mfa_enabled", "is_sso_user", "roles"]
+ "required": [
+ "username",
+ "primary_email",
+ "mfa_enabled",
+ "is_sso_user",
+ "avatar_url",
+ "roles"
+ ]
}
},
"required": ["type", "id", "attributes"]
diff --git a/apps/docs/spec/common-api-sections.json b/apps/docs/spec/common-api-sections.json
index 254629246b8..643f61d6721 100644
--- a/apps/docs/spec/common-api-sections.json
+++ b/apps/docs/spec/common-api-sections.json
@@ -52,6 +52,12 @@
"slug": "v1-get-project-logs",
"type": "operation"
},
+ {
+ "id": "v1-get-project-logs-all",
+ "title": "Get project logs all",
+ "slug": "v1-get-project-logs-all",
+ "type": "operation"
+ },
{
"id": "v1-get-project-usage-api-count",
"title": "Get project usage api count",
@@ -220,6 +226,12 @@
"type": "category",
"title": "Database",
"items": [
+ {
+ "id": "v1-accept-invite-external-jit-access",
+ "title": "Accept invite external jit access",
+ "slug": "v1-accept-invite-external-jit-access",
+ "type": "operation"
+ },
{
"id": "v1-apply-a-migration",
"title": "Apply a migration",
@@ -238,6 +250,12 @@
"slug": "v1-create-login-role",
"type": "operation"
},
+ {
+ "id": "v1-delete-invite-external-jit-access",
+ "title": "Delete invite external jit access",
+ "slug": "v1-delete-invite-external-jit-access",
+ "type": "operation"
+ },
{
"id": "v1-delete-jit-access",
"title": "Delete jit access",
@@ -340,6 +358,12 @@
"slug": "v1-get-ssl-enforcement-config",
"type": "operation"
},
+ {
+ "id": "v1-invite-external-jit-access",
+ "title": "Invite external jit access",
+ "slug": "v1-invite-external-jit-access",
+ "type": "operation"
+ },
{
"id": "v1-list-all-backups",
"title": "List all backups",
diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
index a52a6d0f5ef..7b5acefc63c 100644
--- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
+++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
@@ -5445,11 +5445,7 @@
},
"unavailableReason": {
"type": "string",
- "enum": [
- "manual_migration_required",
- "postgres_upgrade_required",
- "temporarily_unavailable"
- ]
+ "enum": ["postgres_upgrade_required", "temporarily_unavailable"]
}
},
"required": ["state", "unavailableReason"]
@@ -5560,11 +5556,7 @@
},
"unavailableReason": {
"type": "string",
- "enum": [
- "manual_migration_required",
- "postgres_upgrade_required",
- "temporarily_unavailable"
- ]
+ "enum": ["postgres_upgrade_required", "temporarily_unavailable"]
}
},
"required": ["state", "unavailableReason"]
@@ -14949,8 +14941,9 @@
},
"/v1/projects/{ref}/analytics/endpoints/logs.all": {
"get": {
- "description": "Executes a SQL query on the project's logs.\n\nEither the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n\nNote: Unless the `sql` parameter is provided, only edge_logs will be queried. See the [log query docs](/docs/guides/telemetry/logs?queryGroups=product&product=postgres&queryGroups=source&source=edge_logs#querying-with-the-logs-explorer:~:text=logs%20from%20the-,Sources,-drop%2Ddown%3A) for all available sources. \n",
- "operationId": "v1-get-project-logs",
+ "deprecated": true,
+ "description": "Executes a SQL query on the project's logs.\n\nEither the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n\nNote: Unless the `sql` parameter is provided, only edge_logs will be queried. See the [log query docs](/docs/guides/telemetry/logs?queryGroups=product&product=postgres&queryGroups=source&source=edge_logs#querying-with-the-logs-explorer:~:text=logs%20from%20the-,Sources,-drop%2Ddown%3A) for all available sources.\n",
+ "operationId": "v1-get-project-logs-all",
"parameters": [
{
"name": "ref",
@@ -15067,6 +15060,9 @@
"401": {
"description": "Unauthorized"
},
+ "402": {
+ "description": "Usage exceeded. Enable additional usage to continue querying"
+ },
"403": {
"description": "Forbidden action"
},
@@ -15094,6 +15090,157 @@
"x-oauth-scope": "analytics:read"
}
},
+ "/v1/projects/{ref}/analytics/endpoints/logs": {
+ "get": {
+ "deprecated": false,
+ "description": "Executes an SQL or LQL query on the project's unified logs stream.\n\nEither the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n\nFilter by the `source` column to specify specific log sources, such as edge_logs, postgres_logs, etc.\n\nNote: SQL must be written in **ClickHouse SQL dialect**.\n",
+ "operationId": "v1-get-project-logs",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ },
+ {
+ "name": "sql",
+ "required": false,
+ "in": "query",
+ "description": "Custom SQL query to execute on the logs. See [querying logs](/docs/guides/telemetry/logs?queryGroups=product&product=postgres&queryGroups=source&source=edge_logs#querying-with-the-logs-explorer) for more details.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "iso_timestamp_start",
+ "required": false,
+ "in": "query",
+ "schema": {
+ "format": "date-time",
+ "example": "2025-03-01T00:00:00Z",
+ "type": "string"
+ }
+ },
+ {
+ "name": "iso_timestamp_end",
+ "required": false,
+ "in": "query",
+ "schema": {
+ "format": "date-time",
+ "example": "2025-03-01T23:59:59Z",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "type": "array",
+ "items": {}
+ },
+ "error": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "number"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "domain": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string"
+ },
+ "locationType": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "domain",
+ "location",
+ "locationType",
+ "message",
+ "reason"
+ ]
+ }
+ },
+ "message": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ },
+ "required": ["code", "errors", "message", "status"]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "402": {
+ "description": "Usage exceeded. Enable additional usage to continue querying"
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ },
+ {
+ "fga_permissions": ["analytics_logs_read"]
+ }
+ ],
+ "summary": "Gets all project's logs in a single log stream",
+ "tags": ["Analytics"],
+ "x-badges": [
+ {
+ "name": "OAuth scope: analytics:read",
+ "position": "after"
+ }
+ ],
+ "x-endpoint-owners": ["analytics"],
+ "x-oauth-scope": "analytics:read"
+ }
+ },
"/v1/projects/{ref}/analytics/endpoints/usage.api-counts": {
"get": {
"operationId": "v1-get-project-usage-api-count",
@@ -16650,7 +16797,7 @@
}
}
},
- "required": ["user_id", "user_roles"]
+ "required": ["user_roles"]
}
}
}
@@ -16987,7 +17134,7 @@
}
}
},
- "required": ["user_id", "user_roles"]
+ "required": ["user_roles"]
}
}
}
@@ -17002,7 +17149,7 @@
"description": "Rate limit exceeded"
},
"500": {
- "description": "Failed to upsert database migration"
+ "description": "Failed to update JIT access"
}
},
"security": [
@@ -17048,62 +17195,155 @@
"items": {
"type": "array",
"items": {
- "type": "object",
- "properties": {
- "user_id": {
- "type": "string",
- "format": "uuid"
- },
- "user_roles": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "minLength": 1
- },
- "expires_at": {
- "type": "number"
- },
- "allowed_networks": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "user_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "primary_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "invite_id": {
+ "type": "null"
+ },
+ "expires_at": {
+ "type": "null"
+ },
+ "user_roles": {
+ "type": "array",
+ "items": {
"type": "object",
"properties": {
- "allowed_cidrs": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "cidr": {
- "type": "string"
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
}
},
- "required": ["cidr"]
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
}
},
- "allowed_cidrs_v6": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "cidr": {
- "type": "string"
+ "branches_only": {
+ "type": "boolean"
+ }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": [
+ "user_id",
+ "primary_email",
+ "invite_id",
+ "expires_at",
+ "user_roles"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "user_id": {
+ "type": "null"
+ },
+ "primary_email": {
+ "type": "string"
+ },
+ "invite_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "expires_at": {
+ "type": "string"
+ },
+ "user_roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
}
},
- "required": ["cidr"]
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
}
+ },
+ "branches_only": {
+ "type": "boolean"
}
- }
- },
- "branches_only": {
- "type": "boolean"
+ },
+ "required": ["role"]
}
- },
- "required": ["role"]
- }
+ }
+ },
+ "required": [
+ "user_id",
+ "primary_email",
+ "invite_id",
+ "expires_at",
+ "user_roles"
+ ]
}
- },
- "required": ["user_id", "user_roles"]
+ ]
}
}
},
@@ -17138,10 +17378,10 @@
"x-endpoint-owners": ["security"]
}
},
- "/v1/projects/{ref}/database/jit/{user_id}": {
- "delete": {
- "description": "Remove JIT mappings of a user, revoking all JIT database access",
- "operationId": "v1-delete-jit-access",
+ "/v1/projects/{ref}/database/jit/invite": {
+ "post": {
+ "description": "Invites the external user and sets initial roles that can be assumed and for how long",
+ "operationId": "v1-invite-external-jit-access",
"parameters": [
{
"name": "ref",
@@ -17155,21 +17395,160 @@
"example": "abcdefghijklmnopqrst",
"type": "string"
}
- },
- {
- "name": "user_id",
- "required": true,
- "in": "path",
- "schema": {
- "format": "uuid",
- "example": "55555555-5555-4555-8555-555555555555",
- "type": "string"
- }
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "minLength": 1
+ },
+ "roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": {
+ "type": "boolean"
+ }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["email", "roles"],
+ "example": {
+ "email": "[email protected]",
+ "roles": [
+ {
+ "role": "postgres",
+ "expires_at": 1740787200,
+ "allowed_networks": {
+ "allowed_cidrs": [
+ {
+ "cidr": "203.0.113.0/24"
+ }
+ ]
+ },
+ "branches_only": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": ""
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email"
+ },
+ "invite_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "user_roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": {
+ "type": "boolean"
+ }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["email", "invite_id", "user_roles"]
+ }
+ }
+ }
},
"401": {
"description": "Unauthorized"
@@ -17181,7 +17560,7 @@
"description": "Rate limit exceeded"
},
"500": {
- "description": "Failed to remove JIT access"
+ "description": "Failed to invite external user"
}
},
"security": [
@@ -17192,15 +17571,15 @@
"fga_permissions": ["database_jit_write"]
}
],
- "summary": "Delete JIT access by user-id",
+ "summary": "Invites an external user to a database for JIT access",
"tags": ["Database"],
"x-endpoint-owners": ["security"]
}
},
- "/v1/projects/{ref}/database/openapi": {
- "get": {
- "description": "Returns the PostgREST OpenAPI specification for the project. This is the replacement for querying `/rest/v1/` directly with the anon key.",
- "operationId": "v1-get-database-openapi",
+ "/v1/projects/{ref}/database/jit/invite/accept": {
+ "post": {
+ "description": "Accepts the invitation to JIT database access",
+ "operationId": "v1-accept-invite-external-jit-access",
"parameters": [
{
"name": "ref",
@@ -17214,47 +17593,290 @@
"example": "abcdefghijklmnopqrst",
"type": "string"
}
- },
- {
- "name": "schema",
- "required": false,
- "in": "query",
- "description": "The database schema to generate the OpenAPI spec for",
- "schema": {
- "default": "public",
- "type": "string"
- }
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "minLength": 1
+ },
+ "token": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "required": ["email", "token"],
+ "example": {
+ "email": "[email protected]",
+ "token": ""
+ }
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
- "type": "object"
+ "type": "object",
+ "properties": {
+ "user_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "user_roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": {
+ "type": "boolean"
+ }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["user_roles"]
}
}
}
},
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden action"
- },
- "429": {
- "description": "Rate limit exceeded"
- },
"500": {
- "description": "Failed to fetch PostgREST OpenAPI spec"
+ "description": "Failed to accept invitation"
}
},
"security": [
{
"bearer": []
- },
- {
+ }
+ ],
+ "summary": "Accepts invitation for JIT database access",
+ "tags": ["Database"],
+ "x-endpoint-owners": ["security"]
+ }
+ },
+ "/v1/projects/{ref}/database/jit/invite/{invite_id}": {
+ "delete": {
+ "description": "Revokes and deletes the invitation",
+ "operationId": "v1-delete-invite-external-jit-access",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ },
+ {
+ "name": "invite_id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "format": "uuid",
+ "example": "55555555-5555-4555-8555-555555555555",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": ""
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ },
+ "500": {
+ "description": "Failed to revoke invite for external user"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ },
+ {
+ "fga_permissions": ["database_jit_write"]
+ }
+ ],
+ "summary": "Deletes the invite for an external user to a database for JIT access",
+ "tags": ["Database"],
+ "x-endpoint-owners": ["security"]
+ }
+ },
+ "/v1/projects/{ref}/database/jit/{user_id}": {
+ "delete": {
+ "description": "Remove JIT mappings of a user, revoking all JIT database access",
+ "operationId": "v1-delete-jit-access",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ },
+ {
+ "name": "user_id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "format": "uuid",
+ "example": "55555555-5555-4555-8555-555555555555",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": ""
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ },
+ "500": {
+ "description": "Failed to remove JIT access"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ },
+ {
+ "fga_permissions": ["database_jit_write"]
+ }
+ ],
+ "summary": "Delete JIT access by user-id",
+ "tags": ["Database"],
+ "x-endpoint-owners": ["security"]
+ }
+ },
+ "/v1/projects/{ref}/database/openapi": {
+ "get": {
+ "description": "Returns the PostgREST OpenAPI specification for the project. This is the replacement for querying `/rest/v1/` directly with the anon key.",
+ "operationId": "v1-get-database-openapi",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ },
+ {
+ "name": "schema",
+ "required": false,
+ "in": "query",
+ "description": "The database schema to generate the OpenAPI spec for",
+ "schema": {
+ "default": "public",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ },
+ "500": {
+ "description": "Failed to fetch PostgREST OpenAPI spec"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ },
+ {
"fga_permissions": ["database_read"]
}
],
@@ -22379,9 +23001,13 @@
},
"mfa_enabled": {
"type": "boolean"
+ },
+ "avatar_url": {
+ "type": "string",
+ "nullable": true
}
},
- "required": ["user_id", "user_name", "role_name", "mfa_enabled"]
+ "required": ["user_id", "user_name", "role_name", "mfa_enabled", "avatar_url"]
}
}
}
@@ -24616,11 +25242,7 @@
},
"unavailableReason": {
"type": "string",
- "enum": [
- "manual_migration_required",
- "postgres_upgrade_required",
- "temporarily_unavailable"
- ]
+ "enum": ["postgres_upgrade_required", "temporarily_unavailable"]
}
},
"required": ["state", "unavailableReason"]
@@ -29100,49 +29722,329 @@
"name": {
"type": "string"
}
- },
- "required": ["name"],
- "additionalProperties": true
- }
+ },
+ "required": ["name"],
+ "additionalProperties": true
+ }
+ }
+ },
+ "required": ["name", "schemas"],
+ "additionalProperties": true
+ }
+ }
+ },
+ "required": ["databases"]
+ },
+ "V1UpdatePasswordBody": {
+ "type": "object",
+ "properties": {
+ "password": {
+ "type": "string",
+ "minLength": 4
+ }
+ },
+ "required": ["password"],
+ "example": {
+ "password": "correct-horse-battery-staple"
+ }
+ },
+ "V1UpdatePasswordResponse": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": ["message"]
+ },
+ "JitAccessResponse": {
+ "type": "object",
+ "properties": {
+ "user_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "user_roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": {
+ "type": "boolean"
+ }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["user_roles"]
+ },
+ "AuthorizeJitAccessBody": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "rhost": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "required": ["role", "rhost"],
+ "example": {
+ "role": "postgres",
+ "rhost": "203.0.113.10"
+ }
+ },
+ "JitAuthorizeAccessResponse": {
+ "type": "object",
+ "properties": {
+ "user_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "user_role": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": {
+ "type": "boolean"
+ }
+ },
+ "required": ["role"]
+ }
+ },
+ "required": ["user_id", "user_role"]
+ },
+ "JitListAccessResponse": {
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "user_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "primary_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "invite_id": {
+ "type": "null"
+ },
+ "expires_at": {
+ "type": "null"
+ },
+ "user_roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": {
+ "type": "boolean"
+ }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["user_id", "primary_email", "invite_id", "expires_at", "user_roles"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "user_id": {
+ "type": "null"
+ },
+ "primary_email": {
+ "type": "string"
+ },
+ "invite_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "expires_at": {
+ "type": "string"
+ },
+ "user_roles": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "minLength": 1
+ },
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ },
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
+ }
+ },
+ "branches_only": {
+ "type": "boolean"
+ }
+ },
+ "required": ["role"]
+ }
+ }
+ },
+ "required": ["user_id", "primary_email", "invite_id", "expires_at", "user_roles"]
}
- },
- "required": ["name", "schemas"],
- "additionalProperties": true
+ ]
}
}
},
- "required": ["databases"]
- },
- "V1UpdatePasswordBody": {
- "type": "object",
- "properties": {
- "password": {
- "type": "string",
- "minLength": 4
- }
- },
- "required": ["password"],
- "example": {
- "password": "correct-horse-battery-staple"
- }
- },
- "V1UpdatePasswordResponse": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- }
- },
- "required": ["message"]
+ "required": ["items"]
},
- "JitAccessResponse": {
+ "UpdateJitAccessBody": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
- "format": "uuid"
+ "format": "uuid",
+ "minLength": 1
},
- "user_roles": {
+ "roles": {
"type": "array",
"items": {
"type": "object",
@@ -29191,157 +30093,113 @@
}
}
},
- "required": ["user_id", "user_roles"]
- },
- "AuthorizeJitAccessBody": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "minLength": 1
- },
- "rhost": {
- "type": "string",
- "minLength": 1
- }
- },
- "required": ["role", "rhost"],
+ "required": ["user_id", "roles"],
"example": {
- "role": "postgres",
- "rhost": "203.0.113.10"
- }
- },
- "JitAuthorizeAccessResponse": {
- "type": "object",
- "properties": {
- "user_id": {
- "type": "string",
- "format": "uuid"
- },
- "user_role": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "minLength": 1
- },
- "expires_at": {
- "type": "number"
- },
+ "user_id": "55555555-5555-4555-8555-555555555555",
+ "roles": [
+ {
+ "role": "postgres",
+ "expires_at": 1740787200,
"allowed_networks": {
- "type": "object",
- "properties": {
- "allowed_cidrs": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "cidr": {
- "type": "string"
- }
- },
- "required": ["cidr"]
- }
- },
- "allowed_cidrs_v6": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "cidr": {
- "type": "string"
- }
- },
- "required": ["cidr"]
- }
+ "allowed_cidrs": [
+ {
+ "cidr": "203.0.113.0/24"
}
- }
+ ]
},
- "branches_only": {
- "type": "boolean"
- }
- },
- "required": ["role"]
- }
- },
- "required": ["user_id", "user_role"]
+ "branches_only": false
+ }
+ ]
+ }
},
- "JitListAccessResponse": {
+ "InviteExternalUserJitAccessBody": {
"type": "object",
"properties": {
- "items": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "minLength": 1
+ },
+ "roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
- "user_id": {
+ "role": {
"type": "string",
- "format": "uuid"
+ "minLength": 1
},
- "user_roles": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "minLength": 1
- },
- "expires_at": {
- "type": "number"
- },
- "allowed_networks": {
+ "expires_at": {
+ "type": "number"
+ },
+ "allowed_networks": {
+ "type": "object",
+ "properties": {
+ "allowed_cidrs": {
+ "type": "array",
+ "items": {
"type": "object",
"properties": {
- "allowed_cidrs": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "cidr": {
- "type": "string"
- }
- },
- "required": ["cidr"]
- }
- },
- "allowed_cidrs_v6": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "cidr": {
- "type": "string"
- }
- },
- "required": ["cidr"]
- }
+ "cidr": {
+ "type": "string"
}
- }
- },
- "branches_only": {
- "type": "boolean"
+ },
+ "required": ["cidr"]
}
},
- "required": ["role"]
+ "allowed_cidrs_v6": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cidr": {
+ "type": "string"
+ }
+ },
+ "required": ["cidr"]
+ }
+ }
}
+ },
+ "branches_only": {
+ "type": "boolean"
}
},
- "required": ["user_id", "user_roles"]
+ "required": ["role"]
}
}
},
- "required": ["items"]
+ "required": ["email", "roles"],
+ "example": {
+ "email": "[email protected]",
+ "roles": [
+ {
+ "role": "postgres",
+ "expires_at": 1740787200,
+ "allowed_networks": {
+ "allowed_cidrs": [
+ {
+ "cidr": "203.0.113.0/24"
+ }
+ ]
+ },
+ "branches_only": false
+ }
+ ]
+ }
},
- "UpdateJitAccessBody": {
+ "InviteExternalUserJitResponse": {
"type": "object",
"properties": {
- "user_id": {
+ "email": {
"type": "string",
- "format": "uuid",
- "minLength": 1
+ "format": "email"
},
- "roles": {
+ "invite_id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "user_roles": {
"type": "array",
"items": {
"type": "object",
@@ -29390,23 +30248,25 @@
}
}
},
- "required": ["user_id", "roles"],
+ "required": ["email", "invite_id", "user_roles"]
+ },
+ "AcceptInviteExternalUserJitAccessBody": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "minLength": 1
+ },
+ "token": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "required": ["email", "token"],
"example": {
- "user_id": "55555555-5555-4555-8555-555555555555",
- "roles": [
- {
- "role": "postgres",
- "expires_at": 1740787200,
- "allowed_networks": {
- "allowed_cidrs": [
- {
- "cidr": "203.0.113.0/24"
- }
- ]
- },
- "branches_only": false
- }
- ]
+ "email": "[email protected]",
+ "token": ""
}
},
"FunctionResponse": {
@@ -31725,9 +32585,13 @@
},
"mfa_enabled": {
"type": "boolean"
+ },
+ "avatar_url": {
+ "type": "string",
+ "nullable": true
}
},
- "required": ["user_id", "user_name", "role_name", "mfa_enabled"]
+ "required": ["user_id", "user_name", "role_name", "mfa_enabled", "avatar_url"]
},
"V1OrganizationSlugResponse": {
"type": "object",
diff --git a/apps/docs/spec/transforms/api_v2_openapi_deparsed.json b/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
index 45e90da5d75..0dcc4cc1f37 100644
--- a/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
+++ b/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
@@ -1687,6 +1687,11 @@
"type": "boolean",
"description": "Whether this member is a Single Sign-On user"
},
+ "avatar_url": {
+ "type": "string",
+ "nullable": true,
+ "description": "Member's avatar URL"
+ },
"roles": {
"type": "array",
"items": {
@@ -1733,6 +1738,7 @@
"primary_email",
"mfa_enabled",
"is_sso_user",
+ "avatar_url",
"roles"
]
}
@@ -2992,6 +2998,11 @@
"type": "boolean",
"description": "Whether this member is a Single Sign-On user"
},
+ "avatar_url": {
+ "type": "string",
+ "nullable": true,
+ "description": "Member's avatar URL"
+ },
"roles": {
"type": "array",
"items": {
@@ -3033,7 +3044,14 @@
"description": "Roles assigned to this member. Includes both org-level and project-scoped roles."
}
},
- "required": ["username", "primary_email", "mfa_enabled", "is_sso_user", "roles"]
+ "required": [
+ "username",
+ "primary_email",
+ "mfa_enabled",
+ "is_sso_user",
+ "avatar_url",
+ "roles"
+ ]
}
},
"required": ["type", "id", "attributes"]