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 (#47622)

supabase-supabase-autofixer[bot]1bdef6807401
diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json
index df2dd7683e4..d77b7729a32 100644
--- a/apps/docs/spec/api_v1_openapi.json
+++ b/apps/docs/spec/api_v1_openapi.json
@@ -8928,9 +8928,20 @@
"nullable": true,
"description": "If `null`, the value is automatically configured based on compute size."
},
+ "db_pool_acquisition_timeout": {
+ "type": "integer",
+ "nullable": true,
+ "description": "If `null`, the value is automatically configured to 10."
+ },
"jwt_secret": { "type": "string" }
},
- "required": ["db_schema", "max_rows", "db_extra_search_path", "db_pool"]
+ "required": [
+ "db_schema",
+ "max_rows",
+ "db_extra_search_path",
+ "db_pool",
+ "db_pool_acquisition_timeout"
+ ]
},
"V1UpdatePostgrestConfigBody": {
"type": "object",
@@ -8938,7 +8949,8 @@
"db_extra_search_path": { "type": "string" },
"db_schema": { "type": "string" },
"max_rows": { "type": "integer", "minimum": 0, "maximum": 1000000 },
- "db_pool": { "type": "integer", "minimum": 0, "maximum": 1000 }
+ "db_pool": { "type": "integer", "minimum": 0, "maximum": 1000 },
+ "db_pool_acquisition_timeout": { "type": "integer", "minimum": 0, "maximum": 60 }
},
"example": { "db_schema": "public,storage", "db_pool": 20, "max_rows": 1000 }
},
@@ -8952,9 +8964,20 @@
"type": "integer",
"nullable": true,
"description": "If `null`, the value is automatically configured based on compute size."
+ },
+ "db_pool_acquisition_timeout": {
+ "type": "integer",
+ "nullable": true,
+ "description": "If `null`, the value is automatically configured to 10."
}
},
- "required": ["db_schema", "max_rows", "db_extra_search_path", "db_pool"]
+ "required": [
+ "db_schema",
+ "max_rows",
+ "db_extra_search_path",
+ "db_pool",
+ "db_pool_acquisition_timeout"
+ ]
},
"V1ProjectRefResponse": {
"type": "object",
@@ -11762,6 +11785,11 @@
"properties": { "enabled": { "type": "boolean" } },
"required": ["enabled"]
},
+ "purgeCache": {
+ "type": "object",
+ "properties": { "enabled": { "type": "boolean" } },
+ "required": ["enabled"]
+ },
"icebergCatalog": {
"type": "object",
"properties": {
@@ -11782,7 +11810,13 @@
"required": ["enabled", "maxBuckets", "maxIndexes"]
}
},
- "required": ["imageTransformation", "s3Protocol", "icebergCatalog", "vectorBuckets"]
+ "required": [
+ "imageTransformation",
+ "s3Protocol",
+ "purgeCache",
+ "icebergCatalog",
+ "vectorBuckets"
+ ]
},
"capabilities": {
"type": "object",
@@ -11831,6 +11865,11 @@
"properties": { "enabled": { "type": "boolean" } },
"required": ["enabled"]
},
+ "purgeCache": {
+ "type": "object",
+ "properties": { "enabled": { "type": "boolean" } },
+ "required": ["enabled"]
+ },
"icebergCatalog": {
"type": "object",
"properties": {
@@ -12783,6 +12822,7 @@
"storage.image_transformations",
"storage.vector_buckets",
"storage.iceberg_catalog",
+ "storage.purge_cache",
"security.audit_logs_days",
"security.questionnaire",
"security.soc2_report",
@@ -12831,7 +12871,9 @@
"assistant.advance_model",
"integrations.github_connections",
"dedicated_pooler",
- "observability.dashboard_advanced_metrics"
+ "observability.dashboard_advanced_metrics",
+ "api.members.invitations",
+ "api.members.roles"
]
},
"type": { "type": "string", "enum": ["boolean", "numeric", "set"] }
diff --git a/apps/docs/spec/api_v2_openapi.json b/apps/docs/spec/api_v2_openapi.json
index b65f8d3facf..3f82b25778f 100644
--- a/apps/docs/spec/api_v2_openapi.json
+++ b/apps/docs/spec/api_v2_openapi.json
@@ -266,6 +266,133 @@
"x-endpoint-owners": ["management-api"]
}
},
+ "/v2/projects/{ref}/private-link/associations": {
+ "get": {
+ "operationId": "v2-list-private-link-associations",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/V2ListPrivateLinkAssociationsResponse" }
+ }
+ }
+ },
+ "401": { "description": "Unauthorized" },
+ "403": { "description": "Forbidden action" },
+ "429": { "description": "Rate limit exceeded" },
+ "500": { "description": "Failed to retrieve AWS accounts for project" }
+ },
+ "security": [{ "bearer": [] }, { "fga_permissions": ["project_admin_read"] }],
+ "summary": "List AWS accounts attached to the project PrivateLink share",
+ "tags": ["Projects"],
+ "x-endpoint-owners": ["platform-networking", "management-api"]
+ },
+ "post": {
+ "description": "Adds an AWS account to the project's PrivateLink configuration and schedules the AWS resources to be created.",
+ "operationId": "v2-create-private-link-association",
+ "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/V2CreatePrivateLinkAssociationRequest" }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/V2PrivateLinkAssociationResponse" }
+ }
+ }
+ },
+ "401": { "description": "Unauthorized" },
+ "402": {
+ "description": "This feature requires the Team, or Enterprise organization plan."
+ },
+ "403": { "description": "Forbidden action" },
+ "429": { "description": "Rate limit exceeded" },
+ "500": { "description": "Failed to add AWS account to PrivateLink share" }
+ },
+ "security": [{ "bearer": [] }, { "fga_permissions": ["project_admin_write"] }],
+ "summary": "Add an AWS account to the project PrivateLink share",
+ "tags": ["Projects"],
+ "x-allowed-plans": ["Team", "Enterprise"],
+ "x-badges": [{ "name": "Only available on Team, Enterprise", "position": "before" }],
+ "x-endpoint-owners": ["platform-networking", "management-api"]
+ }
+ },
+ "/v2/projects/{ref}/private-link/associations/aws-account/{aws_account_id}": {
+ "delete": {
+ "description": "Removes an AWS account from the project's PrivateLink configuration. Cleans up the associated AWS resources.",
+ "operationId": "v2-delete-private-link-association",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ },
+ {
+ "name": "aws_account_id",
+ "required": false,
+ "in": "path",
+ "description": "AWS account ID used in PrivateLink association",
+ "schema": { "type": "string" }
+ }
+ ],
+ "responses": {
+ "204": { "description": "" },
+ "401": { "description": "Unauthorized" },
+ "403": { "description": "Forbidden action" },
+ "429": { "description": "Rate limit exceeded" },
+ "500": { "description": "Failed to remove AWS account from PrivateLink share" }
+ },
+ "security": [{ "bearer": [] }, { "fga_permissions": ["project_admin_write"] }],
+ "summary": "Remove an AWS account from the project PrivateLink share",
+ "tags": ["Projects"],
+ "x-endpoint-owners": ["platform-networking", "management-api"]
+ }
+ },
"/v2/organizations/{slug}/members": {
"get": {
"description": "Returns a cursor-paginated list of organization members including their roles and project-scoped permissions.",
@@ -329,10 +456,10 @@
"x-oauth-scope": "organizations:read"
}
},
- "/v2/organizations/{slug}/roles": {
- "get": {
- "description": "Returns a cursor-paginated list of organization roles including both org-scoped and project-scoped roles.",
- "operationId": "v2-list-organization-roles",
+ "/v2/organizations/{slug}/members/{user_id}/roles": {
+ "patch": {
+ "description": "Assigns an org-wide role when projects is omitted, or creates a project-scoped assignment when projects is provided. Uses an org-level role template id from GET /v2/organizations/{slug}/roles. Stale role assignments are automatically cleaned up: if a role no longer has any projects, it is deleted; overlapping project assignments in other roles are automatically removed to avoid duplication.",
+ "operationId": "v2-assign-organization-member-role",
"parameters": [
{
"name": "slug",
@@ -346,31 +473,57 @@
}
},
{
- "name": "page",
- "required": false,
- "in": "query",
- "schema": {
- "properties": {
- "size": { "type": "integer", "minimum": 1, "maximum": 100, "required": false },
- "after": { "type": "string", "required": false },
- "before": { "type": "string", "required": false }
- },
- "type": "object"
+ "name": "user_id",
+ "required": true,
+ "in": "path",
+ "schema": { "format": "uuid", "type": "string" }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/V2AssignOrganizationMemberRoleRequest" }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/OrganizationMemberRoleResponse" }
+ }
}
},
+ "401": { "description": "Unauthorized" },
+ "402": { "description": "This feature requires the Enterprise organization plan." },
+ "403": { "description": "Forbidden action" },
+ "429": { "description": "Rate limit exceeded" },
+ "500": { "description": "Failed to assign organization member role" }
+ },
+ "security": [{ "bearer": [] }, { "fga_permissions": ["organization_admin_write"] }],
+ "summary": "Assign or change an organization member role",
+ "tags": ["Organizations"],
+ "x-allowed-plans": ["Enterprise"],
+ "x-badges": [{ "name": "Only available on Enterprise", "position": "before" }],
+ "x-endpoint-owners": ["management-api"]
+ }
+ },
+ "/v2/organizations/{slug}/roles": {
+ "get": {
+ "description": "Returns a list of org-level roles for the organization.",
+ "operationId": "v2-list-organization-roles",
+ "parameters": [
{
- "name": "filter",
- "required": false,
- "in": "query",
+ "name": "slug",
+ "required": true,
+ "in": "path",
+ "description": "Organization slug",
"schema": {
- "properties": {
- "scope": {
- "type": "string",
- "enum": ["organization", "project"],
- "required": false
- }
- },
- "type": "object"
+ "pattern": "^[\\w-]+$",
+ "example": "tsrqponmlkjihgfedcba",
+ "type": "string"
}
}
],
@@ -394,6 +547,57 @@
"x-endpoint-owners": ["management-api"],
"x-oauth-scope": "organizations:read"
}
+ },
+ "/v2/organizations/{slug}/members/invitations": {
+ "post": {
+ "description": "Creates member invitations for an organization. Each invitation can have different role and project scope settings.",
+ "operationId": "v2-create-organization-invitations",
+ "parameters": [
+ {
+ "name": "slug",
+ "required": true,
+ "in": "path",
+ "description": "Organization slug",
+ "schema": {
+ "pattern": "^[\\w-]+$",
+ "example": "tsrqponmlkjihgfedcba",
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/V2CreateInvitationsRequest" }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/V2CreateInvitationsResponse" }
+ }
+ }
+ },
+ "401": { "description": "Unauthorized" },
+ "402": { "description": "This feature requires the Enterprise organization plan." },
+ "403": { "description": "Forbidden action" },
+ "429": { "description": "Rate limit exceeded" }
+ },
+ "security": [{ "bearer": [] }, { "fga_permissions": ["members_write"] }],
+ "summary": "Creates organization invitations",
+ "tags": ["Organizations Members Invitations"],
+ "x-allowed-plans": ["Enterprise"],
+ "x-badges": [
+ { "name": "OAuth scope: organizations:write", "position": "after" },
+ { "name": "Only available on Enterprise", "position": "before" }
+ ],
+ "x-endpoint-owners": ["management-api"],
+ "x-oauth-scope": "organizations:write"
+ }
}
},
"info": {
@@ -1023,6 +1227,150 @@
},
"required": ["data"]
},
+ "V2ListPrivateLinkAssociationsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "id": { "type": "string" },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID this PrivateLink share is associated with."
+ },
+ "account_name": {
+ "type": "string",
+ "description": "Human-readable name for the AWS account."
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "CREATING",
+ "READY",
+ "ASSOCIATION_REQUEST_EXPIRED",
+ "ASSOCIATION_ACCEPTED",
+ "CREATION_FAILED",
+ "DELETING"
+ ],
+ "description": "\n - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.\n - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.\n - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.\n - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.\n - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.\n - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.\n"
+ },
+ "shared_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true,
+ "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending."
+ }
+ },
+ "required": ["aws_account_id", "status", "shared_at"]
+ }
+ },
+ "required": ["type", "id", "attributes"]
+ }
+ }
+ },
+ "required": ["data"]
+ },
+ "V2CreatePrivateLinkAssociationRequest": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID to add to the project PrivateLink share."
+ },
+ "account_name": {
+ "type": "string",
+ "maxLength": 128,
+ "description": "Optional human-readable name for the AWS account."
+ }
+ },
+ "required": ["aws_account_id"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
+ },
+ "V2PrivateLinkAssociationResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "id": { "type": "string" },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID this PrivateLink share is associated with."
+ },
+ "account_name": {
+ "type": "string",
+ "description": "Human-readable name for the AWS account."
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "CREATING",
+ "READY",
+ "ASSOCIATION_REQUEST_EXPIRED",
+ "ASSOCIATION_ACCEPTED",
+ "CREATION_FAILED",
+ "DELETING"
+ ],
+ "description": "\n - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.\n - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.\n - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.\n - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.\n - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.\n - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.\n"
+ },
+ "shared_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true,
+ "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending."
+ }
+ },
+ "required": ["aws_account_id", "status", "shared_at"]
+ }
+ },
+ "required": ["type", "id", "attributes"]
+ }
+ },
+ "required": ["data"]
+ },
"V2ListMembersResponse": {
"type": "object",
"properties": {
@@ -1068,11 +1416,10 @@
"items": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "Role ID." },
"name": {
"type": "string",
"description": "Role name. For project-scoped roles this is the base role name.",
- "example": "Developer"
+ "example": "developer"
},
"scope": {
"type": "string",
@@ -1092,7 +1439,7 @@
"description": "Project refs this role is scoped to. Empty array for org-level roles."
}
},
- "required": ["id", "name", "scope", "projects"]
+ "required": ["name", "scope", "projects"]
},
"description": "Roles assigned to this member. Includes both org-level and project-scoped roles."
}
@@ -1143,6 +1490,93 @@
},
"required": ["data", "links"]
},
+ "V2AssignOrganizationMemberRoleRequest": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_member_role"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "enum": ["owner", "administrator", "developer", "read-only"],
+ "description": "Role name to assign. Must be one of: owner, administrator, developer, read-only. Must be on a Team or Enterprise plan to use the read-only role.",
+ "example": "developer"
+ },
+ "projects": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Project ref",
+ "example": "abcjuqabhgwjjutfvtpa"
+ }
+ },
+ "required": ["ref"]
+ },
+ "minItems": 1,
+ "description": "The projects to assign a project-scoped role for. If omitted, assigns an org-wide role."
+ }
+ },
+ "required": ["role"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
+ },
+ "OrganizationMemberRoleResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_member_role"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Role name. For project-scoped assignments this is the base role name.",
+ "example": "developer"
+ },
+ "scope": {
+ "type": "string",
+ "enum": ["organization", "project"],
+ "description": "Whether this role applies org-wide or is scoped to specific projects for the user."
+ },
+ "projects": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": { "ref": { "type": "string" }, "name": { "type": "string" } },
+ "required": ["ref", "name"]
+ },
+ "description": "Project refs this role is scoped to. Empty array for org-level roles."
+ }
+ },
+ "required": ["name", "scope", "projects"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
+ },
"V2ListRolesResponse": {
"type": "object",
"properties": {
@@ -1156,73 +1590,161 @@
"enum": ["organization_role"],
"description": "Resource type."
},
- "id": { "type": "string" },
+ "id": {},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
- "description": "Role name. For project-scoped roles this is the base role name.",
- "example": "Developer"
- },
- "scope": {
+ "description": "Role name.",
+ "example": "developer"
+ }
+ },
+ "required": ["name"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ }
+ },
+ "required": ["data"]
+ },
+ "V2CreateInvitationsRequest": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_invitation"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "email": { "type": "string", "format": "email" },
+ "role": {
"type": "string",
- "enum": ["organization", "project"],
- "description": "Whether this role applies org-wide or is scoped to specific projects for the user."
- },
- "base_role_id": {
- "type": "integer",
- "nullable": true,
- "description": "null for org-level roles; the base role ID for project-scoped roles."
+ "enum": ["owner", "administrator", "developer", "read-only"],
+ "description": "Role name to assign. Must be on a Team or Enterprise plan to use the read-only role.",
+ "example": "developer"
},
"projects": {
"type": "array",
"items": {
"type": "object",
- "properties": { "ref": { "type": "string" }, "name": { "type": "string" } },
- "required": ["ref", "name"]
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Project ref",
+ "example": "abcjuqabhgwjjutfvtpa"
+ }
+ },
+ "required": ["ref"]
},
- "description": "Project refs this role is scoped to. Empty array for org-level roles."
- }
+ "minItems": 1,
+ "description": "The projects to limit a user to. If omitted, user will have org-wide access with the provided role."
+ },
+ "require_sso": { "type": "boolean" }
},
- "required": ["name", "scope", "base_role_id", "projects"]
+ "required": ["email", "role"]
}
},
- "required": ["type", "id", "attributes"]
- }
- },
- "links": {
+ "required": ["type", "attributes"]
+ },
+ "minItems": 1,
+ "maxItems": 50
+ }
+ },
+ "required": ["data"]
+ },
+ "V2CreateInvitationsResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
"type": "object",
"properties": {
- "first": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the first page if available.",
- "example": "/v2/organizations/my-org/roles?page[size]=10"
- },
- "prev": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the previous page.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7"
- },
- "next": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the next page.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4"
+ "id": { "type": "string" },
+ "code": { "type": "string" },
+ "message": { "type": "string" },
+ "description": { "type": "string" },
+ "links": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": { "type": "string" },
+ "rel": { "type": "string" },
+ "title": { "type": "string" },
+ "type": { "type": "string" },
+ "describedby": { "type": "string" },
+ "meta": { "type": "object", "additionalProperties": {} }
+ },
+ "required": ["href"]
+ }
},
- "last": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the last page if available.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
+ "meta": { "type": "object", "additionalProperties": {} },
+ "issues": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "code": { "type": "string" },
+ "message": { "type": "string" },
+ "description": { "type": "string" },
+ "links": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": { "type": "string" },
+ "rel": { "type": "string" },
+ "title": { "type": "string" },
+ "type": { "type": "string" },
+ "describedby": { "type": "string" },
+ "meta": { "type": "object", "additionalProperties": {} }
+ },
+ "required": ["href"]
+ }
+ },
+ "meta": {
+ "type": "object",
+ "properties": { "email": { "type": "string", "format": "email" } },
+ "required": ["email"]
+ }
+ },
+ "required": ["code", "message", "meta"]
+ }
}
},
- "required": ["prev", "next"]
+ "required": ["code", "message"]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_invitation"],
+ "description": "Resource type."
+ },
+ "id": {},
+ "attributes": {
+ "type": "object",
+ "properties": { "email": { "type": "string", "format": "email" } },
+ "required": ["email"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
}
},
- "required": ["data", "links"]
+ "required": ["data"]
}
}
}
diff --git a/apps/docs/spec/common-api-sections.json b/apps/docs/spec/common-api-sections.json
index 643f61d6721..ffe92d96efb 100644
--- a/apps/docs/spec/common-api-sections.json
+++ b/apps/docs/spec/common-api-sections.json
@@ -730,6 +730,12 @@
"type": "category",
"title": "Organizations",
"items": [
+ {
+ "id": "v2-assign-organization-member-role",
+ "title": "Assign organization member role",
+ "slug": "v2-assign-organization-member-role",
+ "type": "operation"
+ },
{
"id": "v1-create-an-organization",
"title": "Create an organization",
@@ -774,6 +780,18 @@
}
]
},
+ {
+ "type": "category",
+ "title": "Organizations Members Invitations",
+ "items": [
+ {
+ "id": "v2-create-organization-invitations",
+ "title": "Create organization invitations",
+ "slug": "v2-create-organization-invitations",
+ "type": "operation"
+ }
+ ]
+ },
{
"type": "category",
"title": "Profile",
@@ -802,6 +820,12 @@
"slug": "v1-create-a-project",
"type": "operation"
},
+ {
+ "id": "v2-create-private-link-association",
+ "title": "Create private link association",
+ "slug": "v2-create-private-link-association",
+ "type": "operation"
+ },
{
"id": "v1-delete-a-project",
"title": "Delete a project",
@@ -814,6 +838,12 @@
"slug": "v1-delete-network-bans",
"type": "operation"
},
+ {
+ "id": "v2-delete-private-link-association",
+ "title": "Delete private link association",
+ "slug": "v2-delete-private-link-association",
+ "type": "operation"
+ },
{
"id": "v1-get-all-projects-for-organization",
"title": "Get all projects for organization",
@@ -898,6 +928,12 @@
"slug": "v1-list-available-restore-versions",
"type": "operation"
},
+ {
+ "id": "v2-list-private-link-associations",
+ "title": "List private link associations",
+ "slug": "v2-list-private-link-associations",
+ "type": "operation"
+ },
{
"id": "v1-modify-database-disk",
"title": "Modify database disk",
diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
index 7b5acefc63c..c7576a9b540 100644
--- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
+++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
@@ -6480,11 +6480,22 @@
"nullable": true,
"description": "If `null`, the value is automatically configured based on compute size."
},
+ "db_pool_acquisition_timeout": {
+ "type": "integer",
+ "nullable": true,
+ "description": "If `null`, the value is automatically configured to 10."
+ },
"jwt_secret": {
"type": "string"
}
},
- "required": ["db_schema", "max_rows", "db_extra_search_path", "db_pool"]
+ "required": [
+ "db_schema",
+ "max_rows",
+ "db_extra_search_path",
+ "db_pool",
+ "db_pool_acquisition_timeout"
+ ]
}
}
}
@@ -6560,6 +6571,11 @@
"type": "integer",
"minimum": 0,
"maximum": 1000
+ },
+ "db_pool_acquisition_timeout": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 60
}
},
"example": {
@@ -6592,9 +6608,20 @@
"type": "integer",
"nullable": true,
"description": "If `null`, the value is automatically configured based on compute size."
+ },
+ "db_pool_acquisition_timeout": {
+ "type": "integer",
+ "nullable": true,
+ "description": "If `null`, the value is automatically configured to 10."
}
},
- "required": ["db_schema", "max_rows", "db_extra_search_path", "db_pool"]
+ "required": [
+ "db_schema",
+ "max_rows",
+ "db_extra_search_path",
+ "db_pool",
+ "db_pool_acquisition_timeout"
+ ]
}
}
}
@@ -19598,6 +19625,15 @@
},
"required": ["enabled"]
},
+ "purgeCache": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": ["enabled"]
+ },
"icebergCatalog": {
"type": "object",
"properties": {
@@ -19640,6 +19676,7 @@
"required": [
"imageTransformation",
"s3Protocol",
+ "purgeCache",
"icebergCatalog",
"vectorBuckets"
]
@@ -19761,6 +19798,15 @@
},
"required": ["enabled"]
},
+ "purgeCache": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": ["enabled"]
+ },
"icebergCatalog": {
"type": "object",
"properties": {
@@ -22810,6 +22856,7 @@
"storage.image_transformations",
"storage.vector_buckets",
"storage.iceberg_catalog",
+ "storage.purge_cache",
"security.audit_logs_days",
"security.questionnaire",
"security.soc2_report",
@@ -22858,7 +22905,9 @@
"assistant.advance_model",
"integrations.github_connections",
"dedicated_pooler",
- "observability.dashboard_advanced_metrics"
+ "observability.dashboard_advanced_metrics",
+ "api.members.invitations",
+ "api.members.roles"
]
},
"type": {
@@ -25557,11 +25606,22 @@
"nullable": true,
"description": "If `null`, the value is automatically configured based on compute size."
},
+ "db_pool_acquisition_timeout": {
+ "type": "integer",
+ "nullable": true,
+ "description": "If `null`, the value is automatically configured to 10."
+ },
"jwt_secret": {
"type": "string"
}
},
- "required": ["db_schema", "max_rows", "db_extra_search_path", "db_pool"]
+ "required": [
+ "db_schema",
+ "max_rows",
+ "db_extra_search_path",
+ "db_pool",
+ "db_pool_acquisition_timeout"
+ ]
},
"V1UpdatePostgrestConfigBody": {
"type": "object",
@@ -25581,6 +25641,11 @@
"type": "integer",
"minimum": 0,
"maximum": 1000
+ },
+ "db_pool_acquisition_timeout": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 60
}
},
"example": {
@@ -25605,9 +25670,20 @@
"type": "integer",
"nullable": true,
"description": "If `null`, the value is automatically configured based on compute size."
+ },
+ "db_pool_acquisition_timeout": {
+ "type": "integer",
+ "nullable": true,
+ "description": "If `null`, the value is automatically configured to 10."
}
},
- "required": ["db_schema", "max_rows", "db_extra_search_path", "db_pool"]
+ "required": [
+ "db_schema",
+ "max_rows",
+ "db_extra_search_path",
+ "db_pool",
+ "db_pool_acquisition_timeout"
+ ]
},
"V1ProjectRefResponse": {
"type": "object",
@@ -30834,6 +30910,15 @@
},
"required": ["enabled"]
},
+ "purgeCache": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": ["enabled"]
+ },
"icebergCatalog": {
"type": "object",
"properties": {
@@ -30873,7 +30958,13 @@
"required": ["enabled", "maxBuckets", "maxIndexes"]
}
},
- "required": ["imageTransformation", "s3Protocol", "icebergCatalog", "vectorBuckets"]
+ "required": [
+ "imageTransformation",
+ "s3Protocol",
+ "purgeCache",
+ "icebergCatalog",
+ "vectorBuckets"
+ ]
},
"capabilities": {
"type": "object",
@@ -30943,6 +31034,15 @@
},
"required": ["enabled"]
},
+ "purgeCache": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": ["enabled"]
+ },
"icebergCatalog": {
"type": "object",
"properties": {
@@ -32450,6 +32550,7 @@
"storage.image_transformations",
"storage.vector_buckets",
"storage.iceberg_catalog",
+ "storage.purge_cache",
"security.audit_logs_days",
"security.questionnaire",
"security.soc2_report",
@@ -32498,7 +32599,9 @@
"assistant.advance_model",
"integrations.github_connections",
"dedicated_pooler",
- "observability.dashboard_advanced_metrics"
+ "observability.dashboard_advanced_metrics",
+ "api.members.invitations",
+ "api.members.roles"
]
},
"type": {
diff --git a/apps/docs/spec/transforms/api_v2_openapi_deparsed.json b/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
index 0dcc4cc1f37..7b21a0596db 100644
--- a/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
+++ b/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
@@ -1582,6 +1582,332 @@
"x-endpoint-owners": ["management-api"]
}
},
+ "/v2/projects/{ref}/private-link/associations": {
+ "get": {
+ "operationId": "v2-list-private-link-associations",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "id": {
+ "type": "string"
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID this PrivateLink share is associated with."
+ },
+ "account_name": {
+ "type": "string",
+ "description": "Human-readable name for the AWS account."
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "CREATING",
+ "READY",
+ "ASSOCIATION_REQUEST_EXPIRED",
+ "ASSOCIATION_ACCEPTED",
+ "CREATION_FAILED",
+ "DELETING"
+ ],
+ "description": "\n - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.\n - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.\n - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.\n - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.\n - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.\n - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.\n"
+ },
+ "shared_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true,
+ "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending."
+ }
+ },
+ "required": ["aws_account_id", "status", "shared_at"]
+ }
+ },
+ "required": ["type", "id", "attributes"]
+ }
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ },
+ "500": {
+ "description": "Failed to retrieve AWS accounts for project"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ },
+ {
+ "fga_permissions": ["project_admin_read"]
+ }
+ ],
+ "summary": "List AWS accounts attached to the project PrivateLink share",
+ "tags": ["Projects"],
+ "x-endpoint-owners": ["platform-networking", "management-api"]
+ },
+ "post": {
+ "description": "Adds an AWS account to the project's PrivateLink configuration and schedules the AWS resources to be created.",
+ "operationId": "v2-create-private-link-association",
+ "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": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID to add to the project PrivateLink share."
+ },
+ "account_name": {
+ "type": "string",
+ "maxLength": 128,
+ "description": "Optional human-readable name for the AWS account."
+ }
+ },
+ "required": ["aws_account_id"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "id": {
+ "type": "string"
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID this PrivateLink share is associated with."
+ },
+ "account_name": {
+ "type": "string",
+ "description": "Human-readable name for the AWS account."
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "CREATING",
+ "READY",
+ "ASSOCIATION_REQUEST_EXPIRED",
+ "ASSOCIATION_ACCEPTED",
+ "CREATION_FAILED",
+ "DELETING"
+ ],
+ "description": "\n - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.\n - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.\n - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.\n - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.\n - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.\n - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.\n"
+ },
+ "shared_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true,
+ "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending."
+ }
+ },
+ "required": ["aws_account_id", "status", "shared_at"]
+ }
+ },
+ "required": ["type", "id", "attributes"]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "402": {
+ "description": "This feature requires the Team, or Enterprise organization plan."
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ },
+ "500": {
+ "description": "Failed to add AWS account to PrivateLink share"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ },
+ {
+ "fga_permissions": ["project_admin_write"]
+ }
+ ],
+ "summary": "Add an AWS account to the project PrivateLink share",
+ "tags": ["Projects"],
+ "x-allowed-plans": ["Team", "Enterprise"],
+ "x-badges": [
+ {
+ "name": "Only available on Team, Enterprise",
+ "position": "before"
+ }
+ ],
+ "x-endpoint-owners": ["platform-networking", "management-api"]
+ }
+ },
+ "/v2/projects/{ref}/private-link/associations/aws-account/{aws_account_id}": {
+ "delete": {
+ "description": "Removes an AWS account from the project's PrivateLink configuration. Cleans up the associated AWS resources.",
+ "operationId": "v2-delete-private-link-association",
+ "parameters": [
+ {
+ "name": "ref",
+ "required": true,
+ "in": "path",
+ "description": "Project ref",
+ "schema": {
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "example": "abcdefghijklmnopqrst",
+ "type": "string"
+ }
+ },
+ {
+ "name": "aws_account_id",
+ "required": false,
+ "in": "path",
+ "description": "AWS account ID used in PrivateLink association",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": ""
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ },
+ "500": {
+ "description": "Failed to remove AWS account from PrivateLink share"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ },
+ {
+ "fga_permissions": ["project_admin_write"]
+ }
+ ],
+ "summary": "Remove an AWS account from the project PrivateLink share",
+ "tags": ["Projects"],
+ "x-endpoint-owners": ["platform-networking", "management-api"]
+ }
+ },
"/v2/organizations/{slug}/members": {
"get": {
"description": "Returns a cursor-paginated list of organization members including their roles and project-scoped permissions.",
@@ -1697,14 +2023,10 @@
"items": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "description": "Role ID."
- },
"name": {
"type": "string",
"description": "Role name. For project-scoped roles this is the base role name.",
- "example": "Developer"
+ "example": "developer"
},
"scope": {
"type": "string",
@@ -1728,7 +2050,7 @@
"description": "Project refs this role is scoped to. Empty array for org-level roles."
}
},
- "required": ["id", "name", "scope", "projects"]
+ "required": ["name", "scope", "projects"]
},
"description": "Roles assigned to this member. Includes both org-level and project-scoped roles."
}
@@ -1812,10 +2134,10 @@
"x-oauth-scope": "organizations:read"
}
},
- "/v2/organizations/{slug}/roles": {
- "get": {
- "description": "Returns a cursor-paginated list of organization roles including both org-scoped and project-scoped roles.",
- "operationId": "v2-list-organization-roles",
+ "/v2/organizations/{slug}/members/{user_id}/roles": {
+ "patch": {
+ "description": "Assigns an org-wide role when projects is omitted, or creates a project-scoped assignment when projects is provided. Uses an org-level role template id from GET /v2/organizations/{slug}/roles. Stale role assignments are automatically cleaned up: if a role no longer has any projects, it is deleted; overlapping project assignments in other roles are automatically removed to avoid duplication.",
+ "operationId": "v2-assign-organization-member-role",
"parameters": [
{
"name": "slug",
@@ -1829,42 +2151,174 @@
}
},
{
- "name": "page",
- "required": false,
- "in": "query",
+ "name": "user_id",
+ "required": true,
+ "in": "path",
"schema": {
- "properties": {
- "size": {
- "type": "integer",
- "minimum": 1,
- "maximum": 100,
- "required": false
- },
- "after": {
- "type": "string",
- "required": false
+ "format": "uuid",
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_member_role"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "enum": ["owner", "administrator", "developer", "read-only"],
+ "description": "Role name to assign. Must be one of: owner, administrator, developer, read-only. Must be on a Team or Enterprise plan to use the read-only role.",
+ "example": "developer"
+ },
+ "projects": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Project ref",
+ "example": "abcjuqabhgwjjutfvtpa"
+ }
+ },
+ "required": ["ref"]
+ },
+ "minItems": 1,
+ "description": "The projects to assign a project-scoped role for. If omitted, assigns an org-wide role."
+ }
+ },
+ "required": ["role"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
},
- "before": {
- "type": "string",
- "required": false
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_member_role"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Role name. For project-scoped assignments this is the base role name.",
+ "example": "developer"
+ },
+ "scope": {
+ "type": "string",
+ "enum": ["organization", "project"],
+ "description": "Whether this role applies org-wide or is scoped to specific projects for the user."
+ },
+ "projects": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": ["ref", "name"]
+ },
+ "description": "Project refs this role is scoped to. Empty array for org-level roles."
+ }
+ },
+ "required": ["name", "scope", "projects"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
}
- },
- "type": "object"
+ }
}
},
+ "401": {
+ "description": "Unauthorized"
+ },
+ "402": {
+ "description": "This feature requires the Enterprise organization plan."
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ },
+ "500": {
+ "description": "Failed to assign organization member role"
+ }
+ },
+ "security": [
{
- "name": "filter",
- "required": false,
- "in": "query",
+ "bearer": []
+ },
+ {
+ "fga_permissions": ["organization_admin_write"]
+ }
+ ],
+ "summary": "Assign or change an organization member role",
+ "tags": ["Organizations"],
+ "x-allowed-plans": ["Enterprise"],
+ "x-badges": [
+ {
+ "name": "Only available on Enterprise",
+ "position": "before"
+ }
+ ],
+ "x-endpoint-owners": ["management-api"]
+ }
+ },
+ "/v2/organizations/{slug}/roles": {
+ "get": {
+ "description": "Returns a list of org-level roles for the organization.",
+ "operationId": "v2-list-organization-roles",
+ "parameters": [
+ {
+ "name": "slug",
+ "required": true,
+ "in": "path",
+ "description": "Organization slug",
"schema": {
- "properties": {
- "scope": {
- "type": "string",
- "enum": ["organization", "project"],
- "required": false
- }
- },
- "type": "object"
+ "pattern": "^[\\w-]+$",
+ "example": "tsrqponmlkjihgfedcba",
+ "type": "string"
}
}
],
@@ -1886,82 +2340,283 @@
"enum": ["organization_role"],
"description": "Resource type."
},
- "id": {
- "type": "string"
- },
+ "id": {},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
- "description": "Role name. For project-scoped roles this is the base role name.",
- "example": "Developer"
+ "description": "Role name.",
+ "example": "developer"
+ }
+ },
+ "required": ["name"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden action"
+ },
+ "429": {
+ "description": "Rate limit exceeded"
+ }
+ },
+ "security": [
+ {
+ "bearer": []
+ },
+ {
+ "fga_permissions": ["members_read"]
+ }
+ ],
+ "summary": "List roles of an organization",
+ "tags": ["Organizations"],
+ "x-badges": [
+ {
+ "name": "OAuth scope: organizations:read",
+ "position": "after"
+ }
+ ],
+ "x-endpoint-owners": ["management-api"],
+ "x-oauth-scope": "organizations:read"
+ }
+ },
+ "/v2/organizations/{slug}/members/invitations": {
+ "post": {
+ "description": "Creates member invitations for an organization. Each invitation can have different role and project scope settings.",
+ "operationId": "v2-create-organization-invitations",
+ "parameters": [
+ {
+ "name": "slug",
+ "required": true,
+ "in": "path",
+ "description": "Organization slug",
+ "schema": {
+ "pattern": "^[\\w-]+$",
+ "example": "tsrqponmlkjihgfedcba",
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_invitation"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email"
+ },
+ "role": {
+ "type": "string",
+ "enum": ["owner", "administrator", "developer", "read-only"],
+ "description": "Role name to assign. Must be on a Team or Enterprise plan to use the read-only role.",
+ "example": "developer"
+ },
+ "projects": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Project ref",
+ "example": "abcjuqabhgwjjutfvtpa"
+ }
+ },
+ "required": ["ref"]
},
- "scope": {
- "type": "string",
- "enum": ["organization", "project"],
- "description": "Whether this role applies org-wide or is scoped to specific projects for the user."
+ "minItems": 1,
+ "description": "The projects to limit a user to. If omitted, user will have org-wide access with the provided role."
+ },
+ "require_sso": {
+ "type": "boolean"
+ }
+ },
+ "required": ["email", "role"]
+ }
+ },
+ "required": ["type", "attributes"]
+ },
+ "minItems": 1,
+ "maxItems": 50
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "links": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
},
- "base_role_id": {
- "type": "integer",
- "nullable": true,
- "description": "null for org-level roles; the base role ID for project-scoped roles."
+ "rel": {
+ "type": "string"
},
- "projects": {
- "type": "array",
- "items": {
+ "title": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "describedby": {
+ "type": "string"
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {}
+ }
+ },
+ "required": ["href"]
+ }
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {}
+ },
+ "issues": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "links": {
+ "type": "object",
+ "additionalProperties": {
"type": "object",
"properties": {
- "ref": {
+ "href": {
"type": "string"
},
- "name": {
+ "rel": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "describedby": {
"type": "string"
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {}
}
},
- "required": ["ref", "name"]
+ "required": ["href"]
+ }
+ },
+ "meta": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email"
+ }
},
- "description": "Project refs this role is scoped to. Empty array for org-level roles."
+ "required": ["email"]
}
},
- "required": ["name", "scope", "base_role_id", "projects"]
+ "required": ["code", "message", "meta"]
}
- },
- "required": ["type", "id", "attributes"]
- }
- },
- "links": {
- "type": "object",
- "properties": {
- "first": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the first page if available.",
- "example": "/v2/organizations/my-org/roles?page[size]=10"
- },
- "prev": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the previous page.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7"
- },
- "next": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the next page.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4"
- },
- "last": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the last page if available.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
}
},
- "required": ["prev", "next"]
+ "required": ["code", "message"]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_invitation"],
+ "description": "Resource type."
+ },
+ "id": {},
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email"
+ }
+ },
+ "required": ["email"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
}
},
- "required": ["data", "links"]
+ "required": ["data"]
}
}
}
@@ -1969,6 +2624,9 @@
"401": {
"description": "Unauthorized"
},
+ "402": {
+ "description": "This feature requires the Enterprise organization plan."
+ },
"403": {
"description": "Forbidden action"
},
@@ -1981,19 +2639,24 @@
"bearer": []
},
{
- "fga_permissions": ["members_read"]
+ "fga_permissions": ["members_write"]
}
],
- "summary": "List roles of an organization",
- "tags": ["Organizations"],
+ "summary": "Creates organization invitations",
+ "tags": ["Organizations Members Invitations"],
+ "x-allowed-plans": ["Enterprise"],
"x-badges": [
{
- "name": "OAuth scope: organizations:read",
+ "name": "OAuth scope: organizations:write",
"position": "after"
+ },
+ {
+ "name": "Only available on Enterprise",
+ "position": "before"
}
],
"x-endpoint-owners": ["management-api"],
- "x-oauth-scope": "organizations:read"
+ "x-oauth-scope": "organizations:write"
}
}
},
@@ -2921,41 +3584,189 @@
"required": ["key", "message"]
}
},
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- },
- "required": ["key", "message"]
- }
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": ["key", "message"]
+ }
+ },
+ "info": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": ["key", "message"]
+ }
+ }
+ },
+ "required": ["valid", "warnings", "errors", "info"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
+ },
+ "V2ListPrivateLinkAssociationsResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "id": {
+ "type": "string"
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID this PrivateLink share is associated with."
+ },
+ "account_name": {
+ "type": "string",
+ "description": "Human-readable name for the AWS account."
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "CREATING",
+ "READY",
+ "ASSOCIATION_REQUEST_EXPIRED",
+ "ASSOCIATION_ACCEPTED",
+ "CREATION_FAILED",
+ "DELETING"
+ ],
+ "description": "\n - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.\n - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.\n - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.\n - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.\n - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.\n - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.\n"
+ },
+ "shared_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true,
+ "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending."
+ }
+ },
+ "required": ["aws_account_id", "status", "shared_at"]
+ }
+ },
+ "required": ["type", "id", "attributes"]
+ }
+ }
+ },
+ "required": ["data"]
+ },
+ "V2CreatePrivateLinkAssociationRequest": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID to add to the project PrivateLink share."
+ },
+ "account_name": {
+ "type": "string",
+ "maxLength": 128,
+ "description": "Optional human-readable name for the AWS account."
+ }
+ },
+ "required": ["aws_account_id"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
+ },
+ "V2PrivateLinkAssociationResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["private_link_association"],
+ "description": "Resource type."
+ },
+ "id": {
+ "type": "string"
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "aws_account_id": {
+ "type": "string",
+ "minLength": 12,
+ "maxLength": 12,
+ "pattern": "^\\d{12}$",
+ "description": "The AWS account ID this PrivateLink share is associated with."
+ },
+ "account_name": {
+ "type": "string",
+ "description": "Human-readable name for the AWS account."
},
- "info": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- },
- "required": ["key", "message"]
- }
+ "status": {
+ "type": "string",
+ "enum": [
+ "CREATING",
+ "READY",
+ "ASSOCIATION_REQUEST_EXPIRED",
+ "ASSOCIATION_ACCEPTED",
+ "CREATION_FAILED",
+ "DELETING"
+ ],
+ "description": "\n - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.\n - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.\n - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.\n - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.\n - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.\n - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.\n"
+ },
+ "shared_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true,
+ "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending."
}
},
- "required": ["valid", "warnings", "errors", "info"]
+ "required": ["aws_account_id", "status", "shared_at"]
}
},
- "required": ["type", "attributes"]
+ "required": ["type", "id", "attributes"]
}
},
"required": ["data"]
@@ -3008,14 +3819,10 @@
"items": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "description": "Role ID."
- },
"name": {
"type": "string",
"description": "Role name. For project-scoped roles this is the base role name.",
- "example": "Developer"
+ "example": "developer"
},
"scope": {
"type": "string",
@@ -3039,7 +3846,7 @@
"description": "Project refs this role is scoped to. Empty array for org-level roles."
}
},
- "required": ["id", "name", "scope", "projects"]
+ "required": ["name", "scope", "projects"]
},
"description": "Roles assigned to this member. Includes both org-level and project-scoped roles."
}
@@ -3090,6 +3897,100 @@
},
"required": ["data", "links"]
},
+ "V2AssignOrganizationMemberRoleRequest": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_member_role"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "enum": ["owner", "administrator", "developer", "read-only"],
+ "description": "Role name to assign. Must be one of: owner, administrator, developer, read-only. Must be on a Team or Enterprise plan to use the read-only role.",
+ "example": "developer"
+ },
+ "projects": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Project ref",
+ "example": "abcjuqabhgwjjutfvtpa"
+ }
+ },
+ "required": ["ref"]
+ },
+ "minItems": 1,
+ "description": "The projects to assign a project-scoped role for. If omitted, assigns an org-wide role."
+ }
+ },
+ "required": ["role"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
+ },
+ "OrganizationMemberRoleResponse": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_member_role"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Role name. For project-scoped assignments this is the base role name.",
+ "example": "developer"
+ },
+ "scope": {
+ "type": "string",
+ "enum": ["organization", "project"],
+ "description": "Whether this role applies org-wide or is scoped to specific projects for the user."
+ },
+ "projects": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": ["ref", "name"]
+ },
+ "description": "Project refs this role is scoped to. Empty array for org-level roles."
+ }
+ },
+ "required": ["name", "scope", "projects"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ },
+ "required": ["data"]
+ },
"V2ListRolesResponse": {
"type": "object",
"properties": {
@@ -3103,26 +4004,50 @@
"enum": ["organization_role"],
"description": "Resource type."
},
- "id": {
- "type": "string"
- },
+ "id": {},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
- "description": "Role name. For project-scoped roles this is the base role name.",
- "example": "Developer"
- },
- "scope": {
+ "description": "Role name.",
+ "example": "developer"
+ }
+ },
+ "required": ["name"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
+ }
+ },
+ "required": ["data"]
+ },
+ "V2CreateInvitationsRequest": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_invitation"],
+ "description": "Resource type."
+ },
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "email": {
"type": "string",
- "enum": ["organization", "project"],
- "description": "Whether this role applies org-wide or is scoped to specific projects for the user."
+ "format": "email"
},
- "base_role_id": {
- "type": "integer",
- "nullable": true,
- "description": "null for org-level roles; the base role ID for project-scoped roles."
+ "role": {
+ "type": "string",
+ "enum": ["owner", "administrator", "developer", "read-only"],
+ "description": "Role name to assign. Must be on a Team or Enterprise plan to use the read-only role.",
+ "example": "developer"
},
"projects": {
"type": "array",
@@ -3130,55 +4055,170 @@
"type": "object",
"properties": {
"ref": {
- "type": "string"
- },
- "name": {
- "type": "string"
+ "type": "string",
+ "description": "Project ref",
+ "example": "abcjuqabhgwjjutfvtpa"
}
},
- "required": ["ref", "name"]
+ "required": ["ref"]
},
- "description": "Project refs this role is scoped to. Empty array for org-level roles."
+ "minItems": 1,
+ "description": "The projects to limit a user to. If omitted, user will have org-wide access with the provided role."
+ },
+ "require_sso": {
+ "type": "boolean"
}
},
- "required": ["name", "scope", "base_role_id", "projects"]
+ "required": ["email", "role"]
}
},
- "required": ["type", "id", "attributes"]
- }
- },
- "links": {
+ "required": ["type", "attributes"]
+ },
+ "minItems": 1,
+ "maxItems": 50
+ }
+ },
+ "required": ["data"]
+ },
+ "V2CreateInvitationsResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
"type": "object",
"properties": {
- "first": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the first page if available.",
- "example": "/v2/organizations/my-org/roles?page[size]=10"
+ "id": {
+ "type": "string"
},
- "prev": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the previous page.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7"
+ "code": {
+ "type": "string"
},
- "next": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the next page.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4"
+ "message": {
+ "type": "string"
},
- "last": {
- "type": "string",
- "nullable": true,
- "description": "URL path to the last page if available.",
- "example": "/v2/organizations/my-org/roles?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
+ "description": {
+ "type": "string"
+ },
+ "links": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "rel": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "describedby": {
+ "type": "string"
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {}
+ }
+ },
+ "required": ["href"]
+ }
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {}
+ },
+ "issues": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "links": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "rel": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "describedby": {
+ "type": "string"
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {}
+ }
+ },
+ "required": ["href"]
+ }
+ },
+ "meta": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email"
+ }
+ },
+ "required": ["email"]
+ }
+ },
+ "required": ["code", "message", "meta"]
+ }
}
},
- "required": ["prev", "next"]
+ "required": ["code", "message"]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["organization_invitation"],
+ "description": "Resource type."
+ },
+ "id": {},
+ "attributes": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email"
+ }
+ },
+ "required": ["email"]
+ }
+ },
+ "required": ["type", "attributes"]
+ }
}
},
- "required": ["data", "links"]
+ "required": ["data"]
}
}
}