Generates a Bearer Token to authenticate with Skyflow. This method doesn't require the Authorization header.
Note: For recommended ways to authenticate, see API authentication.
", "operationId": "AuthenticationService_GetAuthToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetAuthTokenRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetAuthTokenResponse" } } }, "description": "A successful response." }, "400": { "content": { "application/json": { "schema": { "example": { "error": { "details": [], "grpc_code": 3, "http_code": 400, "http_status": "Bad Request", "message": "Scopes in request token in wrong format" } }, "format": "object", "type": "object" } } }, "description": "Invalid scope format." }, "401": { "content": { "application/json": { "schema": { "example": { "error": { "details": [], "grpc_code": 16, "http_code": 401, "http_status": "Unauthorized", "message": "Error: Key expired, consider rotating." } }, "format": "object", "type": "object" } } }, "description": "Key expired or JWT token unparseable." }, "404": { "content": { "application/json": { "schema": { "format": "object", "type": "object" } } }, "description": "Returned when the resource does not exist." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "An unexpected error response." } }, "summary": "Get Bearer Token", "tags": [ "Authentication" ], "x-severity": 1, "x-codegen-request-body-name": "body" } }, "/v1/auth/sts/token": { "post": { "description": "Generates a Bearer Token to authenticate with Skyflow. This method doesn't require the Authorization header.
INTEROP role.",
"operationId": "create-function",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFunctionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFunctionResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist.",
"$ref": "#/components/responses/404"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response.",
"$ref": "#/components/responses/500"
}
},
"summary": "Create Function",
"tags": [
"Functions"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/functions/{ID}": {
"delete": {
"description": "Deletes the specified function.",
"operationId": "delete-function",
"parameters": [
{
"name": "ID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteFunctionResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist.",
"$ref": "#/components/responses/404"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response.",
"$ref": "#/components/responses/500"
}
},
"summary": "Delete Function",
"tags": [
"Functions"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"get": {
"description": "Returns the specified function.",
"operationId": "get-function",
"parameters": [
{
"name": "ID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFunctionResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist.",
"$ref": "#/components/responses/404"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response.",
"$ref": "#/components/responses/500"
}
},
"summary": "Get Function",
"tags": [
"Functions"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"post": {
"description": "Updates the specified function.",
"operationId": "update-function",
"parameters": [
{
"name": "ID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFunctionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFunctionResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist.",
"$ref": "#/components/responses/404"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response.",
"$ref": "#/components/responses/500"
}
},
"summary": "Update Function",
"tags": [
"Functions"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/functions/{ID}/tags": {
"get": {
"description": "Returns all tags for the specified function.",
"operationId": "list-function-version-tags",
"parameters": [
{
"name": "ID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filterOps.status",
"in": "query",
"description": "Filter that returns only results that match the specified tag status.",
"schema": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"format": "enum"
}
},
{
"name": "sortOps.sortBy",
"in": "query",
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"schema": {
"type": "string"
}
},
{
"name": "sortOps.orderBy",
"in": "query",
"description": "Ascending or descending ordering of results.",
"schema": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string",
"format": "enum"
}
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFunctionTagsResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist.",
"$ref": "#/components/responses/404"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response.",
"$ref": "#/components/responses/500"
}
},
"summary": "List Function Tags",
"tags": [
"Functions"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"offset",
"limit",
"filterOps.status",
"sortOps.sortBy",
"sortOps.orderBy"
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/functions/{ID}/tags/{versionTag}": {
"get": {
"description": "Returns the specified function tag.",
"operationId": "get-function-version-tag",
"parameters": [
{
"name": "ID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionTag",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "downloadURL",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFunctionTagResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist.",
"$ref": "#/components/responses/404"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response.",
"$ref": "#/components/responses/500"
}
},
"summary": "Get Function Tag",
"tags": [
"Functions"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"downloadURL"
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/gateway/inboundRoutes": {
"get": {
"description": "List inbound connections for the specified vault.",
"operationId": "IntegrationService_ListInboundIntegration",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
},
{
"description": "ID of the vault.",
"in": "query",
"name": "vaultID",
"schema": {
"type": "string"
}
},
{
"description": "If `true`, only returns connection IDs.",
"in": "query",
"name": "fetchIDonly",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListIntegrationResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Inbound Connections",
"tags": [
"Connections"
],
"x-severity": 3
},
"post": {
"description": "Creates an inbound connection.",
"operationId": "IntegrationService_CreateInboundIntegration",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1RelayMappings"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateIntegrationResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Inbound Connection",
"tags": [
"Connections"
],
"x-severity": 3,
"x-codegen-request-body-name": "RelayMappings"
}
},
"/v1/gateway/inboundRoutes/{ID}": {
"delete": {
"description": "Deletes the specified inbound connection.",
"operationId": "IntegrationService_DeleteInboundIntegration",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1Empty"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Inbound Connection",
"tags": [
"Connections"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified inbound connection.",
"operationId": "IntegrationService_GetInboundIntegration",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1RelayMappings"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Inbound Connection",
"tags": [
"Connections"
],
"x-severity": 3
},
"put": {
"description": "Updates the specified inbound connection.",
"operationId": "IntegrationService_UpdateInboundIntegration",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1RelayMappings"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdateIntegrationResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Inbound Connection ",
"tags": [
"Connections"
],
"x-severity": 3,
"x-codegen-request-body-name": "RelayMappings"
}
},
"/v1/gateway/{connectionID}/secret": {
"post": {
"description": "Update the specified secrets for a connection. Other secrets aren't updated. All properties for a secret must be specified together. For example, to update the `routeSecret`, you must specify both `publicKey` and `privateKey`.",
"operationId": "update_secrets",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "connectionID",
"required": true,
"schema": {
"type": "string"
},
"example": "c3ec3e65-286d-4248-8bcb-66b472185848"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/secrets"
},
"examples": {
"default": {
"value": {
"routeSecret": {
"publicKey": "exampleUser",
"privateKey": "examplePassword"
},
"soapAuthSecret": {
"userName": "soapUser",
"password": "soapPassword"
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Secrets updated successfully.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/x-request-id"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1Empty"
},
"examples": {
"default": {
"value": {}
}
}
}
}
},
"default": {
"description": "Unexpected error."
}
},
"summary": "Update Connection Secrets",
"tags": [
"Connections"
]
},
"get": {
"description": "Identifies which secrets are set for a connection. Secret values are redacted. Returns 404 if no secrets are found.",
"operationId": "get_secrets",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "connectionID",
"required": true,
"schema": {
"type": "string"
},
"example": "c3ec3e65-286d-4248-8bcb-66b472185848"
}
],
"responses": {
"200": {
"description": "Secrets for the connection.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/x-request-id"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/secrets"
},
"example": {
"routeSecret": {
"publicKey": "SECRET",
"privateKey": "SECRET"
},
"soapAuthSecret": {
"userName": "SECRET",
"password": "SECRET"
}
}
}
}
},
"404": {
"description": "No secrets found for the connection.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"default": {
"description": "Unexpected error."
}
},
"summary": "Get Connection Secrets",
"tags": [
"Connections"
]
}
},
"/v1/gateway/inboundRoutes/{ID}/secret": {
"post": {
"description": "Uploads authentication information for an inbound connection.",
"operationId": "IntegrationService_UploadInboundSecret",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/secrets"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1Empty"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Upload Authentication Credentials (Inbound)",
"tags": [
"Connections"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/gateway/outboundRoutes": {
"get": {
"description": "Lists outbound connections for the specified vault.",
"operationId": "IntegrationService_ListOutboundIntegration",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
},
{
"description": "ID of the vault.",
"in": "query",
"name": "vaultID",
"schema": {
"type": "string"
}
},
{
"description": "If `true`, only returns connection IDs.",
"in": "query",
"name": "fetchIDonly",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListIntegrationResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Outbound Connections",
"tags": [
"Connections"
],
"x-severity": 3
},
"post": {
"description": "Creates an outbound connection for a vault.",
"operationId": "IntegrationService_CreateOutboundIntegration",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1RelayMappings"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateIntegrationResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Outbound Connection",
"tags": [
"Connections"
],
"x-severity": 3,
"x-codegen-request-body-name": "RelayMappings"
}
},
"/v1/gateway/outboundRoutes/{ID}": {
"delete": {
"description": "Deletes the specified outbound connection.",
"operationId": "IntegrationService_DeleteOutboundIntegration",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1Empty"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Outbound Connection",
"tags": [
"Connections"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified outbound connection.",
"operationId": "IntegrationService_GetOutboundIntegration",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1RelayMappings"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Outbound Connection",
"tags": [
"Connections"
],
"x-severity": 3
},
"put": {
"description": "Updates the specified outbound connection .",
"operationId": "IntegrationService_UpdateOutboundIntegration",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1RelayMappings"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdateIntegrationResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Outbound Connection ",
"tags": [
"Connections"
],
"x-severity": 3,
"x-codegen-request-body-name": "RelayMappings"
}
},
"/v1/gateway/outboundRoutes/{ID}/secret": {
"post": {
"description": "Uploads authentication information for an outbound connection.",
"operationId": "IntegrationService_UploadSecret",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the connection.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/secrets"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1Empty"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Upload Authentication Credentials (Outbound)",
"tags": [
"Connections"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/masterKeys/getImportParams": {
"get": {
"description": "Gets parameters to import an external master key into a workspace.",
"operationId": "get-master-key-import-parameters",
"parameters": [
{
"name": "workspaceID",
"in": "query",
"description": "ID of the workspace.",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMasterKeyImportResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Master Key Import Parameters",
"tags": [
"Key Management"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"workspaceID"
],
"x-required-query-parameters": [
"workspaceID"
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/masterKeys/import": {
"post": {
"description": "Imports external master key ciphertext into a workspace.",
"operationId": "import-master-key",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportMasterKeyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportMasterKeyResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Import Master Key",
"tags": [
"Key Management"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/masterKeys/vaults/{vaultID}/getMasterKeyMetadata": {
"get": {
"description": "Gets metadata associated with a vault's master key.",
"operationId": "get-master-key-metadata",
"parameters": [
{
"name": "vaultID",
"in": "path",
"description": "ID of the vault.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMasterKeyMetadataResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Master Key Metadata",
"tags": [
"Key Management"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/masterKeys/vaults/{vaultID}/rotate": {
"post": {
"description": "Rotates a vault's master key.",
"operationId": "rotate-master-key",
"parameters": [
{
"name": "vaultID",
"in": "path",
"description": "ID of the vault.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RotateMasterKeyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RotateMasterKeyResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"409": {
"$ref": "#/components/responses/409"
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Rotate Master Key",
"tags": [
"Key Management"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v2/operations/{ID}": {
"get": {
"description": "Returns the status and details of a specific asynchronous operation.",
"operationId": "OperationService_GetOperation",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the operation.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Operation"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Operation Status",
"tags": [
"Operations"
],
"x-severity": 3
}
},
"/v1/members/{member.ID}/permissions": {
"get": {
"description": "Lists permissions assigned to a member.",
"operationId": "RoleService_ListPermissionsOfMember",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the member.",
"in": "path",
"name": "member.ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "member.type",
"required": true,
"schema": {
"default": "NONE",
"enum": [
"NONE",
"USER",
"GROUP",
"SERVICE_ACCOUNT",
"SQL_SERVICE_ACCOUNT"
],
"type": "string"
}
},
{
"description": "Name of the member.",
"in": "query",
"name": "member.name",
"schema": {
"type": "string"
}
},
{
"description": "Email address of the member.",
"in": "query",
"name": "member.email",
"schema": {
"type": "string"
}
},
{
"description": "Status of the member.",
"in": "query",
"name": "member.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Name of the user.",
"in": "query",
"name": "member.user.name",
"schema": {
"type": "string"
}
},
{
"description": "Address number and street name.",
"in": "query",
"name": "member.user.contactAddress.streetAddress",
"schema": {
"type": "string"
}
},
{
"description": "City.",
"in": "query",
"name": "member.user.contactAddress.city",
"schema": {
"type": "string"
}
},
{
"description": "State or province.",
"in": "query",
"name": "member.user.contactAddress.state",
"schema": {
"type": "string"
}
},
{
"description": "Country.",
"in": "query",
"name": "member.user.contactAddress.country",
"schema": {
"type": "string"
}
},
{
"description": "Postal code.",
"in": "query",
"name": "member.user.contactAddress.zip",
"schema": {
"format": "int32",
"type": "integer"
}
},
{
"description": "Email address of the user.",
"in": "query",
"name": "member.user.userIdentity.email",
"schema": {
"type": "string"
}
},
{
"description": "Okta ID of the user.",
"in": "query",
"name": "member.user.userIdentity.oktaID",
"schema": {
"type": "string"
}
},
{
"description": "ID of the user. Generated by Skyflow.",
"in": "query",
"name": "member.user.ID",
"schema": {
"type": "string"
}
},
{
"description": "Status of the user.",
"in": "query",
"name": "member.user.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "User who created the resource.",
"in": "query",
"name": "member.user.BasicAudit.CreatedBy",
"schema": {
"type": "string"
}
},
{
"description": "User who last modified the resource.",
"in": "query",
"name": "member.user.BasicAudit.LastModifiedBy",
"schema": {
"type": "string"
}
},
{
"description": "Creation time of the resource.",
"in": "query",
"name": "member.user.BasicAudit.CreatedOn",
"schema": {
"type": "string"
}
},
{
"description": "Last modification time of the resource.",
"in": "query",
"name": "member.user.BasicAudit.LastModifiedOn",
"schema": {
"type": "string"
}
},
{
"description": "Name of the service account.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.name",
"schema": {
"type": "string"
}
},
{
"description": "Display name of the service account that appears in user interfaces.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.displayName",
"schema": {
"type": "string"
}
},
{
"description": "Description of the service account.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.description",
"schema": {
"type": "string"
}
},
{
"description": "ID of the service account. Generated by Skyflow.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.ID",
"schema": {
"type": "string"
}
},
{
"description": "Namespace of the service account.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.namespace",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "User who created the resource.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedBy",
"schema": {
"type": "string"
}
},
{
"description": "User who last modified the resource.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedBy",
"schema": {
"type": "string"
}
},
{
"description": "Creation time of the resource.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedOn",
"schema": {
"type": "string"
}
},
{
"description": "Last modification time of the resource.",
"in": "query",
"name": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedOn",
"schema": {
"type": "string"
}
},
{
"description": "When `true`, all JWT assertions for this service account much contain a `ctx` claim.",
"in": "query",
"name": "member.serviceAccountInfo.clientConfiguration.enforceContextID",
"schema": {
"type": "boolean"
}
},
{
"description": "When `true`, all data tokens sent to the vault using this service account must be signed with the associated private key.",
"in": "query",
"name": "member.serviceAccountInfo.clientConfiguration.enforceSignedDataTokens",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListPermissionsOfMemberResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Permissions of Member",
"tags": [
"Roles"
],
"x-severity": 3
}
},
"/v1/members/{member.ID}/roles": {
"get": {
"description": "Lists roles assigned to a member as role-to-resource pairs.",
"operationId": "RoleService_ListRolesOfMember",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the member.",
"in": "path",
"name": "member.ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "member.type",
"required": true,
"schema": {
"default": "NONE",
"enum": [
"NONE",
"USER",
"GROUP",
"SERVICE_ACCOUNT",
"SQL_SERVICE_ACCOUNT"
],
"type": "string"
}
},
{
"description": "Name of the member.",
"in": "query",
"name": "member.name",
"schema": {
"type": "string"
}
},
{
"description": "Email address of the member.",
"in": "query",
"name": "member.email",
"schema": {
"type": "string"
}
},
{
"description": "Status of the member.",
"in": "query",
"name": "member.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified name.",
"in": "query",
"name": "filterOps.name",
"schema": {
"type": "string"
}
},
{
"description": "ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.",
"in": "query",
"name": "filterOps.resource.ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Type of the resource.",
"in": "query",
"name": "filterOps.resource.type",
"required": true,
"schema": {
"default": "NONE",
"enum": [
"NONE",
"ORGANIZATION",
"VAULT",
"ACCOUNT",
"SERVICE_ACCOUNT",
"VAULT_TEMPLATE",
"WORKSPACE",
"FIELD_TEMPLATE",
"RECORD",
"TOKEN",
"CONNECTION",
"ENCRYPTION_KEY",
"NETWORK_TOKEN",
"SUBSCRIPTION",
"PAYMENT_CONFIG"
],
"type": "string"
}
},
{
"description": "Name of the resource.",
"in": "query",
"name": "filterOps.resource.name",
"schema": {
"type": "string"
}
},
{
"description": "Unique namespace for the resource. Generated by Skyflow.",
"in": "query",
"name": "filterOps.resource.namespace",
"schema": {
"type": "string"
}
},
{
"description": "Description of the resource.",
"in": "query",
"name": "filterOps.resource.description",
"schema": {
"type": "string"
}
},
{
"description": "Status of the resource.",
"in": "query",
"name": "filterOps.resource.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Display name of the resource that appears in user interfaces.",
"in": "query",
"name": "filterOps.resource.displayName",
"schema": {
"type": "string"
}
},
{
"description": " - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user.",
"in": "query",
"name": "filterOps.roleType",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"SYSTEM",
"CUSTOM"
],
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListRolesOfMemberResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Roles of Member",
"tags": [
"Roles"
],
"x-severity": 3
}
},
"/v1/pipelines": {
"get": {
"description": "Lists the pipelines you can access.",
"operationId": "list-pipelines",
"parameters": [
{
"name": "filterOps.name",
"in": "query",
"description": "Name of the pipeline.",
"schema": {
"type": "string"
}
},
{
"name": "sortOps.sortBy",
"in": "query",
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"schema": {
"type": "string"
}
},
{
"name": "sortOps.orderBy",
"in": "query",
"description": "Ascending or descending ordering of results.",
"schema": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string",
"format": "enum"
}
},
{
"name": "offset",
"in": "query",
"description": "Record position at which to start retrieving pipelines.",
"schema": {
"type": "integer",
"format": "uint32"
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of pipelines to retrieve. Maximum 25.",
"schema": {
"type": "integer",
"format": "uint32"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListPipelinesResponse_list-pipelines"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Pipelines",
"tags": [
"Pipelines"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"filterOps.name",
"sortOps.sortBy",
"sortOps.orderBy",
"offset",
"limit"
],
"x-fern-audiences": [
"external"
]
},
"post": {
"description": "Creates a pipeline.",
"operationId": "create-pipeline",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePipelineRequest"
}
}
},
"description": "Request to create a pipeline.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePipelineResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Pipeline",
"tags": [
"Pipelines"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/pipelines/{ID}": {
"delete": {
"description": "Deletes the specified pipeline and the entities it contains.",
"operationId": "delete-pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the pipeline.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletePipelineResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Pipeline",
"tags": [
"Pipelines"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"get": {
"description": "Returns the specified pipeline.",
"operationId": "get-pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the pipeline.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPipelineResponse_get-pipeline"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Pipeline",
"tags": [
"Pipelines"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"patch": {
"tags": [
"Pipelines"
],
"summary": "Update Pipeline",
"description": "Updates the specified pipeline.",
"operationId": "update-pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the pipeline.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePipelineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePipelineResponse"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/pipelines/{ID}/run": {
"post": {
"description": "Runs the specified pipeline.",
"operationId": "run-pipeline",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the pipeline.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunPipelineRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunPipelineResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Run Pipeline",
"tags": [
"Pipelines"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/pipelines/{ID}/runs/{runID}/stop": {
"post": {
"description": "Stops the specified pipeline run.",
"operationId": "stop-pipeline-run",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the pipeline.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "runID",
"in": "path",
"description": "ID of the pipeline run.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StopPipelineRunRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StopPipelineRunResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Stop Pipeline Run",
"tags": [
"Pipelines"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/pipelines/{pipelineID}/runs": {
"get": {
"description": "Lists runs of the specified pipeline.",
"operationId": "list-pipeline-runs",
"parameters": [
{
"name": "pipelineID",
"in": "path",
"description": "ID of the pipeline.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filterOps.state",
"in": "query",
"description": "State of the pipeline run.",
"schema": {
"enum": [
"SUCCEEDED",
"FAILED"
],
"type": "string",
"format": "enum"
}
},
{
"name": "offset",
"in": "query",
"description": "Record position at which to start retrieving pipeline runs.",
"schema": {
"type": "integer",
"format": "uint32"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of pipeline runs to retrieve.",
"schema": {
"type": "integer",
"format": "uint32"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListPipelineRunsResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Pipeline Runs",
"tags": [
"Pipelines"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"filterOps.state",
"offset",
"limit"
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/pipelines/{pipelineID}/runs/{ID}": {
"get": {
"description": "Returns the specified pipeline run.",
"operationId": "get-pipeline-run",
"parameters": [
{
"name": "pipelineID",
"in": "path",
"description": "ID of the pipeline.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ID",
"in": "path",
"description": "ID of the pipeline run.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPipelineRunResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Pipeline Run",
"tags": [
"Pipelines"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/policies": {
"get": {
"description": "Lists policies associated with a resource.",
"operationId": "PolicyAuthoringService_ListPolicies",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.",
"in": "query",
"name": "resource.ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Type of the resource.",
"in": "query",
"name": "resource.type",
"required": true,
"schema": {
"default": "NONE",
"enum": [
"NONE",
"ORGANIZATION",
"VAULT",
"ACCOUNT",
"SERVICE_ACCOUNT",
"VAULT_TEMPLATE",
"WORKSPACE",
"FIELD_TEMPLATE",
"RECORD",
"TOKEN",
"CONNECTION",
"ENCRYPTION_KEY",
"NETWORK_TOKEN",
"SUBSCRIPTION",
"PAYMENT_CONFIG"
],
"type": "string"
}
},
{
"description": "Name of the resource.",
"in": "query",
"name": "resource.name",
"schema": {
"type": "string"
}
},
{
"description": "Unique namespace for the resource. Generated by Skyflow.",
"in": "query",
"name": "resource.namespace",
"schema": {
"type": "string"
}
},
{
"description": "Description of the resource.",
"in": "query",
"name": "resource.description",
"schema": {
"type": "string"
}
},
{
"description": "Status of the resource.",
"in": "query",
"name": "resource.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Display name of the resource that appears in user interfaces.",
"in": "query",
"name": "resource.displayName",
"schema": {
"type": "string"
}
},
{
"description": "filter that limits results to those that match the specified name.\n\nstring ruleName = 2;\n Action action = 3;\n Effect effect = 4;",
"in": "query",
"name": "filterOps.name",
"schema": {
"type": "string"
}
},
{
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"in": "query",
"name": "sortOps.sortBy",
"schema": {
"type": "string"
}
},
{
"description": "Ascending or descending ordering of results.",
"in": "query",
"name": "sortOps.orderBy",
"schema": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to retrieve.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListPoliciesResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Policies",
"tags": [
"Policies"
],
"x-severity": 3
},
"post": {
"description": "Creates a policy for the specified resource.",
"operationId": "PolicyAuthoringService_CreatePolicy",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreatePolicyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreatePolicyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Policy",
"tags": [
"Policies"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/policies/assign": {
"post": {
"description": "Assigns a policy to one or more roles.",
"operationId": "PolicyAuthoringService_AssignPolicy",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1AssignPolicyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1AssignPolicyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Assign Policy",
"tags": [
"Policies"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/policies/rules": {
"post": {
"description": "Creates a rule in a policy.",
"operationId": "PolicyAuthoringService_CreateRule",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateRuleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateRuleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Rule",
"tags": [
"Policies"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/policies/rules/{ID}": {
"delete": {
"description": "Deletes a rule from a policy.",
"operationId": "PolicyAuthoringService_DeleteRule",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the rule.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the policy that contains the rule.",
"in": "query",
"name": "policyID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeleteRuleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Rule",
"tags": [
"Policies"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified rule.",
"operationId": "PolicyAuthoringService_GetRule",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the rule.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the policy that contains the rule.",
"in": "query",
"name": "policyID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetRuleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Rule",
"tags": [
"Policies"
],
"x-severity": 3
},
"patch": {
"description": "Update a rule.",
"operationId": "PolicyAuthoringService_UpdateRule",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the rule.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyAuthoringServiceUpdateRuleBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdateRuleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Rule",
"tags": [
"Policies"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/policies/unassign": {
"post": {
"description": "Unassigns a policy from one or more roles.",
"operationId": "PolicyAuthoringService_UnassignPolicy",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UnassignPolicyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UnassignPolicyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Unassign Policy",
"tags": [
"Policies"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/policies/{ID}": {
"delete": {
"description": "Deletes the specified policy.",
"operationId": "PolicyAuthoringService_DeletePolicy",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the policy.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeletePolicyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Policy",
"tags": [
"Policies"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified policy.",
"operationId": "PolicyAuthoringService_GetPolicy",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the policy.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetPolicyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Policy",
"tags": [
"Policies"
],
"x-severity": 3
},
"patch": {
"description": "Updates the specified policy.",
"operationId": "PolicyAuthoringService_UpdatePolicy",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the policy.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyAuthoringServiceUpdatePolicyBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdatePolicyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Policy",
"tags": [
"Policies"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/policies/{ID}/status": {
"patch": {
"description": "Updates a policy's status.",
"operationId": "PolicyAuthoringService_UpdateStatus",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the entity to update.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1PolicyAuthoringServiceUpdateStatusBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdateStatusResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Policy Status",
"tags": [
"Policies"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/policies/{policyID}/roles": {
"get": {
"description": "Lists roles assigned to a policy.",
"operationId": "RoleService_ListRolesOfPolicy",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the policy.",
"in": "path",
"name": "policyID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified role name.",
"in": "query",
"name": "filterOps.name",
"schema": {
"type": "string"
}
},
{
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"in": "query",
"name": "sortOps.sortBy",
"schema": {
"type": "string"
}
},
{
"description": "Ascending or descending ordering of results.",
"in": "query",
"name": "sortOps.orderBy",
"schema": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListRolesOfPolicyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Roles of Policy",
"tags": [
"Roles"
],
"x-severity": 3
}
},
"/v1/resources": {
"get": {
"description": "List resources under a given resource.",
"operationId": "AccountService_ListResources",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.",
"in": "query",
"name": "resource.ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Type of the resource.",
"in": "query",
"name": "resource.type",
"required": true,
"schema": {
"default": "NONE",
"enum": [
"NONE",
"ORGANIZATION",
"VAULT",
"ACCOUNT",
"SERVICE_ACCOUNT",
"VAULT_TEMPLATE",
"WORKSPACE",
"FIELD_TEMPLATE",
"RECORD",
"TOKEN",
"CONNECTION",
"ENCRYPTION_KEY",
"NETWORK_TOKEN",
"SUBSCRIPTION",
"PAYMENT_CONFIG"
],
"type": "string"
}
},
{
"description": "Name of the resource.",
"in": "query",
"name": "resource.name",
"schema": {
"type": "string"
}
},
{
"description": "Unique namespace for the resource. Generated by Skyflow.",
"in": "query",
"name": "resource.namespace",
"schema": {
"type": "string"
}
},
{
"description": "Description of the resource.",
"in": "query",
"name": "resource.description",
"schema": {
"type": "string"
}
},
{
"description": "Status of the resource.",
"in": "query",
"name": "resource.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Display name of the resource that appears in user interfaces.",
"in": "query",
"name": "resource.displayName",
"schema": {
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListResourcesResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Resources",
"tags": [
"Accounts"
],
"x-severity": 3
}
},
"/v1/roleDefinitions": {
"get": {
"description": "Lists Skyflow-defined roles. You can't update or delete these roles.",
"operationId": "RoleService_ListRoleDefinitions",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "Filter that limits results to those that match the specified type.",
"in": "query",
"name": "resourceType",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"ORGANIZATION",
"VAULT",
"ACCOUNT",
"SERVICE_ACCOUNT",
"VAULT_TEMPLATE",
"WORKSPACE",
"FIELD_TEMPLATE",
"RECORD",
"TOKEN",
"CONNECTION",
"ENCRYPTION_KEY",
"NETWORK_TOKEN",
"FUNCTION_CONFIG",
"SUBSCRIPTION",
"PAYMENT_CONFIG"
],
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListRoleDefinitionsResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Skyflow-defined Roles",
"tags": [
"Roles"
],
"x-severity": 3
}
},
"/v1/roles": {
"get": {
"description": "Lists roles associated with a resource.",
"operationId": "RoleService_ListRoles",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.",
"in": "query",
"name": "resource.ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Type of the resource.",
"in": "query",
"name": "resource.type",
"required": true,
"schema": {
"default": "NONE",
"enum": [
"NONE",
"ORGANIZATION",
"VAULT",
"ACCOUNT",
"SERVICE_ACCOUNT",
"VAULT_TEMPLATE",
"WORKSPACE",
"FIELD_TEMPLATE",
"RECORD",
"TOKEN",
"CONNECTION",
"ENCRYPTION_KEY",
"NETWORK_TOKEN",
"SUBSCRIPTION",
"PAYMENT_CONFIG"
],
"type": "string"
}
},
{
"description": "Name of the resource.",
"in": "query",
"name": "resource.name",
"schema": {
"type": "string"
}
},
{
"description": "Unique namespace for the resource. Generated by Skyflow.",
"in": "query",
"name": "resource.namespace",
"schema": {
"type": "string"
}
},
{
"description": "Description of the resource.",
"in": "query",
"name": "resource.description",
"schema": {
"type": "string"
}
},
{
"description": "Status of the resource.",
"in": "query",
"name": "resource.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Display name of the resource that appears in user interfaces.",
"in": "query",
"name": "resource.displayName",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified name.",
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified type.\n\n - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user.",
"in": "query",
"name": "type",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"SYSTEM",
"CUSTOM"
],
"type": "string"
}
},
{
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"in": "query",
"name": "sortOps.sortBy",
"schema": {
"type": "string"
}
},
{
"description": "Ascending or descending ordering of results.",
"in": "query",
"name": "sortOps.orderBy",
"schema": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListRolesResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Roles",
"tags": [
"Roles"
],
"x-severity": 3
},
"post": {
"description": "Creates a custom role for the specified resource. After you create a role, you need to assign the role to a user or service account.",
"operationId": "RoleService_CreateRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateRoleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateRoleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Role",
"tags": [
"Roles"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/roles/assign": {
"post": {
"description": "Assigns a role to a member.",
"operationId": "RoleService_AssignRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1AssignRoleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1AssignRoleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Assign Role",
"tags": [
"Roles"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/roles/unassign": {
"post": {
"description": "Removes a role from members.",
"operationId": "RoleService_UnassignRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UnassignRoleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UnassignRoleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Unassign Role",
"tags": [
"Roles"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/roles/{ID}": {
"delete": {
"description": "Deletes a custom role. Attempting to delete Skyflow-defined roles results in an error.",
"operationId": "RoleService_DeleteRole",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the role.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeleteRoleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Role",
"tags": [
"Roles"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified role.",
"operationId": "RoleService_GetRole",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the role.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetRoleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Role",
"tags": [
"Roles"
],
"x-severity": 3
},
"patch": {
"description": "Updates a custom role. Attempting to update Skyflow-defined roles results in an error.",
"operationId": "RoleService_UpdateRole",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the role.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleServiceUpdateRoleBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdateRoleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Role",
"tags": [
"Roles"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/roles/{ID}/members": {
"get": {
"description": "Lists members that are assign the specified role.",
"operationId": "RoleService_ListMembersByRole",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified email address.",
"in": "query",
"name": "filterOps.email",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified type.",
"in": "query",
"name": "filterOps.type",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"USER",
"GROUP",
"SERVICE_ACCOUNT",
"SQL_SERVICE_ACCOUNT"
],
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified name.",
"in": "query",
"name": "filterOps.name",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified status.",
"in": "query",
"name": "filterOps.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"in": "query",
"name": "sortOps.sortBy",
"schema": {
"type": "string"
}
},
{
"description": "Ascending or descending ordering of results.",
"in": "query",
"name": "sortOps.orderBy",
"schema": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListMembersResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Members by Role",
"tags": [
"Roles"
],
"x-severity": 3
}
},
"/v1/roles/{roleID}/policies": {
"get": {
"description": "Lists policies assigned to a role.",
"operationId": "PolicyAuthoringService_ListPoliciesByRole",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the role.",
"in": "path",
"name": "roleID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified policy name.\n\nAction action = 2;\n Effect effect = 3;",
"in": "query",
"name": "filterOps.name",
"schema": {
"type": "string"
}
},
{
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"in": "query",
"name": "sortOps.sortBy",
"schema": {
"type": "string"
}
},
{
"description": "Ascending or descending ordering of results.",
"in": "query",
"name": "sortOps.orderBy",
"schema": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to receive.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListPoliciesByRoleResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Policies By Role",
"tags": [
"Policies"
],
"x-severity": 3
}
},
"/v1/serviceAccounts": {
"get": {
"description": "Lists service accounts.",
"operationId": "ServiceAccountService_ListServiceAccounts",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "Record position at with to start returning results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
},
{
"description": "ID of the account that the service account belongs to. Defaults to the account specified in the `X-Skyflow-Account-ID` header.",
"in": "query",
"name": "accountID",
"schema": {
"$ref": "#/components/parameters/AccountID"
}
},
{
"description": "Filter that limits results to those that match the specified name.",
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Deprecated. ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.",
"in": "query",
"name": "resource.ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Deprecated. Type of the resource.",
"in": "query",
"name": "resource.type",
"required": true,
"schema": {
"default": "NONE",
"enum": [
"NONE",
"ORGANIZATION",
"VAULT",
"ACCOUNT",
"SERVICE_ACCOUNT",
"VAULT_TEMPLATE",
"WORKSPACE",
"FIELD_TEMPLATE",
"RECORD",
"TOKEN",
"CONNECTION",
"ENCRYPTION_KEY",
"NETWORK_TOKEN",
"SUBSCRIPTION",
"PAYMENT_CONFIG"
],
"type": "string"
}
},
{
"description": "Deprecated. Name of the resource.",
"in": "query",
"name": "resource.name",
"schema": {
"type": "string"
}
},
{
"description": "Deprecated. Unique namespace for the resource. Generated by Skyflow.",
"in": "query",
"name": "resource.namespace",
"schema": {
"type": "string"
}
},
{
"description": "Deprecated. Description of the resource.",
"in": "query",
"name": "resource.description",
"schema": {
"type": "string"
}
},
{
"description": "Deprecated. Status of the resource.",
"in": "query",
"name": "resource.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Deprecated. Display name of the resource that appears in user interfaces.",
"in": "query",
"name": "resource.displayName",
"schema": {
"type": "string"
}
},
{
"description": "Deprecated. Number of levels of contained resources for which to return associated service accounts, starting at the specified resource.",
"in": "query",
"name": "depth",
"schema": {
"default": "5",
"format": "int64",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListServiceAccountsResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Service Accounts",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"post": {
"description": "Creates a service account.",
"operationId": "ServiceAccountService_CreateServiceAccount",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/create_service_account_request"
}
}
},
"description": "The service account create request.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateServiceAccountResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Service Account",
"tags": [
"Service Accounts"
],
"x-severity": 3,
"x-permission": "serviceAccount.create"
}
},
"/v1/serviceAccounts/{ID}": {
"delete": {
"description": "Deletes the specified service account.",
"operationId": "ServiceAccountService_DeleteServiceAccount",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeleteServiceAccountResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Service Account",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified service account.",
"operationId": "ServiceAccountService_GetServiceAccount",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetServiceAccountResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Service Account",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"patch": {
"description": "Updates the specified service account.",
"operationId": "ServiceAccountService_UpdateServiceAccount",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
},
"example": "b24e7ba813654628819586e4c0086ca5"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/update_service_account_request"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdateServiceAccountResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Service Account",
"tags": [
"Service Accounts"
],
"x-severity": 3,
"x-permission": "serviceAccount.update"
}
},
"/v1/serviceAccounts/{ID}/apikey": {
"get": {
"description": "Lists API keys for the specified service account.",
"operationId": "ServiceAccountService_ListAPIKeys",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListAPIKeysResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List API Keys",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"post": {
"description": "Creates an API key for the specified service account.",
"operationId": "ServiceAccountService_CreateAPIKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ServiceAccountResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create API Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
}
},
"/v1/serviceAccounts/{ID}/apikey/{keyID}": {
"delete": {
"description": "Deletes the specified API key.",
"operationId": "ServiceAccountService_DeleteAPIKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the API key.",
"in": "path",
"name": "keyID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeleteAPIKeyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete API Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified API key.",
"operationId": "ServiceAccountService_GetAPIKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the API key.",
"in": "path",
"name": "keyID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1APIKey"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get API Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
}
},
"/v1/serviceAccounts/{ID}/apikey/{keyID}/rotate": {
"put": {
"description": "Rotates the specified API key.",
"operationId": "ServiceAccountService_RotateAPIKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the API key.",
"in": "path",
"name": "keyID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ServiceAccountResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Rotate API Key",
"tags": [
"Service Accounts"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/serviceAccounts/{ID}/keys": {
"get": {
"description": "Lists keys for the specified service account.",
"operationId": "ServiceAccountService_ListServiceAccountKeys",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filters that limits results to those that match the specified key type.\n\n - USER_MANAGED: Keys managed and rotated by the users.\n - SYSTEM_MANAGED: Keys managed and rotated by Skyflow.",
"explode": true,
"in": "query",
"name": "keyTypes",
"schema": {
"items": {
"enum": [
"KEY_TYPE_UNSPECIFIED",
"USER_MANAGED",
"SYSTEM_MANAGED"
],
"type": "string"
},
"type": "array"
},
"style": "form"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListServiceAccountKeysResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Keys",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"post": {
"description": "Creates a key for the specified service account.",
"operationId": "ServiceAccountService_CreateServiceAccountKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ServiceAccountResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
}
},
"/v1/serviceAccounts/{ID}/keys/{KeyID}/rotate": {
"put": {
"description": "Rotates the specified key.",
"operationId": "ServiceAccountService_RotateServiceAccountKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the key linked with the service account.",
"in": "path",
"name": "KeyID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ServiceAccountResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Rotate Key",
"tags": [
"Service Accounts"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/serviceAccounts/{ID}/keys/{keyID}": {
"delete": {
"description": "Deletes the specified key.",
"operationId": "ServiceAccountService_DeleteServiceAccountKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the service account key.",
"in": "path",
"name": "keyID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeleteServiceAccountKeyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified key.",
"operationId": "ServiceAccountService_GetServiceAccountKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the service account key.",
"in": "path",
"name": "keyID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Output format of the public key.",
"in": "query",
"name": "publicKeyType",
"schema": {
"default": "TYPE_NONE",
"enum": [
"TYPE_NONE",
"TYPE_X509_PEM_FILE",
"TYPE_RAW_PUBLIC_KEY"
],
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ServiceAccountKey"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
}
},
"/v1/serviceAccounts/{ID}/signedtokenkey": {
"get": {
"description": "Returns signed token keys for the specified service account.",
"operationId": "ServiceAccountService_ListSignedDataTokenKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListSignedDataTokenKeyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Signed Token Keys",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"post": {
"description": "Creates a signed token key for the specified service account.",
"operationId": "ServiceAccountService_CreateSignedDataTokenKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1SignedDataTokenKeyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Signed Token Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
}
},
"/v1/serviceAccounts/{ID}/signedtokenkey/{KeyID}/rotate": {
"put": {
"description": "Rotates the specified signed token key.",
"operationId": "ServiceAccountService_RotateSignedDataTokenKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the signed token key.",
"in": "path",
"name": "KeyID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1SignedDataTokenKeyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Rotate Signed Token Key",
"tags": [
"Service Accounts"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/serviceAccounts/{ID}/signedtokenkey/{keyID}": {
"delete": {
"description": "Deletes the specified signed token key.",
"operationId": "ServiceAccountService_DeleteSignedDataTokenKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the signed token key.",
"in": "path",
"name": "keyID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeleteSignedDataTokenKeyResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Signed Token Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified signed token key.",
"operationId": "ServiceAccountService_GetSignedDataTokenKey",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the service account.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "ID of the signed token key.",
"in": "path",
"name": "keyID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1SignedDataTokenKey"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Signed Token Key",
"tags": [
"Service Accounts"
],
"x-severity": 3
}
},
"/v1/users": {
"get": {
"description": "Lists users in the account.",
"operationId": "UserService_ListUsers",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
},
{
"description": "ID of the account.",
"in": "query",
"name": "accountID",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified email address.",
"in": "query",
"name": "filterOps.email",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified status.",
"in": "query",
"name": "filterOps.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified name.",
"in": "query",
"name": "filterOps.name",
"schema": {
"type": "string"
}
},
{
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"in": "query",
"name": "sortOps.sortBy",
"schema": {
"type": "string"
}
},
{
"description": "Ascending or descending ordering of results.",
"in": "query",
"name": "sortOps.orderBy",
"schema": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListUsersResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Users",
"tags": [
"Users"
],
"x-severity": 3
},
"post": {
"description": "Creates a user.",
"operationId": "UserService_CreateUser",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateUserRequest"
}
}
},
"description": "User creation request.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateUserResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create User",
"tags": [
"Users"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/users/{ID}": {
"delete": {
"description": "Deletes a user.",
"operationId": "UserService_DeleteUser",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the user.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeleteUserResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete User",
"tags": [
"Users"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified user.",
"operationId": "UserService_GetUser",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the user.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetUserResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get User",
"tags": [
"Users"
],
"x-severity": 3
},
"patch": {
"description": "Updates the specified user.",
"operationId": "UserService_UpdateUser",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the user.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserServiceUpdateUserBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdateUserResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update User",
"tags": [
"Users"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/vault-templates": {
"get": {
"description": "Lists the vault templates available to an account.",
"operationId": "VaultTemplateService_ListVaultTemplates",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the account.",
"in": "query",
"name": "accountID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified name.",
"in": "query",
"name": "filterOps.name",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified status.",
"in": "query",
"name": "filterOps.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"in": "query",
"name": "sortOps.sortBy",
"schema": {
"type": "string"
}
},
{
"description": "Ascending or descending ordering of results.",
"in": "query",
"name": "sortOps.orderBy",
"schema": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": 0,
"format": "int64",
"type": "integer"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": 25,
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListVaultTemplatesResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Vault Templates",
"tags": [
"Vault Templates"
],
"x-severity": 3
}
},
"/v1/vault-templates/{ID}": {
"get": {
"description": "Returns the specified vault template.",
"operationId": "VaultTemplateService_GetVaultTemplate",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the vault template.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetVaultTemplateResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Vault Template",
"tags": [
"Vault Templates"
],
"x-severity": 3
}
},
"/v1/vaults": {
"get": {
"description": "Lists the vaults you can access in a workspace.",
"operationId": "list-vaults",
"parameters": [
{
"name": "filterOps.name",
"in": "query",
"description": "Filter that returns only results that match the specified name.",
"schema": {
"type": "string"
}
},
{
"name": "filterOps.status",
"in": "query",
"description": "Filter that returns only results that match the specified status.",
"schema": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"format": "enum"
}
},
{
"name": "filterOps.type",
"in": "query",
"description": "Filter that returns only results that match the specified vault type.",
"schema": {
"enum": [
"VAULT_TYPE_NONE",
"SCRATCH_TEMPLATE",
"QUICKSTART",
"UI_QUICKSTART",
"CUSTOMER_IDENTITY",
"PAYMENT",
"PII_DATA",
"PLAID",
"PAYMENTS_ACCEPTANCE_SAMPLE"
],
"type": "string",
"format": "enum"
}
},
{
"name": "sortOps.orderBy",
"in": "query",
"description": "Ascending or descending ordering of results.",
"schema": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string",
"format": "enum"
}
},
{
"name": "offset",
"in": "query",
"description": "Record position at which to start receiving results.",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results to return.",
"schema": {
"type": "string"
}
},
{
"name": "fetchMetadataOnly",
"in": "query",
"description": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListObjectVaultsResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Vaults",
"tags": [
"Vaults"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"filterOps.name",
"filterOps.status",
"filterOps.type",
"sortOps.sortyBy",
"sortOps.orderBy",
"offset",
"limit",
"fetchMetadataOnly"
],
"x-required-query-parameters": [
"workspaceID"
],
"x-fern-audiences": [
"external"
]
},
"post": {
"description": "Creates a vault.",
"operationId": "create-vault",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateObjectVaultRequest"
}
}
},
"description": "Vault creation request.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateObjectVaultResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Vault",
"tags": [
"Vaults"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/vaults/{ID}": {
"delete": {
"description": "Deletes the specified vault and everything contained within it.",
"operationId": "delete-vault",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the vault.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteObjectVaultResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Vault",
"tags": [
"Vaults"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"get": {
"description": "Returns the specified vault.",
"operationId": "get-vault",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the vault.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fetchMetadataOnly",
"in": "query",
"description": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetObjectVaultResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Vault",
"tags": [
"Vaults"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"fetchMetadataOnly"
],
"x-fern-audiences": [
"external"
]
},
"patch": {
"description": "Updates the specified vault.",
"operationId": "update-vault",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the vault.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateObjectVaultRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateObjectVaultResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Vault",
"tags": [
"Vaults"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/vaults/{vaultID}/versions": {
"get": {
"description": "Returns a list of schema versions for the specified vault.",
"operationId": "list-vault-schema-versions",
"parameters": [
{
"name": "vaultID",
"in": "path",
"description": "ID of the vault.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListObjectVaultVersionResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Vault Schema Versions",
"tags": [
"Vaults"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/vaults/{vaultID}/versions/{versionTag}": {
"get": {
"description": "Returns the specified vault schema version.",
"operationId": "get-vault-schema-version",
"parameters": [
{
"name": "vaultID",
"in": "path",
"description": "ID of the vault.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionTag",
"in": "path",
"description": "Unique tag of the vault schema version.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetObjectVaultVersionResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Vault Schema Version",
"tags": [
"Vaults"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/workspaces": {
"get": {
"description": "Lists the workspaces in an account.",
"operationId": "WorkspaceService_ListWorkspaces",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the account.",
"in": "query",
"name": "accountID",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified name.",
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified status.",
"in": "query",
"name": "status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to retrieve.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListWorkspacesResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Workspaces",
"tags": [
"Workspaces"
],
"x-severity": 3
},
"post": {
"description": "Creates a workspace for an account.",
"operationId": "WorkspaceService_CreateWorkspace",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateWorkspaceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1CreateWorkspaceResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Workspace",
"tags": [
"Workspaces"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/workspaces/{ID}": {
"delete": {
"description": "Deletes the specified Workspace and the entities it contains.",
"operationId": "WorkspaceService_DeleteWorkspace",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the workspace.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DeleteWorkspaceResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Workspace",
"tags": [
"Workspaces"
],
"x-severity": 3
},
"get": {
"description": "Returns the specified workspace.",
"operationId": "WorkspaceService_GetWorkspace",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the workspace.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1GetWorkspaceResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Workspace",
"tags": [
"Workspaces"
],
"x-severity": 3
},
"patch": {
"description": "Updates the specified Workspace.",
"operationId": "WorkspaceService_UpdateWorkspace",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the workspace.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceServiceUpdateWorkspaceBody"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1UpdateWorkspaceResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Workspace",
"tags": [
"Workspaces"
],
"x-severity": 3,
"x-codegen-request-body-name": "body"
}
},
"/v1/workspaces/{ID}/members": {
"get": {
"description": "Lists members for the specified workspace.",
"operationId": "WorkspaceService_ListMembers",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
},
{
"description": "ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.",
"in": "path",
"name": "ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified email address.",
"in": "query",
"name": "filterOps.email",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified type.",
"in": "query",
"name": "filterOps.type",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"USER",
"GROUP",
"SERVICE_ACCOUNT",
"SQL_SERVICE_ACCOUNT"
],
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified name.",
"in": "query",
"name": "filterOps.name",
"schema": {
"type": "string"
}
},
{
"description": "Filter that limits results to those that match the specified status.",
"in": "query",
"name": "filterOps.status",
"schema": {
"default": "NONE",
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string"
}
},
{
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"in": "query",
"name": "sortOps.sortBy",
"schema": {
"type": "string"
}
},
{
"description": "Ascending or descending ordering of results.",
"in": "query",
"name": "sortOps.orderBy",
"schema": {
"default": "ASCENDING",
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
}
},
{
"description": "Record position at which to start receiving results.",
"in": "query",
"name": "offset",
"schema": {
"default": "0",
"format": "int64",
"type": "string"
}
},
{
"description": "Number of results to return.",
"in": "query",
"name": "limit",
"schema": {
"default": "25",
"format": "int64",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1ListMembersResponse"
}
}
},
"description": "A successful response."
},
"404": {
"content": {
"application/json": {
"schema": {
"format": "object",
"type": "object"
}
}
},
"description": "Returned when the resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Members by Workspace",
"tags": [
"Workspaces"
],
"x-severity": 3
}
},
"/v1/webhooks": {
"get": {
"description": "Gets details for multiple [webhooks](/docs/processing/webhooks/overview).",
"operationId": "list-webhooks",
"parameters": [
{
"name": "filterOps.name",
"in": "query",
"description": "Filter by webhook name.",
"schema": {
"type": "string"
}
},
{
"name": "filterOps.URL",
"in": "query",
"description": "Filter by endpoint URL.",
"schema": {
"type": "string"
}
},
{
"name": "filterOps.eventTypes",
"in": "query",
"description": "Filter by event types.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "sortOps.sortBy",
"in": "query",
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"schema": {
"type": "string"
}
},
{
"name": "sortOps.orderBy",
"in": "query",
"description": "Ascending or descending ordering of results.",
"schema": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string",
"format": "enum"
}
},
{
"name": "offset",
"in": "query",
"description": "Number of webhooks to skip before returning results. Defaults to 0.",
"schema": {
"type": "integer",
"format": "uint32"
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of webhooks to return. Defaults to 25, maximum is 25.",
"schema": {
"type": "integer",
"format": "uint32"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListWebhooksResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "List Webhooks",
"tags": [
"Webhooks"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"filterOps.name",
"filterOps.URL",
"filterOps.eventTypes",
"sortOps.sortBy",
"sortOps.orderBy",
"offset",
"limit"
],
"x-fern-audiences": [
"external"
]
},
"post": {
"description": "Creates a new [webhook](/docs/processing/webhooks/overview) to notify you about events within Skyflow.",
"operationId": "create-webhook",
"parameters": [
{
"$ref": "#/components/parameters/AccountID"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhookResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Create Webhook",
"tags": [
"Webhooks"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/webhooks/{webhookID}": {
"get": {
"description": "Gets the details of a specific [webhook](/docs/processing/webhooks/overview).",
"operationId": "get-webhook",
"parameters": [
{
"name": "webhookID",
"in": "path",
"description": "ID of the webhook to retrieve.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetWebhookResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Get Webhook",
"tags": [
"Webhooks"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"patch": {
"description": "Updates the details of a specific [webhook](/docs/processing/webhooks/overview).\nYou only need to include the fields you want to change in the request body. All other fields remain unchanged.",
"operationId": "update-webhook",
"parameters": [
{
"name": "webhookID",
"in": "path",
"description": "ID of the webhook to update.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWebhookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWebhookResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Update Webhook",
"tags": [
"Webhooks"
],
"x-severity": 3,
"x-codegen-request-body-name": "body",
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"delete": {
"description": "Deletes a specific [webhook](/docs/processing/webhooks/overview).",
"operationId": "delete-webhook",
"parameters": [
{
"name": "webhookID",
"in": "path",
"description": "ID of the webhook to delete.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteWebhookResponse"
}
}
},
"description": "OK",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
},
"description": "An unexpected error response."
}
},
"summary": "Delete Webhook",
"tags": [
"Webhooks"
],
"x-severity": 3,
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/triggers": {
"get": {
"tags": [
"Triggers"
],
"summary": "List Triggers",
"description": "Retrieves a list of [triggers](/docs/processing/triggers/overview).",
"operationId": "list-triggers",
"parameters": [
{
"name": "filterOps.name",
"in": "query",
"description": "Filter by trigger name.",
"schema": {
"type": "string"
}
},
{
"name": "filterOps.eventTypes",
"in": "query",
"description": "Filter by event types.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "sortOps.sortBy",
"in": "query",
"description": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").",
"schema": {
"type": "string"
}
},
{
"name": "sortOps.orderBy",
"in": "query",
"description": "Ascending or descending ordering of results.",
"schema": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string",
"format": "enum"
}
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"format": "uint32"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "uint32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTriggersResponse"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"filterOps.name",
"filterOps.eventTypes",
"sortOps.sortBy",
"sortOps.orderBy",
"offset",
"limit"
],
"x-fern-audiences": [
"external"
]
},
"post": {
"tags": [
"Triggers"
],
"summary": "Create Trigger",
"description": "Creates a new [trigger](/docs/processing/triggers/overview) to automate actions based on input events.",
"operationId": "create-trigger",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTriggerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTriggerResponse"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/triggers/{triggerID}": {
"get": {
"tags": [
"Triggers"
],
"summary": "Get Trigger",
"description": "Retrieves the specified [trigger](/docs/processing/triggers/overview).",
"operationId": "get-trigger",
"parameters": [
{
"name": "triggerID",
"in": "path",
"description": "ID of the trigger.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTriggerResponse"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"delete": {
"tags": [
"Triggers"
],
"summary": "Delete Trigger",
"description": "Deletes the specified [trigger](/docs/processing/triggers/overview).",
"operationId": "delete-trigger",
"parameters": [
{
"name": "triggerID",
"in": "path",
"description": "ID of the trigger.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTriggerResponse"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"patch": {
"tags": [
"Triggers"
],
"summary": "Update Trigger",
"description": "Updates the specified [trigger](/docs/processing/triggers/overview). Only properties included in the request are updated.",
"operationId": "update-trigger",
"parameters": [
{
"name": "triggerID",
"in": "path",
"description": "ID of the trigger.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTriggerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTriggerResponse"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/gateway/{ID}/secret": {
"get": {
"tags": [
"Connections"
],
"summary": "Get Connection Secrets",
"description": "Identifies which secrets are set for a connection. Secret values are redacted. Returns 404 if no secrets are found.",
"operationId": "get_secrets",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the connection.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConnectionSecretResponse"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"post": {
"tags": [
"Connections"
],
"summary": "Update Connection Secrets",
"description": "Update the specified secrets for a connection. Other secrets aren't updated. All properties for a secret must be specified together. For example, to update the `routeSecret`, you must specify both `publicKey` and `privateKey`.",
"operationId": "update_secrets",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the connection.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConnectionSecretRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
},
"delete": {
"tags": [
"Connections"
],
"summary": "Delete Connection Secrets",
"description": "Deletes the specified secrets for a connection. Provide secret keys to delete as field paths in the connection secret object (e.g., \"messageSecrets.encPublicKey\", \"soapAuthSecret\"). See Get Connection Secrets for the connection secret object schema.",
"operationId": "delete-connection-secrets",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "ID of the connection.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteConnectionSecretRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/configurations/getAll/{vault_id}": {
"get": {
"tags": [
"Detect Configurations V1"
],
"summary": "List Detect Configurations",
"description": "Returns all Detect Configurations for the vault.",
"operationId": "list-detect-configs",
"parameters": [
{
"name": "vault_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAllDetectConfigResponse"
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v2/detect/configurations": {
"post": {
"tags": [
"Detect Configurations V2"
],
"summary": "Create Detect Configuration V2",
"description": "Creates a new detect configuration.iss: Issuer of the JWT.key: Unique identifier for the key.aud: Recipient the JWT is intended for.exp: Time the JWT expires.sub: Subject of the JWT.ctx: (Optional) Value for Context-aware authorization.pendingWindowInDays doesn't equal 0. If not specified, the default user for the account receives rotation reminders."
}
},
"description": "Request to rotate a master key.",
"x-visibility": [
"external"
]
},
"RotateMasterKeyResponse": {
"type": "object",
"properties": {
"status": {
"enum": [
"QUEUED",
"DONE"
],
"type": "string",
"description": "Status of the master key rotation.",
"format": "enum"
}
},
"description": "Response for master key rotation.",
"x-visibility": [
"external"
]
},
"S3Bucket": {
"required": [
"name",
"region",
"assumedRoleARN"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the bucket."
},
"region": {
"type": "string",
"description": "Region of the bucket."
},
"assumedRoleARN": {
"type": "string",
"description": "Name of the assumed role to use when accessing the bucket."
}
},
"description": "Type of source or destination system.",
"x-visibility": [
"external"
]
},
"Schema": {
"type": "object",
"properties": {},
"description": "`Schema` is a representation of OpenAPI v2 specification's Schema object.\n\n See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject"
},
"Tag": {
"type": "object",
"properties": {},
"description": "`Tag` is a representation of OpenAPI v2 specification's Tag object.\n\n See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject"
},
"UpdateObjectVaultRequest": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the vault."
},
"name": {
"type": "string",
"description": "Updated name for the vault."
},
"description": {
"type": "string",
"description": "Updated description for the vault."
},
"templateID": {
"type": "string",
"description": "ID of the template used to create the vault. Can't be specified with `vaultSchema`."
},
"vaultSchema": {
"allOf": [
{
"$ref": "#/components/schemas/VaultSchema"
}
],
"description": "Schema to create the vault with. Can't be specified with `templateID`."
}
},
"description": "Vault update request.",
"x-visibility": [
"external"
]
},
"UpdateObjectVaultResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the vault."
}
},
"description": "Vault update response.",
"x-visibility": [
"external"
]
},
"UpdateWebhookRequest": {
"type": "object",
"properties": {
"webhookID": {
"type": "string",
"description": "ID of the webhook to update."
},
"name": {
"type": "string",
"description": "Name of the webhook."
},
"displayName": {
"type": "string",
"description": "Display name of the webhook."
},
"description": {
"type": "string",
"description": "Description of the webhook."
},
"URL": {
"type": "string",
"description": "Endpoint URL that receives HTTP POST requests from Skyflow when subscribed events occur."
},
"eventTypes": {
"type": "array",
"items": {
"enum": [
"deidentifyFile.*",
"deidentifyFile.completed",
"pipelineRun.*",
"pipelineRun.started",
"pipelineRun.completed",
"triggerRun.*",
"triggerRun.completed",
"vaultColumn.*",
"vaultColumn.updated"
]
},
"description": "List of event types in `{object}.{action}`` format that trigger the webhook. Wildcards (`*`) are supported for actions (for example, `pipelineRun.*`, `deidentifyFile.completed`)."
}
},
"description": "Request to update an existing webhook.",
"x-visibility": [
"external"
]
},
"UpdateWebhookResponse": {
"type": "object",
"properties": {
"webhookID": {
"type": "string",
"description": "ID of the updated webhook."
}
},
"description": "Response containing the ID of the updated webhook.",
"x-visibility": [
"external"
]
},
"VaultSchema": {
"required": [
"schemas",
"tags"
],
"type": "object",
"properties": {
"schemas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Schema"
},
"description": "Schema that represents the fields and field options of the vault."
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
},
"description": "Tags applied to the whole vault."
}
},
"description": "Schema definition and settings for a vault.",
"x-visibility": [
"external"
]
},
"Datastore_Source": {
"required": [
"dataFormat",
"fileNameRegexes"
],
"type": "object",
"properties": {
"dataFormat": {
"enum": [
"CSV",
"JSON",
"METRO2",
"AUDIO",
"TEXT",
"ACH",
"FIXED_WIDTH",
"TSV",
"PSV",
"PARQUET"
],
"type": "string",
"description": "Format of the data for input files.FAILED."
},
"parserErrorFileURL": {
"type": "string",
"description": "URL of the file that lists errors encountered from the parse task during the pipeline run."
},
"vaultErrorFileURL": {
"type": "string",
"description": "URL of the file that lists errors encountered from the vault task during the pipeline run."
},
"tokenFileURL": {
"type": "string",
"description": "URL of the file composed of tokens generated during the pipeline run."
},
"deidentifyReportFileURL": {
"type": "string",
"description": "URL of the file that lists errors encountered from the vault task during the pipeline run."
}
},
"description": "Response fields for a specified pipeline run report.",
"x-visibility": [
"external"
]
},
"RelayAuthSecret": {
"type": "object",
"properties": {
"sharedKey": {
"type": "string",
"description": "Shared key used to connect to the inbound base URL."
},
"publicKey": {
"type": "string",
"description": "Public key for MTLS authentication."
},
"privateKey": {
"type": "string",
"description": "Private key for MTLS authentication."
}
},
"description": "Shared key and MTLS secrets for the connection.",
"x-visibility": [
"external"
]
},
"RunPipelineRequest": {
"type": "object",
"properties": {
"fileNameRegexes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Valid regex patterns to identify files in the source datastore to be processed. If provided, this overrides regex patterns supplied at pipeline creation for this run."
},
"exportDirectory": {
"type": "string",
"description": "Directory in destination datastore where exported files will be written. If provided, this overrides the directory supplied at pipeline creation for this run."
}
},
"description": "Request to run a specified pipeline.",
"x-visibility": [
"external"
]
},
"RunPipelineResponse": {
"type": "object",
"properties": {
"runID": {
"type": "string"
}
},
"description": "Response to the Run Pipeline request.",
"x-visibility": [
"external"
]
},
"SoapAuthSecret": {
"type": "object",
"properties": {
"keyStore": {
"type": "string",
"description": "Keystore for the PFX file that contains the private key and public keychain."
},
"binarySecurityToken": {
"type": "string",
"description": "Binary security token."
},
"userName": {
"type": "string",
"description": "Username."
},
"password": {
"type": "string",
"description": "Password."
},
"keyStorePassword": {
"type": "string",
"description": "Password for the keystore file."
}
},
"description": "Secrets for SOAP authentication.",
"x-visibility": [
"external"
]
},
"StopPipelineRunRequest": {
"type": "object",
"properties": {},
"description": "Request to stop a specified pipeline run.",
"x-visibility": [
"external"
]
},
"StopPipelineRunResponse": {
"type": "object",
"properties": {
"runID": {
"type": "string",
"description": "ID of the pipeline run."
}
},
"description": "Response to the Stop Pipeline Run request.",
"x-visibility": [
"external"
]
},
"UpdateConnectionSecretRequest": {
"type": "object",
"properties": {
"routeSecret": {
"$ref": "#/components/schemas/RelayAuthSecret"
},
"authMode": {
"enum": [
"NOAUTH",
"MTLS",
"SHAREDKEY"
],
"type": "string",
"format": "enum"
},
"mleAuthSecret": {
"$ref": "#/components/schemas/MLEAuthSecret"
},
"soapAuthSecret": {
"$ref": "#/components/schemas/SoapAuthSecret"
},
"messageSecrets": {
"$ref": "#/components/schemas/MessageSecrets"
},
"fieldEncryptionSecret": {
"type": "string",
"description": "Secret used in field-level encryption operations."
},
"oAuth1aSecret": {
"allOf": [
{
"$ref": "#/components/schemas/OAuth1aSecret"
}
],
"description": "Secret used for oAuth 1.0a."
}
},
"x-visibility": [
"external"
]
},
"UpdatePipelineRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the pipeline."
},
"displayName": {
"type": "string",
"description": "Display name of the pipeline."
},
"description": {
"type": "string",
"description": "Description of the pipeline."
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/UpdatePipelineRequest_DatastoreUpdate"
}
],
"description": "Updates to the datastore from which unprocessed data is ingested."
},
"destination": {
"allOf": [
{
"$ref": "#/components/schemas/UpdatePipelineRequest_DatastoreUpdate"
}
],
"description": "Updates to the datastore to which processed data is sent."
},
"runTriggers": {
"type": "array",
"items": {
"enum": [
"ON_DEMAND"
],
"type": "string",
"format": "enum"
},
"description": "Trigger mechanisms supported by the pipeline."
},
"reportOptions": {
"allOf": [
{
"$ref": "#/components/schemas/ReportOptions"
}
],
"description": "Optional configurations for reports generated by the pipeline."
}
},
"description": "Request to update a pipeline.",
"x-visibility": [
"external"
]
},
"UpdatePipelineRequest_DatastoreUpdate": {
"type": "object",
"properties": {
"encryptionKeyID": {
"type": "string",
"description": "ID of the encryption key."
},
"ftpServer": {
"allOf": [
{
"$ref": "#/components/schemas/UpdatePipelineRequest_FTPServerUpdate"
}
],
"description": "FTP server details."
}
},
"description": "Update to the datastore from which data is ingested or to which data is sent.",
"x-visibility": [
"external"
]
},
"UpdatePipelineRequest_FTPServerUpdate": {
"type": "object",
"properties": {
"plainText": {
"allOf": [
{
"$ref": "#/components/schemas/UpdatePipelineRequest_PlainTextCredentialsUpdate"
}
],
"description": "Plain text credentials."
}
},
"description": "FTP server details.",
"x-visibility": [
"external"
]
},
"UpdatePipelineRequest_PlainTextCredentialsUpdate": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "Username to access the server."
},
"password": {
"type": "string",
"description": "Password to access the server."
},
"sshKeyID": {
"type": "string",
"description": "ID of the SSH key."
}
},
"description": "Plain text credentials to update.",
"x-visibility": [
"external"
]
},
"UpdatePipelineResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the updated pipeline."
}
},
"description": "Response to the Update Pipeline request.",
"x-visibility": [
"external"
]
},
"ClientConfiguration": {
"type": "object",
"properties": {
"enforceContextID": {
"type": "boolean",
"description": "When `true`, all JWT assertions for this service account must contain a `ctx` claim."
},
"enforceSignedDataTokens": {
"type": "boolean",
"description": "When `true`, all data tokens sent to the vault using this service account must be signed with the associated private key."
}
},
"description": "Client-side configuration for a service account.",
"x-visibility": [
"external"
]
},
"CreateFunctionDeploymentRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the deployment."
},
"description": {
"type": "string",
"description": "Description of the deployment."
},
"functionID": {
"type": "string",
"description": "ID of the function to deploy."
},
"versionTag": {
"type": "string",
"description": "Version of the function to deploy."
},
"functionEnvironmentID": {
"type": "string",
"description": "ID of the environment to deploy the function in."
},
"regionID": {
"type": "string",
"description": "ID of the region to deploy the function in."
}
},
"x-visibility": [
"external"
]
},
"CreateFunctionDeploymentResponse": {
"type": "object",
"properties": {
"functionDeploymentID": {
"type": "string",
"description": "ID of the deployment."
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"default": "NONE",
"description": "Status of the resource.",
"format": "enum"
}
},
"x-visibility": [
"external"
]
},
"CreateFunctionEnvironmentRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the environment."
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
},
"description": "Variables defined in the environment."
},
"description": {
"type": "string",
"description": "Description of the environment."
},
"isDefault": {
"type": "boolean",
"description": "If true, sets the environment as the default for the account."
}
},
"x-visibility": [
"external"
]
},
"CreateFunctionEnvironmentResponse": {
"type": "object",
"properties": {
"functionEnvironmentID": {
"type": "string",
"description": "ID of the function as which you want to create the environment."
},
"functionEnvironmentName": {
"type": "string",
"description": "Name of the environment."
},
"functionEnvironmentDescription": {
"type": "string",
"description": "Description of the environment."
},
"isDefault": {
"type": "boolean",
"description": "If true, sets the environment as the default for the account."
}
},
"x-visibility": [
"external"
]
},
"CreateFunctionRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the function."
},
"description": {
"type": "string",
"description": "Description of the function."
},
"code": {
"type": "string",
"description": "Function code snippet as string."
},
"functionConfigs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandlerConfig"
},
"description": "Function handler configuration details."
},
"functionDeployment": {
"allOf": [
{
"$ref": "#/components/schemas/FunctionDeploymentConfig"
}
],
"description": "Function deployment parameters. Only needed to immediately deploy a function after creation."
},
"language": {
"allOf": [
{
"$ref": "#/components/schemas/FunctionLanguage"
}
],
"description": "Programming language the code is written in."
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Required libraries for the function."
}
},
"x-visibility": [
"external"
]
},
"CreateFunctionResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the function."
},
"name": {
"type": "string",
"description": "Name of the function."
},
"versionTag": {
"type": "string",
"description": "Version of the function."
},
"deploymentID": {
"type": "string",
"description": "ID of the function deployment."
}
},
"x-visibility": [
"external"
]
},
"DeleteFunctionDeploymentResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the deleted function deployment."
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"default": "NONE",
"description": "Status of the resource.",
"format": "enum"
}
},
"x-visibility": [
"external"
]
},
"DeleteFunctionEnvironmentResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the environment."
}
},
"x-visibility": [
"external"
]
},
"DeleteFunctionEnvironmentVariableRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the variable."
}
},
"x-visibility": [
"external"
]
},
"DeleteFunctionEnvironmentVariableResponse": {
"type": "object",
"properties": {
"functionEnvironmentID": {
"type": "string",
"description": "ID of the deleted function environment."
},
"functionEnvironmentName": {
"type": "string",
"description": "Name of the environment."
},
"functionEnvironmentDescription": {
"type": "string",
"description": "Description of the environment."
},
"isDefault": {
"type": "boolean",
"description": "If true, sets the environment as the default for the account."
}
},
"x-visibility": [
"external"
]
},
"DeleteFunctionResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the deleted function."
}
},
"x-visibility": [
"external"
]
},
"Dependency": {
"type": "object",
"properties": {
"language": {
"allOf": [
{
"$ref": "#/components/schemas/FunctionLanguage"
}
],
"description": "Programming language the code is written in."
},
"whitelistedDependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Required libraries for the function."
}
},
"description": "A language-specific set of allowlisted dependencies.",
"x-visibility": [
"external"
]
},
"EnvironmentVariable": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the variable."
},
"value": {
"type": "string",
"description": "Value of the variable."
},
"type": {
"enum": [
"NONE",
"PLAIN_TEXT",
"SECRET"
],
"type": "string",
"default": "NONE",
"description": "Type of the variable.",
"format": "enum"
}
},
"description": "Environment variable details.",
"x-visibility": [
"external"
]
},
"FunctionDeploymentConfig": {
"type": "object",
"properties": {
"deploy": {
"type": "boolean",
"description": "If true, the function creates a deploymentID."
},
"functionEnvironmentID": {
"type": "string",
"description": "ID of the function environment to deploy the function in."
},
"regionID": {
"type": "string",
"description": "ID of the region to deploy the function in."
},
"functionDeploymentName": {
"type": "string",
"description": "Name of function deployment."
},
"functionDeploymentDescription": {
"type": "string",
"description": "Description of function deployment."
}
},
"description": "Function deployment parameters. Only needed to immediately deploy a function after creation.",
"x-visibility": [
"external"
]
},
"FunctionLanguage": {
"type": "object",
"properties": {
"languageName": {
"enum": [
"LANGUAGE_NOT_DEFINED",
"NODEJS"
],
"type": "string",
"default": "LANGUAGE_NOT_DEFINED",
"description": "Programming languages.",
"format": "enum"
},
"languageVersion": {
"type": "string",
"description": "Version of the language."
}
},
"description": "Programming language used by a function.",
"x-visibility": [
"external"
]
},
"FunctionTagsResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the function tag."
},
"functionID": {
"type": "string",
"description": "ID of the function."
},
"versionTag": {
"type": "string",
"description": "Version of the function."
},
"downloadInfo": {
"$ref": "#/components/schemas/TagDownloadInfo"
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"description": "Status of the tag.",
"format": "enum"
},
"handlerConfigs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandlerConfig"
},
"description": "Handler configuration details."
},
"BasicAudit": {
"$ref": "#/components/schemas/BasicAudit"
},
"language": {
"$ref": "#/components/schemas/FunctionLanguage"
},
"isZipped": {
"type": "boolean",
"description": "If true, the function code is sent in a zipped file."
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Required libraries for the function."
},
"errorMessage": {
"type": "string",
"description": "Error message returned if the function tag is in a FAILED state."
},
"functionName": {
"type": "string",
"description": "Name of the function."
}
},
"x-visibility": [
"external"
]
},
"GetFunctionConfigResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the resource."
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dependency"
},
"description": "Required libraries for the function."
},
"BasicAudit": {
"allOf": [
{
"$ref": "#/components/schemas/BasicAudit"
}
],
"description": "Audit details of the resource creation."
},
"whitelistedConnectionBaseURLs": {
"type": "array",
"items": {
"type": "string"
},
"description": "WhiteListed base URLs for connection."
}
},
"x-visibility": [
"external"
]
},
"GetFunctionDeploymentLogsResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the function deployment."
},
"logs": {
"type": "string",
"description": "Function deployment logs."
}
},
"x-visibility": [
"external"
]
},
"GetFunctionDeploymentResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the deployment."
},
"name": {
"type": "string",
"description": "Name of the deployment."
},
"functionID": {
"type": "string",
"description": "ID of the function."
},
"versionTag": {
"type": "string",
"description": "Version of the function."
},
"functionEnvironmentID": {
"type": "string",
"description": "ID of the environment to deploy the function in."
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"default": "NONE",
"description": "Status of the resource.",
"format": "enum"
},
"methodNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of all function methods in the deployment."
},
"BasicAudit": {
"$ref": "#/components/schemas/BasicAudit"
},
"errorMessage": {
"type": "string",
"description": "Error message returned if the function deployment is in a FAILED state."
},
"regionID": {
"type": "string",
"description": "ID of the region to deploy the function in."
},
"functionEnvironmentName": {
"type": "string",
"description": "Name of the function environment."
},
"description": {
"type": "string",
"description": "Description of the deployment."
}
},
"x-visibility": [
"external"
]
},
"GetFunctionEnvironmentResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the environment."
},
"name": {
"type": "string",
"description": "Name of the environment."
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
},
"description": "Variables defined in the environment."
},
"description": {
"type": "string",
"description": "Description of the environment."
},
"isDefault": {
"type": "boolean",
"description": "If true, sets the environment as the default for the account."
},
"BasicAudit": {
"$ref": "#/components/schemas/BasicAudit"
}
},
"x-visibility": [
"external"
]
},
"GetFunctionResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the function."
},
"name": {
"type": "string",
"description": "Name of the function."
},
"description": {
"type": "string",
"description": "Description of the function."
},
"BasicAudit": {
"$ref": "#/components/schemas/BasicAudit"
}
},
"x-visibility": [
"external"
]
},
"GetFunctionTagResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the function tag."
},
"functionID": {
"type": "string",
"description": "ID of the function."
},
"versionTag": {
"type": "string",
"description": "Version of the function."
},
"downloadInfo": {
"$ref": "#/components/schemas/TagDownloadInfo"
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"description": "Status of the tag.",
"format": "enum"
},
"handlerConfigs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandlerConfig"
},
"description": "Handler configuration details."
},
"BasicAudit": {
"$ref": "#/components/schemas/BasicAudit"
},
"language": {
"$ref": "#/components/schemas/FunctionLanguage"
},
"isZipped": {
"type": "boolean",
"description": "If true, the function code is sent in a zipped file."
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Required libraries for the function."
},
"errorMessage": {
"type": "string",
"description": "Error message returned if the function tag is in a FAILED state."
}
},
"x-visibility": [
"external"
]
},
"HandlerConfig": {
"type": "object",
"properties": {
"handlerName": {
"type": "string",
"description": "Name of the function handler."
},
"methodName": {
"type": "string",
"description": "Name of the method present in the code that the handler corresponds to."
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
},
"description": "Environment variables used by the function handler."
},
"resourceConfig": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceConfig"
}
],
"description": "Resource configuration details."
},
"numberOfWarmInstances": {
"type": "integer",
"description": "Number of warm instances for the function handler.",
"format": "int64"
}
},
"description": "Function handler details.",
"x-visibility": [
"external"
]
},
"ListAllFunctionTagsResponse": {
"type": "object",
"properties": {
"functionTag": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FunctionTagsResponse"
},
"description": "List all tags for all accounts."
}
},
"x-visibility": [
"external"
]
},
"ListFunctionDeploymentResponse": {
"type": "object",
"properties": {
"functionDeployments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetFunctionDeploymentResponse"
},
"description": "List of function deployments."
}
},
"x-visibility": [
"external"
]
},
"ListFunctionEnvironmentResponse": {
"type": "object",
"properties": {
"functionEnvironments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetFunctionEnvironmentResponse"
},
"description": "List all function environments in the account."
}
},
"x-visibility": [
"external"
]
},
"ListFunctionResponse": {
"type": "object",
"properties": {
"functions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetFunctionResponse"
},
"description": "List all functions in the account."
}
},
"x-visibility": [
"external"
]
},
"ListFunctionTagsResponse": {
"type": "object",
"properties": {
"functionID": {
"type": "string",
"description": "ID of the function."
},
"functionName": {
"type": "string",
"description": "Name of the function."
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagDetail"
},
"description": "List all tags of the specified function."
}
},
"x-visibility": [
"external"
]
},
"ResourceConfig": {
"type": "object",
"properties": {
"timeout": {
"type": "integer",
"description": "Timeout for the function handler.",
"format": "int64"
},
"memory": {
"type": "integer",
"description": "Memory limit for the function handler in MBs.",
"format": "int64"
}
},
"description": "Resource configuration details.",
"x-visibility": [
"external"
]
},
"ServiceAccount": {
"type": "object",
"properties": {
"BasicAudit": {
"$ref": "#/components/schemas/BasicAudit"
}
},
"description": "Service account details."
},
"ServiceAccountInfo": {
"type": "object",
"properties": {
"serviceAccount": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceAccount"
}
],
"description": "The service account details."
},
"clientConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ClientConfiguration"
}
],
"description": "Client-side configuration for the service account."
}
},
"description": "Information about a service account, including its configuration.",
"x-visibility": [
"external"
]
},
"TagDetail": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the tag."
},
"versionTag": {
"type": "string",
"description": "Version of the function."
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"format": "enum"
},
"BasicAudit": {
"$ref": "#/components/schemas/BasicAudit"
},
"language": {
"$ref": "#/components/schemas/FunctionLanguage"
},
"isZipped": {
"type": "boolean",
"description": "If true, the function code is sent in a zipped file."
},
"errorMessage": {
"type": "string",
"description": "Error message returned if the function tag is in a FAILED state."
}
},
"x-visibility": [
"external"
]
},
"TagDownloadInfo": {
"type": "object",
"properties": {
"codeURL": {
"type": "string",
"description": "If true, includes a downloadURL in the response."
},
"expiryTime": {
"type": "string",
"description": "Expiry timestamp for the codeURL."
}
},
"description": "Download information for a function tag's code artifact.",
"x-visibility": [
"external"
]
},
"UpdateFunctionDeploymentRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the deployment."
},
"description": {
"type": "string",
"description": "Description of the deployment."
},
"functionID": {
"type": "string",
"description": "ID of the function."
},
"versionTag": {
"type": "string",
"description": "Version of the function."
},
"functionEnvironmentID": {
"type": "string",
"description": "ID of the environment to deploy the function in."
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionDeploymentResponse": {
"type": "object",
"properties": {
"functionDeploymentID": {
"type": "string",
"description": "ID of the function deployment."
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"default": "NONE",
"description": "Status of the resource.",
"format": "enum"
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionEnvironmentRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the environment."
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentVariable"
},
"description": "Variables defined in the environment."
},
"description": {
"type": "string",
"description": "Description of the environment."
},
"isDefault": {
"type": "boolean",
"description": "If true, sets the environment as the default for the account."
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionEnvironmentResponse": {
"type": "object",
"properties": {
"functionEnvironmentID": {
"type": "string",
"description": "ID of the environment."
},
"functionEnvironmentName": {
"type": "string",
"description": "Name of the environment."
},
"functionEnvironmentDescription": {
"type": "string",
"description": "Description of the environment."
},
"isDefault": {
"type": "boolean",
"description": "If true, sets the environment as the default for the account."
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionEnvironmentVariableRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the variable."
},
"value": {
"type": "string",
"description": "Value of the variable."
},
"type": {
"enum": [
"NONE",
"PLAIN_TEXT",
"SECRET"
],
"type": "string",
"default": "NONE",
"description": "Type of the variable.",
"format": "enum"
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionEnvironmentVariableResponse": {
"type": "object",
"properties": {
"functionEnvironmentID": {
"type": "string",
"description": "ID of the environment."
},
"functionEnvironmentName": {
"type": "string",
"description": "Name of the environment."
},
"functionEnvironmentDescription": {
"type": "string",
"description": "Description of the environment."
},
"isDefault": {
"type": "boolean",
"description": "If true, sets the environment as the default for the account."
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the function."
},
"description": {
"type": "string",
"description": "Description of the function."
},
"code": {
"type": "string",
"description": "Function code snippet as string."
},
"functionConfigs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandlerConfig"
},
"description": "Function handler configuration details."
},
"functionDeployment": {
"$ref": "#/components/schemas/FunctionDeploymentConfig"
},
"language": {
"$ref": "#/components/schemas/FunctionLanguage"
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Required libraries for the function."
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the function."
},
"name": {
"type": "string",
"description": "Name of the function."
},
"versionTag": {
"type": "string",
"description": "Version of the function."
},
"deploymentID": {
"type": "string",
"description": "ID of the function deployment."
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionTagRequest": {
"required": [
"ID"
],
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the function tag."
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"description": "Status of the specified tag.",
"format": "enum"
},
"message": {
"type": "string",
"description": "Function tag message to include in the request."
}
},
"x-visibility": [
"external"
]
},
"UpdateFunctionTagResponse": {
"required": [
"ID"
],
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "ID of the tag."
},
"status": {
"enum": [
"NONE",
"CREATED",
"PENDING",
"ACTIVE",
"INACTIVE",
"ARCHIVED",
"DELETED"
],
"type": "string",
"description": "Status of the tag.",
"format": "enum"
}
},
"x-visibility": [
"external"
]
},
"Audio": {
"type": "object",
"properties": {
"output_processed_audio": {
"type": "boolean",
"description": "If true, includes processed audio file in the response."
},
"bleep_start_padding": {
"type": "number",
"description": "Padding added to the beginning of a bleep, in seconds.",
"format": "float",
"maximum": 20,
"default": 0.5
},
"bleep_stop_padding": {
"type": "number",
"description": "Padding added to the end of a bleep, in seconds.",
"format": "float",
"maximum": 20,
"default": 0.2
},
"bleep_frequency": {
"type": "integer",
"description": "Frequency of the sine wave used for the bleep sound in an audio segment.",
"format": "int32",
"maximum": 20000,
"minimum": 20,
"default": 600
},
"bleep_gain": {
"type": "integer",
"description": "Controls the relative loudness of the bleep. Positive values increase loudness; negative values decrease it.",
"format": "int32",
"minimum": -60,
"default": -3
},
"output_transcription": {
"enum": [
"transcription",
"medical_transcription",
"diarized_transcription",
"medical_diarized_transcription"
],
"type": "string",
"description": "Type of transcription output to include in the response.",
"format": "enum"
}
},
"description": "Advanced audio options to apply.",
"x-visibility": [
"external"
]
},
"CreateDetectConfigResponse": {
"type": "object",
"properties": {
"configuration_id": {
"type": "string"
}
}
},
"DeleteDetectConfigResponse": {
"type": "object",
"properties": {}
},
"DetectConfig": {
"required": [
"vault_id"
],
"type": "object",
"properties": {
"ID": {
"readOnly": true,
"type": "string",
"description": "ID of the configuration."
},
"name": {
"type": "string",
"description": "Name of the configuration."
},
"namespace": {
"readOnly": true,
"type": "string",
"description": "Namespace of the configuration."
},
"description": {
"type": "string",
"description": "Description of the configuration."
},
"BasicAudit": {
"$ref": "#/components/schemas/BasicAudit"
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum"
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping"
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Expressions do not match across entity boundaries."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to always redact. Matching strings are replaced with 'RESTRICTED'. Note: Vault tokens are currently not supported."
},
"columns_mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityToColumnsMapping"
},
"description": "Column mappings for different entities."
},
"audio": {
"$ref": "#/components/schemas/Audio"
},
"vault_id": {
"type": "string",
"description": "ID of the vault."
},
"document": {
"$ref": "#/components/schemas/Document"
},
"image": {
"$ref": "#/components/schemas/Image"
},
"vault_file_mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VaultFileMapping"
},
"description": "Mappings for source and de-identified vault file locations."
},
"skip_entities": {
"type": "boolean",
"description": "If true, excludes entity list in the output."
},
"skip_object_entity_types": {
"type": "array",
"items": {
"enum": [
"all",
"face",
"license_plate",
"logo",
"signature"
],
"type": "string",
"format": "enum"
},
"description": "Object entity selectors to disable specific entity types."
}
},
"description": "Configuration for detecting and de-identifying entities.",
"x-visibility": [
"external"
]
},
"Document": {
"type": "object",
"properties": {
"pdf": {
"$ref": "#/components/schemas/PdfOptions"
}
},
"description": "Advanced document options to apply.",
"x-visibility": [
"external"
]
},
"EntityToColumnsMapping": {
"type": "object",
"properties": {
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum"
},
"description": "Entities to detect and de-identify."
},
"table_name": {
"type": "string",
"description": "Table name where the entity is stored."
},
"column_name": {
"type": "string",
"description": "Column name where the entity is stored."
}
},
"x-visibility": [
"external"
]
},
"GetAllDetectConfigResponse": {
"type": "object",
"properties": {
"configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DetectConfig"
},
"description": "List of detect configurations."
}
}
},
"GetDetectConfigResponse": {
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/DetectConfig"
}
}
},
"Image": {
"type": "object",
"properties": {
"output_processed_image": {
"type": "boolean",
"description": "If true, includes processed image in the output."
},
"output_ocr_text": {
"type": "boolean",
"description": "If true, includes text detected by OCR in the response."
},
"masking_method": {
"enum": [
"none",
"blur",
"blackbox"
],
"type": "string",
"description": "Method to mask detected entities in the image.",
"format": "enum"
}
},
"description": "Advanced image options to apply.",
"x-visibility": [
"external"
]
},
"PdfOptions": {
"type": "object",
"properties": {
"density": {
"type": "integer",
"description": "DPI of the PDF file.",
"format": "int32",
"maximum": 1000,
"default": 200
},
"max_resolution": {
"type": "integer",
"description": "Maximum resolution of the PDF file.",
"format": "int32",
"maximum": 3000,
"minimum": 72,
"default": 3000
}
},
"description": "Options for PDF de-identification.",
"x-visibility": [
"external"
]
},
"ShiftDates": {
"type": "object",
"properties": {
"min_days": {
"type": "integer",
"description": "Minimum number of days to shift the date by.",
"format": "int32"
},
"max_days": {
"type": "integer",
"description": "Maximum number of days to shift the date by.",
"format": "int32"
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"date",
"date_interval",
"dob"
],
"type": "string",
"format": "enum",
"maxLength": 3
},
"description": "Entity types to shift dates for."
}
},
"description": "Shift dates by a specified number of days.",
"x-visibility": [
"external"
]
},
"TokenTypeMapping": {
"type": "object",
"properties": {
"vault_token": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with vault tokens."
},
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only",
"vault_token"
],
"type": "string",
"description": "Default token type to generate for detected entities.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"Transformations": {
"type": "object",
"properties": {
"shift_dates": {
"$ref": "#/components/schemas/ShiftDates"
}
},
"description": "Transformations to apply to detected entities.",
"x-visibility": [
"external"
]
},
"UpdateDetectConfigResponse": {
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/DetectConfig"
}
}
},
"VaultFileMapping": {
"type": "object",
"properties": {
"source_file_location": {
"$ref": "#/components/schemas/VaultFileTableColumn"
},
"deidentified_file_location": {
"$ref": "#/components/schemas/VaultFileTableColumn"
}
},
"description": "Mapping from source to deidentified vault file locations",
"x-visibility": [
"external"
]
},
"VaultFileTableColumn": {
"type": "object",
"properties": {
"table_name": {
"type": "string",
"description": "Table name."
},
"column_name": {
"type": "string",
"description": "Column name."
}
},
"description": "Column location descriptor for vault file mappings",
"x-visibility": [
"external"
]
},
"AudioV2": {
"type": "object",
"properties": {
"outputProcessedAudio": {
"type": "boolean",
"default": true,
"description": "If `true`, includes processed audio file in the response."
},
"outputTranscription": {
"enum": [
"NONE",
"TRANSCRIPTION",
"MEDICAL_TRANSCRIPTION",
"DIARIZED_TRANSCRIPTION",
"MEDICAL_DIARIZED_TRANSCRIPTION"
],
"type": "string",
"default": "NONE",
"description": "Transcription type to include in the response.",
"format": "enum"
},
"bleep": {
"$ref": "#/components/schemas/AudioV2_Bleep"
}
},
"description": "Audio detection and deidentification configuration.",
"x-visibility": [
"external"
]
},
"AudioV2_Bleep": {
"type": "object",
"properties": {
"startPadding": {
"maximum": 20,
"type": "number",
"default": 0.5,
"description": "Padding added to the beginning of a bleep, in seconds. Range: 0–20. Defaults to 0.5.",
"format": "float"
},
"stopPadding": {
"maximum": 20,
"type": "number",
"default": 0.2,
"description": "Padding added to the end of a bleep, in seconds. Range: 0–20. Defaults to 0.2.",
"format": "float"
},
"frequency": {
"maximum": 20000,
"minimum": 20,
"type": "integer",
"default": 600,
"description": "Frequency of the sine wave used for the bleep sound, in Hz.",
"format": "int32"
},
"gain": {
"minimum": -60,
"type": "integer",
"default": -3,
"description": "Relative loudness of the bleep. Positive values increase loudness and negative values decrease it.",
"format": "int32"
}
},
"description": "Configuration for the bleep sound used to mask detected entities in audio.",
"x-visibility": [
"external"
]
},
"CreateDetectConfigResponseV2": {
"type": "object",
"properties": {
"configurationId": {
"type": "string",
"description": "Detect Configuration ID."
}
},
"description": "Response containing the ID of the newly created v2 detect configuration."
},
"DeleteDetectConfigResponseV2": {
"type": "object",
"properties": {
"configurationId": {
"type": "string",
"description": "Detect Configuration ID."
}
},
"description": "Empty response for a successful delete operation."
},
"Detect": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Detect_Entity"
},
"description": "Entities and their deidentification settings."
},
"objectEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Detect_ObjectEntity"
},
"description": "Object entities and their deidentification settings."
},
"restrict": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `skip` and `restrict`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict` pattern only matches a substring of it, the `restrict` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"skip": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `skip` and `restrict`, the entity is displayed in plaintext."
},
"customTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Detect_CustomTypes"
},
"description": "Custom entity type definitions."
},
"returnEntities": {
"enum": [
"EXCLUDE_SENSITIVE_DATA",
"ALL",
"NONE"
],
"type": "string",
"default": "EXCLUDE_SENSITIVE_DATA",
"description": "Controls which entities are returned in the response.",
"format": "enum"
}
},
"description": "Entity detection and deidentification settings.",
"x-visibility": [
"external"
]
},
"DetectConfigV2": {
"required": [
"vaultId"
],
"type": "object",
"properties": {
"ID": {
"readOnly": true,
"type": "string",
"description": "ID of the configuration."
},
"name": {
"type": "string",
"description": "Name of the configuration."
},
"namespace": {
"readOnly": true,
"type": "string",
"description": "Namespace of the configuration."
},
"description": {
"type": "string",
"description": "Description of the configuration."
},
"vaultId": {
"type": "string",
"description": "ID of the vault."
},
"vaultType": {
"readOnly": true,
"enum": [
"NONE",
"PRIVACYDB",
"FLOWDB",
"FLOWDB_SCHEMALESS"
],
"type": "string",
"description": "Type of the vault.",
"format": "enum"
},
"detect": {
"$ref": "#/components/schemas/Detect"
},
"fileMapping": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileMapping"
},
"description": "Mappings for source and deidentified file locations."
},
"media": {
"$ref": "#/components/schemas/Media"
}
},
"description": "Configuration for detecting and deidentifying entities in a vault.",
"x-visibility": [
"external"
]
},
"Detect_CustomTypes": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label of the custom type. Note: Vault tokens are currently not supported."
},
"match": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[