Introduction

https://adminv2.api.formalcloud.net/

import os
import formal_sdk
from formal_sdk.gen.admin.v1.integration_slack_pb2 import CreateSlackIntegrationRequest

api_key = os.environ.get('API_KEY') 
formal_client = formal_sdk.Client(api_key) # Formal base client

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey") // Formal base client
}

Welcome to the Formal API! You can use our API to access Formal API endpoints

You can choose the language as Shell, Python or Go! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Formal client libraries

Python: Python-SDK
Go: Go-SDK

Authentication

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/GetDatastores' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--data-raw '{"limit": 10}' \
--compressed

import os
import formal_sdk
from formal_sdk.gen.admin.v1.integration_slack_pb2 import CreateSlackIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")
}

The Formal API uses API keys to authenticate requests. You can view and manage your API keys in the Formal Dashboard.

Keep your API keys secure! Do not share your secret API keys in publicly accessible areas like GitHub, Google Drive, and so forth.

To authenticate use -H x-api-key: {your_api_key} in your curl command

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Errors

In general: Codes in the 2xx range indicate success. Code in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate error with Formal's servers.

HTTP

Formal API HTTP error codes:

Code	HTTP Status	Meaning
invalid_argument	400 Bad Request	Request is invalid, regardless of system state.
out_of_range	400 Bad Request	The operation was attempted past the valid range.
unauthenticated	401 Unauthorized	Caller doesn't have valid authentication credentials for the operation.
permission_denied	403 Forbidden	Caller isn't authorized to perform the operation.
not_found	404 Not Found	User requested a resource (for example, a file or directory) that can't be found.
unimplemented	404 Not Found	The operation isn't implemented, supported, or enabled.
canceled	408 Request Tiemout	RPC canceled, usually by the caller.
deadline_exceeded	408 Request Timeout	Deadline expired before RPC could complete or before the client received the response.
already_exists	409 Conflict	Caller attempted to create a resource that already exists.
aborted	409 Conflict	The operation was aborted, often because of concurrency issues like a database transaction abort.
failed_precondition	412 Precondition Failed	Operation can't be completed because the system isn't in the required state.
resource_exhausted	429 Too Many Requests	Operation can't be completed because some resource is exhausted. Use unavailable if the server is temporarily overloaded and the caller should retry later.
internal	500 Internal Server Error	An invariant expected by the underlying system has been broken. Reserved for serious errors.
unknown	500 Internal Server Error	Catch-all for errors of unclear origin and errors without a more appropriate code.
data_loss	500 Internal Server Error	Unrecoverable data loss or corruption.
unavailable	503 Service Unavailable	The service is currently unavailable, usually transiently. Clients should back off and retry idempotent operations.

Reference: Error Codes

Python-SDK

Formal python-sdk gRPC error codes:

Code	Number	Description
OK	0	Not an error; returned on success.
CANCELLED	1	The operation was cancelled, typically by the caller.
UNKNOWN	2	Unknown error. For example, this error may be returned when a Status value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error.
INVALID_ARGUMENT	3	The client specified an invalid argument. Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name).
DEADLINE_EXCEEDED	4	The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long
NOT_FOUND	5	Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, NOT_FOUND may be used. If a request is denied for some users within a class of users, such as user-based access control, PERMISSION_DENIED must be used.
ALREADY_EXISTS	6	The entity that a client attempted to create (e.g., file or directory) already exists.
PERMISSION_DENIED	7	The caller does not have permission to execute the specified operation. PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead for those errors). PERMISSION_DENIED must not be used if the caller can not be identified (use UNAUTHENTICATED instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions.
RESOURCE_EXHAUSTED	8	Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
FAILED_PRECONDITION	9	The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: (a) Use UNAVAILABLE if the client can retry just the failing call. (b) Use ABORTED if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use FAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, FAILED_PRECONDITION should be returned since the client should not retry unless the files are deleted from the directory.
ABORTED	10	The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
OUT_OF_RANGE	11	The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate INVALID_ARGUMENT if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OUT_OF_RANGE if asked to read from an offset past the current file size. There is a fair bit of overlap between FAILED_PRECONDITION and OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OUT_OF_RANGE error to detect when they are done.
UNIMPLEMENTED	12	The operation is not implemented or is not supported/enabled in this service.
INTERNAL	13	Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors.
UNAVAILABLE	14	The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations.
DATA_LOSS	15	Unrecoverable data loss or corruption.
UNAUTHENTICATED	16	The request does not have valid authentication credentials for the operation.

Reference: Error Codes

Pagination

Current implementation

{
    "lastEvaluatedKey": "42c25a04-a293-4ca7-97e2-10f3b4c3d0d2#ho",
    "hasMore": true,
    "datastores": [
        {}
    ]
}

GetDatastoresResponse(
    last_evaluated_key: <string>,
    has_more: <bool>,
    datastores: <Datastore[]>
)

GetDatastoresResponse(
    LastEvaluatedKey: <string>,
    HasMore: <bool>,
    Datastores: <Datastore[]>
)

Parameters:

limit: a limit on the number of objects to be returned, between 1 and 100
cursor: a string of specific item id in the dataset as a starting point
goBack: a boolean to indicate the set of the result, true means get items before the cursor.

Response format:

hasMore: a boolean whether or not there are more elements available after this set. If false, this set comprises end of the list
lastEvaluatedKey: a string of last item to be used as cursor for next set of items

Future Updates

Parameters:

{
    "object": "list",
    "url": "/admin.v1.DevService/",
    "has_more": true,
    "data": [
        {}
    ]
}

GetDatastoresResponse(
    object = "list",
    url ="/admin.v1.DevService/",
    has_more = True,
    data = []
)

GetDatastoresResponse(
    Object : "list",
    Url : "/admin.v1.DevService/",
    HasMore : true,
    Data : []
)

limit optional, default is 10

A limit on the number of objects to be returned, between 1 and 100.
starting_after optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
ending_before optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

Response Format

object string, value is "list"

A string describing the object type returned.
data array

An array containing the actual response elements, paginated by any request parameters.
has_more boolean

Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
url string

The URL for accessing this list.

Dev Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.DevService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).DevClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.DevServiceClient
}

GetApiKeys

curl 'https://adminv2.api.formalcloud.net/admin.v1.DevService/GetApiKeys' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.admin_pb2 import GetApiKeysRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DevClient.GetApiKeys(
    GetApiKeysRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DevServiceClient.GetApiKeys(context.Background(), connect.NewRequest(
        &adminv1.GetApiKeysRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>},
    ))
}

{
    "apiKeys": <ApiKey[]>,
    "listMetadata": <types.v1.ListMetadata>
}

GetApiKeysResponse(
    api_keys: <ApiKey[]>,
    list_metadata: <types.v1.ListMetadata>
)

GetApiKeysResponse(
    ApiKeys <ApiKey[]>,
    ListMetadata <types.v1.ListMetadata>
)

GetApiKeysRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

GetApiKeysResponse

Parameter	Python Attribute	Type	Description	Is Optional
apiKeys	api_keys	ApiKey array
listMetadata	list_metadata	types.v1.ListMetadata

CreateApiKey

curl 'https://adminv2.api.formalcloud.net/admin.v1.DevService/CreateApiKey' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.admin_pb2 import CreateApiKeyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DevClient.CreateApiKey(
    CreateApiKeyRequest("name": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DevServiceClient.CreateApiKey(context.Background(), connect.NewRequest(
        &adminv1.CreateApiKeyRequest{Name: <string>},
    ))
}

{
    "id": <string>,
    "name": <string>,
    "secret": <string>,
    "createdAt": <google.protobuf.Timestamp>
}

CreateApiKeyResponse(
    id: <string>,
    name: <string>,
    secret: <string>,
    created_at: <google.protobuf.Timestamp>
)

CreateApiKeyResponse(
    Id <string>,
    Name <string>,
    Secret <string>,
    CreatedAt <google.protobuf.Timestamp>
)

CreateApiKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string

CreateApiKeyResponse

Parameter	Python Attribute	Type
id	id	string
name	name	string
secret	secret	string
createdAt	created_at	google.protobuf.Timestamp

DeleteApiKey

curl 'https://adminv2.api.formalcloud.net/admin.v1.DevService/DeleteApiKey' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.admin_pb2 import DeleteApiKeyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DevClient.DeleteApiKey(
    DeleteApiKeyRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DevServiceClient.DeleteApiKey(context.Background(), connect.NewRequest(
        &adminv1.DeleteApiKeyRequest{Id: <string>},
    ))
}

{}

DeleteApiKeyResponse()

DeleteApiKeyResponse()

DeleteApiKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteApiKeyResponse

This response has no parameters.

GetApiKeysRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

ApiKey

Parameter	Python Attribute	Type
id	id	string
name	name	string
createdAt	created_at	google.protobuf.Timestamp

GetApiKeysResponse

Parameter	Python Attribute	Type	Description	Is Optional
apiKeys	api_keys	ApiKey array
listMetadata	list_metadata	types.v1.ListMetadata

CreateApiKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string

CreateApiKeyResponse

Parameter	Python Attribute	Type
id	id	string
name	name	string
secret	secret	string
createdAt	created_at	google.protobuf.Timestamp

DeleteApiKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteApiKeyResponse

This message has no parameters.

AuditLogs Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.AuditLogsService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).AuditLogsClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.AuditLogsServiceClient
}

GetLogs

curl 'https://adminv2.api.formalcloud.net/admin.v1.AuditLogsService/GetLogs' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "offset": <int32>, 
    "filter": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.audit_pb2 import GetLogsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AuditLogsClient.GetLogs(
    GetLogsRequest("limit": <int32>, 
        "offset": <int32>, 
        "filter": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AuditLogsServiceClient.GetLogs(context.Background(), connect.NewRequest(
        &adminv1.GetLogsRequest{Limit: <int32>, 
            Offset: <int32>, 
            Filter: <string>},
    ))
}

{
    "logs": <types.v1.FormalLog[]>,
    "hasMore": <bool>
}

GetLogsResponse(
    logs: <types.v1.FormalLog[]>,
    has_more: <bool>
)

GetLogsResponse(
    Logs <types.v1.FormalLog[]>,
    HasMore <bool>
)

GetLogsRequest

Parameter	Python Attribute	Type	Is Optional
limit	limit	int32
offset	offset	int32
filter	filter	string	True

GetLogsResponse

Parameter	Python Attribute	Type	Description	Is Optional
logs	logs	types.v1.FormalLog array
hasMore	has_more	bool

GetLogByID

curl 'https://adminv2.api.formalcloud.net/admin.v1.AuditLogsService/GetLogByID' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.audit_pb2 import GetLogByIDRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AuditLogsClient.GetLogByID(
    GetLogByIDRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AuditLogsServiceClient.GetLogByID(context.Background(), connect.NewRequest(
        &adminv1.GetLogByIDRequest{Id: <string>},
    ))
}

{
    "log": <types.v1.FormalLog>
}

GetLogByIDResponse(
    log: <types.v1.FormalLog>
)

GetLogByIDResponse(
    Log <types.v1.FormalLog>
)

GetLogByIDRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLogByIDResponse

Parameter	Python Attribute	Type	Description	Is Optional
log	log	types.v1.FormalLog

GetEventBySession

curl 'https://adminv2.api.formalcloud.net/admin.v1.AuditLogsService/GetEventBySession' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.audit_pb2 import GetEventBySessionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AuditLogsClient.GetEventBySession(
    GetEventBySessionRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AuditLogsServiceClient.GetEventBySession(context.Background(), connect.NewRequest(
        &adminv1.GetEventBySessionRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetEventBySessionRequest(
    id: <string>
)

GetEventBySessionRequest(
    Id <string>
)

GetEventBySessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetEventBySessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataBySession

curl 'https://adminv2.api.formalcloud.net/admin.v1.AuditLogsService/GetDataBySession' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.audit_pb2 import GetDataBySessionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AuditLogsClient.GetDataBySession(
    GetDataBySessionRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AuditLogsServiceClient.GetDataBySession(context.Background(), connect.NewRequest(
        &adminv1.GetDataBySessionRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetDataBySessionRequest(
    id: <string>
)

GetDataBySessionRequest(
    Id <string>
)

GetDataBySessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataBySessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLogsRequest

Parameter	Python Attribute	Type	Is Optional
limit	limit	int32
offset	offset	int32
filter	filter	string	True

GetLogByIDRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLogsResponse

Parameter	Python Attribute	Type	Description	Is Optional
logs	logs	types.v1.FormalLog array
hasMore	has_more	bool

GetLogByIDResponse

Parameter	Python Attribute	Type	Description	Is Optional
log	log	types.v1.FormalLog

GetEventBySessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetEventBySessionResponse

Parameter	Python Attribute	Type	Description	Is Optional
eventData	event_data	EventData array

EventData

Parameter	Python Attribute	Type
timestamp	timestamp	google.protobuf.Timestamp
type	type	string
sessionId	session_id	string
bytes	bytes	int32
offset	offset	int32

GetDataBySessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

SshData

Parameter	Python Attribute	Type
timestamp	timestamp	google.protobuf.Timestamp
data	data	bytes
messageType	message_type	string

GetDataBySessionResponse

Parameter	Python Attribute	Type	Description	Is Optional
sshData	ssh_data	SshData array

Cord Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.CordService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).CordClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.CordServiceClient
}

GetClientAuthToken

curl 'https://adminv2.api.formalcloud.net/admin.v1.CordService/GetClientAuthToken' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "userId": <string>, 
    "userName": <string>, 
    "userEmail": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.cord_pb2 import GetClientAuthTokenRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CordClient.GetClientAuthToken(
    GetClientAuthTokenRequest("user_id": <string>, 
        "user_name": <string>, 
        "user_email": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CordServiceClient.GetClientAuthToken(context.Background(), connect.NewRequest(
        &adminv1.GetClientAuthTokenRequest{UserId: <string>, 
            UserName: <string>, 
            UserEmail: <string>},
    ))
}

{
    "userId": <string>,
    "userName": <string>,
    "userEmail": <string>
}

GetClientAuthTokenRequest(
    user_id: <string>,
    user_name: <string>,
    user_email: <string>
)

GetClientAuthTokenRequest(
    UserId <string>,
    UserName <string>,
    UserEmail <string>
)

GetClientAuthTokenRequest

Parameter	Python Attribute	Type
userId	user_id	string
userName	user_name	string
userEmail	user_email	string

GetClientAuthTokenRequest

Parameter	Python Attribute	Type
userId	user_id	string
userName	user_name	string
userEmail	user_email	string

GetClientAuthTokenRequest

Parameter	Python Attribute	Type
userId	user_id	string
userName	user_name	string
userEmail	user_email	string

GetClientAuthTokenResponse

Parameter	Python Attribute	Type	Description	Is Optional
token	token	string

test

Parameter	Python Attribute	Type	Description	Is Optional
test	test	string

DataStore Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).DataStoreClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.DataStoreServiceClient
}

CreateDatastore

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/CreateDatastore' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "hostname": <string>, 
    "port": <int32>, 
    "technology": <string>, 
    "healthCheckDbName": <string>, 
    "dbDiscoveryJobWaitTime": <string>, 
    "dbDiscoveryNativeRoleId": <string>, 
    "environment": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import CreateDatastoreRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.CreateDatastore(
    CreateDatastoreRequest("name": <string>, 
        "hostname": <string>, 
        "port": <int32>, 
        "technology": <string>, 
        "health_check_db_name": <string>, 
        "db_discovery_job_wait_time": <string>, 
        "db_discovery_native_role_id": <string>, 
        "environment": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.CreateDatastore(context.Background(), connect.NewRequest(
        &adminv1.CreateDatastoreRequest{Name: <string>, 
            Hostname: <string>, 
            Port: <int32>, 
            Technology: <string>, 
            HealthCheckDbName: <string>, 
            DbDiscoveryJobWaitTime: <string>, 
            DbDiscoveryNativeRoleId: <string>, 
            Environment: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "id": <string>
}

CreateDatastoreResponse(
    id: <string>
)

CreateDatastoreResponse(
    Id <string>
)

CreateDatastoreRequest

Parameter	Python Attribute	Type
name	name	string
hostname	hostname	string
port	port	int32
technology	technology	string
healthCheckDbName	health_check_db_name	string
dbDiscoveryJobWaitTime	db_discovery_job_wait_time	string
dbDiscoveryNativeRoleId	db_discovery_native_role_id	string
environment	environment	string
terminationProtection	termination_protection	bool

CreateDatastoreResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDatastore

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/GetDatastore' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import GetDatastoreRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.GetDatastore(
    GetDatastoreRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.GetDatastore(context.Background(), connect.NewRequest(
        &adminv1.GetDatastoreRequest{Id: <string>},
    ))
}

{
    "datastore": <Datastore>
}

GetDatastoreResponse(
    datastore: <Datastore>
)

GetDatastoreResponse(
    Datastore <Datastore>
)

GetDatastoreRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDatastoreResponse

Parameter	Python Attribute	Type	Description	Is Optional
datastore	datastore	Datastore

GetDatastores

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/GetDatastores' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "filter": <string>, 
    "search": <string>, 
    "searchFields": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import GetDatastoresRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.GetDatastores(
    GetDatastoresRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "filter": <string>, 
        "search": <string>, 
        "search_fields": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.GetDatastores(context.Background(), connect.NewRequest(
        &adminv1.GetDatastoresRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Filter: <string>, 
            Search: <string>, 
            SearchFields: <string[]>},
    ))
}

{
    "datastores": <Datastore[]>,
    "listMetadata": <types.v1.ListMetadata>
}

GetDatastoresResponse(
    datastores: <Datastore[]>,
    list_metadata: <types.v1.ListMetadata>
)

GetDatastoresResponse(
    Datastores <Datastore[]>,
    ListMetadata <types.v1.ListMetadata>
)

GetDatastoresRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
filter	filter	string
search	search	string
searchFields	search_fields	string array

GetDatastoresResponse

Parameter	Python Attribute	Type	Description	Is Optional
datastores	datastores	Datastore array
listMetadata	list_metadata	types.v1.ListMetadata

GetLinkedSidecars

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/GetLinkedSidecars' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import GetLinkedSidecarsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.GetLinkedSidecars(
    GetLinkedSidecarsRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.GetLinkedSidecars(context.Background(), connect.NewRequest(
        &adminv1.GetLinkedSidecarsRequest{Id: <string>},
    ))
}

{
    "sidecars": <LinkedSidecar[]>
}

GetLinkedSidecarsResponse(
    sidecars: <LinkedSidecar[]>
)

GetLinkedSidecarsResponse(
    Sidecars <LinkedSidecar[]>
)

GetLinkedSidecarsRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLinkedSidecarsResponse

Parameter	Python Attribute	Type	Description	Is Optional
sidecars	sidecars	LinkedSidecar array

DeleteDatastore

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/DeleteDatastore' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import DeleteDatastoreRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.DeleteDatastore(
    DeleteDatastoreRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.DeleteDatastore(context.Background(), connect.NewRequest(
        &adminv1.DeleteDatastoreRequest{Id: <string>},
    ))
}

{}

DeleteDatastoreResponse()

DeleteDatastoreResponse()

DeleteDatastoreRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDatastoreResponse

This response has no parameters.

UpdateDatastoreName

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/UpdateDatastoreName' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "name": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import UpdateDatastoreNameRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.UpdateDatastoreName(
    UpdateDatastoreNameRequest("id": <string>, 
        "name": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.UpdateDatastoreName(context.Background(), connect.NewRequest(
        &adminv1.UpdateDatastoreNameRequest{Id: <string>, 
            Name: <string>},
    ))
}

{}

UpdateDatastoreNameResponse()

UpdateDatastoreNameResponse()

UpdateDatastoreNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
name	name	string

UpdateDatastoreNameResponse

This response has no parameters.

UpdateDbDiscoveryConfig

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/UpdateDbDiscoveryConfig' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "dbDiscoveryJobWaitTime": <string>, 
    "dbDiscoveryNativeRoleId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import UpdateDbDiscoveryConfigRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.UpdateDbDiscoveryConfig(
    UpdateDbDiscoveryConfigRequest("id": <string>, 
        "db_discovery_job_wait_time": <string>, 
        "db_discovery_native_role_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.UpdateDbDiscoveryConfig(context.Background(), connect.NewRequest(
        &adminv1.UpdateDbDiscoveryConfigRequest{Id: <string>, 
            DbDiscoveryJobWaitTime: <string>, 
            DbDiscoveryNativeRoleId: <string>},
    ))
}

{}

UpdateDbDiscoveryConfigResponse()

UpdateDbDiscoveryConfigResponse()

UpdateDbDiscoveryConfigRequest

Parameter	Python Attribute	Type
id	id	string
dbDiscoveryJobWaitTime	db_discovery_job_wait_time	string
dbDiscoveryNativeRoleId	db_discovery_native_role_id	string

UpdateDbDiscoveryConfigResponse

This response has no parameters.

UpdateDataStoreHealthCheckDbName

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/UpdateDataStoreHealthCheckDbName' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "healthCheckDbName": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import UpdateDataStoreHealthCheckDbNameRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.UpdateDataStoreHealthCheckDbName(
    UpdateDataStoreHealthCheckDbNameRequest("id": <string>, 
        "health_check_db_name": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.UpdateDataStoreHealthCheckDbName(context.Background(), connect.NewRequest(
        &adminv1.UpdateDataStoreHealthCheckDbNameRequest{Id: <string>, 
            HealthCheckDbName: <string>},
    ))
}

{}

UpdateDataStoreHealthCheckDbNameResponse()

UpdateDataStoreHealthCheckDbNameResponse()

UpdateDataStoreHealthCheckDbNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
healthCheckDbName	health_check_db_name	string

UpdateDataStoreHealthCheckDbNameResponse

This response has no parameters.

UpdateDataStoreDefaultAccessBehavior

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/UpdateDataStoreDefaultAccessBehavior' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "defaultAccessBehavior": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import UpdateDataStoreDefaultAccessBehaviorRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.UpdateDataStoreDefaultAccessBehavior(
    UpdateDataStoreDefaultAccessBehaviorRequest("id": <string>, 
        "default_access_behavior": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.UpdateDataStoreDefaultAccessBehavior(context.Background(), connect.NewRequest(
        &adminv1.UpdateDataStoreDefaultAccessBehaviorRequest{Id: <string>, 
            DefaultAccessBehavior: <string>},
    ))
}

{}

UpdateDataStoreDefaultAccessBehaviorResponse()

UpdateDataStoreDefaultAccessBehaviorResponse()

UpdateDataStoreDefaultAccessBehaviorRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
defaultAccessBehavior	default_access_behavior	string

UpdateDataStoreDefaultAccessBehaviorResponse

This response has no parameters.

SetTerminationProtection

curl 'https://adminv2.api.formalcloud.net/admin.v1.DataStoreService/SetTerminationProtection' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.datastore_pb2 import SetTerminationProtectionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DataStoreClient.SetTerminationProtection(
    SetTerminationProtectionRequest("id": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DataStoreServiceClient.SetTerminationProtection(context.Background(), connect.NewRequest(
        &adminv1.SetTerminationProtectionRequest{Id: <string>, 
            TerminationProtection: <bool>},
    ))
}

{}

SetTerminationProtectionResponse()

SetTerminationProtectionResponse()

SetTerminationProtectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool

SetTerminationProtectionResponse

This response has no parameters.

CreateDatastoreRequest

Parameter	Python Attribute	Type
name	name	string
hostname	hostname	string
port	port	int32
technology	technology	string
healthCheckDbName	health_check_db_name	string
dbDiscoveryJobWaitTime	db_discovery_job_wait_time	string
dbDiscoveryNativeRoleId	db_discovery_native_role_id	string
environment	environment	string
terminationProtection	termination_protection	bool

CreateDatastoreResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDatastoreRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDatastoreResponse

Parameter	Python Attribute	Type	Description	Is Optional
datastore	datastore	Datastore

GetDatastoresRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
filter	filter	string
search	search	string
searchFields	search_fields	string array

GetDatastoresResponse

Parameter	Python Attribute	Type	Description	Is Optional
datastores	datastores	Datastore array
listMetadata	list_metadata	types.v1.ListMetadata

DeleteDatastoreRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDatastoreResponse

This message has no parameters.

UpdateDatastoreNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
name	name	string

UpdateDatastoreNameResponse

This message has no parameters.

UpdateDbDiscoveryConfigRequest

Parameter	Python Attribute	Type
id	id	string
dbDiscoveryJobWaitTime	db_discovery_job_wait_time	string
dbDiscoveryNativeRoleId	db_discovery_native_role_id	string

UpdateDbDiscoveryConfigResponse

This message has no parameters.

UpdateDataStoreHealthCheckDbNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
healthCheckDbName	health_check_db_name	string

UpdateDataStoreHealthCheckDbNameResponse

This message has no parameters.

UpdateDataStoreDefaultAccessBehaviorRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
defaultAccessBehavior	default_access_behavior	string

UpdateDataStoreDefaultAccessBehaviorResponse

This message has no parameters.

SetTerminationProtectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool

SetTerminationProtectionResponse

This message has no parameters.

GetLinkedSidecarsRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLinkedSidecarsResponse

Parameter	Python Attribute	Type	Description	Is Optional
sidecars	sidecars	LinkedSidecar array

LinkedSidecar

Parameter	Python Attribute	Type
id	id	string
name	name	string
hostname	hostname	string
linkId	link_id	string

Datastore

Parameter	Python Attribute	Type
id	id	string
datastoreId	datastore_id	string
name	name	string
port	port	int32
hostname	hostname	string
healthCheckDbName	health_check_db_name	string
technology	technology	string
createdAt	created_at	google.protobuf.Timestamp
expireAt	expire_at	string
dbDiscoveryJobWaitTime	db_discovery_job_wait_time	string
dbDiscoveryNativeRoleId	db_discovery_native_role_id	string
defaultAccessBehavior	default_access_behavior	string
linkedLogs	linked_logs	IntegrationLog array
environment	environment	string
terminationProtection	termination_protection	bool

IntegrationLog

Parameter	Python Attribute	Type
id	id	string
name	name	string
type	type	string
createdAt	created_at	int32

FieldEncryptionPolicy Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.FieldEncryptionPolicyService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).FieldEncryptionPolicyClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.FieldEncryptionPolicyServiceClient
}

CreateOrUpdateDefaultFieldEncryptionPolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.FieldEncryptionPolicyService/CreateOrUpdateDefaultFieldEncryptionPolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "kmsKeyId": <string>, 
    "encryptionAlg": <string>, 
    "dataKeyStorage": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.encryption_pb2 import CreateOrUpdateDefaultFieldEncryptionPolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.FieldEncryptionPolicyClient.CreateOrUpdateDefaultFieldEncryptionPolicy(
    CreateOrUpdateDefaultFieldEncryptionPolicyRequest("kms_key_id": <string>, 
        "encryption_alg": <string>, 
        "data_key_storage": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.FieldEncryptionPolicyServiceClient.CreateOrUpdateDefaultFieldEncryptionPolicy(context.Background(), connect.NewRequest(
        &adminv1.CreateOrUpdateDefaultFieldEncryptionPolicyRequest{KmsKeyId: <string>, 
            EncryptionAlg: <string>, 
            DataKeyStorage: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "defaultFieldEncryptionPolicy": <DefaultFieldEncryptionPolicy>
}

CreateOrUpdateDefaultFieldEncryptionPolicyResponse(
    default_field_encryption_policy: <DefaultFieldEncryptionPolicy>
)

CreateOrUpdateDefaultFieldEncryptionPolicyResponse(
    DefaultFieldEncryptionPolicy <DefaultFieldEncryptionPolicy>
)

CreateOrUpdateDefaultFieldEncryptionPolicyRequest

Parameter	Python Attribute	Type
kmsKeyId	kms_key_id	string
encryptionAlg	encryption_alg	string
dataKeyStorage	data_key_storage	string
terminationProtection	termination_protection	bool

CreateOrUpdateDefaultFieldEncryptionPolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
defaultFieldEncryptionPolicy	default_field_encryption_policy	DefaultFieldEncryptionPolicy

GetDefaultFieldEncryptionPolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.FieldEncryptionPolicyService/GetDefaultFieldEncryptionPolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.encryption_pb2 import GetDefaultFieldEncryptionPolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.FieldEncryptionPolicyClient.GetDefaultFieldEncryptionPolicy(
    GetDefaultFieldEncryptionPolicyRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.FieldEncryptionPolicyServiceClient.GetDefaultFieldEncryptionPolicy(context.Background(), connect.NewRequest(
        &adminv1.GetDefaultFieldEncryptionPolicyRequest{},
    ))
}

{
    "defaultFieldEncryptionPolicy": <DefaultFieldEncryptionPolicy>
}

GetDefaultFieldEncryptionPolicyResponse(
    default_field_encryption_policy: <DefaultFieldEncryptionPolicy>
)

GetDefaultFieldEncryptionPolicyResponse(
    DefaultFieldEncryptionPolicy <DefaultFieldEncryptionPolicy>
)

GetDefaultFieldEncryptionPolicyRequest

This request has no parameters.

GetDefaultFieldEncryptionPolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
defaultFieldEncryptionPolicy	default_field_encryption_policy	DefaultFieldEncryptionPolicy

FieldEncryption Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.FieldEncryptionService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).FieldEncryptionClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.FieldEncryptionServiceClient
}

CreateFieldEncryption

curl 'https://adminv2.api.formalcloud.net/admin.v1.FieldEncryptionService/CreateFieldEncryption' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "path": <string>, 
    "keyStorage": <string>, 
    "keyId": <string>, 
    "alg": <string>, 
    "datastoreId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.encryption_pb2 import CreateFieldEncryptionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.FieldEncryptionClient.CreateFieldEncryption(
    CreateFieldEncryptionRequest("path": <string>, 
        "key_storage": <string>, 
        "key_id": <string>, 
        "alg": <string>, 
        "datastore_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.FieldEncryptionServiceClient.CreateFieldEncryption(context.Background(), connect.NewRequest(
        &adminv1.CreateFieldEncryptionRequest{Path: <string>, 
            KeyStorage: <string>, 
            KeyId: <string>, 
            Alg: <string>, 
            DatastoreId: <string>},
    ))
}

{
    "path": <string>,
    "keyStorage": <string>,
    "keyId": <string>,
    "alg": <string>,
    "datastoreId": <string>
}

CreateFieldEncryptionRequest(
    path: <string>,
    key_storage: <string>,
    key_id: <string>,
    alg: <string>,
    datastore_id: <string>
)

CreateFieldEncryptionRequest(
    Path <string>,
    KeyStorage <string>,
    KeyId <string>,
    Alg <string>,
    DatastoreId <string>
)

CreateFieldEncryptionRequest

Parameter	Python Attribute	Type
path	path	string
keyStorage	key_storage	string
keyId	key_id	string
alg	alg	string
datastoreId	datastore_id	string

CreateFieldEncryptionRequest

Parameter	Python Attribute	Type
path	path	string
keyStorage	key_storage	string
keyId	key_id	string
alg	alg	string
datastoreId	datastore_id	string

GetFieldEncryptionsByDatastore

curl 'https://adminv2.api.formalcloud.net/admin.v1.FieldEncryptionService/GetFieldEncryptionsByDatastore' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.encryption_pb2 import GetFieldEncryptionsByDatastoreRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.FieldEncryptionClient.GetFieldEncryptionsByDatastore(
    GetFieldEncryptionsByDatastoreRequest("datastore_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.FieldEncryptionServiceClient.GetFieldEncryptionsByDatastore(context.Background(), connect.NewRequest(
        &adminv1.GetFieldEncryptionsByDatastoreRequest{DatastoreId: <string>},
    ))
}

{
    "datastoreId": <string>
}

GetFieldEncryptionsByDatastoreRequest(
    datastore_id: <string>
)

GetFieldEncryptionsByDatastoreRequest(
    DatastoreId <string>
)

GetFieldEncryptionsByDatastoreRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string

GetFieldEncryptionsByDatastoreRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string

DeleteFieldEncryption

curl 'https://adminv2.api.formalcloud.net/admin.v1.FieldEncryptionService/DeleteFieldEncryption' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "fieldEncryptionId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.encryption_pb2 import DeleteFieldEncryptionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.FieldEncryptionClient.DeleteFieldEncryption(
    DeleteFieldEncryptionRequest("datastore_id": <string>, 
        "field_encryption_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.FieldEncryptionServiceClient.DeleteFieldEncryption(context.Background(), connect.NewRequest(
        &adminv1.DeleteFieldEncryptionRequest{DatastoreId: <string>, 
            FieldEncryptionId: <string>},
    ))
}

{
    "datastoreId": <string>,
    "fieldEncryptionId": <string>
}

DeleteFieldEncryptionRequest(
    datastore_id: <string>,
    field_encryption_id: <string>
)

DeleteFieldEncryptionRequest(
    DatastoreId <string>,
    FieldEncryptionId <string>
)

DeleteFieldEncryptionRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
fieldEncryptionId	field_encryption_id	string

DeleteFieldEncryptionRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
fieldEncryptionId	field_encryption_id	string

CreateOrUpdateDefaultFieldEncryptionPolicyRequest

Parameter	Python Attribute	Type
kmsKeyId	kms_key_id	string
encryptionAlg	encryption_alg	string
dataKeyStorage	data_key_storage	string
terminationProtection	termination_protection	bool

CreateOrUpdateDefaultFieldEncryptionPolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
defaultFieldEncryptionPolicy	default_field_encryption_policy	DefaultFieldEncryptionPolicy

GetDefaultFieldEncryptionPolicyRequest

This message has no parameters.

GetDefaultFieldEncryptionPolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
defaultFieldEncryptionPolicy	default_field_encryption_policy	DefaultFieldEncryptionPolicy

DefaultFieldEncryptionPolicy

Parameter	Python Attribute	Type
kmsKeyId	kms_key_id	string
encryptionAlg	encryption_alg	string
dataKeyStorage	data_key_storage	string
updatedAt	updated_at	int64
terminationProtection	termination_protection	bool

CreateFieldEncryptionRequest

Parameter	Python Attribute	Type
path	path	string
keyStorage	key_storage	string
keyId	key_id	string
alg	alg	string
datastoreId	datastore_id	string

CreateFieldEncryptionResponse

Parameter	Python Attribute	Type	Description	Is Optional
fieldEncryption	field_encryption	FieldEncryption

GetFieldEncryptionsByDatastoreRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string

GetFieldEncryptionsByDatastoreResponse

Parameter	Python Attribute	Type	Description	Is Optional
fieldEncryptions	field_encryptions	FieldEncryption array

DeleteFieldEncryptionRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
fieldEncryptionId	field_encryption_id	string

DeleteFieldEncryptionResponse

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string

FieldEncryption

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
name	name	string
path	path	string
keyStorage	key_storage	string
keyId	key_id	string
keyRegion	key_region	string
alg	alg	string

ETL Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).ETLClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.ETLServiceClient
}

GetConnectors

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetConnectors' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "hostname": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetConnectorsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetConnectors(
    GetConnectorsRequest("hostname": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetConnectors(context.Background(), connect.NewRequest(
        &adminv1.GetConnectorsRequest{Hostname: <string>},
    ))
}

{
    "connectors": <types.v1.ETLConnector[]>
}

GetConnectorsResponse(
    connectors: <types.v1.ETLConnector[]>
)

GetConnectorsResponse(
    Connectors <types.v1.ETLConnector[]>
)

GetConnectorsRequest

Parameter	Python Attribute	Type	Description	Is Optional
hostname	hostname	string

GetConnectorsResponse

Parameter	Python Attribute	Type	Description	Is Optional
connectors	connectors	types.v1.ETLConnector array

GetConnectorByDbName

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetConnectorByDbName' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "hostname": <string>, 
    "dbName": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetConnectorByDbNameRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetConnectorByDbName(
    GetConnectorByDbNameRequest("hostname": <string>, 
        "db_name": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetConnectorByDbName(context.Background(), connect.NewRequest(
        &adminv1.GetConnectorByDbNameRequest{Hostname: <string>, 
            DbName: <string>},
    ))
}

{
    "connector": <types.v1.ETLConnector>,
    "datastore": <types.v1.Datastore>
}

GetConnectorByDbNameResponse(
    connector: <types.v1.ETLConnector>,
    datastore: <types.v1.Datastore>
)

GetConnectorByDbNameResponse(
    Connector <types.v1.ETLConnector>,
    Datastore <types.v1.Datastore>
)

GetConnectorByDbNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
hostname	hostname	string
dbName	db_name	string

GetConnectorByDbNameResponse

Parameter	Python Attribute	Type	Description	Is Optional
connector	connector	types.v1.ETLConnector
datastore	datastore	types.v1.Datastore

GetDestinations

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetDestinations' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "hostname": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetDestinationsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetDestinations(
    GetDestinationsRequest("hostname": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetDestinations(context.Background(), connect.NewRequest(
        &adminv1.GetDestinationsRequest{Hostname: <string>},
    ))
}

{
    "hostname": <string>
}

GetDestinationsRequest(
    hostname: <string>
)

GetDestinationsRequest(
    Hostname <string>
)

GetDestinationsRequest

Parameter	Python Attribute	Type	Description	Is Optional
hostname	hostname	string

GetDestinationsRequest

Parameter	Python Attribute	Type	Description	Is Optional
hostname	hostname	string

GetDestinationByID

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetDestinationByID' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetDestinationByIDRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetDestinationByID(
    GetDestinationByIDRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetDestinationByID(context.Background(), connect.NewRequest(
        &adminv1.GetDestinationByIDRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetDestinationByIDRequest(
    id: <string>
)

GetDestinationByIDRequest(
    Id <string>
)

GetDestinationByIDRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDestinationByIDRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetGroups

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetGroups' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetGroupsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetGroups(
    GetGroupsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetGroups(context.Background(), connect.NewRequest(
        &adminv1.GetGroupsRequest{},
    ))
}

{
    "groups": <types.v1.ETLGroup[]>
}

GetGroupsResponse(
    groups: <types.v1.ETLGroup[]>
)

GetGroupsResponse(
    Groups <types.v1.ETLGroup[]>
)

GetGroupsRequest

This request has no parameters.

GetGroupsResponse

Parameter	Python Attribute	Type	Description	Is Optional
groups	groups	types.v1.ETLGroup array

GetLineageSchemas

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetLineageSchemas' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "connectorId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetLineageSchemasRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetLineageSchemas(
    GetLineageSchemasRequest("connector_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetLineageSchemas(context.Background(), connect.NewRequest(
        &adminv1.GetLineageSchemasRequest{ConnectorId: <string>},
    ))
}

{
    "connectorId": <string>
}

GetLineageSchemasRequest(
    connector_id: <string>
)

GetLineageSchemasRequest(
    ConnectorId <string>
)

GetLineageSchemasRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageSchemasRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageSchemaByName

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetLineageSchemaByName' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "connectorId": <string>, 
    "schemaName": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetLineageSchemaByNameRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetLineageSchemaByName(
    GetLineageSchemaByNameRequest("connector_id": <string>, 
        "schema_name": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetLineageSchemaByName(context.Background(), connect.NewRequest(
        &adminv1.GetLineageSchemaByNameRequest{ConnectorId: <string>, 
            SchemaName: <string>},
    ))
}

{
    "connectorId": <string>,
    "schemaName": <string>
}

GetLineageSchemaByNameRequest(
    connector_id: <string>,
    schema_name: <string>
)

GetLineageSchemaByNameRequest(
    ConnectorId <string>,
    SchemaName <string>
)

GetLineageSchemaByNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string
schemaName	schema_name	string

GetLineageSchemaByNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string
schemaName	schema_name	string

GetLineageTables

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetLineageTables' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "connectorId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetLineageTablesRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetLineageTables(
    GetLineageTablesRequest("connector_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetLineageTables(context.Background(), connect.NewRequest(
        &adminv1.GetLineageTablesRequest{ConnectorId: <string>},
    ))
}

{
    "connectorId": <string>
}

GetLineageTablesRequest(
    connector_id: <string>
)

GetLineageTablesRequest(
    ConnectorId <string>
)

GetLineageTablesRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageTablesRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageTableByName

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetLineageTableByName' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "connectorId": <string>, 
    "schemaId": <string>, 
    "tableName": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetLineageTableByNameRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetLineageTableByName(
    GetLineageTableByNameRequest("connector_id": <string>, 
        "schema_id": <string>, 
        "table_name": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetLineageTableByName(context.Background(), connect.NewRequest(
        &adminv1.GetLineageTableByNameRequest{ConnectorId: <string>, 
            SchemaId: <string>, 
            TableName: <string>},
    ))
}

{
    "connectorId": <string>,
    "schemaId": <string>,
    "tableName": <string>
}

GetLineageTableByNameRequest(
    connector_id: <string>,
    schema_id: <string>,
    table_name: <string>
)

GetLineageTableByNameRequest(
    ConnectorId <string>,
    SchemaId <string>,
    TableName <string>
)

GetLineageTableByNameRequest

Parameter	Python Attribute	Type
connectorId	connector_id	string
schemaId	schema_id	string
tableName	table_name	string

GetLineageTableByNameRequest

Parameter	Python Attribute	Type
connectorId	connector_id	string
schemaId	schema_id	string
tableName	table_name	string

GetLineageColumns

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetLineageColumns' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "connectorId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetLineageColumnsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetLineageColumns(
    GetLineageColumnsRequest("connector_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetLineageColumns(context.Background(), connect.NewRequest(
        &adminv1.GetLineageColumnsRequest{ConnectorId: <string>},
    ))
}

{
    "connectorId": <string>
}

GetLineageColumnsRequest(
    connector_id: <string>
)

GetLineageColumnsRequest(
    ConnectorId <string>
)

GetLineageColumnsRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageColumnsRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageColumnsByTable

curl 'https://adminv2.api.formalcloud.net/admin.v1.ETLService/GetLineageColumnsByTable' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "connectorId": <string>, 
    "tableId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.etl_pb2 import GetLineageColumnsByTableRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ETLClient.GetLineageColumnsByTable(
    GetLineageColumnsByTableRequest("connector_id": <string>, 
        "table_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ETLServiceClient.GetLineageColumnsByTable(context.Background(), connect.NewRequest(
        &adminv1.GetLineageColumnsByTableRequest{ConnectorId: <string>, 
            TableId: <string>},
    ))
}

{
    "connectorId": <string>,
    "tableId": <string>
}

GetLineageColumnsByTableRequest(
    connector_id: <string>,
    table_id: <string>
)

GetLineageColumnsByTableRequest(
    ConnectorId <string>,
    TableId <string>
)

GetLineageColumnsByTableRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string
tableId	table_id	string

GetLineageColumnsByTableRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string
tableId	table_id	string

GetGroupsRequest

This message has no parameters.

GetGroupsResponse

Parameter	Python Attribute	Type	Description	Is Optional
groups	groups	types.v1.ETLGroup array

GetConnectorsRequest

Parameter	Python Attribute	Type	Description	Is Optional
hostname	hostname	string

GetConnectorsResponse

Parameter	Python Attribute	Type	Description	Is Optional
connectors	connectors	types.v1.ETLConnector array

GetConnectorByDbNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
hostname	hostname	string
dbName	db_name	string

GetConnectorByDbNameResponse

Parameter	Python Attribute	Type	Description	Is Optional
connector	connector	types.v1.ETLConnector
datastore	datastore	types.v1.Datastore

GetDestinationsRequest

Parameter	Python Attribute	Type	Description	Is Optional
hostname	hostname	string

GetDestinationsResponse

Parameter	Python Attribute	Type	Description	Is Optional
destinations	destinations	types.v1.ETLDestination array

GetDestinationByIDRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDestinationByIDResponse

Parameter	Python Attribute	Type	Description	Is Optional
destination	destination	types.v1.ETLDestination
datastore	datastore	types.v1.Datastore

GetLineageSchemasRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageSchemasResponse

Parameter	Python Attribute	Type	Description	Is Optional
schemas	schemas	types.v1.ETLSchemaLineage array

GetLineageSchemaByNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string
schemaName	schema_name	string

GetLineageSchemaByNameResponse

Parameter	Python Attribute	Type	Description	Is Optional
schema	schema	types.v1.ETLSchemaLineage

GetLineageTablesRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageTablesResponse

Parameter	Python Attribute	Type	Description	Is Optional
tables	tables	types.v1.ETLTableLineage array

GetLineageTableByNameRequest

Parameter	Python Attribute	Type
connectorId	connector_id	string
schemaId	schema_id	string
tableName	table_name	string

GetLineageTableByNameResponse

Parameter	Python Attribute	Type	Description	Is Optional
table	table	types.v1.ETLTableLineage

GetLineageColumnsRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string

GetLineageColumnsResponse

Parameter	Python Attribute	Type	Description	Is Optional
columns	columns	types.v1.ETLColumnLineage array

GetLineageColumnsByTableRequest

Parameter	Python Attribute	Type	Description	Is Optional
connectorId	connector_id	string
tableId	table_id	string

GetLineageColumnsByTableResponse

Parameter	Python Attribute	Type	Description	Is Optional
columns	columns	types.v1.ETLColumnLineage array

User Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.UserService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).UserClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.UserServiceClient
}

ListUsers

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/ListUsers' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "search": <string>, 
    "searchFields": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import ListUsersRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.ListUsers(
    ListUsersRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "search": <string>, 
        "search_fields": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.ListUsers(context.Background(), connect.NewRequest(
        &adminv1.ListUsersRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Search: <string>, 
            SearchFields: <string[]>},
    ))
}

{
    "users": <types.v1.User[]>,
    "listMetadata": <types.v1.ListMetadata>
}

ListUsersResponse(
    users: <types.v1.User[]>,
    list_metadata: <types.v1.ListMetadata>
)

ListUsersResponse(
    Users <types.v1.User[]>,
    ListMetadata <types.v1.ListMetadata>
)

ListUsersRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
search	search	string
searchFields	search_fields	string array

ListUsersResponse

Parameter	Python Attribute	Type	Description	Is Optional
users	users	types.v1.User array
listMetadata	list_metadata	types.v1.ListMetadata

CreateUser

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/CreateUser' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "firstName": <string>, 
    "lastName": <string>, 
    "type": <string>, 
    "appType": <string>, 
    "appId": <string>, 
    "name": <string>, 
    "email": <string>, 
    "admin": <bool>, 
    "idp": <string>, 
    "status": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import CreateUserRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.CreateUser(
    CreateUserRequest("first_name": <string>, 
        "last_name": <string>, 
        "type": <string>, 
        "app_type": <string>, 
        "app_id": <string>, 
        "name": <string>, 
        "email": <string>, 
        "admin": <bool>, 
        "idp": <string>, 
        "status": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.CreateUser(context.Background(), connect.NewRequest(
        &adminv1.CreateUserRequest{FirstName: <string>, 
            LastName: <string>, 
            Type: <string>, 
            AppType: <string>, 
            AppId: <string>, 
            Name: <string>, 
            Email: <string>, 
            Admin: <bool>, 
            Idp: <string>, 
            Status: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            TerminationProtection: <bool>},
    ))
}

{
    "user": <types.v1.User>,
    "tenantId": <string>
}

CreateUserResponse(
    user: <types.v1.User>,
    tenant_id: <string>
)

CreateUserResponse(
    User <types.v1.User>,
    TenantId <string>
)

CreateUserRequest

Parameter	Python Attribute	Type
firstName	first_name	string
lastName	last_name	string
type	type	string
appType	app_type	string
appId	app_id	string
name	name	string
email	email	string
admin	admin	bool
idp	idp	string
status	status	string
expireAt	expire_at	google.protobuf.Timestamp
terminationProtection	termination_protection	bool

CreateUserResponse

Parameter	Python Attribute	Type	Description	Is Optional
user	user	types.v1.User
tenantId	tenant_id	string

CreateUserV2

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/CreateUserV2' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "firstName": <string>, 
    "lastName": <string>, 
    "type": <string>, 
    "appType": <string>, 
    "appId": <string>, 
    "name": <string>, 
    "email": <string>, 
    "admin": <bool>, 
    "idp": <string>, 
    "status": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import CreateUserV2Request

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.CreateUserV2(
    CreateUserV2Request("first_name": <string>, 
        "last_name": <string>, 
        "type": <string>, 
        "app_type": <string>, 
        "app_id": <string>, 
        "name": <string>, 
        "email": <string>, 
        "admin": <bool>, 
        "idp": <string>, 
        "status": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.CreateUserV2(context.Background(), connect.NewRequest(
        &adminv1.CreateUserV2Request{FirstName: <string>, 
            LastName: <string>, 
            Type: <string>, 
            AppType: <string>, 
            AppId: <string>, 
            Name: <string>, 
            Email: <string>, 
            Admin: <bool>, 
            Idp: <string>, 
            Status: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            TerminationProtection: <bool>},
    ))
}

{
    "id": <string>
}

CreateUserV2Response(
    id: <string>
)

CreateUserV2Response(
    Id <string>
)

CreateUserV2Request

Parameter	Python Attribute	Type
firstName	first_name	string
lastName	last_name	string
type	type	string
appType	app_type	string
appId	app_id	string
name	name	string
email	email	string
admin	admin	bool
idp	idp	string
status	status	string
expireAt	expire_at	google.protobuf.Timestamp
terminationProtection	termination_protection	bool

CreateUserV2Response

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUserById

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/GetUserById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import GetUserByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.GetUserById(
    GetUserByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.GetUserById(context.Background(), connect.NewRequest(
        &adminv1.GetUserByIdRequest{Id: <string>},
    ))
}

{
    "user": <types.v1.User>
}

GetUserByIdResponse(
    user: <types.v1.User>
)

GetUserByIdResponse(
    User <types.v1.User>
)

GetUserByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUserByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
user	user	types.v1.User

DeleteUser

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/DeleteUser' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import DeleteUserRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.DeleteUser(
    DeleteUserRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.DeleteUser(context.Background(), connect.NewRequest(
        &adminv1.DeleteUserRequest{Id: <string>},
    ))
}

{}

DeleteUserResponse()

DeleteUserResponse()

DeleteUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteUserResponse

This response has no parameters.

UpdateUser

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/UpdateUser' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "name": <string>, 
    "firstName": <string>, 
    "lastName": <string>, 
    "email": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import UpdateUserRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.UpdateUser(
    UpdateUserRequest("id": <string>, 
        "name": <string>, 
        "first_name": <string>, 
        "last_name": <string>, 
        "email": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.UpdateUser(context.Background(), connect.NewRequest(
        &adminv1.UpdateUserRequest{Id: <string>, 
            Name: <string>, 
            FirstName: <string>, 
            LastName: <string>, 
            Email: <string>, 
            TerminationProtection: <bool>},
    ))
}

{}

UpdateUserResponse()

UpdateUserResponse()

UpdateUserRequest

Parameter	Python Attribute	Type	Is Optional
id	id	string
name	name	string
firstName	first_name	string
lastName	last_name	string
email	email	string
terminationProtection	termination_protection	bool	True

UpdateUserResponse

This response has no parameters.

GetMachineUserAuthToken

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/GetMachineUserAuthToken' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import GetMachineUserAuthTokenRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.GetMachineUserAuthToken(
    GetMachineUserAuthTokenRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.GetMachineUserAuthToken(context.Background(), connect.NewRequest(
        &adminv1.GetMachineUserAuthTokenRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetMachineUserAuthTokenRequest(
    id: <string>
)

GetMachineUserAuthTokenRequest(
    Id <string>
)

GetMachineUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetMachineUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CreateHumanUserAuthToken

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/CreateHumanUserAuthToken' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "email": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import CreateHumanUserAuthTokenRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.CreateHumanUserAuthToken(
    CreateHumanUserAuthTokenRequest("email": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.CreateHumanUserAuthToken(context.Background(), connect.NewRequest(
        &adminv1.CreateHumanUserAuthTokenRequest{Email: <string>},
    ))
}

{
    "email": <string>
}

CreateHumanUserAuthTokenRequest(
    email: <string>
)

CreateHumanUserAuthTokenRequest(
    Email <string>
)

CreateHumanUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
email	email	string

CreateHumanUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
email	email	string

RefreshMachineUserAuthToken

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/RefreshMachineUserAuthToken' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import RefreshMachineUserAuthTokenRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.RefreshMachineUserAuthToken(
    RefreshMachineUserAuthTokenRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.RefreshMachineUserAuthToken(context.Background(), connect.NewRequest(
        &adminv1.RefreshMachineUserAuthTokenRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

RefreshMachineUserAuthTokenRequest(
    id: <string>
)

RefreshMachineUserAuthTokenRequest(
    Id <string>
)

RefreshMachineUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

RefreshMachineUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUserExternalIds

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/GetUserExternalIds' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import GetUserExternalIdsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.GetUserExternalIds(
    GetUserExternalIdsRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.GetUserExternalIds(context.Background(), connect.NewRequest(
        &adminv1.GetUserExternalIdsRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetUserExternalIdsRequest(
    id: <string>
)

GetUserExternalIdsRequest(
    Id <string>
)

GetUserExternalIdsRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUserExternalIdsRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

MapUserToExternalId

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/MapUserToExternalId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "userId": <string>, 
    "externalId": <string>, 
    "description": <string>, 
    "appId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import MapUserToExternalIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.MapUserToExternalId(
    MapUserToExternalIdRequest("user_id": <string>, 
        "external_id": <string>, 
        "description": <string>, 
        "app_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.MapUserToExternalId(context.Background(), connect.NewRequest(
        &adminv1.MapUserToExternalIdRequest{UserId: <string>, 
            ExternalId: <string>, 
            Description: <string>, 
            AppId: <string>},
    ))
}

{
    "userId": <string>,
    "externalId": <string>,
    "description": <string>,
    "appId": <string>
}

MapUserToExternalIdRequest(
    user_id: <string>,
    external_id: <string>,
    description: <string>,
    app_id: <string>
)

MapUserToExternalIdRequest(
    UserId <string>,
    ExternalId <string>,
    Description <string>,
    AppId <string>
)

MapUserToExternalIdRequest

Parameter	Python Attribute	Type
userId	user_id	string
externalId	external_id	string
description	description	string
appId	app_id	string

MapUserToExternalIdRequest

Parameter	Python Attribute	Type
userId	user_id	string
externalId	external_id	string
description	description	string
appId	app_id	string

DeleteExternalIdMapping

curl 'https://adminv2.api.formalcloud.net/admin.v1.UserService/DeleteExternalIdMapping' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "mappingId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import DeleteExternalIdMappingRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.UserClient.DeleteExternalIdMapping(
    DeleteExternalIdMappingRequest("mapping_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.UserServiceClient.DeleteExternalIdMapping(context.Background(), connect.NewRequest(
        &adminv1.DeleteExternalIdMappingRequest{MappingId: <string>},
    ))
}

{
    "mappingId": <string>
}

DeleteExternalIdMappingRequest(
    mapping_id: <string>
)

DeleteExternalIdMappingRequest(
    MappingId <string>
)

DeleteExternalIdMappingRequest

Parameter	Python Attribute	Type	Description	Is Optional
mappingId	mapping_id	string

DeleteExternalIdMappingRequest

Parameter	Python Attribute	Type	Description	Is Optional
mappingId	mapping_id	string

Group Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).GroupClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.GroupServiceClient
}

CreateGroup

curl 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/CreateGroup' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "description": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import CreateGroupRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GroupClient.CreateGroup(
    CreateGroupRequest("name": <string>, 
        "description": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GroupServiceClient.CreateGroup(context.Background(), connect.NewRequest(
        &adminv1.CreateGroupRequest{Name: <string>, 
            Description: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "group": <types.v1.Group>
}

CreateGroupResponse(
    group: <types.v1.Group>
)

CreateGroupResponse(
    Group <types.v1.Group>
)

CreateGroupRequest

Parameter	Python Attribute	Type
name	name	string
description	description	string
terminationProtection	termination_protection	bool

CreateGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.Group

ListGroups

curl 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/ListGroups' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "search": <string>, 
    "searchFields": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import ListGroupsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GroupClient.ListGroups(
    ListGroupsRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "search": <string>, 
        "search_fields": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GroupServiceClient.ListGroups(context.Background(), connect.NewRequest(
        &adminv1.ListGroupsRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Search: <string>, 
            SearchFields: <string[]>},
    ))
}

{
    "groups": <types.v1.Group[]>,
    "listMetadata": <types.v1.ListMetadata>
}

ListGroupsResponse(
    groups: <types.v1.Group[]>,
    list_metadata: <types.v1.ListMetadata>
)

ListGroupsResponse(
    Groups <types.v1.Group[]>,
    ListMetadata <types.v1.ListMetadata>
)

ListGroupsRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
search	search	string
searchFields	search_fields	string array

ListGroupsResponse

Parameter	Python Attribute	Type	Description	Is Optional
groups	groups	types.v1.Group array
listMetadata	list_metadata	types.v1.ListMetadata

GetGroupById

curl 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/GetGroupById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import GetGroupByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GroupClient.GetGroupById(
    GetGroupByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GroupServiceClient.GetGroupById(context.Background(), connect.NewRequest(
        &adminv1.GetGroupByIdRequest{Id: <string>},
    ))
}

{
    "group": <types.v1.Group>
}

GetGroupByIdResponse(
    group: <types.v1.Group>
)

GetGroupByIdResponse(
    Group <types.v1.Group>
)

GetGroupByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetGroupByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.Group

UpdateGroup

curl 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/UpdateGroup' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "name": <string>, 
    "description": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import UpdateGroupRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GroupClient.UpdateGroup(
    UpdateGroupRequest("id": <string>, 
        "name": <string>, 
        "description": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GroupServiceClient.UpdateGroup(context.Background(), connect.NewRequest(
        &adminv1.UpdateGroupRequest{Id: <string>, 
            Name: <string>, 
            Description: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "group": <types.v1.Group>
}

UpdateGroupResponse(
    group: <types.v1.Group>
)

UpdateGroupResponse(
    Group <types.v1.Group>
)

UpdateGroupRequest

Parameter	Python Attribute	Type	Is Optional
id	id	string
name	name	string
description	description	string
terminationProtection	termination_protection	bool	True

UpdateGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.Group

LinkUsersToGroup

curl 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/LinkUsersToGroup' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "userIds": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import LinkUsersToGroupRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GroupClient.LinkUsersToGroup(
    LinkUsersToGroupRequest("id": <string>, 
        "user_ids": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GroupServiceClient.LinkUsersToGroup(context.Background(), connect.NewRequest(
        &adminv1.LinkUsersToGroupRequest{Id: <string>, 
            UserIds: <string[]>},
    ))
}

{
    "id": <string>,
    "userIds": <string[]>
}

LinkUsersToGroupRequest(
    id: <string>,
    user_ids: <string[]>
)

LinkUsersToGroupRequest(
    Id <string>,
    UserIds <string[]>
)

LinkUsersToGroupRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

LinkUsersToGroupRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

LinkUsersToGroupV2

curl 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/LinkUsersToGroupV2' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "userIds": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import LinkUsersToGroupV2Request

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GroupClient.LinkUsersToGroupV2(
    LinkUsersToGroupV2Request("id": <string>, 
        "user_ids": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GroupServiceClient.LinkUsersToGroupV2(context.Background(), connect.NewRequest(
        &adminv1.LinkUsersToGroupV2Request{Id: <string>, 
            UserIds: <string[]>},
    ))
}

{
    "id": <string>,
    "userIds": <string[]>
}

LinkUsersToGroupV2Request(
    id: <string>,
    user_ids: <string[]>
)

LinkUsersToGroupV2Request(
    Id <string>,
    UserIds <string[]>
)

LinkUsersToGroupV2Request

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

LinkUsersToGroupV2Request

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

UnlinkUsersFromGroup

curl 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/UnlinkUsersFromGroup' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "userIds": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import UnlinkUsersFromGroupRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GroupClient.UnlinkUsersFromGroup(
    UnlinkUsersFromGroupRequest("id": <string>, 
        "user_ids": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GroupServiceClient.UnlinkUsersFromGroup(context.Background(), connect.NewRequest(
        &adminv1.UnlinkUsersFromGroupRequest{Id: <string>, 
            UserIds: <string[]>},
    ))
}

{
    "id": <string>,
    "userIds": <string[]>
}

UnlinkUsersFromGroupRequest(
    id: <string>,
    user_ids: <string[]>
)

UnlinkUsersFromGroupRequest(
    Id <string>,
    UserIds <string[]>
)

UnlinkUsersFromGroupRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

UnlinkUsersFromGroupRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

DeleteGroup

curl 'https://adminv2.api.formalcloud.net/admin.v1.GroupService/DeleteGroup' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.identities_pb2 import DeleteGroupRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GroupClient.DeleteGroup(
    DeleteGroupRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GroupServiceClient.DeleteGroup(context.Background(), connect.NewRequest(
        &adminv1.DeleteGroupRequest{Id: <string>},
    ))
}

{
    "group": <types.v1.Group>
}

DeleteGroupResponse(
    group: <types.v1.Group>
)

DeleteGroupResponse(
    Group <types.v1.Group>
)

DeleteGroupRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.Group

ListGroupsRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
search	search	string
searchFields	search_fields	string array

CreateGroupRequest

Parameter	Python Attribute	Type
name	name	string
description	description	string
terminationProtection	termination_protection	bool

GetGroupByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteGroupRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

UpdateGroupRequest

Parameter	Python Attribute	Type	Is Optional
id	id	string
name	name	string
description	description	string
terminationProtection	termination_protection	bool	True

LinkUsersToGroupRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

LinkUsersToGroupV2Request

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

UnlinkUsersFromGroupRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
userIds	user_ids	string array

CreateGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.Group

GetGroupByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.Group

DeleteGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.Group

UpdateGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.Group

ListGroupsResponse

Parameter	Python Attribute	Type	Description	Is Optional
groups	groups	types.v1.Group array
listMetadata	list_metadata	types.v1.ListMetadata

LinkUsersToGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
userIds	user_ids	string array
groupId	group_id	string

LinkUsersToGroupV2Response

Parameter	Python Attribute	Type	Description	Is Optional
userIds	user_ids	string array
groupId	group_id	string

UnlinkUsersFromGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
userIds	user_ids	string array
groupId	group_id	string

UserLinkGroupResponse

Parameter	Python Attribute	Type	Description	Is Optional
userIds	user_ids	string array
groupId	group_id	string

ListUsersRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
search	search	string
searchFields	search_fields	string array

ListUsersResponse

Parameter	Python Attribute	Type	Description	Is Optional
users	users	types.v1.User array
listMetadata	list_metadata	types.v1.ListMetadata

CreateUserRequest

Parameter	Python Attribute	Type
firstName	first_name	string
lastName	last_name	string
type	type	string
appType	app_type	string
appId	app_id	string
name	name	string
email	email	string
admin	admin	bool
idp	idp	string
status	status	string
expireAt	expire_at	google.protobuf.Timestamp
terminationProtection	termination_protection	bool

CreateUserResponse

Parameter	Python Attribute	Type	Description	Is Optional
user	user	types.v1.User
tenantId	tenant_id	string

CreateUserV2Request

Parameter	Python Attribute	Type
firstName	first_name	string
lastName	last_name	string
type	type	string
appType	app_type	string
appId	app_id	string
name	name	string
email	email	string
admin	admin	bool
idp	idp	string
status	status	string
expireAt	expire_at	google.protobuf.Timestamp
terminationProtection	termination_protection	bool

CreateUserV2Response

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUserByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUserByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
user	user	types.v1.User

DeleteUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteUserResponse

This message has no parameters.

UpdateUserRequest

Parameter	Python Attribute	Type	Is Optional
id	id	string
name	name	string
firstName	first_name	string
lastName	last_name	string
email	email	string
terminationProtection	termination_protection	bool	True

UpdateUserResponse

This message has no parameters.

GetMachineUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetMachineUserAuthTokenResponse

Parameter	Python Attribute	Type	Description	Is Optional
token	token	string
username	username	string

CreateHumanUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
email	email	string

CreateHumanUserAuthTokenResponse

Parameter	Python Attribute	Type
token	token	string
username	username	string
expiresAt	expires_at	google.protobuf.Timestamp

RefreshMachineUserAuthTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

RefreshMachineUserAuthTokenResponse

Parameter	Python Attribute	Type	Description	Is Optional
token	token	string
username	username	string

GetUserExternalIdsRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUserExternalIdsResponse

Parameter	Python Attribute	Type	Description	Is Optional
externalIds	external_ids	types.v1.ExternalId array

MapUserToExternalIdRequest

Parameter	Python Attribute	Type
userId	user_id	string
externalId	external_id	string
description	description	string
appId	app_id	string

MapUserToExternalIdResponse

This message has no parameters.

DeleteExternalIdMappingRequest

Parameter	Python Attribute	Type	Description	Is Optional
mappingId	mapping_id	string

DeleteExternalIdMappingResponse

This message has no parameters.

App Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.AppService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).AppClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.AppServiceClient
}

RefreshIntegrationApps

curl 'https://adminv2.api.formalcloud.net/admin.v1.AppService/RefreshIntegrationApps' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_app_pb2 import RefreshIntegrationAppsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AppClient.RefreshIntegrationApps(
    RefreshIntegrationAppsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AppServiceClient.RefreshIntegrationApps(context.Background(), connect.NewRequest(
        &adminv1.RefreshIntegrationAppsRequest{},
    ))
}

{}

RefreshIntegrationAppsRequest()

RefreshIntegrationAppsRequest()

RefreshIntegrationAppsRequest

This request has no parameters.

RefreshIntegrationAppsRequest

This response has no parameters.

GetIntegrationApps

curl 'https://adminv2.api.formalcloud.net/admin.v1.AppService/GetIntegrationApps' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_app_pb2 import GetIntegrationAppsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AppClient.GetIntegrationApps(
    GetIntegrationAppsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AppServiceClient.GetIntegrationApps(context.Background(), connect.NewRequest(
        &adminv1.GetIntegrationAppsRequest{},
    ))
}

{}

GetIntegrationAppsRequest()

GetIntegrationAppsRequest()

GetIntegrationAppsRequest

This request has no parameters.

GetIntegrationAppsRequest

This response has no parameters.

GetIntegrationById

curl 'https://adminv2.api.formalcloud.net/admin.v1.AppService/GetIntegrationById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_app_pb2 import GetIntegrationByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AppClient.GetIntegrationById(
    GetIntegrationByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AppServiceClient.GetIntegrationById(context.Background(), connect.NewRequest(
        &adminv1.GetIntegrationByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetIntegrationByIdRequest(
    id: <string>
)

GetIntegrationByIdRequest(
    Id <string>
)

GetIntegrationByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetIntegrationByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CreateIntegrationApp

curl 'https://adminv2.api.formalcloud.net/admin.v1.AppService/CreateIntegrationApp' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "type": <string>, 
    "metabaseHostname": <string>, 
    "metabaseUsername": <string>, 
    "metabasePassword": <string>, 
    "linkedDbUserId": <string>, 
    "fivetranApiKey": <string>, 
    "fivetranApiSecret": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_app_pb2 import CreateIntegrationAppRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AppClient.CreateIntegrationApp(
    CreateIntegrationAppRequest("name": <string>, 
        "type": <string>, 
        "metabase_hostname": <string>, 
        "metabase_username": <string>, 
        "metabase_password": <string>, 
        "linked_db_user_id": <string>, 
        "fivetran_api_key": <string>, 
        "fivetran_api_secret": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AppServiceClient.CreateIntegrationApp(context.Background(), connect.NewRequest(
        &adminv1.CreateIntegrationAppRequest{Name: <string>, 
            Type: <string>, 
            MetabaseHostname: <string>, 
            MetabaseUsername: <string>, 
            MetabasePassword: <string>, 
            LinkedDbUserId: <string>, 
            FivetranApiKey: <string>, 
            FivetranApiSecret: <string>},
    ))
}

{
    "name": <string>,
    "type": <string>,
    "metabaseHostname": <string>,
    "metabaseUsername": <string>,
    "metabasePassword": <string>,
    "linkedDbUserId": <string>,
    "fivetranApiKey": <string>,
    "fivetranApiSecret": <string>
}

CreateIntegrationAppRequest(
    name: <string>,
    type: <string>,
    metabase_hostname: <string>,
    metabase_username: <string>,
    metabase_password: <string>,
    linked_db_user_id: <string>,
    fivetran_api_key: <string>,
    fivetran_api_secret: <string>
)

CreateIntegrationAppRequest(
    Name <string>,
    Type <string>,
    MetabaseHostname <string>,
    MetabaseUsername <string>,
    MetabasePassword <string>,
    LinkedDbUserId <string>,
    FivetranApiKey <string>,
    FivetranApiSecret <string>
)

CreateIntegrationAppRequest

Parameter	Python Attribute	Type
name	name	string
type	type	string
metabaseHostname	metabase_hostname	string
metabaseUsername	metabase_username	string
metabasePassword	metabase_password	string
linkedDbUserId	linked_db_user_id	string
fivetranApiKey	fivetran_api_key	string
fivetranApiSecret	fivetran_api_secret	string

CreateIntegrationAppRequest

Parameter	Python Attribute	Type
name	name	string
type	type	string
metabaseHostname	metabase_hostname	string
metabaseUsername	metabase_username	string
metabasePassword	metabase_password	string
linkedDbUserId	linked_db_user_id	string
fivetranApiKey	fivetran_api_key	string
fivetranApiSecret	fivetran_api_secret	string

DeleteIntegrationApp

curl 'https://adminv2.api.formalcloud.net/admin.v1.AppService/DeleteIntegrationApp' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_app_pb2 import DeleteIntegrationAppRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.AppClient.DeleteIntegrationApp(
    DeleteIntegrationAppRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.AppServiceClient.DeleteIntegrationApp(context.Background(), connect.NewRequest(
        &adminv1.DeleteIntegrationAppRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteIntegrationAppRequest(
    id: <string>
)

DeleteIntegrationAppRequest(
    Id <string>
)

DeleteIntegrationAppRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteIntegrationAppRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

RefreshIntegrationAppsRequest

This message has no parameters.

RefreshIntegrationAppsResponse

This message has no parameters.

GetIntegrationAppsRequest

This message has no parameters.

GetIntegrationAppsResponse

Parameter	Python Attribute	Type	Description	Is Optional
integrations	integrations	types.v1.IntegrationApp array

GetIntegrationByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetIntegrationByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	types.v1.IntegrationApp

CreateIntegrationAppRequest

Parameter	Python Attribute	Type
name	name	string
type	type	string
metabaseHostname	metabase_hostname	string
metabaseUsername	metabase_username	string
metabasePassword	metabase_password	string
linkedDbUserId	linked_db_user_id	string
fivetranApiKey	fivetran_api_key	string
fivetranApiSecret	fivetran_api_secret	string

CreateIntegrationAppResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	types.v1.IntegrationApp

DeleteIntegrationAppRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteIntegrationAppResponse

This message has no parameters.

Cloud Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).CloudClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.CloudServiceClient
}

CreateDataplane

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/CreateDataplane' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "region": <string>, 
    "cloudAccountId": <string>, 
    "availabilityZone": <int32>, 
    "vpcPeering": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import CreateDataplaneRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.CreateDataplane(
    CreateDataplaneRequest("name": <string>, 
        "region": <string>, 
        "cloud_account_id": <string>, 
        "availability_zone": <int32>, 
        "vpc_peering": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.CreateDataplane(context.Background(), connect.NewRequest(
        &adminv1.CreateDataplaneRequest{Name: <string>, 
            Region: <string>, 
            CloudAccountId: <string>, 
            AvailabilityZone: <int32>, 
            VpcPeering: <bool>},
    ))
}

{
    "dataplane": <types.v1.FlatDataplane>
}

CreateDataplaneResponse(
    dataplane: <types.v1.FlatDataplane>
)

CreateDataplaneResponse(
    Dataplane <types.v1.FlatDataplane>
)

CreateDataplaneRequest

Parameter	Python Attribute	Type
name	name	string
region	region	string
cloudAccountId	cloud_account_id	string
availabilityZone	availability_zone	int32
vpcPeering	vpc_peering	bool

CreateDataplaneResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplane	dataplane	types.v1.FlatDataplane

GetDataplaneById

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/GetDataplaneById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import GetDataplaneByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.GetDataplaneById(
    GetDataplaneByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.GetDataplaneById(context.Background(), connect.NewRequest(
        &adminv1.GetDataplaneByIdRequest{Id: <string>},
    ))
}

{
    "dataplane": <types.v1.FlatDataplane>
}

GetDataplaneByIdResponse(
    dataplane: <types.v1.FlatDataplane>
)

GetDataplaneByIdResponse(
    Dataplane <types.v1.FlatDataplane>
)

GetDataplaneByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataplaneByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplane	dataplane	types.v1.FlatDataplane

DeleteDataplane

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/DeleteDataplane' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import DeleteDataplaneRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.DeleteDataplane(
    DeleteDataplaneRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.DeleteDataplane(context.Background(), connect.NewRequest(
        &adminv1.DeleteDataplaneRequest{Id: <string>},
    ))
}

{}

DeleteDataplaneResponse()

DeleteDataplaneResponse()

DeleteDataplaneRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDataplaneResponse

This response has no parameters.

CreateDataplaneRoutes

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/CreateDataplaneRoutes' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataplaneId": <string>, 
    "destinationCidrBlock": <string>, 
    "transitGatewayId": <string>, 
    "vpcPeeringConnectionId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import CreateDataplaneRoutesRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.CreateDataplaneRoutes(
    CreateDataplaneRoutesRequest("dataplane_id": <string>, 
        "destination_cidr_block": <string>, 
        "transit_gateway_id": <string>, 
        "vpc_peering_connection_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.CreateDataplaneRoutes(context.Background(), connect.NewRequest(
        &adminv1.CreateDataplaneRoutesRequest{DataplaneId: <string>, 
            DestinationCidrBlock: <string>, 
            TransitGatewayId: <string>, 
            VpcPeeringConnectionId: <string>},
    ))
}

{
    "dataplaneRoutes": <types.v1.DataplaneTransitGatewayRoutes>
}

CreateDataplaneRoutesResponse(
    dataplane_routes: <types.v1.DataplaneTransitGatewayRoutes>
)

CreateDataplaneRoutesResponse(
    DataplaneRoutes <types.v1.DataplaneTransitGatewayRoutes>
)

CreateDataplaneRoutesRequest

Parameter	Python Attribute	Type
dataplaneId	dataplane_id	string
destinationCidrBlock	destination_cidr_block	string
transitGatewayId	transit_gateway_id	string
vpcPeeringConnectionId	vpc_peering_connection_id	string

CreateDataplaneRoutesResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplaneRoutes	dataplane_routes	types.v1.DataplaneTransitGatewayRoutes

GetDataplaneRoutesById

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/GetDataplaneRoutesById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import GetDataplaneRoutesByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.GetDataplaneRoutesById(
    GetDataplaneRoutesByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.GetDataplaneRoutesById(context.Background(), connect.NewRequest(
        &adminv1.GetDataplaneRoutesByIdRequest{Id: <string>},
    ))
}

{
    "dataplaneRoutes": <types.v1.DataplaneTransitGatewayRoutes>
}

GetDataplaneRoutesByIdResponse(
    dataplane_routes: <types.v1.DataplaneTransitGatewayRoutes>
)

GetDataplaneRoutesByIdResponse(
    DataplaneRoutes <types.v1.DataplaneTransitGatewayRoutes>
)

GetDataplaneRoutesByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataplaneRoutesByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplaneRoutes	dataplane_routes	types.v1.DataplaneTransitGatewayRoutes

DeleteDataplaneRoutes

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/DeleteDataplaneRoutes' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import DeleteDataplaneRoutesRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.DeleteDataplaneRoutes(
    DeleteDataplaneRoutesRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.DeleteDataplaneRoutes(context.Background(), connect.NewRequest(
        &adminv1.DeleteDataplaneRoutesRequest{Id: <string>},
    ))
}

{
    "message": <string>
}

DeleteDataplaneRoutesResponse(
    message: <string>
)

DeleteDataplaneRoutesResponse(
    Message <string>
)

DeleteDataplaneRoutesRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDataplaneRoutesResponse

Parameter	Python Attribute	Type	Description	Is Optional
message	message	string

GetDataplaneStacksByCloudAccountId

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/GetDataplaneStacksByCloudAccountId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "cloudAccountId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import GetDataplaneStacksByCloudAccountIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.GetDataplaneStacksByCloudAccountId(
    GetDataplaneStacksByCloudAccountIdRequest("cloud_account_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.GetDataplaneStacksByCloudAccountId(context.Background(), connect.NewRequest(
        &adminv1.GetDataplaneStacksByCloudAccountIdRequest{CloudAccountId: <string>},
    ))
}

{
    "dataplanes": <types.v1.FlatDataplane[]>
}

GetDataplaneStacksByCloudAccountIdResponse(
    dataplanes: <types.v1.FlatDataplane[]>
)

GetDataplaneStacksByCloudAccountIdResponse(
    Dataplanes <types.v1.FlatDataplane[]>
)

GetDataplaneStacksByCloudAccountIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
cloudAccountId	cloud_account_id	string

GetDataplaneStacksByCloudAccountIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplanes	dataplanes	types.v1.FlatDataplane array

CreateAwsConnectionSession

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/CreateAwsConnectionSession' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "cloudAccountName": <string>, 
    "cloudAccountRegion": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import CreateAwsConnectionSessionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.CreateAwsConnectionSession(
    CreateAwsConnectionSessionRequest("cloud_account_name": <string>, 
        "cloud_account_region": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.CreateAwsConnectionSession(context.Background(), connect.NewRequest(
        &adminv1.CreateAwsConnectionSessionRequest{CloudAccountName: <string>, 
            CloudAccountRegion: <string>},
    ))
}

{
    "cloudIntegration": <types.v1.CloudIntegration>
}

CreateAwsConnectionSessionResponse(
    cloud_integration: <types.v1.CloudIntegration>
)

CreateAwsConnectionSessionResponse(
    CloudIntegration <types.v1.CloudIntegration>
)

CreateAwsConnectionSessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
cloudAccountName	cloud_account_name	string
cloudAccountRegion	cloud_account_region	string

CreateAwsConnectionSessionResponse

Parameter	Python Attribute	Type	Description	Is Optional
cloudIntegration	cloud_integration	types.v1.CloudIntegration

DeleteAwsConnectionSession

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/DeleteAwsConnectionSession' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import DeleteAwsConnectionSessionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.DeleteAwsConnectionSession(
    DeleteAwsConnectionSessionRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.DeleteAwsConnectionSession(context.Background(), connect.NewRequest(
        &adminv1.DeleteAwsConnectionSessionRequest{Id: <string>},
    ))
}

{}

DeleteAwsConnectionSessionResponse()

DeleteAwsConnectionSessionResponse()

DeleteAwsConnectionSessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteAwsConnectionSessionResponse

This response has no parameters.

GetIntegrationsCloudAccountById

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/GetIntegrationsCloudAccountById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import GetIntegrationsCloudAccountByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.GetIntegrationsCloudAccountById(
    GetIntegrationsCloudAccountByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.GetIntegrationsCloudAccountById(context.Background(), connect.NewRequest(
        &adminv1.GetIntegrationsCloudAccountByIdRequest{Id: <string>},
    ))
}

{
    "integration": <types.v1.CloudIntegration>
}

GetIntegrationsCloudAccountByIdResponse(
    integration: <types.v1.CloudIntegration>
)

GetIntegrationsCloudAccountByIdResponse(
    Integration <types.v1.CloudIntegration>
)

GetIntegrationsCloudAccountByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetIntegrationsCloudAccountByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	types.v1.CloudIntegration

GetIntegrationsCloudAccounts

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/GetIntegrationsCloudAccounts' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import GetIntegrationsCloudAccountsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.GetIntegrationsCloudAccounts(
    GetIntegrationsCloudAccountsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.GetIntegrationsCloudAccounts(context.Background(), connect.NewRequest(
        &adminv1.GetIntegrationsCloudAccountsRequest{},
    ))
}

{
    "integrations": <types.v1.CloudIntegration[]>
}

GetIntegrationsCloudAccountsResponse(
    integrations: <types.v1.CloudIntegration[]>
)

GetIntegrationsCloudAccountsResponse(
    Integrations <types.v1.CloudIntegration[]>
)

GetIntegrationsCloudAccountsRequest

This request has no parameters.

GetIntegrationsCloudAccountsResponse

Parameter	Python Attribute	Type	Description	Is Optional
integrations	integrations	types.v1.CloudIntegration array

CreateGcpConnectionSession

curl 'https://adminv2.api.formalcloud.net/admin.v1.CloudService/CreateGcpConnectionSession' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "projectId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_cloud_pb2 import CreateGcpConnectionSessionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CloudClient.CreateGcpConnectionSession(
    CreateGcpConnectionSessionRequest("project_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CloudServiceClient.CreateGcpConnectionSession(context.Background(), connect.NewRequest(
        &adminv1.CreateGcpConnectionSessionRequest{ProjectId: <string>},
    ))
}

{}

CreateGcpConnectionSessionResponse()

CreateGcpConnectionSessionResponse()

CreateGcpConnectionSessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
projectId	project_id	string

CreateGcpConnectionSessionResponse

This response has no parameters.

CreateDataplaneRequest

Parameter	Python Attribute	Type
name	name	string
region	region	string
cloudAccountId	cloud_account_id	string
availabilityZone	availability_zone	int32
vpcPeering	vpc_peering	bool

CreateDataplaneResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplane	dataplane	types.v1.FlatDataplane

GetDataplaneByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataplaneByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplane	dataplane	types.v1.FlatDataplane

DeleteDataplaneRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDataplaneResponse

This message has no parameters.

CreateDataplaneRoutesRequest

Parameter	Python Attribute	Type
dataplaneId	dataplane_id	string
destinationCidrBlock	destination_cidr_block	string
transitGatewayId	transit_gateway_id	string
vpcPeeringConnectionId	vpc_peering_connection_id	string

CreateDataplaneRoutesResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplaneRoutes	dataplane_routes	types.v1.DataplaneTransitGatewayRoutes

GetDataplaneRoutesByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataplaneRoutesByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplaneRoutes	dataplane_routes	types.v1.DataplaneTransitGatewayRoutes

DeleteDataplaneRoutesRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDataplaneRoutesResponse

Parameter	Python Attribute	Type	Description	Is Optional
message	message	string

CreateAwsConnectionSessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
cloudAccountName	cloud_account_name	string
cloudAccountRegion	cloud_account_region	string

CreateAwsConnectionSessionResponse

Parameter	Python Attribute	Type	Description	Is Optional
cloudIntegration	cloud_integration	types.v1.CloudIntegration

DeleteAwsConnectionSessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetIntegrationsCloudAccountByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetIntegrationsCloudAccountByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	types.v1.CloudIntegration

GetIntegrationsCloudAccountsRequest

This message has no parameters.

GetIntegrationsCloudAccountsResponse

Parameter	Python Attribute	Type	Description	Is Optional
integrations	integrations	types.v1.CloudIntegration array

CreateGcpConnectionSessionRequest

Parameter	Python Attribute	Type	Description	Is Optional
projectId	project_id	string

CreateGcpConnectionSessionResponse

This message has no parameters.

DeleteAwsConnectionSessionResponse

This message has no parameters.

GetDataplaneStacksByCloudAccountIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
cloudAccountId	cloud_account_id	string

GetDataplaneStacksByCloudAccountIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
dataplanes	dataplanes	types.v1.FlatDataplane array

CodeRepository Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).CodeRepositoryClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.CodeRepositoryServiceClient
}

DeleteCodeRepoById

curl 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/DeleteCodeRepoById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_code_repository_pb2 import DeleteCodeRepoByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CodeRepositoryClient.DeleteCodeRepoById(
    DeleteCodeRepoByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CodeRepositoryServiceClient.DeleteCodeRepoById(context.Background(), connect.NewRequest(
        &adminv1.DeleteCodeRepoByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteCodeRepoByIdRequest(
    id: <string>
)

DeleteCodeRepoByIdRequest(
    Id <string>
)

DeleteCodeRepoByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteCodeRepoByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CancelDeleteCodeRepoById

curl 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/CancelDeleteCodeRepoById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_code_repository_pb2 import CancelDeleteCodeRepoByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CodeRepositoryClient.CancelDeleteCodeRepoById(
    CancelDeleteCodeRepoByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CodeRepositoryServiceClient.CancelDeleteCodeRepoById(context.Background(), connect.NewRequest(
        &adminv1.CancelDeleteCodeRepoByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

CancelDeleteCodeRepoByIdRequest(
    id: <string>
)

CancelDeleteCodeRepoByIdRequest(
    Id <string>
)

CancelDeleteCodeRepoByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CancelDeleteCodeRepoByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

ConnectCodeRepository

curl 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/ConnectCodeRepository' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "userId": <string>, 
    "type": <string>, 
    "code": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_code_repository_pb2 import ConnectCodeRepositoryRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CodeRepositoryClient.ConnectCodeRepository(
    ConnectCodeRepositoryRequest("user_id": <string>, 
        "type": <string>, 
        "code": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CodeRepositoryServiceClient.ConnectCodeRepository(context.Background(), connect.NewRequest(
        &adminv1.ConnectCodeRepositoryRequest{UserId: <string>, 
            Type: <string>, 
            Code: <string>},
    ))
}

{
    "userId": <string>,
    "type": <string>,
    "code": <string>
}

ConnectCodeRepositoryRequest(
    user_id: <string>,
    type: <string>,
    code: <string>
)

ConnectCodeRepositoryRequest(
    UserId <string>,
    Type <string>,
    Code <string>
)

ConnectCodeRepositoryRequest

Parameter	Python Attribute	Type
userId	user_id	string
type	type	string
code	code	string

ConnectCodeRepositoryRequest

Parameter	Python Attribute	Type
userId	user_id	string
type	type	string
code	code	string

GetAccessToken

curl 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/GetAccessToken' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "userId": <string>, 
    "type": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_code_repository_pb2 import GetAccessTokenRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CodeRepositoryClient.GetAccessToken(
    GetAccessTokenRequest("user_id": <string>, 
        "type": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CodeRepositoryServiceClient.GetAccessToken(context.Background(), connect.NewRequest(
        &adminv1.GetAccessTokenRequest{UserId: <string>, 
            Type: <string>},
    ))
}

{
    "accessToken": <string>
}

GetAccessTokenResponse(
    access_token: <string>
)

GetAccessTokenResponse(
    AccessToken <string>
)

GetAccessTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
userId	user_id	string
type	type	string

GetAccessTokenResponse

Parameter	Python Attribute	Type	Description	Is Optional
accessToken	access_token	string

GetGithubRepositoriesFromAuthUser

curl 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/GetGithubRepositoriesFromAuthUser' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "userId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_code_repository_pb2 import GetGithubRepositoriesFromAuthUserRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CodeRepositoryClient.GetGithubRepositoriesFromAuthUser(
    GetGithubRepositoriesFromAuthUserRequest("user_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CodeRepositoryServiceClient.GetGithubRepositoriesFromAuthUser(context.Background(), connect.NewRequest(
        &adminv1.GetGithubRepositoriesFromAuthUserRequest{UserId: <string>},
    ))
}

{
    "userId": <string>
}

GetGithubRepositoriesFromAuthUserRequest(
    user_id: <string>
)

GetGithubRepositoriesFromAuthUserRequest(
    UserId <string>
)

GetGithubRepositoriesFromAuthUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
userId	user_id	string

GetGithubRepositoriesFromAuthUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
userId	user_id	string

GetUserAccessToken

curl 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/GetUserAccessToken' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "userId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_code_repository_pb2 import GetUserAccessTokenRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CodeRepositoryClient.GetUserAccessToken(
    GetUserAccessTokenRequest("user_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CodeRepositoryServiceClient.GetUserAccessToken(context.Background(), connect.NewRequest(
        &adminv1.GetUserAccessTokenRequest{UserId: <string>},
    ))
}

{
    "userId": <string>
}

GetUserAccessTokenRequest(
    user_id: <string>
)

GetUserAccessTokenRequest(
    UserId <string>
)

GetUserAccessTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
userId	user_id	string

GetUserAccessTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
userId	user_id	string

GetCodeRepos

curl 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/GetCodeRepos' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_code_repository_pb2 import GetCodeReposRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CodeRepositoryClient.GetCodeRepos(
    GetCodeReposRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CodeRepositoryServiceClient.GetCodeRepos(context.Background(), connect.NewRequest(
        &adminv1.GetCodeReposRequest{},
    ))
}

{
    "repositories": <types.v1.CodeRepo[]>
}

GetCodeReposResponse(
    repositories: <types.v1.CodeRepo[]>
)

GetCodeReposResponse(
    Repositories <types.v1.CodeRepo[]>
)

GetCodeReposRequest

This request has no parameters.

GetCodeReposResponse

Parameter	Python Attribute	Type	Description	Is Optional
repositories	repositories	types.v1.CodeRepo array

CreateCodeRepo

curl 'https://adminv2.api.formalcloud.net/admin.v1.CodeRepositoryService/CreateCodeRepo' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "repository": <types.v1.CodeRepo>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_code_repository_pb2 import CreateCodeRepoRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.CodeRepositoryClient.CreateCodeRepo(
    CreateCodeRepoRequest("repository": <types.v1.CodeRepo>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.CodeRepositoryServiceClient.CreateCodeRepo(context.Background(), connect.NewRequest(
        &adminv1.CreateCodeRepoRequest{Repository: <types.v1.CodeRepo>},
    ))
}

{}

CreateCodeRepoResponse()

CreateCodeRepoResponse()

CreateCodeRepoRequest

Parameter	Python Attribute	Type	Description	Is Optional
repository	repository	types.v1.CodeRepo

CreateCodeRepoResponse

This response has no parameters.

DeleteCodeRepoByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteCodeRepoByIdResponse

This message has no parameters.

CancelDeleteCodeRepoByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CancelDeleteCodeRepoByIdResponse

This message has no parameters.

ConnectCodeRepositoryRequest

Parameter	Python Attribute	Type
userId	user_id	string
type	type	string
code	code	string

ConnectCodeRepositoryResponse

Parameter	Python Attribute	Type	Description	Is Optional
accessToken	access_token	string

GetAccessTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
userId	user_id	string
type	type	string

GetAccessTokenResponse

Parameter	Python Attribute	Type	Description	Is Optional
accessToken	access_token	string

GetGithubRepositoriesFromAuthUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
userId	user_id	string

GetGithubRepositoriesFromAuthUserResponse

Parameter	Python Attribute	Type	Description	Is Optional
repositories	repositories	types.v1.GithubRepository array

GetUserAccessTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
userId	user_id	string

GetUserAccessTokenResponse

Parameter	Python Attribute	Type	Description	Is Optional
accessToken	access_token	string

GetCodeReposRequest

This message has no parameters.

GetCodeReposResponse

Parameter	Python Attribute	Type	Description	Is Optional
repositories	repositories	types.v1.CodeRepo array

CreateCodeRepoRequest

Parameter	Python Attribute	Type	Description	Is Optional
repository	repository	types.v1.CodeRepo

CreateCodeRepoResponse

This message has no parameters.

Datahub Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.DatahubService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).DatahubClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.DatahubServiceClient
}

CreateDatahubIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.DatahubService/CreateDatahubIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    ":": <in>, 
    "generalizedMetadataServiceUrl": <string>, 
    "active": <bool>, 
    "apiKey": <string>, 
    "syncedEntities": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_datahub_pb2 import CreateDatahubIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DatahubClient.CreateDatahubIntegration(
    CreateDatahubIntegrationRequest(":": <in>, 
        "generalized_metadata_service_url": <string>, 
        "active": <bool>, 
        "api_key": <string>, 
        "synced_entities": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DatahubServiceClient.CreateDatahubIntegration(context.Background(), connect.NewRequest(
        &adminv1.CreateDatahubIntegrationRequest{:: <in>, 
            GeneralizedMetadataServiceUrl: <string>, 
            Active: <bool>, 
            ApiKey: <string>, 
            SyncedEntities: <string[]>},
    ))
}

{
    ":": <in>,
    "generalizedMetadataServiceUrl": <string>,
    "active": <bool>,
    "apiKey": <string>,
    "syncedEntities": <string[]>
}

CreateDatahubIntegrationRequest(
    :: <in>,
    generalized_metadata_service_url: <string>,
    active: <bool>,
    api_key: <string>,
    synced_entities: <string[]>
)

CreateDatahubIntegrationRequest(
    : <in>,
    GeneralizedMetadataServiceUrl <string>,
    Active <bool>,
    ApiKey <string>,
    SyncedEntities <string[]>
)

CreateDatahubIntegrationRequest

Parameter	Python Attribute	Type
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

CreateDatahubIntegrationRequest

Parameter	Python Attribute	Type
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

GetDatahubIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.DatahubService/GetDatahubIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "integration": <types.v1.Datahub>, 
    "id": <string>, 
    ":": <in>, 
    "generalizedMetadataServiceUrl": <string>, 
    "active": <bool>, 
    "apiKey": <string>, 
    "syncedEntities": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_datahub_pb2 import GetDatahubIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DatahubClient.GetDatahubIntegration(
    GetDatahubIntegrationRequest("integration": <types.v1.Datahub>, 
        "id": <string>, 
        ":": <in>, 
        "generalized_metadata_service_url": <string>, 
        "active": <bool>, 
        "api_key": <string>, 
        "synced_entities": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DatahubServiceClient.GetDatahubIntegration(context.Background(), connect.NewRequest(
        &adminv1.GetDatahubIntegrationRequest{Integration: <types.v1.Datahub>, 
            Id: <string>, 
            :: <in>, 
            GeneralizedMetadataServiceUrl: <string>, 
            Active: <bool>, 
            ApiKey: <string>, 
            SyncedEntities: <string[]>},
    ))
}

{
    "integration": <types.v1.Datahub>,
    "id": <string>,
    ":": <in>,
    "generalizedMetadataServiceUrl": <string>,
    "active": <bool>,
    "apiKey": <string>,
    "syncedEntities": <string[]>
}

GetDatahubIntegrationRequest(
    integration: <types.v1.Datahub>,
    id: <string>,
    :: <in>,
    generalized_metadata_service_url: <string>,
    active: <bool>,
    api_key: <string>,
    synced_entities: <string[]>
)

GetDatahubIntegrationRequest(
    Integration <types.v1.Datahub>,
    Id <string>,
    : <in>,
    GeneralizedMetadataServiceUrl <string>,
    Active <bool>,
    ApiKey <string>,
    SyncedEntities <string[]>
)

GetDatahubIntegrationRequest

Parameter	Python Attribute	Type
integration	integration	types.v1.Datahub
id	id	string
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

GetDatahubIntegrationRequest

Parameter	Python Attribute	Type
integration	integration	types.v1.Datahub
id	id	string
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

UpdateDatahubIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.DatahubService/UpdateDatahubIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    ":": <in>, 
    "generalizedMetadataServiceUrl": <string>, 
    "active": <bool>, 
    "apiKey": <string>, 
    "syncedEntities": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_datahub_pb2 import UpdateDatahubIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DatahubClient.UpdateDatahubIntegration(
    UpdateDatahubIntegrationRequest("id": <string>, 
        ":": <in>, 
        "generalized_metadata_service_url": <string>, 
        "active": <bool>, 
        "api_key": <string>, 
        "synced_entities": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DatahubServiceClient.UpdateDatahubIntegration(context.Background(), connect.NewRequest(
        &adminv1.UpdateDatahubIntegrationRequest{Id: <string>, 
            :: <in>, 
            GeneralizedMetadataServiceUrl: <string>, 
            Active: <bool>, 
            ApiKey: <string>, 
            SyncedEntities: <string[]>},
    ))
}

{
    "id": <string>,
    ":": <in>,
    "generalizedMetadataServiceUrl": <string>,
    "active": <bool>,
    "apiKey": <string>,
    "syncedEntities": <string[]>
}

UpdateDatahubIntegrationRequest(
    id: <string>,
    :: <in>,
    generalized_metadata_service_url: <string>,
    active: <bool>,
    api_key: <string>,
    synced_entities: <string[]>
)

UpdateDatahubIntegrationRequest(
    Id <string>,
    : <in>,
    GeneralizedMetadataServiceUrl <string>,
    Active <bool>,
    ApiKey <string>,
    SyncedEntities <string[]>
)

UpdateDatahubIntegrationRequest

Parameter	Python Attribute	Type
id	id	string
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

UpdateDatahubIntegrationRequest

Parameter	Python Attribute	Type
id	id	string
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

RefreshWebhookToken

curl 'https://adminv2.api.formalcloud.net/admin.v1.DatahubService/RefreshWebhookToken' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_datahub_pb2 import RefreshWebhookTokenRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DatahubClient.RefreshWebhookToken(
    RefreshWebhookTokenRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DatahubServiceClient.RefreshWebhookToken(context.Background(), connect.NewRequest(
        &adminv1.RefreshWebhookTokenRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

RefreshWebhookTokenRequest(
    id: <string>
)

RefreshWebhookTokenRequest(
    Id <string>
)

RefreshWebhookTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

RefreshWebhookTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDatahubIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.DatahubService/DeleteDatahubIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_datahub_pb2 import DeleteDatahubIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DatahubClient.DeleteDatahubIntegration(
    DeleteDatahubIntegrationRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DatahubServiceClient.DeleteDatahubIntegration(context.Background(), connect.NewRequest(
        &adminv1.DeleteDatahubIntegrationRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteDatahubIntegrationRequest(
    id: <string>
)

DeleteDatahubIntegrationRequest(
    Id <string>
)

DeleteDatahubIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDatahubIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CreateDatahubIntegrationRequest

Parameter	Python Attribute	Type
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

CreateDatahubIntegrationResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDatahubIntegrationRequest

Parameter	Python Attribute	Type
integration	integration	types.v1.Datahub
id	id	string
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

GetDatahubIntegrationResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	types.v1.Datahub

UpdateDatahubIntegrationRequest

Parameter	Python Attribute	Type
id	id	string
:	:	in
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
active	active	bool
apiKey	api_key	string
syncedEntities	synced_entities	string array

UpdateDatahubIntegrationResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	types.v1.Datahub

RefreshWebhookTokenRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

RefreshWebhookTokenResponse

Parameter	Python Attribute	Type	Description	Is Optional
token	token	string

DeleteDatahubIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDatahubIntegrationResponse

This message has no parameters.

ExternalApi Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.ExternalApiService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).ExternalApiClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.ExternalApiServiceClient
}

CreateExternalApiIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.ExternalApiService/CreateExternalApiIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "type": <string>, 
    "auth": <Auth>, 
    "id": <string>, 
    "type": <string>, 
    "authType": <string>, 
    "createdAt": <google.protobuf.Timestamp>, 
    "updatedAt": <google.protobuf.Timestamp>, 
    "integration": <ApiIntegration>, 
    "integrations": <ApiIntegration[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_external_api_pb2 import CreateExternalApiIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ExternalApiClient.CreateExternalApiIntegration(
    CreateExternalApiIntegrationRequest("type": <string>, 
        "auth": <Auth>, 
        "id": <string>, 
        "type": <string>, 
        "auth_type": <string>, 
        "created_at": <google.protobuf.Timestamp>, 
        "updated_at": <google.protobuf.Timestamp>, 
        "integration": <ApiIntegration>, 
        "integrations": <ApiIntegration[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ExternalApiServiceClient.CreateExternalApiIntegration(context.Background(), connect.NewRequest(
        &adminv1.CreateExternalApiIntegrationRequest{Type: <string>, 
            Auth: <Auth>, 
            Id: <string>, 
            Type: <string>, 
            AuthType: <string>, 
            CreatedAt: <google.protobuf.Timestamp>, 
            UpdatedAt: <google.protobuf.Timestamp>, 
            Integration: <ApiIntegration>, 
            Integrations: <ApiIntegration[]>},
    ))
}

{
    "type": <string>,
    "auth": <Auth>,
    "id": <string>,
    "type": <string>,
    "authType": <string>,
    "createdAt": <google.protobuf.Timestamp>,
    "updatedAt": <google.protobuf.Timestamp>,
    "integration": <ApiIntegration>,
    "integrations": <ApiIntegration[]>
}

CreateExternalApiIntegrationRequest(
    type: <string>,
    auth: <Auth>,
    id: <string>,
    type: <string>,
    auth_type: <string>,
    created_at: <google.protobuf.Timestamp>,
    updated_at: <google.protobuf.Timestamp>,
    integration: <ApiIntegration>,
    integrations: <ApiIntegration[]>
)

CreateExternalApiIntegrationRequest(
    Type <string>,
    Auth <Auth>,
    Id <string>,
    Type <string>,
    AuthType <string>,
    CreatedAt <google.protobuf.Timestamp>,
    UpdatedAt <google.protobuf.Timestamp>,
    Integration <ApiIntegration>,
    Integrations <ApiIntegration[]>
)

CreateExternalApiIntegrationRequest

Parameter	Python Attribute	Type
type	type	string
auth	auth	Auth
id	id	string
type	type	string
authType	auth_type	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
integration	integration	ApiIntegration
integrations	integrations	ApiIntegration array

CreateExternalApiIntegrationRequest

Parameter	Python Attribute	Type
type	type	string
auth	auth	Auth
id	id	string
type	type	string
authType	auth_type	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
integration	integration	ApiIntegration
integrations	integrations	ApiIntegration array

GetExternalApiIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.ExternalApiService/GetExternalApiIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "integration": <ApiIntegration>, 
    "integrations": <ApiIntegration[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_external_api_pb2 import GetExternalApiIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ExternalApiClient.GetExternalApiIntegration(
    GetExternalApiIntegrationRequest("integration": <ApiIntegration>, 
        "integrations": <ApiIntegration[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ExternalApiServiceClient.GetExternalApiIntegration(context.Background(), connect.NewRequest(
        &adminv1.GetExternalApiIntegrationRequest{Integration: <ApiIntegration>, 
            Integrations: <ApiIntegration[]>},
    ))
}

{
    "integration": <ApiIntegration>,
    "integrations": <ApiIntegration[]>
}

GetExternalApiIntegrationRequest(
    integration: <ApiIntegration>,
    integrations: <ApiIntegration[]>
)

GetExternalApiIntegrationRequest(
    Integration <ApiIntegration>,
    Integrations <ApiIntegration[]>
)

GetExternalApiIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	ApiIntegration
integrations	integrations	ApiIntegration array

GetExternalApiIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	ApiIntegration
integrations	integrations	ApiIntegration array

DeleteExternalApiIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.ExternalApiService/DeleteExternalApiIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "integrations": <ApiIntegration[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_external_api_pb2 import DeleteExternalApiIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ExternalApiClient.DeleteExternalApiIntegration(
    DeleteExternalApiIntegrationRequest("integrations": <ApiIntegration[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ExternalApiServiceClient.DeleteExternalApiIntegration(context.Background(), connect.NewRequest(
        &adminv1.DeleteExternalApiIntegrationRequest{Integrations: <ApiIntegration[]>},
    ))
}

{
    "integrations": <ApiIntegration[]>
}

DeleteExternalApiIntegrationRequest(
    integrations: <ApiIntegration[]>
)

DeleteExternalApiIntegrationRequest(
    Integrations <ApiIntegration[]>
)

DeleteExternalApiIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
integrations	integrations	ApiIntegration array

DeleteExternalApiIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
integrations	integrations	ApiIntegration array

GetExternalApiIntegrations

curl 'https://adminv2.api.formalcloud.net/admin.v1.ExternalApiService/GetExternalApiIntegrations' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_external_api_pb2 import GetExternalApiIntegrationsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.ExternalApiClient.GetExternalApiIntegrations(
    GetExternalApiIntegrationsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.ExternalApiServiceClient.GetExternalApiIntegrations(context.Background(), connect.NewRequest(
        &adminv1.GetExternalApiIntegrationsRequest{},
    ))
}

{}

GetExternalApiIntegrationsRequest()

GetExternalApiIntegrationsRequest()

GetExternalApiIntegrationsRequest

This request has no parameters.

GetExternalApiIntegrationsRequest

This response has no parameters.

Auth

Parameter	Python Attribute	Type
username	username	string
password	password	string
basic	basic	Basic

Basic

Parameter	Python Attribute	Type	Description	Is Optional
username	username	string
password	password	string

CreateExternalApiIntegrationRequest

Parameter	Python Attribute	Type
type	type	string
auth	auth	Auth
id	id	string
type	type	string
authType	auth_type	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
integration	integration	ApiIntegration
integrations	integrations	ApiIntegration array

CreateExternalApiIntegrationResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

ApiIntegration

Parameter	Python Attribute	Type
type	type	string
authType	auth_type	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
integration	integration	ApiIntegration
integrations	integrations	ApiIntegration array

GetExternalApiIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	ApiIntegration
integrations	integrations	ApiIntegration array

GetExternalApiIntegrationResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	ApiIntegration

DeleteExternalApiIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
integrations	integrations	ApiIntegration array

DeleteExternalApiIntegrationResponse

This message has no parameters.

GetExternalApiIntegrationsRequest

This message has no parameters.

GetExternalApiIntegrationsResponse

Parameter	Python Attribute	Type	Description	Is Optional
integrations	integrations	ApiIntegration array

Github Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.GithubService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).GithubClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.GithubServiceClient
}

InstallGithubApp

curl 'https://adminv2.api.formalcloud.net/admin.v1.GithubService/InstallGithubApp' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "installationId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_github_pb2 import InstallGithubAppRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GithubClient.InstallGithubApp(
    InstallGithubAppRequest("installation_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GithubServiceClient.InstallGithubApp(context.Background(), connect.NewRequest(
        &adminv1.InstallGithubAppRequest{InstallationId: <string>},
    ))
}

{
    "installationId": <string>
}

InstallGithubAppRequest(
    installation_id: <string>
)

InstallGithubAppRequest(
    InstallationId <string>
)

InstallGithubAppRequest

Parameter	Python Attribute	Type	Description	Is Optional
installationId	installation_id	string

InstallGithubAppRequest

Parameter	Python Attribute	Type	Description	Is Optional
installationId	installation_id	string

GetGithubAppForOrg

curl 'https://adminv2.api.formalcloud.net/admin.v1.GithubService/GetGithubAppForOrg' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_github_pb2 import GetGithubAppForOrgRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.GithubClient.GetGithubAppForOrg(
    GetGithubAppForOrgRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.GithubServiceClient.GetGithubAppForOrg(context.Background(), connect.NewRequest(
        &adminv1.GetGithubAppForOrgRequest{},
    ))
}

{}

GetGithubAppForOrgRequest()

GetGithubAppForOrgRequest()

GetGithubAppForOrgRequest

This request has no parameters.

GetGithubAppForOrgRequest

This response has no parameters.

InstallGithubAppRequest

Parameter	Python Attribute	Type	Description	Is Optional
installationId	installation_id	string

InstallGithubAppResponse

This message has no parameters.

GetGithubAppForOrgRequest

This message has no parameters.

GetGithubAppForOrgResponse

Parameter	Python Attribute	Type	Description	Is Optional
message	message	string

Kms Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.KmsService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).KmsClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.KmsServiceClient
}

CreateKeyRegistration

curl 'https://adminv2.api.formalcloud.net/admin.v1.KmsService/CreateKeyRegistration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "cloudRegion": <string>, 
    "keyId": <string>, 
    "managedBy": <string>, 
    "keyType": <string>, 
    "keyName": <string>, 
    "cloudAccountId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_kms_pb2 import CreateKeyRegistrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.KmsClient.CreateKeyRegistration(
    CreateKeyRegistrationRequest("cloud_region": <string>, 
        "key_id": <string>, 
        "managed_by": <string>, 
        "key_type": <string>, 
        "key_name": <string>, 
        "cloud_account_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.KmsServiceClient.CreateKeyRegistration(context.Background(), connect.NewRequest(
        &adminv1.CreateKeyRegistrationRequest{CloudRegion: <string>, 
            KeyId: <string>, 
            ManagedBy: <string>, 
            KeyType: <string>, 
            KeyName: <string>, 
            CloudAccountId: <string>},
    ))
}

{
    "cloudRegion": <string>,
    "keyId": <string>,
    "managedBy": <string>,
    "keyType": <string>,
    "keyName": <string>,
    "cloudAccountId": <string>
}

CreateKeyRegistrationRequest(
    cloud_region: <string>,
    key_id: <string>,
    managed_by: <string>,
    key_type: <string>,
    key_name: <string>,
    cloud_account_id: <string>
)

CreateKeyRegistrationRequest(
    CloudRegion <string>,
    KeyId <string>,
    ManagedBy <string>,
    KeyType <string>,
    KeyName <string>,
    CloudAccountId <string>
)

CreateKeyRegistrationRequest

Parameter	Python Attribute	Type
cloudRegion	cloud_region	string
keyId	key_id	string
managedBy	managed_by	string
keyType	key_type	string
keyName	key_name	string
cloudAccountId	cloud_account_id	string

CreateKeyRegistrationRequest

Parameter	Python Attribute	Type
cloudRegion	cloud_region	string
keyId	key_id	string
managedBy	managed_by	string
keyType	key_type	string
keyName	key_name	string
cloudAccountId	cloud_account_id	string

GetKeys

curl 'https://adminv2.api.formalcloud.net/admin.v1.KmsService/GetKeys' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "filterByStatus": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_kms_pb2 import GetKeysRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.KmsClient.GetKeys(
    GetKeysRequest("filter_by_status": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.KmsServiceClient.GetKeys(context.Background(), connect.NewRequest(
        &adminv1.GetKeysRequest{FilterByStatus: <string>},
    ))
}

{
    "keys": <types.v1.Key[]>
}

GetKeysResponse(
    keys: <types.v1.Key[]>
)

GetKeysResponse(
    Keys <types.v1.Key[]>
)

GetKeysRequest

Parameter	Python Attribute	Type	Description	Is Optional
filterByStatus	filter_by_status	string

GetKeysResponse

Parameter	Python Attribute	Type	Description	Is Optional
keys	keys	types.v1.Key array

GetKey

curl 'https://adminv2.api.formalcloud.net/admin.v1.KmsService/GetKey' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_kms_pb2 import GetKeyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.KmsClient.GetKey(
    GetKeyRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.KmsServiceClient.GetKey(context.Background(), connect.NewRequest(
        &adminv1.GetKeyRequest{Id: <string>},
    ))
}

{
    "key": <types.v1.Key>
}

GetKeyResponse(
    key: <types.v1.Key>
)

GetKeyResponse(
    Key <types.v1.Key>
)

GetKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetKeyResponse

Parameter	Python Attribute	Type	Description	Is Optional
key	key	types.v1.Key

DeactivateFieldEncryptionKey

curl 'https://adminv2.api.formalcloud.net/admin.v1.KmsService/DeactivateFieldEncryptionKey' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_kms_pb2 import DeactivateFieldEncryptionKeyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.KmsClient.DeactivateFieldEncryptionKey(
    DeactivateFieldEncryptionKeyRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.KmsServiceClient.DeactivateFieldEncryptionKey(context.Background(), connect.NewRequest(
        &adminv1.DeactivateFieldEncryptionKeyRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeactivateFieldEncryptionKeyRequest(
    id: <string>
)

DeactivateFieldEncryptionKeyRequest(
    Id <string>
)

DeactivateFieldEncryptionKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeactivateFieldEncryptionKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CreateKeyRegistrationRequest

Parameter	Python Attribute	Type
cloudRegion	cloud_region	string
keyId	key_id	string
managedBy	managed_by	string
keyType	key_type	string
keyName	key_name	string
cloudAccountId	cloud_account_id	string

CreateKeyRegistrationResponse

Parameter	Python Attribute	Type	Description	Is Optional
key	key	types.v1.Key

GetKeysRequest

Parameter	Python Attribute	Type	Description	Is Optional
filterByStatus	filter_by_status	string

GetKeysResponse

Parameter	Python Attribute	Type	Description	Is Optional
keys	keys	types.v1.Key array

GetKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetKeyResponse

Parameter	Python Attribute	Type	Description	Is Optional
key	key	types.v1.Key

DeactivateFieldEncryptionKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeactivateFieldEncryptionKeyResponse

This message has no parameters.

Logs Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.LogsService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).LogsClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.LogsServiceClient
}

CreateIntegrationLogs

curl 'https://adminv2.api.formalcloud.net/admin.v1.LogsService/CreateIntegrationLogs' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "type": <string>, 
    "ddSite": <string>, 
    "ddApiKey": <string>, 
    "ddAccountId": <string>, 
    "splunkUrl": <string>, 
    "splunkApiKey": <string>, 
    "awsAccessKeyId": <string>, 
    "awsSecretAccessKey": <string>, 
    "awsRegion": <string>, 
    "awsS3Bucket": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_log_pb2 import CreateIntegrationLogsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.LogsClient.CreateIntegrationLogs(
    CreateIntegrationLogsRequest("name": <string>, 
        "type": <string>, 
        "dd_site": <string>, 
        "dd_api_key": <string>, 
        "dd_account_id": <string>, 
        "splunk_url": <string>, 
        "splunk_api_key": <string>, 
        "aws_access_key_id": <string>, 
        "aws_secret_access_key": <string>, 
        "aws_region": <string>, 
        "aws_s3_bucket": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.LogsServiceClient.CreateIntegrationLogs(context.Background(), connect.NewRequest(
        &adminv1.CreateIntegrationLogsRequest{Name: <string>, 
            Type: <string>, 
            DdSite: <string>, 
            DdApiKey: <string>, 
            DdAccountId: <string>, 
            SplunkUrl: <string>, 
            SplunkApiKey: <string>, 
            AwsAccessKeyId: <string>, 
            AwsSecretAccessKey: <string>, 
            AwsRegion: <string>, 
            AwsS3Bucket: <string>},
    ))
}

{
    "name": <string>,
    "type": <string>,
    "ddSite": <string>,
    "ddApiKey": <string>,
    "ddAccountId": <string>,
    "splunkUrl": <string>,
    "splunkApiKey": <string>,
    "awsAccessKeyId": <string>,
    "awsSecretAccessKey": <string>,
    "awsRegion": <string>,
    "awsS3Bucket": <string>
}

CreateIntegrationLogsRequest(
    name: <string>,
    type: <string>,
    dd_site: <string>,
    dd_api_key: <string>,
    dd_account_id: <string>,
    splunk_url: <string>,
    splunk_api_key: <string>,
    aws_access_key_id: <string>,
    aws_secret_access_key: <string>,
    aws_region: <string>,
    aws_s3_bucket: <string>
)

CreateIntegrationLogsRequest(
    Name <string>,
    Type <string>,
    DdSite <string>,
    DdApiKey <string>,
    DdAccountId <string>,
    SplunkUrl <string>,
    SplunkApiKey <string>,
    AwsAccessKeyId <string>,
    AwsSecretAccessKey <string>,
    AwsRegion <string>,
    AwsS3Bucket <string>
)

CreateIntegrationLogsRequest

Parameter	Python Attribute	Type
name	name	string
type	type	string
ddSite	dd_site	string
ddApiKey	dd_api_key	string
ddAccountId	dd_account_id	string
splunkUrl	splunk_url	string
splunkApiKey	splunk_api_key	string
awsAccessKeyId	aws_access_key_id	string
awsSecretAccessKey	aws_secret_access_key	string
awsRegion	aws_region	string
awsS3Bucket	aws_s3_bucket	string

CreateIntegrationLogsRequest

Parameter	Python Attribute	Type
name	name	string
type	type	string
ddSite	dd_site	string
ddApiKey	dd_api_key	string
ddAccountId	dd_account_id	string
splunkUrl	splunk_url	string
splunkApiKey	splunk_api_key	string
awsAccessKeyId	aws_access_key_id	string
awsSecretAccessKey	aws_secret_access_key	string
awsRegion	aws_region	string
awsS3Bucket	aws_s3_bucket	string

GetIntegrationLogs

curl 'https://adminv2.api.formalcloud.net/admin.v1.LogsService/GetIntegrationLogs' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_log_pb2 import GetIntegrationLogsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.LogsClient.GetIntegrationLogs(
    GetIntegrationLogsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.LogsServiceClient.GetIntegrationLogs(context.Background(), connect.NewRequest(
        &adminv1.GetIntegrationLogsRequest{},
    ))
}

{}

GetIntegrationLogsRequest()

GetIntegrationLogsRequest()

GetIntegrationLogsRequest

This request has no parameters.

GetIntegrationLogsRequest

This response has no parameters.

GetIntegrationLogById

curl 'https://adminv2.api.formalcloud.net/admin.v1.LogsService/GetIntegrationLogById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_log_pb2 import GetIntegrationLogByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.LogsClient.GetIntegrationLogById(
    GetIntegrationLogByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.LogsServiceClient.GetIntegrationLogById(context.Background(), connect.NewRequest(
        &adminv1.GetIntegrationLogByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetIntegrationLogByIdRequest(
    id: <string>
)

GetIntegrationLogByIdRequest(
    Id <string>
)

GetIntegrationLogByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetIntegrationLogByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteIntegrationLogs

curl 'https://adminv2.api.formalcloud.net/admin.v1.LogsService/DeleteIntegrationLogs' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_log_pb2 import DeleteIntegrationLogsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.LogsClient.DeleteIntegrationLogs(
    DeleteIntegrationLogsRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.LogsServiceClient.DeleteIntegrationLogs(context.Background(), connect.NewRequest(
        &adminv1.DeleteIntegrationLogsRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteIntegrationLogsRequest(
    id: <string>
)

DeleteIntegrationLogsRequest(
    Id <string>
)

DeleteIntegrationLogsRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteIntegrationLogsRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CreateLogsLinkItem

curl 'https://adminv2.api.formalcloud.net/admin.v1.LogsService/CreateLogsLinkItem' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "integrationId": <string>, 
    "datastoreId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_log_pb2 import CreateLogsLinkItemRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.LogsClient.CreateLogsLinkItem(
    CreateLogsLinkItemRequest("integration_id": <string>, 
        "datastore_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.LogsServiceClient.CreateLogsLinkItem(context.Background(), connect.NewRequest(
        &adminv1.CreateLogsLinkItemRequest{IntegrationId: <string>, 
            DatastoreId: <string>},
    ))
}

{
    "integrationId": <string>,
    "datastoreId": <string>
}

CreateLogsLinkItemRequest(
    integration_id: <string>,
    datastore_id: <string>
)

CreateLogsLinkItemRequest(
    IntegrationId <string>,
    DatastoreId <string>
)

CreateLogsLinkItemRequest

Parameter	Python Attribute	Type	Description	Is Optional
integrationId	integration_id	string
datastoreId	datastore_id	string

CreateLogsLinkItemRequest

Parameter	Python Attribute	Type	Description	Is Optional
integrationId	integration_id	string
datastoreId	datastore_id	string

GetLogsLinkItemById

curl 'https://adminv2.api.formalcloud.net/admin.v1.LogsService/GetLogsLinkItemById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_log_pb2 import GetLogsLinkItemByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.LogsClient.GetLogsLinkItemById(
    GetLogsLinkItemByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.LogsServiceClient.GetLogsLinkItemById(context.Background(), connect.NewRequest(
        &adminv1.GetLogsLinkItemByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetLogsLinkItemByIdRequest(
    id: <string>
)

GetLogsLinkItemByIdRequest(
    Id <string>
)

GetLogsLinkItemByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLogsLinkItemByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteLogsLinkItem

curl 'https://adminv2.api.formalcloud.net/admin.v1.LogsService/DeleteLogsLinkItem' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_log_pb2 import DeleteLogsLinkItemRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.LogsClient.DeleteLogsLinkItem(
    DeleteLogsLinkItemRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.LogsServiceClient.DeleteLogsLinkItem(context.Background(), connect.NewRequest(
        &adminv1.DeleteLogsLinkItemRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteLogsLinkItemRequest(
    id: <string>
)

DeleteLogsLinkItemRequest(
    Id <string>
)

DeleteLogsLinkItemRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteLogsLinkItemRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CreateIntegrationLogsRequest

Parameter	Python Attribute	Type
name	name	string
type	type	string
ddSite	dd_site	string
ddApiKey	dd_api_key	string
ddAccountId	dd_account_id	string
splunkUrl	splunk_url	string
splunkApiKey	splunk_api_key	string
awsAccessKeyId	aws_access_key_id	string
awsSecretAccessKey	aws_secret_access_key	string
awsRegion	aws_region	string
awsS3Bucket	aws_s3_bucket	string

CreateIntegrationLogsResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	types.v1.IntegrationLogs

GetIntegrationLogsRequest

This message has no parameters.

GetIntegrationLogsResponse

Parameter	Python Attribute	Type	Description	Is Optional
integrations	integrations	types.v1.IntegrationLogs array

GetIntegrationLogByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetIntegrationLogByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
integration	integration	types.v1.IntegrationLogs

DeleteIntegrationLogsRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteIntegrationLogsResponse

This message has no parameters.

CreateLogsLinkItemRequest

Parameter	Python Attribute	Type	Description	Is Optional
integrationId	integration_id	string
datastoreId	datastore_id	string

CreateLogsLinkItemResponse

Parameter	Python Attribute	Type	Description	Is Optional
logItemLink	log_item_link	types.v1.LogLinkItem

GetLogsLinkItemByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLogsLinkItemByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
logItemLinks	log_item_links	types.v1.LogLinkItem

DeleteLogsLinkItemRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteLogsLinkItemResponse

This message has no parameters.

Slack Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.SlackService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).SlackClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.SlackServiceClient
}

CreateSlackIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.SlackService/CreateSlackIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "code": <string>, 
    "redirectUri": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_slack_pb2 import CreateSlackIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SlackClient.CreateSlackIntegration(
    CreateSlackIntegrationRequest("code": <string>, 
        "redirect_uri": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SlackServiceClient.CreateSlackIntegration(context.Background(), connect.NewRequest(
        &adminv1.CreateSlackIntegrationRequest{Code: <string>, 
            RedirectUri: <string>},
    ))
}

{
    "code": <string>,
    "redirectUri": <string>
}

CreateSlackIntegrationRequest(
    code: <string>,
    redirect_uri: <string>
)

CreateSlackIntegrationRequest(
    Code <string>,
    RedirectUri <string>
)

CreateSlackIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
code	code	string
redirectUri	redirect_uri	string

CreateSlackIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
code	code	string
redirectUri	redirect_uri	string

GetSlackIntegration

curl 'https://adminv2.api.formalcloud.net/admin.v1.SlackService/GetSlackIntegration' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_slack_pb2 import GetSlackIntegrationRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SlackClient.GetSlackIntegration(
    GetSlackIntegrationRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SlackServiceClient.GetSlackIntegration(context.Background(), connect.NewRequest(
        &adminv1.GetSlackIntegrationRequest{},
    ))
}

{}

GetSlackIntegrationRequest()

GetSlackIntegrationRequest()

GetSlackIntegrationRequest

This request has no parameters.

GetSlackIntegrationRequest

This response has no parameters.

CreateSlackIntegrationRequest

Parameter	Python Attribute	Type	Description	Is Optional
code	code	string
redirectUri	redirect_uri	string

CreateSlackIntegrationResponse

This message has no parameters.

GetSlackIntegrationRequest

This message has no parameters.

GetSlackIntegrationResponse

Parameter	Python Attribute	Type
isConnected	is_connected	bool
slack	slack	SlackIntegration
teamId	team_id	string
teamName	team_name	string
botUserId	bot_user_id	string
botAccessToken	bot_access_token	string
authedUserId	authed_user_id	string
channelId	channel_id	string

SlackIntegration

Parameter	Python Attribute	Type
teamId	team_id	string
teamName	team_name	string
botUserId	bot_user_id	string
botAccessToken	bot_access_token	string
authedUserId	authed_user_id	string
channelId	channel_id	string

Sso Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.SsoService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).SsoClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.SsoServiceClient
}

GetWorkOsOrg

curl 'https://adminv2.api.formalcloud.net/admin.v1.SsoService/GetWorkOsOrg' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_sso_pb2 import GetWorkOsOrgRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SsoClient.GetWorkOsOrg(
    GetWorkOsOrgRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SsoServiceClient.GetWorkOsOrg(context.Background(), connect.NewRequest(
        &adminv1.GetWorkOsOrgRequest{},
    ))
}

{
    "workosOrg": <types.v1.Organization>,
    "selfSignUp": <bool>
}

GetWorkOsOrgResponse(
    workos_org: <types.v1.Organization>,
    self_sign_up: <bool>
)

GetWorkOsOrgResponse(
    WorkosOrg <types.v1.Organization>,
    SelfSignUp <bool>
)

GetWorkOsOrgRequest

This request has no parameters.

GetWorkOsOrgResponse

Parameter	Python Attribute	Type	Description	Is Optional
workosOrg	workos_org	types.v1.Organization
selfSignUp	self_sign_up	bool

UpdateWorkOsOrg

curl 'https://adminv2.api.formalcloud.net/admin.v1.SsoService/UpdateWorkOsOrg' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "domains": <string[]>, 
    "selfSignUp": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_sso_pb2 import UpdateWorkOsOrgRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SsoClient.UpdateWorkOsOrg(
    UpdateWorkOsOrgRequest("domains": <string[]>, 
        "self_sign_up": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SsoServiceClient.UpdateWorkOsOrg(context.Background(), connect.NewRequest(
        &adminv1.UpdateWorkOsOrgRequest{Domains: <string[]>, 
            SelfSignUp: <bool>},
    ))
}

{}

UpdateWorkOsOrgResponse()

UpdateWorkOsOrgResponse()

UpdateWorkOsOrgRequest

Parameter	Python Attribute	Type	Description	Is Optional
domains	domains	string array
selfSignUp	self_sign_up	bool

UpdateWorkOsOrgResponse

This response has no parameters.

GetSsoConnections

curl 'https://adminv2.api.formalcloud.net/admin.v1.SsoService/GetSsoConnections' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_sso_pb2 import GetSsoConnectionsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SsoClient.GetSsoConnections(
    GetSsoConnectionsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SsoServiceClient.GetSsoConnections(context.Background(), connect.NewRequest(
        &adminv1.GetSsoConnectionsRequest{},
    ))
}

{}

GetSsoConnectionsRequest()

GetSsoConnectionsRequest()

GetSsoConnectionsRequest

This request has no parameters.

GetSsoConnectionsRequest

This response has no parameters.

DeleteConnection

curl 'https://adminv2.api.formalcloud.net/admin.v1.SsoService/DeleteConnection' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.integration_sso_pb2 import DeleteConnectionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SsoClient.DeleteConnection(
    DeleteConnectionRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SsoServiceClient.DeleteConnection(context.Background(), connect.NewRequest(
        &adminv1.DeleteConnectionRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteConnectionRequest(
    id: <string>
)

DeleteConnectionRequest(
    Id <string>
)

DeleteConnectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteConnectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetWorkOsOrgRequest

This message has no parameters.

GetWorkOsOrgResponse

Parameter	Python Attribute	Type	Description	Is Optional
workosOrg	workos_org	types.v1.Organization
selfSignUp	self_sign_up	bool

UpdateWorkOsOrgRequest

Parameter	Python Attribute	Type	Description	Is Optional
domains	domains	string array
selfSignUp	self_sign_up	bool

UpdateWorkOsOrgResponse

This message has no parameters.

GetSsoConnectionsRequest

This message has no parameters.

GetSsoConnectionsResponse

Parameter	Python Attribute	Type	Description	Is Optional
connections	connections	types.v1.Connection array

DeleteConnectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteConnectionResponse

This message has no parameters.

Inventory Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).InventoryClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.InventoryServiceClient
}

GetInventoryHierarchical

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetInventoryHierarchical' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetInventoryHierarchicalRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetInventoryHierarchical(
    GetInventoryHierarchicalRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetInventoryHierarchical(context.Background(), connect.NewRequest(
        &adminv1.GetInventoryHierarchicalRequest{},
    ))
}

{}

GetInventoryHierarchicalRequest()

GetInventoryHierarchicalRequest()

GetInventoryHierarchicalRequest

This request has no parameters.

GetInventoryHierarchicalRequest

This response has no parameters.

GetInventory

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetInventory' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "path": <string>, 
    "excludedPaths": <string[]>, 
    "includedObjects": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetInventoryRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetInventory(
    GetInventoryRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "path": <string>, 
        "excluded_paths": <string[]>, 
        "included_objects": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetInventory(context.Background(), connect.NewRequest(
        &adminv1.GetInventoryRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Path: <string>, 
            ExcludedPaths: <string[]>, 
            IncludedObjects: <string[]>},
    ))
}

{
    "inventory": <InventoryObject[]>,
    "listMetadata": <types.v1.ListMetadata>
}

GetInventoryResponse(
    inventory: <InventoryObject[]>,
    list_metadata: <types.v1.ListMetadata>
)

GetInventoryResponse(
    Inventory <InventoryObject[]>,
    ListMetadata <types.v1.ListMetadata>
)

GetInventoryRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
path	path	string
excludedPaths	excluded_paths	string array
includedObjects	included_objects	string array

GetInventoryResponse

Parameter	Python Attribute	Type	Description	Is Optional
inventory	inventory	InventoryObject array
listMetadata	list_metadata	types.v1.ListMetadata

GetInventoryFlat

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetInventoryFlat' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetInventoryFlatRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetInventoryFlat(
    GetInventoryFlatRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetInventoryFlat(context.Background(), connect.NewRequest(
        &adminv1.GetInventoryFlatRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>},
    ))
}

{
    "limit": <int32>,
    "cursor": <string>,
    "order": <string>
}

GetInventoryFlatRequest(
    limit: <int32>,
    cursor: <string>,
    order: <string>
)

GetInventoryFlatRequest(
    Limit <int32>,
    Cursor <string>,
    Order <string>
)

GetInventoryFlatRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

GetInventoryFlatRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

GetInventoryFlatOld

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetInventoryFlatOld' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetInventoryFlatOldRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetInventoryFlatOld(
    GetInventoryFlatOldRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetInventoryFlatOld(context.Background(), connect.NewRequest(
        &adminv1.GetInventoryFlatOldRequest{},
    ))
}

{}

GetInventoryFlatOldRequest()

GetInventoryFlatOldRequest()

GetInventoryFlatOldRequest

This request has no parameters.

GetInventoryFlatOldRequest

This response has no parameters.

GetInventoryObject

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetInventoryObject' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "path": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetInventoryObjectRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetInventoryObject(
    GetInventoryObjectRequest("datastore_id": <string>, 
        "path": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetInventoryObject(context.Background(), connect.NewRequest(
        &adminv1.GetInventoryObjectRequest{DatastoreId: <string>, 
            Path: <string>},
    ))
}

{
    "datastoreId": <string>,
    "path": <string>
}

GetInventoryObjectRequest(
    datastore_id: <string>,
    path: <string>
)

GetInventoryObjectRequest(
    DatastoreId <string>,
    Path <string>
)

GetInventoryObjectRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
path	path	string

GetInventoryObjectRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
path	path	string

UpdateColumnLockStatus

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/UpdateColumnLockStatus' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "path": <string>, 
    "validated": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import UpdateColumnLockStatusRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.UpdateColumnLockStatus(
    UpdateColumnLockStatusRequest("datastore_id": <string>, 
        "path": <string>, 
        "validated": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.UpdateColumnLockStatus(context.Background(), connect.NewRequest(
        &adminv1.UpdateColumnLockStatusRequest{DatastoreId: <string>, 
            Path: <string>, 
            Validated: <bool>},
    ))
}

{
    "datastoreId": <string>,
    "path": <string>,
    "validated": <bool>
}

UpdateColumnLockStatusRequest(
    datastore_id: <string>,
    path: <string>,
    validated: <bool>
)

UpdateColumnLockStatusRequest(
    DatastoreId <string>,
    Path <string>,
    Validated <bool>
)

UpdateColumnLockStatusRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
validated	validated	bool

UpdateColumnLockStatusRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
validated	validated	bool

UpdateColumnDataLabel

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/UpdateColumnDataLabel' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "path": <string>, 
    "dataLabel": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import UpdateColumnDataLabelRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.UpdateColumnDataLabel(
    UpdateColumnDataLabelRequest("datastore_id": <string>, 
        "path": <string>, 
        "data_label": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.UpdateColumnDataLabel(context.Background(), connect.NewRequest(
        &adminv1.UpdateColumnDataLabelRequest{DatastoreId: <string>, 
            Path: <string>, 
            DataLabel: <string>},
    ))
}

{
    "datastoreId": <string>,
    "path": <string>,
    "dataLabel": <string>
}

UpdateColumnDataLabelRequest(
    datastore_id: <string>,
    path: <string>,
    data_label: <string>
)

UpdateColumnDataLabelRequest(
    DatastoreId <string>,
    Path <string>,
    DataLabel <string>
)

UpdateColumnDataLabelRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
dataLabel	data_label	string

UpdateColumnDataLabelRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
dataLabel	data_label	string

UpdateColumnFieldEncryption

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/UpdateColumnFieldEncryption' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "path": <string>, 
    ":": <in>, 
    "encryptionKeyId": <string>, 
    "encryptionAlgorithm": <string>, 
    "encryptExistingData": <bool>, 
    "datastoreId": <string>, 
    "path": <string>, 
    "column": <Column>, 
    "id": <string>, 
    "name": <string>, 
    "technology": <string>, 
    "dbs": <Db[]>, 
    "path": <string>, 
    "name": <string>, 
    "datastoreId": <string>, 
    "schemas": <Schema[]>, 
    "tables": <Table[]>, 
    "views": <View[]>, 
    "path": <string>, 
    "name": <string>, 
    "dbPath": <string>, 
    "tables": <Table[]>, 
    "views": <View[]>, 
    "path": <string>, 
    "name": <string>, 
    "dbPath": <string>, 
    "schemaPath": <string>, 
    "columns": <Column[]>, 
    "path": <string>, 
    "name": <string>, 
    "dbPath": <string>, 
    "schemaPath": <string>, 
    "columns": <Column[]>, 
    "path": <string>, 
    "name": <string>, 
    "tablePath": <string>, 
    "inventory": <Datastore[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import UpdateColumnFieldEncryptionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.UpdateColumnFieldEncryption(
    UpdateColumnFieldEncryptionRequest("datastore_id": <string>, 
        "path": <string>, 
        ":": <in>, 
        "encryption_key_id": <string>, 
        "encryption_algorithm": <string>, 
        "encrypt_existing_data": <bool>, 
        "datastore_id": <string>, 
        "path": <string>, 
        "column": <Column>, 
        "id": <string>, 
        "name": <string>, 
        "technology": <string>, 
        "dbs": <Db[]>, 
        "path": <string>, 
        "name": <string>, 
        "datastore_id": <string>, 
        "schemas": <Schema[]>, 
        "tables": <Table[]>, 
        "views": <View[]>, 
        "path": <string>, 
        "name": <string>, 
        "db_path": <string>, 
        "tables": <Table[]>, 
        "views": <View[]>, 
        "path": <string>, 
        "name": <string>, 
        "db_path": <string>, 
        "schema_path": <string>, 
        "columns": <Column[]>, 
        "path": <string>, 
        "name": <string>, 
        "db_path": <string>, 
        "schema_path": <string>, 
        "columns": <Column[]>, 
        "path": <string>, 
        "name": <string>, 
        "table_path": <string>, 
        "inventory": <Datastore[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.UpdateColumnFieldEncryption(context.Background(), connect.NewRequest(
        &adminv1.UpdateColumnFieldEncryptionRequest{DatastoreId: <string>, 
            Path: <string>, 
            :: <in>, 
            EncryptionKeyId: <string>, 
            EncryptionAlgorithm: <string>, 
            EncryptExistingData: <bool>, 
            DatastoreId: <string>, 
            Path: <string>, 
            Column: <Column>, 
            Id: <string>, 
            Name: <string>, 
            Technology: <string>, 
            Dbs: <Db[]>, 
            Path: <string>, 
            Name: <string>, 
            DatastoreId: <string>, 
            Schemas: <Schema[]>, 
            Tables: <Table[]>, 
            Views: <View[]>, 
            Path: <string>, 
            Name: <string>, 
            DbPath: <string>, 
            Tables: <Table[]>, 
            Views: <View[]>, 
            Path: <string>, 
            Name: <string>, 
            DbPath: <string>, 
            SchemaPath: <string>, 
            Columns: <Column[]>, 
            Path: <string>, 
            Name: <string>, 
            DbPath: <string>, 
            SchemaPath: <string>, 
            Columns: <Column[]>, 
            Path: <string>, 
            Name: <string>, 
            TablePath: <string>, 
            Inventory: <Datastore[]>},
    ))
}

{
    "datastoreId": <string>,
    "path": <string>,
    ":": <in>,
    "encryptionKeyId": <string>,
    "encryptionAlgorithm": <string>,
    "encryptExistingData": <bool>,
    "datastoreId": <string>,
    "path": <string>,
    "column": <Column>,
    "id": <string>,
    "name": <string>,
    "technology": <string>,
    "dbs": <Db[]>,
    "path": <string>,
    "name": <string>,
    "datastoreId": <string>,
    "schemas": <Schema[]>,
    "tables": <Table[]>,
    "views": <View[]>,
    "path": <string>,
    "name": <string>,
    "dbPath": <string>,
    "tables": <Table[]>,
    "views": <View[]>,
    "path": <string>,
    "name": <string>,
    "dbPath": <string>,
    "schemaPath": <string>,
    "columns": <Column[]>,
    "path": <string>,
    "name": <string>,
    "dbPath": <string>,
    "schemaPath": <string>,
    "columns": <Column[]>,
    "path": <string>,
    "name": <string>,
    "tablePath": <string>,
    "inventory": <Datastore[]>
}

UpdateColumnFieldEncryptionRequest(
    datastore_id: <string>,
    path: <string>,
    :: <in>,
    encryption_key_id: <string>,
    encryption_algorithm: <string>,
    encrypt_existing_data: <bool>,
    datastore_id: <string>,
    path: <string>,
    column: <Column>,
    id: <string>,
    name: <string>,
    technology: <string>,
    dbs: <Db[]>,
    path: <string>,
    name: <string>,
    datastore_id: <string>,
    schemas: <Schema[]>,
    tables: <Table[]>,
    views: <View[]>,
    path: <string>,
    name: <string>,
    db_path: <string>,
    tables: <Table[]>,
    views: <View[]>,
    path: <string>,
    name: <string>,
    db_path: <string>,
    schema_path: <string>,
    columns: <Column[]>,
    path: <string>,
    name: <string>,
    db_path: <string>,
    schema_path: <string>,
    columns: <Column[]>,
    path: <string>,
    name: <string>,
    table_path: <string>,
    inventory: <Datastore[]>
)

UpdateColumnFieldEncryptionRequest(
    DatastoreId <string>,
    Path <string>,
    : <in>,
    EncryptionKeyId <string>,
    EncryptionAlgorithm <string>,
    EncryptExistingData <bool>,
    DatastoreId <string>,
    Path <string>,
    Column <Column>,
    Id <string>,
    Name <string>,
    Technology <string>,
    Dbs <Db[]>,
    Path <string>,
    Name <string>,
    DatastoreId <string>,
    Schemas <Schema[]>,
    Tables <Table[]>,
    Views <View[]>,
    Path <string>,
    Name <string>,
    DbPath <string>,
    Tables <Table[]>,
    Views <View[]>,
    Path <string>,
    Name <string>,
    DbPath <string>,
    SchemaPath <string>,
    Columns <Column[]>,
    Path <string>,
    Name <string>,
    DbPath <string>,
    SchemaPath <string>,
    Columns <Column[]>,
    Path <string>,
    Name <string>,
    TablePath <string>,
    Inventory <Datastore[]>
)

UpdateColumnFieldEncryptionRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
:	:	in
encryptionKeyId	encryption_key_id	string
encryptionAlgorithm	encryption_algorithm	string
encryptExistingData	encrypt_existing_data	bool
datastoreId	datastore_id	string
path	path	string
column	column	Column
id	id	string
name	name	string
technology	technology	string
dbs	dbs	Db array
path	path	string
name	name	string
datastoreId	datastore_id	string
schemas	schemas	Schema array
tables	tables	Table array
views	views	View array
path	path	string
name	name	string
dbPath	db_path	string
tables	tables	Table array
views	views	View array
path	path	string
name	name	string
dbPath	db_path	string
schemaPath	schema_path	string
columns	columns	Column array
path	path	string
name	name	string
dbPath	db_path	string
schemaPath	schema_path	string
columns	columns	Column array
path	path	string
name	name	string
tablePath	table_path	string
inventory	inventory	Datastore array

UpdateColumnFieldEncryptionRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
:	:	in
encryptionKeyId	encryption_key_id	string
encryptionAlgorithm	encryption_algorithm	string
encryptExistingData	encrypt_existing_data	bool
datastoreId	datastore_id	string
path	path	string
column	column	Column
id	id	string
name	name	string
technology	technology	string
dbs	dbs	Db array
path	path	string
name	name	string
datastoreId	datastore_id	string
schemas	schemas	Schema array
tables	tables	Table array
views	views	View array
path	path	string
name	name	string
dbPath	db_path	string
tables	tables	Table array
views	views	View array
path	path	string
name	name	string
dbPath	db_path	string
schemaPath	schema_path	string
columns	columns	Column array
path	path	string
name	name	string
dbPath	db_path	string
schemaPath	schema_path	string
columns	columns	Column array
path	path	string
name	name	string
tablePath	table_path	string
inventory	inventory	Datastore array

UpdateInventoryObjectTags

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/UpdateInventoryObjectTags' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "path": <string>, 
    "tags": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import UpdateInventoryObjectTagsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.UpdateInventoryObjectTags(
    UpdateInventoryObjectTagsRequest("datastore_id": <string>, 
        "path": <string>, 
        "tags": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.UpdateInventoryObjectTags(context.Background(), connect.NewRequest(
        &adminv1.UpdateInventoryObjectTagsRequest{DatastoreId: <string>, 
            Path: <string>, 
            Tags: <string[]>},
    ))
}

{
    "datastoreId": <string>,
    "path": <string>,
    "tags": <string[]>
}

UpdateInventoryObjectTagsRequest(
    datastore_id: <string>,
    path: <string>,
    tags: <string[]>
)

UpdateInventoryObjectTagsRequest(
    DatastoreId <string>,
    Path <string>,
    Tags <string[]>
)

UpdateInventoryObjectTagsRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
tags	tags	string array

UpdateInventoryObjectTagsRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
tags	tags	string array

CreateInventoryObject

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/CreateInventoryObject' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "path": <string>, 
    "name": <string>, 
    "path": <string>, 
    "name": <string>, 
    "path": <string>, 
    "name": <string>, 
    "path": <string>, 
    "name": <string>, 
    "path": <string>, 
    "name": <string>, 
    "dataType": <string>, 
    "path": <string>, 
    "name": <string>, 
    "subType": <string>, 
    "datastoreId": <string>, 
    ":": <in>, 
    "db": <Db>, 
    "schema": <Schema>, 
    "table": <Table>, 
    "column": <Column>, 
    "subColumn": <SubColumn>, 
    "view": <View>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import CreateInventoryObjectRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.CreateInventoryObject(
    CreateInventoryObjectRequest("path": <string>, 
        "name": <string>, 
        "path": <string>, 
        "name": <string>, 
        "path": <string>, 
        "name": <string>, 
        "path": <string>, 
        "name": <string>, 
        "path": <string>, 
        "name": <string>, 
        "data_type": <string>, 
        "path": <string>, 
        "name": <string>, 
        "sub_type": <string>, 
        "datastore_id": <string>, 
        ":": <in>, 
        "db": <Db>, 
        "schema": <Schema>, 
        "table": <Table>, 
        "column": <Column>, 
        "sub_column": <SubColumn>, 
        "view": <View>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.CreateInventoryObject(context.Background(), connect.NewRequest(
        &adminv1.CreateInventoryObjectRequest{Path: <string>, 
            Name: <string>, 
            Path: <string>, 
            Name: <string>, 
            Path: <string>, 
            Name: <string>, 
            Path: <string>, 
            Name: <string>, 
            Path: <string>, 
            Name: <string>, 
            DataType: <string>, 
            Path: <string>, 
            Name: <string>, 
            SubType: <string>, 
            DatastoreId: <string>, 
            :: <in>, 
            Db: <Db>, 
            Schema: <Schema>, 
            Table: <Table>, 
            Column: <Column>, 
            SubColumn: <SubColumn>, 
            View: <View>},
    ))
}

{
    "path": <string>,
    "name": <string>,
    "path": <string>,
    "name": <string>,
    "path": <string>,
    "name": <string>,
    "path": <string>,
    "name": <string>,
    "path": <string>,
    "name": <string>,
    "dataType": <string>,
    "path": <string>,
    "name": <string>,
    "subType": <string>,
    "datastoreId": <string>,
    ":": <in>,
    "db": <Db>,
    "schema": <Schema>,
    "table": <Table>,
    "column": <Column>,
    "subColumn": <SubColumn>,
    "view": <View>
}

CreateInventoryObjectRequest(
    path: <string>,
    name: <string>,
    path: <string>,
    name: <string>,
    path: <string>,
    name: <string>,
    path: <string>,
    name: <string>,
    path: <string>,
    name: <string>,
    data_type: <string>,
    path: <string>,
    name: <string>,
    sub_type: <string>,
    datastore_id: <string>,
    :: <in>,
    db: <Db>,
    schema: <Schema>,
    table: <Table>,
    column: <Column>,
    sub_column: <SubColumn>,
    view: <View>
)

CreateInventoryObjectRequest(
    Path <string>,
    Name <string>,
    Path <string>,
    Name <string>,
    Path <string>,
    Name <string>,
    Path <string>,
    Name <string>,
    Path <string>,
    Name <string>,
    DataType <string>,
    Path <string>,
    Name <string>,
    SubType <string>,
    DatastoreId <string>,
    : <in>,
    Db <Db>,
    Schema <Schema>,
    Table <Table>,
    Column <Column>,
    SubColumn <SubColumn>,
    View <View>
)

CreateInventoryObjectRequest

Parameter	Python Attribute	Type
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
dataType	data_type	string
path	path	string
name	name	string
subType	sub_type	string
datastoreId	datastore_id	string
:	:	in
db	db	Db
schema	schema	Schema
table	table	Table
column	column	Column
subColumn	sub_column	SubColumn
view	view	View

CreateInventoryObjectRequest

Parameter	Python Attribute	Type
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
dataType	data_type	string
path	path	string
name	name	string
subType	sub_type	string
datastoreId	datastore_id	string
:	:	in
db	db	Db
schema	schema	Schema
table	table	Table
column	column	Column
subColumn	sub_column	SubColumn
view	view	View

DeleteInventoryObject

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/DeleteInventoryObject' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "path": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import DeleteInventoryObjectRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.DeleteInventoryObject(
    DeleteInventoryObjectRequest("datastore_id": <string>, 
        "path": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.DeleteInventoryObject(context.Background(), connect.NewRequest(
        &adminv1.DeleteInventoryObjectRequest{DatastoreId: <string>, 
            Path: <string>},
    ))
}

{
    "datastoreId": <string>,
    "path": <string>
}

DeleteInventoryObjectRequest(
    datastore_id: <string>,
    path: <string>
)

DeleteInventoryObjectRequest(
    DatastoreId <string>,
    Path <string>
)

DeleteInventoryObjectRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
path	path	string

DeleteInventoryObjectRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
path	path	string

CreateInventoryTag

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/CreateInventoryTag' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import CreateInventoryTagRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.CreateInventoryTag(
    CreateInventoryTagRequest("name": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.CreateInventoryTag(context.Background(), connect.NewRequest(
        &adminv1.CreateInventoryTagRequest{Name: <string>},
    ))
}

{
    "name": <string>
}

CreateInventoryTagRequest(
    name: <string>
)

CreateInventoryTagRequest(
    Name <string>
)

CreateInventoryTagRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string

CreateInventoryTagRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string

GetInventoryTags

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetInventoryTags' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetInventoryTagsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetInventoryTags(
    GetInventoryTagsRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetInventoryTags(context.Background(), connect.NewRequest(
        &adminv1.GetInventoryTagsRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>},
    ))
}

{
    "limit": <int32>,
    "cursor": <string>,
    "order": <string>
}

GetInventoryTagsRequest(
    limit: <int32>,
    cursor: <string>,
    order: <string>
)

GetInventoryTagsRequest(
    Limit <int32>,
    Cursor <string>,
    Order <string>
)

GetInventoryTagsRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

GetInventoryTagsRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

DeleteInventoryTag

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/DeleteInventoryTag' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import DeleteInventoryTagRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.DeleteInventoryTag(
    DeleteInventoryTagRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.DeleteInventoryTag(context.Background(), connect.NewRequest(
        &adminv1.DeleteInventoryTagRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteInventoryTagRequest(
    id: <string>
)

DeleteInventoryTagRequest(
    Id <string>
)

DeleteInventoryTagRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteInventoryTagRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetInventoryMetrics

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetInventoryMetrics' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "userId": <string>, 
    "datastoreId": <string>, 
    "path": <string>, 
    "objectType": <string>, 
    "timeframe": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetInventoryMetricsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetInventoryMetrics(
    GetInventoryMetricsRequest("user_id": <string>, 
        "datastore_id": <string>, 
        "path": <string>, 
        "object_type": <string>, 
        "timeframe": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetInventoryMetrics(context.Background(), connect.NewRequest(
        &adminv1.GetInventoryMetricsRequest{UserId: <string>, 
            DatastoreId: <string>, 
            Path: <string>, 
            ObjectType: <string>, 
            Timeframe: <string>},
    ))
}

{
    "userId": <string>,
    "datastoreId": <string>,
    "path": <string>,
    "objectType": <string>,
    "timeframe": <string>
}

GetInventoryMetricsRequest(
    user_id: <string>,
    datastore_id: <string>,
    path: <string>,
    object_type: <string>,
    timeframe: <string>
)

GetInventoryMetricsRequest(
    UserId <string>,
    DatastoreId <string>,
    Path <string>,
    ObjectType <string>,
    Timeframe <string>
)

GetInventoryMetricsRequest

Parameter	Python Attribute	Type
userId	user_id	string
datastoreId	datastore_id	string
path	path	string
objectType	object_type	string
timeframe	timeframe	string

GetInventoryMetricsRequest

Parameter	Python Attribute	Type
userId	user_id	string
datastoreId	datastore_id	string
path	path	string
objectType	object_type	string
timeframe	timeframe	string

CreateDataDomain

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/CreateDataDomain' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "description": <string>, 
    "owners": <types.v1.Owner[]>, 
    "excludedPaths": <string[]>, 
    "includedPaths": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import CreateDataDomainRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.CreateDataDomain(
    CreateDataDomainRequest("name": <string>, 
        "description": <string>, 
        "owners": <types.v1.Owner[]>, 
        "excluded_paths": <string[]>, 
        "included_paths": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.CreateDataDomain(context.Background(), connect.NewRequest(
        &adminv1.CreateDataDomainRequest{Name: <string>, 
            Description: <string>, 
            Owners: <types.v1.Owner[]>, 
            ExcludedPaths: <string[]>, 
            IncludedPaths: <string[]>},
    ))
}

{
    "name": <string>,
    "description": <string>,
    "owners": <types.v1.Owner[]>,
    "excludedPaths": <string[]>,
    "includedPaths": <string[]>
}

CreateDataDomainRequest(
    name: <string>,
    description: <string>,
    owners: <types.v1.Owner[]>,
    excluded_paths: <string[]>,
    included_paths: <string[]>
)

CreateDataDomainRequest(
    Name <string>,
    Description <string>,
    Owners <types.v1.Owner[]>,
    ExcludedPaths <string[]>,
    IncludedPaths <string[]>
)

CreateDataDomainRequest

Parameter	Python Attribute	Type
name	name	string
description	description	string
owners	owners	types.v1.Owner array
excludedPaths	excluded_paths	string array
includedPaths	included_paths	string array

CreateDataDomainRequest

Parameter	Python Attribute	Type
name	name	string
description	description	string
owners	owners	types.v1.Owner array
excludedPaths	excluded_paths	string array
includedPaths	included_paths	string array

GetDataDomains

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetDataDomains' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetDataDomainsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetDataDomains(
    GetDataDomainsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetDataDomains(context.Background(), connect.NewRequest(
        &adminv1.GetDataDomainsRequest{},
    ))
}

{
    "domains": <types.v1.Domain[]>
}

GetDataDomainsResponse(
    domains: <types.v1.Domain[]>
)

GetDataDomainsResponse(
    Domains <types.v1.Domain[]>
)

GetDataDomainsRequest

This request has no parameters.

GetDataDomainsResponse

Parameter	Python Attribute	Type	Description	Is Optional
domains	domains	types.v1.Domain array

GetDataDomainById

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/GetDataDomainById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import GetDataDomainByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.GetDataDomainById(
    GetDataDomainByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.GetDataDomainById(context.Background(), connect.NewRequest(
        &adminv1.GetDataDomainByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetDataDomainByIdRequest(
    id: <string>
)

GetDataDomainByIdRequest(
    Id <string>
)

GetDataDomainByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataDomainByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

UpdateDataDomain

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/UpdateDataDomain' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "name": <string>, 
    "description": <string>, 
    "owners": <types.v1.Owner[]>, 
    "excludedPaths": <string[]>, 
    "includedPaths": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import UpdateDataDomainRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.UpdateDataDomain(
    UpdateDataDomainRequest("id": <string>, 
        "name": <string>, 
        "description": <string>, 
        "owners": <types.v1.Owner[]>, 
        "excluded_paths": <string[]>, 
        "included_paths": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.UpdateDataDomain(context.Background(), connect.NewRequest(
        &adminv1.UpdateDataDomainRequest{Id: <string>, 
            Name: <string>, 
            Description: <string>, 
            Owners: <types.v1.Owner[]>, 
            ExcludedPaths: <string[]>, 
            IncludedPaths: <string[]>},
    ))
}

{
    "id": <string>,
    "name": <string>,
    "description": <string>,
    "owners": <types.v1.Owner[]>,
    "excludedPaths": <string[]>,
    "includedPaths": <string[]>
}

UpdateDataDomainRequest(
    id: <string>,
    name: <string>,
    description: <string>,
    owners: <types.v1.Owner[]>,
    excluded_paths: <string[]>,
    included_paths: <string[]>
)

UpdateDataDomainRequest(
    Id <string>,
    Name <string>,
    Description <string>,
    Owners <types.v1.Owner[]>,
    ExcludedPaths <string[]>,
    IncludedPaths <string[]>
)

UpdateDataDomainRequest

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
owners	owners	types.v1.Owner array
excludedPaths	excluded_paths	string array
includedPaths	included_paths	string array

UpdateDataDomainRequest

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
owners	owners	types.v1.Owner array
excludedPaths	excluded_paths	string array
includedPaths	included_paths	string array

DeleteDataDomain

curl 'https://adminv2.api.formalcloud.net/admin.v1.InventoryService/DeleteDataDomain' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.inventory_pb2 import DeleteDataDomainRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.InventoryClient.DeleteDataDomain(
    DeleteDataDomainRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.InventoryServiceClient.DeleteDataDomain(context.Background(), connect.NewRequest(
        &adminv1.DeleteDataDomainRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteDataDomainRequest(
    id: <string>
)

DeleteDataDomainRequest(
    Id <string>
)

DeleteDataDomainRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDataDomainRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetInventoryFlatOldRequest

This message has no parameters.

ColumnOld

Parameter	Python Attribute	Type
createdAt	created_at	int64
updatedAt	updated_at	int64
datastoreId	datastore_id	string
datastoreName	datastore_name	string
path	path	string
tablePhysicalId	table_physical_id	string
tableAttributeNumber	table_attribute_number	uint64
name	name	string
alias	alias	string
tablePath	table_path	string
dataLabel	data_label	string
dataType	data_type	string
dataTypeOid	data_type_oid	uint32
dataLabelLockedForSidecar	data_label_locked_for_sidecar	bool
tags	tags	string array
encrypted	encrypted	bool

GetInventoryFlatOldResponse

Parameter	Python Attribute	Type	Description	Is Optional
inventory	inventory	ColumnOld array

UpdateColumnFieldEncryptionRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
:	:	in
encryptionKeyId	encryption_key_id	string
encryptionAlgorithm	encryption_algorithm	string
encryptExistingData	encrypt_existing_data	bool
datastoreId	datastore_id	string
path	path	string
column	column	Column
id	id	string
name	name	string
technology	technology	string
dbs	dbs	Db array
path	path	string
name	name	string
datastoreId	datastore_id	string
schemas	schemas	Schema array
tables	tables	Table array
views	views	View array
path	path	string
name	name	string
dbPath	db_path	string
tables	tables	Table array
views	views	View array
path	path	string
name	name	string
dbPath	db_path	string
schemaPath	schema_path	string
columns	columns	Column array
path	path	string
name	name	string
dbPath	db_path	string
schemaPath	schema_path	string
columns	columns	Column array
path	path	string
name	name	string
tablePath	table_path	string
inventory	inventory	Datastore array

UpdateColumnFieldEncryptionResponse

This message has no parameters.

GetInventoryObjectRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
path	path	string

GetInventoryObjectResponse

Parameter	Python Attribute	Type	Description	Is Optional
column	column	Column

GetInventoryHierarchicalRequest

This message has no parameters.

GetInventoryHierarchicalResponse

Parameter	Python Attribute	Type
id	id	string
name	name	string
technology	technology	string
dbs	dbs	Db array
path	path	string
name	name	string
datastoreId	datastore_id	string
schemas	schemas	Schema array
tables	tables	Table array
views	views	View array
path	path	string
name	name	string
dbPath	db_path	string
tables	tables	Table array
views	views	View array
path	path	string
name	name	string
dbPath	db_path	string
schemaPath	schema_path	string
columns	columns	Column array
path	path	string
name	name	string
dbPath	db_path	string
schemaPath	schema_path	string
columns	columns	Column array
path	path	string
name	name	string
tablePath	table_path	string
inventory	inventory	Datastore array

Datastore

Parameter	Python Attribute	Type
id	id	string
name	name	string
technology	technology	string
dbs	dbs	Db array

Db

Parameter	Python Attribute	Type	Description	Is Optional
path	path	string
name	name	string

Schema

Parameter	Python Attribute	Type	Description	Is Optional
path	path	string
name	name	string

Table

Parameter	Python Attribute	Type	Description	Is Optional
path	path	string
name	name	string

View

Parameter	Python Attribute	Type	Description	Is Optional
path	path	string
name	name	string

Column

Parameter	Python Attribute	Type
path	path	string
name	name	string
dataType	data_type	string

GetInventoryRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
path	path	string
excludedPaths	excluded_paths	string array
includedObjects	included_objects	string array

GetInventoryResponse

Parameter	Python Attribute	Type	Description	Is Optional
inventory	inventory	InventoryObject array
listMetadata	list_metadata	types.v1.ListMetadata

GetInventoryFlatRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

Ds

Parameter	Python Attribute	Type
id	id	string
name	name	string
technology	technology	string
dbs	dbs	Db array

SubColumn

Parameter	Python Attribute	Type
path	path	string
name	name	string
subType	sub_type	string
datastoreId	datastore_id	string
:	:	in
db	db	Db
schema	schema	Schema
table	table	Table
column	column	Column
subColumn	sub_column	SubColumn
view	view	View

InventoryObject

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
type	type	string
path	path	string
dbPath	db_path	string
tablePath	table_path	string
schemaPath	schema_path	string
tableAttributeNumber	table_attribute_number	uint64
dataType	data_type	string
dataLabel	data_label	string
updatedAt	updated_at	int64
createdAt	created_at	int64
dataStoreName	data_store_name	string
name	name	string
validated	validated	bool
tags	tags	string array

GetInventoryFlatResponse

Parameter	Python Attribute	Type	Description	Is Optional
inventory	inventory	InventoryObject array
listMetadata	list_metadata	types.v1.ListMetadata

UpdateColumnLockStatusRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
validated	validated	bool

UpdateColumnLockStatusResponse

This message has no parameters.

UpdateColumnDataLabelRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
dataLabel	data_label	string

UpdateColumnDataLabelResponse

This message has no parameters.

CreateInventoryObjectRequest

Parameter	Python Attribute	Type
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
path	path	string
name	name	string
dataType	data_type	string
path	path	string
name	name	string
subType	sub_type	string
datastoreId	datastore_id	string
:	:	in
db	db	Db
schema	schema	Schema
table	table	Table
column	column	Column
subColumn	sub_column	SubColumn
view	view	View

CreateInventoryObjectResponse

This message has no parameters.

DeleteInventoryObjectRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string
path	path	string

DeleteInventoryObjectResponse

This message has no parameters.

Tag

Parameter	Python Attribute	Type
id	id	string
name	name	string
createdAt	created_at	google.protobuf.Timestamp
(validate.v1.rules).timestamp.required	(validate.v1.rules).timestamp.required	[

CreateInventoryTagRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string

CreateInventoryTagResponse

Parameter	Python Attribute	Type	Description	Is Optional
tag	tag	Tag

GetInventoryTagsRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

GetInventoryTagsResponse

Parameter	Python Attribute	Type	Description	Is Optional
tags	tags	Tag array
listMetadata	list_metadata	types.v1.ListMetadata

UpdateInventoryObjectTagsRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
tags	tags	string array

UpdateInventoryObjectTagsResponse

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
type	type	string
path	path	string
dbPath	db_path	string
tablePath	table_path	string
schemaPath	schema_path	string
tableAttributeNumber	table_attribute_number	uint64
dataType	data_type	string
dataLabel	data_label	string
updatedAt	updated_at	int64
createdAt	created_at	int64
dataStoreName	data_store_name	string
name	name	string
validated	validated	bool
tags	tags	string array
object	object	InventoryObject

DeleteInventoryTagRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteInventoryTagResponse

Parameter	Python Attribute	Type	Description	Is Optional
tags	tags	Tag array

GetInventoryMetricsRequest

Parameter	Python Attribute	Type
userId	user_id	string
datastoreId	datastore_id	string
path	path	string
objectType	object_type	string
timeframe	timeframe	string

GetInventoryMetricsResponse

Parameter	Python Attribute	Type
name	name	string
path	path	string
columnName	column_name	string
columnPath	column_path	string
tableName	table_name	string
tablePath	table_path	string
schemaName	schema_name	string
schemaPath	schema_path	string
dbName	db_name	string
userId	user_id	string
dbUser	db_user	string
endUserId	end_user_id	string
endUserDbUsername	end_user_db_username	string
appType	app_type	string
orgId	org_id	string
datastoreId	datastore_id	string
datastoreName	datastore_name	string
ts	ts	string
counter	counter	int32
returnedRows	returned_rows	int32
ipAddress	ip_address	string
dataLabel	data_label	string
dataLabels	data_labels	string array
datastoreTechnology	datastore_technology	string
bucket	bucket	string
metrics	metrics	Metric array

Metric

Parameter	Python Attribute	Type
name	name	string
path	path	string
columnName	column_name	string
columnPath	column_path	string
tableName	table_name	string
tablePath	table_path	string
schemaName	schema_name	string
schemaPath	schema_path	string
dbName	db_name	string
userId	user_id	string
dbUser	db_user	string
endUserId	end_user_id	string
endUserDbUsername	end_user_db_username	string
appType	app_type	string
orgId	org_id	string
datastoreId	datastore_id	string
datastoreName	datastore_name	string
ts	ts	string
counter	counter	int32
returnedRows	returned_rows	int32
ipAddress	ip_address	string
dataLabel	data_label	string
dataLabels	data_labels	string array
datastoreTechnology	datastore_technology	string
bucket	bucket	string

CreateDataDomainRequest

Parameter	Python Attribute	Type
name	name	string
description	description	string
owners	owners	types.v1.Owner array
excludedPaths	excluded_paths	string array
includedPaths	included_paths	string array

CreateDataDomainResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataDomainsRequest

This message has no parameters.

GetDataDomainsResponse

Parameter	Python Attribute	Type	Description	Is Optional
domains	domains	types.v1.Domain array

GetDataDomainByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDataDomainByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
domain	domain	types.v1.Domain

UpdateDataDomainRequest

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
owners	owners	types.v1.Owner array
excludedPaths	excluded_paths	string array
includedPaths	included_paths	string array

UpdateDataDomainResponse

Parameter	Python Attribute	Type	Description	Is Optional
domain	domain	types.v1.Domain

DeleteDataDomainRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteDataDomainResponse

This message has no parameters.

Metrics Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.MetricsService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).MetricsClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.MetricsServiceClient
}

GetMetrics

curl 'https://adminv2.api.formalcloud.net/admin.v1.MetricsService/GetMetrics' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string[]>, 
    "interval": <string>, 
    "userId": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.metrics_pb2 import GetMetricsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.MetricsClient.GetMetrics(
    GetMetricsRequest("datastore_id": <string[]>, 
        "interval": <string>, 
        "user_id": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.MetricsServiceClient.GetMetrics(context.Background(), connect.NewRequest(
        &adminv1.GetMetricsRequest{DatastoreId: <string[]>, 
            Interval: <string>, 
            UserId: <string[]>},
    ))
}

{
    "metrics": <Metric[]>,
    "nodes": <Node[]>,
    "links": <Link[]>
}

GetMetricsResponse(
    metrics: <Metric[]>,
    nodes: <Node[]>,
    links: <Link[]>
)

GetMetricsResponse(
    Metrics <Metric[]>,
    Nodes <Node[]>,
    Links <Link[]>
)

GetMetricsRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string array
interval	interval	string
userId	user_id	string array

GetMetricsResponse

Parameter	Python Attribute	Type
metrics	metrics	Metric array
nodes	nodes	Node array
links	links	Link array

CreateCustomMetric

curl 'https://adminv2.api.formalcloud.net/admin.v1.MetricsService/CreateCustomMetric' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "path": <string>, 
    "allowClearTextValue": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.metrics_pb2 import CreateCustomMetricRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.MetricsClient.CreateCustomMetric(
    CreateCustomMetricRequest("datastore_id": <string>, 
        "path": <string>, 
        "allow_clear_text_value": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.MetricsServiceClient.CreateCustomMetric(context.Background(), connect.NewRequest(
        &adminv1.CreateCustomMetricRequest{DatastoreId: <string>, 
            Path: <string>, 
            AllowClearTextValue: <bool>},
    ))
}

{
    "id": <string>
}

CreateCustomMetricResponse(
    id: <string>
)

CreateCustomMetricResponse(
    Id <string>
)

CreateCustomMetricRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
allowClearTextValue	allow_clear_text_value	bool

CreateCustomMetricResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetCustomMetrics

curl 'https://adminv2.api.formalcloud.net/admin.v1.MetricsService/GetCustomMetrics' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.metrics_pb2 import GetCustomMetricsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.MetricsClient.GetCustomMetrics(
    GetCustomMetricsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.MetricsServiceClient.GetCustomMetrics(context.Background(), connect.NewRequest(
        &adminv1.GetCustomMetricsRequest{},
    ))
}

{
    "rowLevelMetricConfigurations": <RowLevelMetricConfiguration[]>
}

GetCustomMetricsResponse(
    row_level_metric_configurations: <RowLevelMetricConfiguration[]>
)

GetCustomMetricsResponse(
    RowLevelMetricConfigurations <RowLevelMetricConfiguration[]>
)

GetCustomMetricsRequest

This request has no parameters.

GetCustomMetricsResponse

Parameter	Python Attribute	Type	Description	Is Optional
rowLevelMetricConfigurations	row_level_metric_configurations	RowLevelMetricConfiguration array

GetCustomMetricsDetails

curl 'https://adminv2.api.formalcloud.net/admin.v1.MetricsService/GetCustomMetricsDetails' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "interval": <string>, 
    "userId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.metrics_pb2 import GetCustomMetricsDetailsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.MetricsClient.GetCustomMetricsDetails(
    GetCustomMetricsDetailsRequest("id": <string>, 
        "interval": <string>, 
        "user_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.MetricsServiceClient.GetCustomMetricsDetails(context.Background(), connect.NewRequest(
        &adminv1.GetCustomMetricsDetailsRequest{Id: <string>, 
            Interval: <string>, 
            UserId: <string>},
    ))
}

{
    "series": <MetricsGroup>
}

GetCustomMetricsDetailsResponse(
    series: <MetricsGroup>
)

GetCustomMetricsDetailsResponse(
    Series <MetricsGroup>
)

GetCustomMetricsDetailsRequest

Parameter	Python Attribute	Type
id	id	string
interval	interval	string
userId	user_id	string

GetCustomMetricsDetailsResponse

Parameter	Python Attribute	Type	Description	Is Optional
series	series	map<string, MetricsGroup>

DeleteCustomMetric

curl 'https://adminv2.api.formalcloud.net/admin.v1.MetricsService/DeleteCustomMetric' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.metrics_pb2 import DeleteCustomMetricRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.MetricsClient.DeleteCustomMetric(
    DeleteCustomMetricRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.MetricsServiceClient.DeleteCustomMetric(context.Background(), connect.NewRequest(
        &adminv1.DeleteCustomMetricRequest{Id: <string>},
    ))
}

{}

DeleteCustomMetricResponse()

DeleteCustomMetricResponse()

DeleteCustomMetricRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteCustomMetricResponse

This response has no parameters.

GetMetricsRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string array
interval	interval	string
userId	user_id	string array

Metric

Parameter	Python Attribute	Type
name	name	string
path	path	string
columnName	column_name	string
columnPath	column_path	string
tableName	table_name	string
tablePath	table_path	string
schemaName	schema_name	string
schemaPath	schema_path	string
dbName	db_name	string
userId	user_id	string
dbUser	db_user	string
endUserId	end_user_id	string
endUserDbUsername	end_user_db_username	string
appType	app_type	string
datastoreId	datastore_id	string
datastoreName	datastore_name	string
ts	ts	google.protobuf.Timestamp
counter	counter	uint64
returnedRows	returned_rows	int64
ipAddress	ip_address	string
dataLabel	data_label	string
dataLabels	data_labels	string array
datastoreTechnology	datastore_technology	string
bucket	bucket	google.protobuf.Timestamp

Node

Parameter	Python Attribute	Type
id	id	string
type	type	string
shape	shape	string
color	color	string
label	label	string

Link

Parameter	Python Attribute	Type	Description	Is Optional
source	source	string
target	target	string

GetMetricsResponse

Parameter	Python Attribute	Type
metrics	metrics	Metric array
nodes	nodes	Node array
links	links	Link array

RowLevelMetric

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
datastoreName	datastore_name	string
endUserId	end_user_id	string
endUserDbUsername	end_user_db_username	string
userId	user_id	string
dbUser	db_user	string
dbName	db_name	string
schemaName	schema_name	string
tableName	table_name	string
path	path	string
hashedRowLevelValue	hashed_row_level_value	string
clearTextRowLevelValue	clear_text_row_level_value	string
timestamp	timestamp	google.protobuf.Timestamp
queriesCount	queries_count	int64
rowsCount	rows_count	int64
timeBucket	time_bucket	google.protobuf.Timestamp

RowLevelMetricConfiguration

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
id	id	string
metricId	metric_id	string
path	path	string
allowClearTextValue	allow_clear_text_value	bool
createdAt	created_at	google.protobuf.Timestamp

GetCustomMetricsDetailsRequest

Parameter	Python Attribute	Type
id	id	string
interval	interval	string
userId	user_id	string

GetCustomMetricsDetailsResponse

Parameter	Python Attribute	Type	Description	Is Optional
series	series	map<string, MetricsGroup>

MetricsGroup

Parameter	Python Attribute	Type	Description	Is Optional
metrics	metrics	RowLevelMetric array
clearText	clear_text	string

GetCustomMetricsRequest

This message has no parameters.

GetCustomMetricsResponse

Parameter	Python Attribute	Type	Description	Is Optional
rowLevelMetricConfigurations	row_level_metric_configurations	RowLevelMetricConfiguration array

CreateCustomMetricRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
path	path	string
allowClearTextValue	allow_clear_text_value	bool

CreateCustomMetricResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteCustomMetricRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteCustomMetricResponse

This message has no parameters.

NativeUser Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).NativeUserClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.NativeUserServiceClient
}

CreateNativeUser

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/CreateNativeUser' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "nativeUserId": <string>, 
    "nativeUserSecret": <string>, 
    "useAsDefault": <bool>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import CreateNativeUserRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.CreateNativeUser(
    CreateNativeUserRequest("data_store_id": <string>, 
        "native_user_id": <string>, 
        "native_user_secret": <string>, 
        "use_as_default": <bool>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.CreateNativeUser(context.Background(), connect.NewRequest(
        &adminv1.CreateNativeUserRequest{DataStoreId: <string>, 
            NativeUserId: <string>, 
            NativeUserSecret: <string>, 
            UseAsDefault: <bool>, 
            TerminationProtection: <bool>},
    ))
}

{
    "dataStoreId": <string>,
    "nativeUserId": <string>,
    "nativeUserSecret": <string>,
    "useAsDefault": <bool>,
    "terminationProtection": <bool>
}

CreateNativeUserRequest(
    data_store_id: <string>,
    native_user_id: <string>,
    native_user_secret: <string>,
    use_as_default: <bool>,
    termination_protection: <bool>
)

CreateNativeUserRequest(
    DataStoreId <string>,
    NativeUserId <string>,
    NativeUserSecret <string>,
    UseAsDefault <bool>,
    TerminationProtection <bool>
)

CreateNativeUserRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
nativeUserSecret	native_user_secret	string
useAsDefault	use_as_default	bool
terminationProtection	termination_protection	bool

CreateNativeUserRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
nativeUserSecret	native_user_secret	string
useAsDefault	use_as_default	bool
terminationProtection	termination_protection	bool

GetNativeUser

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/GetNativeUser' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "nativeUserId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import GetNativeUserRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.GetNativeUser(
    GetNativeUserRequest("data_store_id": <string>, 
        "native_user_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.GetNativeUser(context.Background(), connect.NewRequest(
        &adminv1.GetNativeUserRequest{DataStoreId: <string>, 
            NativeUserId: <string>},
    ))
}

{
    "nativeUser": <NativeUser>
}

GetNativeUserResponse(
    native_user: <NativeUser>
)

GetNativeUserResponse(
    NativeUser <NativeUser>
)

GetNativeUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string

GetNativeUserResponse

Parameter	Python Attribute	Type	Description	Is Optional
nativeUser	native_user	NativeUser

GetNativeUsers

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/GetNativeUsers' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import GetNativeUsersRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.GetNativeUsers(
    GetNativeUsersRequest("data_store_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.GetNativeUsers(context.Background(), connect.NewRequest(
        &adminv1.GetNativeUsersRequest{DataStoreId: <string>},
    ))
}

{
    "nativeUsers": <NativeUser>
}

GetNativeUsersResponse(
    native_users: <NativeUser>
)

GetNativeUsersResponse(
    NativeUsers <NativeUser>
)

GetNativeUsersRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string

GetNativeUsersResponse

Parameter	Python Attribute	Type	Description	Is Optional
nativeUsers	native_users	map<string, NativeUser>

DeleteNativeUser

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/DeleteNativeUser' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "nativeUserId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import DeleteNativeUserRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.DeleteNativeUser(
    DeleteNativeUserRequest("data_store_id": <string>, 
        "native_user_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.DeleteNativeUser(context.Background(), connect.NewRequest(
        &adminv1.DeleteNativeUserRequest{DataStoreId: <string>, 
            NativeUserId: <string>},
    ))
}

{
    "dataStoreId": <string>,
    "nativeUserId": <string>
}

DeleteNativeUserRequest(
    data_store_id: <string>,
    native_user_id: <string>
)

DeleteNativeUserRequest(
    DataStoreId <string>,
    NativeUserId <string>
)

DeleteNativeUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string

DeleteNativeUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string

UpdateNativeUserSecret

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/UpdateNativeUserSecret' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "nativeUserId": <string>, 
    "nativeUserSecret": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import UpdateNativeUserSecretRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.UpdateNativeUserSecret(
    UpdateNativeUserSecretRequest("data_store_id": <string>, 
        "native_user_id": <string>, 
        "native_user_secret": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.UpdateNativeUserSecret(context.Background(), connect.NewRequest(
        &adminv1.UpdateNativeUserSecretRequest{DataStoreId: <string>, 
            NativeUserId: <string>, 
            NativeUserSecret: <string>},
    ))
}

{
    "dataStoreId": <string>,
    "nativeUserId": <string>,
    "nativeUserSecret": <string>
}

UpdateNativeUserSecretRequest(
    data_store_id: <string>,
    native_user_id: <string>,
    native_user_secret: <string>
)

UpdateNativeUserSecretRequest(
    DataStoreId <string>,
    NativeUserId <string>,
    NativeUserSecret <string>
)

UpdateNativeUserSecretRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
nativeUserSecret	native_user_secret	string

UpdateNativeUserSecretRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
nativeUserSecret	native_user_secret	string

SetNativeUserAsDefault

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/SetNativeUserAsDefault' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "nativeUserId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import SetNativeUserAsDefaultRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.SetNativeUserAsDefault(
    SetNativeUserAsDefaultRequest("data_store_id": <string>, 
        "native_user_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.SetNativeUserAsDefault(context.Background(), connect.NewRequest(
        &adminv1.SetNativeUserAsDefaultRequest{DataStoreId: <string>, 
            NativeUserId: <string>},
    ))
}

{
    "dataStoreId": <string>,
    "nativeUserId": <string>
}

SetNativeUserAsDefaultRequest(
    data_store_id: <string>,
    native_user_id: <string>
)

SetNativeUserAsDefaultRequest(
    DataStoreId <string>,
    NativeUserId <string>
)

SetNativeUserAsDefaultRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string

SetNativeUserAsDefaultRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string

SetNativeUserTerminationProtection

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/SetNativeUserTerminationProtection' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import SetNativeUserTerminationProtectionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.SetNativeUserTerminationProtection(
    SetNativeUserTerminationProtectionRequest("id": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.SetNativeUserTerminationProtection(context.Background(), connect.NewRequest(
        &adminv1.SetNativeUserTerminationProtectionRequest{Id: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "id": <string>,
    "terminationProtection": <bool>
}

SetNativeUserTerminationProtectionRequest(
    id: <string>,
    termination_protection: <bool>
)

SetNativeUserTerminationProtectionRequest(
    Id <string>,
    TerminationProtection <bool>
)

SetNativeUserTerminationProtectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool

SetNativeUserTerminationProtectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool

CreateNativeUserIdentityLink

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/CreateNativeUserIdentityLink' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "nativeUserId": <string>, 
    "identityId": <string>, 
    "formalIdentityType": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import CreateNativeUserIdentityLinkRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.CreateNativeUserIdentityLink(
    CreateNativeUserIdentityLinkRequest("data_store_id": <string>, 
        "native_user_id": <string>, 
        "identity_id": <string>, 
        "formal_identity_type": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.CreateNativeUserIdentityLink(context.Background(), connect.NewRequest(
        &adminv1.CreateNativeUserIdentityLinkRequest{DataStoreId: <string>, 
            NativeUserId: <string>, 
            IdentityId: <string>, 
            FormalIdentityType: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "dataStoreId": <string>,
    "nativeUserId": <string>,
    "identityId": <string>,
    "formalIdentityType": <string>,
    "terminationProtection": <bool>
}

CreateNativeUserIdentityLinkRequest(
    data_store_id: <string>,
    native_user_id: <string>,
    identity_id: <string>,
    formal_identity_type: <string>,
    termination_protection: <bool>
)

CreateNativeUserIdentityLinkRequest(
    DataStoreId <string>,
    NativeUserId <string>,
    IdentityId <string>,
    FormalIdentityType <string>,
    TerminationProtection <bool>
)

CreateNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
identityId	identity_id	string
formalIdentityType	formal_identity_type	string
terminationProtection	termination_protection	bool

CreateNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
identityId	identity_id	string
formalIdentityType	formal_identity_type	string
terminationProtection	termination_protection	bool

CreateNativeUserIdentityLinkV2

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/CreateNativeUserIdentityLinkV2' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "nativeUserId": <string>, 
    "identityId": <string>, 
    "formalIdentityType": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import CreateNativeUserIdentityLinkV2Request

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.CreateNativeUserIdentityLinkV2(
    CreateNativeUserIdentityLinkV2Request("data_store_id": <string>, 
        "native_user_id": <string>, 
        "identity_id": <string>, 
        "formal_identity_type": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.CreateNativeUserIdentityLinkV2(context.Background(), connect.NewRequest(
        &adminv1.CreateNativeUserIdentityLinkV2Request{DataStoreId: <string>, 
            NativeUserId: <string>, 
            IdentityId: <string>, 
            FormalIdentityType: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "dataStoreId": <string>,
    "nativeUserId": <string>,
    "identityId": <string>,
    "formalIdentityType": <string>,
    "terminationProtection": <bool>
}

CreateNativeUserIdentityLinkV2Request(
    data_store_id: <string>,
    native_user_id: <string>,
    identity_id: <string>,
    formal_identity_type: <string>,
    termination_protection: <bool>
)

CreateNativeUserIdentityLinkV2Request(
    DataStoreId <string>,
    NativeUserId <string>,
    IdentityId <string>,
    FormalIdentityType <string>,
    TerminationProtection <bool>
)

CreateNativeUserIdentityLinkV2Request

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
identityId	identity_id	string
formalIdentityType	formal_identity_type	string
terminationProtection	termination_protection	bool

CreateNativeUserIdentityLinkV2Request

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
identityId	identity_id	string
formalIdentityType	formal_identity_type	string
terminationProtection	termination_protection	bool

GetNativeUserIdentityLink

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/GetNativeUserIdentityLink' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "identityId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import GetNativeUserIdentityLinkRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.GetNativeUserIdentityLink(
    GetNativeUserIdentityLinkRequest("data_store_id": <string>, 
        "identity_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.GetNativeUserIdentityLink(context.Background(), connect.NewRequest(
        &adminv1.GetNativeUserIdentityLinkRequest{DataStoreId: <string>, 
            IdentityId: <string>},
    ))
}

{
    "dataStoreId": <string>,
    "identityId": <string>
}

GetNativeUserIdentityLinkRequest(
    data_store_id: <string>,
    identity_id: <string>
)

GetNativeUserIdentityLinkRequest(
    DataStoreId <string>,
    IdentityId <string>
)

GetNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
identityId	identity_id	string

GetNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
identityId	identity_id	string

UpdateNativeUserIdentityLink

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/UpdateNativeUserIdentityLink' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import UpdateNativeUserIdentityLinkRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.UpdateNativeUserIdentityLink(
    UpdateNativeUserIdentityLinkRequest("id": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.UpdateNativeUserIdentityLink(context.Background(), connect.NewRequest(
        &adminv1.UpdateNativeUserIdentityLinkRequest{Id: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "id": <string>,
    "terminationProtection": <bool>
}

UpdateNativeUserIdentityLinkRequest(
    id: <string>,
    termination_protection: <bool>
)

UpdateNativeUserIdentityLinkRequest(
    Id <string>,
    TerminationProtection <bool>
)

UpdateNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool		True

UpdateNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool		True

DeleteNativeUserIdentityLink

curl 'https://adminv2.api.formalcloud.net/admin.v1.NativeUserService/DeleteNativeUserIdentityLink' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "dataStoreId": <string>, 
    "identityId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.native_user_pb2 import DeleteNativeUserIdentityLinkRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.NativeUserClient.DeleteNativeUserIdentityLink(
    DeleteNativeUserIdentityLinkRequest("data_store_id": <string>, 
        "identity_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.NativeUserServiceClient.DeleteNativeUserIdentityLink(context.Background(), connect.NewRequest(
        &adminv1.DeleteNativeUserIdentityLinkRequest{DataStoreId: <string>, 
            IdentityId: <string>},
    ))
}

{
    "dataStoreId": <string>,
    "identityId": <string>
}

DeleteNativeUserIdentityLinkRequest(
    data_store_id: <string>,
    identity_id: <string>
)

DeleteNativeUserIdentityLinkRequest(
    DataStoreId <string>,
    IdentityId <string>
)

DeleteNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
identityId	identity_id	string

DeleteNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
identityId	identity_id	string

CreateNativeUserRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
nativeUserSecret	native_user_secret	string
useAsDefault	use_as_default	bool
terminationProtection	termination_protection	bool

CreateNativeUserResponse

Parameter	Python Attribute	Type	Description	Is Optional
nativeUser	native_user	NativeUser

GetNativeUsersRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string

GetNativeUsersResponse

Parameter	Python Attribute	Type	Description	Is Optional
nativeUsers	native_users	map<string, NativeUser>

GetNativeUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string

GetNativeUserResponse

Parameter	Python Attribute	Type	Description	Is Optional
nativeUser	native_user	NativeUser

NativeUser

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
nativeUserId	native_user_id	string
nativeUserSecret	native_user_secret	string
useAsDefault	use_as_default	bool
createdAt	created_at	int64
users	users	string array
groups	groups	string array
id	id	string
terminationProtection	termination_protection	bool

DeleteNativeUserRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string

DeleteNativeUserResponse

This message has no parameters.

UpdateNativeUserSecretRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
nativeUserSecret	native_user_secret	string

UpdateNativeUserSecretResponse

This message has no parameters.

SetNativeUserAsDefaultRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string

SetNativeUserAsDefaultResponse

This message has no parameters.

SetNativeUserTerminationProtectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool

SetNativeUserTerminationProtectionResponse

This message has no parameters.

CreateNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
identityId	identity_id	string
formalIdentityType	formal_identity_type	string
terminationProtection	termination_protection	bool

CreateNativeUserIdentityLinkResponse

Parameter	Python Attribute	Type	Description	Is Optional
link	link	NativeUserLink

GetNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
identityId	identity_id	string

CreateNativeUserIdentityLinkV2Request

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
nativeUserId	native_user_id	string
identityId	identity_id	string
formalIdentityType	formal_identity_type	string
terminationProtection	termination_protection	bool

CreateNativeUserIdentityLinkV2Response

Parameter	Python Attribute	Type	Description	Is Optional
link	link	NativeUserLink

GetNativeUserIdentityLinkResponse

Parameter	Python Attribute	Type	Description	Is Optional
link	link	NativeUserLink

DeleteNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
dataStoreId	data_store_id	string
identityId	identity_id	string

DeleteNativeUserIdentityLinkResponse

This message has no parameters.

UpdateNativeUserIdentityLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool		True

UpdateNativeUserIdentityLinkResponse

This message has no parameters.

NativeUserLink

Parameter	Python Attribute	Type
dataStoreId	data_store_id	string
formalIdentityId	formal_identity_id	string
formalIdentityType	formal_identity_type	string
nativeUserId	native_user_id	string
terminationProtection	termination_protection	bool
id	id	string

Permission Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.PermissionService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).PermissionClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.PermissionServiceClient
}

GetPermissions

curl 'https://adminv2.api.formalcloud.net/admin.v1.PermissionService/GetPermissions' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.permissions_pb2 import GetPermissionsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PermissionClient.GetPermissions(
    GetPermissionsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PermissionServiceClient.GetPermissions(context.Background(), connect.NewRequest(
        &adminv1.GetPermissionsRequest{},
    ))
}

{
    "permissions": <bool>
}

GetPermissionsResponse(
    permissions: <bool>
)

GetPermissionsResponse(
    Permissions <bool>
)

GetPermissionsRequest

This request has no parameters.

GetPermissionsResponse

Parameter	Python Attribute	Type	Description	Is Optional
permissions	permissions	map<string, bool>

GetPermissionsByService

curl 'https://adminv2.api.formalcloud.net/admin.v1.PermissionService/GetPermissionsByService' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "service": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.permissions_pb2 import GetPermissionsByServiceRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PermissionClient.GetPermissionsByService(
    GetPermissionsByServiceRequest("service": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PermissionServiceClient.GetPermissionsByService(context.Background(), connect.NewRequest(
        &adminv1.GetPermissionsByServiceRequest{Service: <string>},
    ))
}

{
    "service": <string>
}

GetPermissionsByServiceRequest(
    service: <string>
)

GetPermissionsByServiceRequest(
    Service <string>
)

GetPermissionsByServiceRequest

Parameter	Python Attribute	Type	Description	Is Optional
service	service	string

GetPermissionsByServiceRequest

Parameter	Python Attribute	Type	Description	Is Optional
service	service	string

GetPermissionsByServiceRequest

Parameter	Python Attribute	Type	Description	Is Optional
service	service	string

GetPermissionsByServiceResponse

Parameter	Python Attribute	Type	Description	Is Optional
permissions	permissions	map<string, bool>

GetPermissionsRequest

This message has no parameters.

GetPermissionsResponse

Parameter	Python Attribute	Type	Description	Is Optional
permissions	permissions	map<string, bool>

Policy Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).PolicyClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.PolicyServiceClient
}

GetPolicies

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/GetPolicies' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import GetPoliciesRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.GetPolicies(
    GetPoliciesRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.GetPolicies(context.Background(), connect.NewRequest(
        &adminv1.GetPoliciesRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>},
    ))
}

{
    "policies": <types.v1.Policy[]>,
    "listMetadata": <types.v1.ListMetadata>
}

GetPoliciesResponse(
    policies: <types.v1.Policy[]>,
    list_metadata: <types.v1.ListMetadata>
)

GetPoliciesResponse(
    Policies <types.v1.Policy[]>,
    ListMetadata <types.v1.ListMetadata>
)

GetPoliciesRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

GetPoliciesResponse

Parameter	Python Attribute	Type	Description	Is Optional
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata

GetPolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/GetPolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "policyId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import GetPolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.GetPolicy(
    GetPolicyRequest("policy_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.GetPolicy(context.Background(), connect.NewRequest(
        &adminv1.GetPolicyRequest{PolicyId: <string>},
    ))
}

{
    "policy": <types.v1.Policy>
}

GetPolicyResponse(
    policy: <types.v1.Policy>
)

GetPolicyResponse(
    Policy <types.v1.Policy>
)

GetPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
policyId	policy_id	string

GetPolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.Policy

GetPolicyV2

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/GetPolicyV2' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "policyId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import GetPolicyV2Request

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.GetPolicyV2(
    GetPolicyV2Request("policy_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.GetPolicyV2(context.Background(), connect.NewRequest(
        &adminv1.GetPolicyV2Request{PolicyId: <string>},
    ))
}

{
    "policy": <types.v1.PolicyV2>
}

GetPolicyV2Response(
    policy: <types.v1.PolicyV2>
)

GetPolicyV2Response(
    Policy <types.v1.PolicyV2>
)

GetPolicyV2Request

Parameter	Python Attribute	Type	Description	Is Optional
policyId	policy_id	string

GetPolicyV2Response

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.PolicyV2

CreatePolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/CreatePolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "sourceType": <string>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "sourceType": <string>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "policy": <types.v1.Policy>, 
    "policy": <types.v1.PolicyV2>, 
    "id": <string>, 
    "sourceType": <string>, 
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "id": <string>, 
    "sourceType": <string>, 
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "policyId": <string>, 
    "policyId": <string>, 
    "policy": <types.v1.Policy>, 
    "policy": <types.v1.PolicyV2>, 
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "policies": <types.v1.Policy[]>, 
    "listMetadata": <types.v1.ListMetadata>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>, 
    "id": <string>, 
    "id": <string>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import CreatePolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.CreatePolicy(
    CreatePolicyRequest("name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "source_type": <string>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "source_type": <string>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "policy": <types.v1.Policy>, 
        "policy": <types.v1.PolicyV2>, 
        "id": <string>, 
        "source_type": <string>, 
        "name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "id": <string>, 
        "source_type": <string>, 
        "name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "policy_id": <string>, 
        "policy_id": <string>, 
        "policy": <types.v1.Policy>, 
        "policy": <types.v1.PolicyV2>, 
        "limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "policies": <types.v1.Policy[]>, 
        "list_metadata": <types.v1.ListMetadata>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>, 
        "id": <string>, 
        "id": <string>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.CreatePolicy(context.Background(), connect.NewRequest(
        &adminv1.CreatePolicyRequest{Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            SourceType: <string>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            SourceType: <string>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            Policy: <types.v1.Policy>, 
            Policy: <types.v1.PolicyV2>, 
            Id: <string>, 
            SourceType: <string>, 
            Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            Id: <string>, 
            SourceType: <string>, 
            Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            PolicyId: <string>, 
            PolicyId: <string>, 
            Policy: <types.v1.Policy>, 
            Policy: <types.v1.PolicyV2>, 
            Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Policies: <types.v1.Policy[]>, 
            ListMetadata: <types.v1.ListMetadata>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>, 
            Id: <string>, 
            Id: <string>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>},
    ))
}

{
    "policy": <types.v1.Policy>
}

CreatePolicyResponse(
    policy: <types.v1.Policy>
)

CreatePolicyResponse(
    Policy <types.v1.Policy>
)

CreatePolicyRequest

Parameter	Python Attribute	Type
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
active	active	bool
terminationProtection	termination_protection	bool
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
active	active	bool
terminationProtection	termination_protection	bool
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
policyId	policy_id	string
policyId	policy_id	string
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
limit	limit	int32
cursor	cursor	string
order	order	string
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

CreatePolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.Policy

CreatePolicyV2

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/CreatePolicyV2' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "sourceType": <string>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "policy": <types.v1.Policy>, 
    "policy": <types.v1.PolicyV2>, 
    "id": <string>, 
    "sourceType": <string>, 
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "id": <string>, 
    "sourceType": <string>, 
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "policyId": <string>, 
    "policyId": <string>, 
    "policy": <types.v1.Policy>, 
    "policy": <types.v1.PolicyV2>, 
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "policies": <types.v1.Policy[]>, 
    "listMetadata": <types.v1.ListMetadata>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>, 
    "id": <string>, 
    "id": <string>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import CreatePolicyV2Request

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.CreatePolicyV2(
    CreatePolicyV2Request("name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "source_type": <string>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "policy": <types.v1.Policy>, 
        "policy": <types.v1.PolicyV2>, 
        "id": <string>, 
        "source_type": <string>, 
        "name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "id": <string>, 
        "source_type": <string>, 
        "name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "policy_id": <string>, 
        "policy_id": <string>, 
        "policy": <types.v1.Policy>, 
        "policy": <types.v1.PolicyV2>, 
        "limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "policies": <types.v1.Policy[]>, 
        "list_metadata": <types.v1.ListMetadata>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>, 
        "id": <string>, 
        "id": <string>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.CreatePolicyV2(context.Background(), connect.NewRequest(
        &adminv1.CreatePolicyV2Request{Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            SourceType: <string>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            Policy: <types.v1.Policy>, 
            Policy: <types.v1.PolicyV2>, 
            Id: <string>, 
            SourceType: <string>, 
            Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            Id: <string>, 
            SourceType: <string>, 
            Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            PolicyId: <string>, 
            PolicyId: <string>, 
            Policy: <types.v1.Policy>, 
            Policy: <types.v1.PolicyV2>, 
            Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Policies: <types.v1.Policy[]>, 
            ListMetadata: <types.v1.ListMetadata>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>, 
            Id: <string>, 
            Id: <string>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>},
    ))
}

{
    "policy": <types.v1.PolicyV2>
}

CreatePolicyV2Response(
    policy: <types.v1.PolicyV2>
)

CreatePolicyV2Response(
    Policy <types.v1.PolicyV2>
)

CreatePolicyV2Request

Parameter	Python Attribute	Type
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
active	active	bool
terminationProtection	termination_protection	bool
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
policyId	policy_id	string
policyId	policy_id	string
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
limit	limit	int32
cursor	cursor	string
order	order	string
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

CreatePolicyV2Response

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.PolicyV2

UpdatePolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/UpdatePolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "sourceType": <string>, 
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "id": <string>, 
    "sourceType": <string>, 
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "policyId": <string>, 
    "policyId": <string>, 
    "policy": <types.v1.Policy>, 
    "policy": <types.v1.PolicyV2>, 
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "policies": <types.v1.Policy[]>, 
    "listMetadata": <types.v1.ListMetadata>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>, 
    "id": <string>, 
    "id": <string>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import UpdatePolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.UpdatePolicy(
    UpdatePolicyRequest("id": <string>, 
        "source_type": <string>, 
        "name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "id": <string>, 
        "source_type": <string>, 
        "name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "policy_id": <string>, 
        "policy_id": <string>, 
        "policy": <types.v1.Policy>, 
        "policy": <types.v1.PolicyV2>, 
        "limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "policies": <types.v1.Policy[]>, 
        "list_metadata": <types.v1.ListMetadata>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>, 
        "id": <string>, 
        "id": <string>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.UpdatePolicy(context.Background(), connect.NewRequest(
        &adminv1.UpdatePolicyRequest{Id: <string>, 
            SourceType: <string>, 
            Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            Id: <string>, 
            SourceType: <string>, 
            Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            PolicyId: <string>, 
            PolicyId: <string>, 
            Policy: <types.v1.Policy>, 
            Policy: <types.v1.PolicyV2>, 
            Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Policies: <types.v1.Policy[]>, 
            ListMetadata: <types.v1.ListMetadata>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>, 
            Id: <string>, 
            Id: <string>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>},
    ))
}

{}

UpdatePolicyResponse()

UpdatePolicyResponse()

UpdatePolicyRequest

Parameter	Python Attribute	Type
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
policyId	policy_id	string
policyId	policy_id	string
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
limit	limit	int32
cursor	cursor	string
order	order	string
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

UpdatePolicyResponse

This response has no parameters.

UpdatePolicyV2

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/UpdatePolicyV2' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "sourceType": <string>, 
    "name": <string>, 
    "description": <string>, 
    "code": <string>, 
    "notification": <string>, 
    "owners": <string[]>, 
    "active": <bool>, 
    "terminationProtection": <bool>, 
    "policyId": <string>, 
    "policyId": <string>, 
    "policy": <types.v1.Policy>, 
    "policy": <types.v1.PolicyV2>, 
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "policies": <types.v1.Policy[]>, 
    "listMetadata": <types.v1.ListMetadata>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>, 
    "id": <string>, 
    "id": <string>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import UpdatePolicyV2Request

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.UpdatePolicyV2(
    UpdatePolicyV2Request("id": <string>, 
        "source_type": <string>, 
        "name": <string>, 
        "description": <string>, 
        "code": <string>, 
        "notification": <string>, 
        "owners": <string[]>, 
        "active": <bool>, 
        "termination_protection": <bool>, 
        "policy_id": <string>, 
        "policy_id": <string>, 
        "policy": <types.v1.Policy>, 
        "policy": <types.v1.PolicyV2>, 
        "limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "policies": <types.v1.Policy[]>, 
        "list_metadata": <types.v1.ListMetadata>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>, 
        "id": <string>, 
        "id": <string>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.UpdatePolicyV2(context.Background(), connect.NewRequest(
        &adminv1.UpdatePolicyV2Request{Id: <string>, 
            SourceType: <string>, 
            Name: <string>, 
            Description: <string>, 
            Code: <string>, 
            Notification: <string>, 
            Owners: <string[]>, 
            Active: <bool>, 
            TerminationProtection: <bool>, 
            PolicyId: <string>, 
            PolicyId: <string>, 
            Policy: <types.v1.Policy>, 
            Policy: <types.v1.PolicyV2>, 
            Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Policies: <types.v1.Policy[]>, 
            ListMetadata: <types.v1.ListMetadata>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>, 
            Id: <string>, 
            Id: <string>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>},
    ))
}

{}

UpdatePolicyV2Response()

UpdatePolicyV2Response()

UpdatePolicyV2Request

Parameter	Python Attribute	Type
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
policyId	policy_id	string
policyId	policy_id	string
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
limit	limit	int32
cursor	cursor	string
order	order	string
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

UpdatePolicyV2Response

This response has no parameters.

DeletePolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/DeletePolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import DeletePolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.DeletePolicy(
    DeletePolicyRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.DeletePolicy(context.Background(), connect.NewRequest(
        &adminv1.DeletePolicyRequest{Id: <string>},
    ))
}

{}

DeletePolicyResponse()

DeletePolicyResponse()

DeletePolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeletePolicyResponse

This response has no parameters.

DryRunPolicies

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/DryRunPolicies' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "policyRuleType": <PolicyRuleType>, 
    "applicationName": <string>, 
    "clientIpAddress": <string>, 
    "clientTls": <bool>, 
    "statementType": <string>, 
    "dbName": <string>, 
    "schemaPaths": <string[]>, 
    "tablePaths": <string[]>, 
    "columnTags": <string[]>, 
    "columnName": <string>, 
    "columnPath": <string>, 
    "dataLabel": <string>, 
    "sidecarId": <string>, 
    "aws": <AWS>, 
    "columns": <ColumnPolicy[]>, 
    "userId": <string>, 
    "endUserId": <string>, 
    "datastore": <Resource>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import DryRunPoliciesRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.DryRunPolicies(
    DryRunPoliciesRequest("policy_rule_type": <PolicyRuleType>, 
        "application_name": <string>, 
        "client_ip_address": <string>, 
        "client_tls": <bool>, 
        "statement_type": <string>, 
        "db_name": <string>, 
        "schema_paths": <string[]>, 
        "table_paths": <string[]>, 
        "column_tags": <string[]>, 
        "column_name": <string>, 
        "column_path": <string>, 
        "data_label": <string>, 
        "sidecar_id": <string>, 
        "aws": <AWS>, 
        "columns": <ColumnPolicy[]>, 
        "user_id": <string>, 
        "end_user_id": <string>, 
        "datastore": <Resource>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.DryRunPolicies(context.Background(), connect.NewRequest(
        &adminv1.DryRunPoliciesRequest{PolicyRuleType: <PolicyRuleType>, 
            ApplicationName: <string>, 
            ClientIpAddress: <string>, 
            ClientTls: <bool>, 
            StatementType: <string>, 
            DbName: <string>, 
            SchemaPaths: <string[]>, 
            TablePaths: <string[]>, 
            ColumnTags: <string[]>, 
            ColumnName: <string>, 
            ColumnPath: <string>, 
            DataLabel: <string>, 
            SidecarId: <string>, 
            Aws: <AWS>, 
            Columns: <ColumnPolicy[]>, 
            UserId: <string>, 
            EndUserId: <string>, 
            Datastore: <Resource>},
    ))
}

{
    "results": <PolicyType[]>
}

DryRunPoliciesResponse(
    results: <PolicyType[]>
)

DryRunPoliciesResponse(
    Results <PolicyType[]>
)

DryRunPoliciesRequest

Parameter	Python Attribute	Type
policyRuleType	policy_rule_type	PolicyRuleType
applicationName	application_name	string
clientIpAddress	client_ip_address	string
clientTls	client_tls	bool
statementType	statement_type	string
dbName	db_name	string
schemaPaths	schema_paths	string array
tablePaths	table_paths	string array
columnTags	column_tags	string array
columnName	column_name	string
columnPath	column_path	string
dataLabel	data_label	string
sidecarId	sidecar_id	string
aws	aws	AWS
columns	columns	ColumnPolicy array
userId	user_id	string
endUserId	end_user_id	string
datastore	datastore	Resource

DryRunPoliciesResponse

Parameter	Python Attribute	Type	Description	Is Optional
results	results	PolicyType array

EvaluatePolicyValidity

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/EvaluatePolicyValidity' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "code": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import EvaluatePolicyValidityRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.EvaluatePolicyValidity(
    EvaluatePolicyValidityRequest("code": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.EvaluatePolicyValidity(context.Background(), connect.NewRequest(
        &adminv1.EvaluatePolicyValidityRequest{Code: <string>},
    ))
}

{
    "code": <string>
}

EvaluatePolicyValidityRequest(
    code: <string>
)

EvaluatePolicyValidityRequest(
    Code <string>
)

EvaluatePolicyValidityRequest

Parameter	Python Attribute	Type	Description	Is Optional
code	code	string

EvaluatePolicyValidityRequest

Parameter	Python Attribute	Type	Description	Is Optional
code	code	string

CreatePolicySuggestion

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/CreatePolicySuggestion' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "description": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import CreatePolicySuggestionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.CreatePolicySuggestion(
    CreatePolicySuggestionRequest("name": <string>, 
        "description": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.CreatePolicySuggestion(context.Background(), connect.NewRequest(
        &adminv1.CreatePolicySuggestionRequest{Name: <string>, 
            Description: <string>},
    ))
}

{
    "name": <string>,
    "description": <string>
}

CreatePolicySuggestionRequest(
    name: <string>,
    description: <string>
)

CreatePolicySuggestionRequest(
    Name <string>,
    Description <string>
)

CreatePolicySuggestionRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string
description	description	string

CreatePolicySuggestionRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string
description	description	string

CreateSuspensionPolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/CreateSuspensionPolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>, 
    "id": <string>, 
    "id": <string>, 
    "policyId": <string>, 
    "identityId": <string>, 
    "identityType": <string>, 
    "expireAt": <google.protobuf.Timestamp>, 
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import CreateSuspensionPolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.CreateSuspensionPolicy(
    CreateSuspensionPolicyRequest("policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>, 
        "id": <string>, 
        "id": <string>, 
        "policy_id": <string>, 
        "identity_id": <string>, 
        "identity_type": <string>, 
        "expire_at": <google.protobuf.Timestamp>, 
        "id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.CreateSuspensionPolicy(context.Background(), connect.NewRequest(
        &adminv1.CreateSuspensionPolicyRequest{PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>, 
            Id: <string>, 
            Id: <string>, 
            PolicyId: <string>, 
            IdentityId: <string>, 
            IdentityType: <string>, 
            ExpireAt: <google.protobuf.Timestamp>, 
            Id: <string>},
    ))
}

{
    "policyId": <string>,
    "identityId": <string>,
    "identityType": <string>,
    "expireAt": <google.protobuf.Timestamp>,
    "id": <string>,
    "id": <string>,
    "id": <string>,
    "policyId": <string>,
    "identityId": <string>,
    "identityType": <string>,
    "expireAt": <google.protobuf.Timestamp>,
    "id": <string>
}

CreateSuspensionPolicyRequest(
    policy_id: <string>,
    identity_id: <string>,
    identity_type: <string>,
    expire_at: <google.protobuf.Timestamp>,
    id: <string>,
    id: <string>,
    id: <string>,
    policy_id: <string>,
    identity_id: <string>,
    identity_type: <string>,
    expire_at: <google.protobuf.Timestamp>,
    id: <string>
)

CreateSuspensionPolicyRequest(
    PolicyId <string>,
    IdentityId <string>,
    IdentityType <string>,
    ExpireAt <google.protobuf.Timestamp>,
    Id <string>,
    Id <string>,
    Id <string>,
    PolicyId <string>,
    IdentityId <string>,
    IdentityType <string>,
    ExpireAt <google.protobuf.Timestamp>,
    Id <string>
)

CreateSuspensionPolicyRequest

Parameter	Python Attribute	Type
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

CreateSuspensionPolicyRequest

Parameter	Python Attribute	Type
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

GetSuspensionPolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/GetSuspensionPolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import GetSuspensionPolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.GetSuspensionPolicy(
    GetSuspensionPolicyRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.GetSuspensionPolicy(context.Background(), connect.NewRequest(
        &adminv1.GetSuspensionPolicyRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetSuspensionPolicyRequest(
    id: <string>
)

GetSuspensionPolicyRequest(
    Id <string>
)

GetSuspensionPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSuspensionPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteSuspensionPolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.PolicyService/DeleteSuspensionPolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.policies_pb2 import DeleteSuspensionPolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.PolicyClient.DeleteSuspensionPolicy(
    DeleteSuspensionPolicyRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.PolicyServiceClient.DeleteSuspensionPolicy(context.Background(), connect.NewRequest(
        &adminv1.DeleteSuspensionPolicyRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

DeleteSuspensionPolicyRequest(
    id: <string>
)

DeleteSuspensionPolicyRequest(
    Id <string>
)

DeleteSuspensionPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteSuspensionPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

CreatePolicySuggestionRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string
description	description	string

CreatePolicySuggestionResponse

Parameter	Python Attribute	Type	Description	Is Optional
suggestion	suggestion	string

DeletePolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeletePolicyResponse

This message has no parameters.

EvaluatePolicyValidityRequest

Parameter	Python Attribute	Type	Description	Is Optional
code	code	string

EvaluatePolicyValidityResponse

Parameter	Python Attribute	Type
valid	valid	bool
ast	ast	string
error	error	string

DryRunPoliciesRequest

Parameter	Python Attribute	Type
policyRuleType	policy_rule_type	PolicyRuleType
applicationName	application_name	string
clientIpAddress	client_ip_address	string
clientTls	client_tls	bool
statementType	statement_type	string
dbName	db_name	string
schemaPaths	schema_paths	string array
tablePaths	table_paths	string array
columnTags	column_tags	string array
columnName	column_name	string
columnPath	column_path	string
dataLabel	data_label	string
sidecarId	sidecar_id	string
aws	aws	AWS
columns	columns	ColumnPolicy array
userId	user_id	string
endUserId	end_user_id	string
datastore	datastore	Resource

Resource

Parameter	Python Attribute	Type
id	id	string
name	name	string
technology	technology	string
hostname	hostname	string
port	port	int32

ColumnPolicy

Parameter	Python Attribute	Type
index	index	int32
parentColumnPath	parent_column_path	string
parentColumnType	parent_column_type	string
parentIsArray	parent_is_array	bool
parentIndex	parent_index	int32
parentDataType	parent_data_type	string
subColumn	sub_column	bool
dataType	data_type	string
name	name	string
path	path	string
tags	tags	string array
dataLabel	data_label	string
value	value	google.protobuf.Any
rowLevelUsage	row_level_usage	map<string, int64>
arrayIndex	array_index	int32
jsonPath	json_path	string

AWSAccount

Parameter	Python Attribute	Type	Description	Is Optional
accountId	account_id	string
region	region	string

AWSEC2

Parameter	Python Attribute	Type	Description	Is Optional
instanceId	instance_id	string

AWSECS

Parameter	Python Attribute	Type
clusterName	cluster_name	string
serviceName	service_name	string
taskId	task_id	string
containerName	container_name	string

AWS

Parameter	Python Attribute	Type
account	account	AWSAccount
ec2	ec2	AWSEC2
ecs	ecs	AWSECS

DryRunPoliciesResponse

Parameter	Python Attribute	Type	Description	Is Optional
results	results	PolicyType array

CreatePolicyRequest

Parameter	Python Attribute	Type
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
active	active	bool
terminationProtection	termination_protection	bool
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
active	active	bool
terminationProtection	termination_protection	bool
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
policyId	policy_id	string
policyId	policy_id	string
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
limit	limit	int32
cursor	cursor	string
order	order	string
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

CreatePolicyV2Request

Parameter	Python Attribute	Type
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
active	active	bool
terminationProtection	termination_protection	bool
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
policyId	policy_id	string
policyId	policy_id	string
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
limit	limit	int32
cursor	cursor	string
order	order	string
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

CreatePolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.Policy

CreatePolicyV2Response

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.PolicyV2

UpdatePolicyRequest

Parameter	Python Attribute	Type
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
policyId	policy_id	string
policyId	policy_id	string
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
limit	limit	int32
cursor	cursor	string
order	order	string
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

UpdatePolicyV2Request

Parameter	Python Attribute	Type
id	id	string
sourceType	source_type	string
name	name	string
description	description	string
code	code	string
notification	notification	string
owners	owners	string array
active	active	bool
terminationProtection	termination_protection	bool
policyId	policy_id	string
policyId	policy_id	string
policy	policy	types.v1.Policy
policy	policy	types.v1.PolicyV2
limit	limit	int32
cursor	cursor	string
order	order	string
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

UpdatePolicyResponse

This message has no parameters.

UpdatePolicyV2Response

This message has no parameters.

GetPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
policyId	policy_id	string

GetPolicyV2Request

Parameter	Python Attribute	Type	Description	Is Optional
policyId	policy_id	string

GetPolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.Policy

GetPolicyV2Response

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.PolicyV2

GetPoliciesRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string

GetPoliciesResponse

Parameter	Python Attribute	Type	Description	Is Optional
policies	policies	types.v1.Policy array
listMetadata	list_metadata	types.v1.ListMetadata

CreateSuspensionPolicyRequest

Parameter	Python Attribute	Type
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string
id	id	string
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

CreateSuspensionPolicyResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSuspensionPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSuspensionPolicyResponse

Parameter	Python Attribute	Type
id	id	string
policyId	policy_id	string
identityId	identity_id	string
identityType	identity_type	string
expireAt	expire_at	google.protobuf.Timestamp
id	id	string

DeleteSuspensionPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteSuspensionPolicyResponse

This message has no parameters.

Registry Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.RegistryService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).RegistryClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.RegistryServiceClient
}

GetOnlineInstancesByOrgId

curl 'https://adminv2.api.formalcloud.net/admin.v1.RegistryService/GetOnlineInstancesByOrgId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.registry_pb2 import GetOnlineInstancesByOrgIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.RegistryClient.GetOnlineInstancesByOrgId(
    GetOnlineInstancesByOrgIdRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.RegistryServiceClient.GetOnlineInstancesByOrgId(context.Background(), connect.NewRequest(
        &adminv1.GetOnlineInstancesByOrgIdRequest{},
    ))
}

{}

GetOnlineInstancesByOrgIdRequest()

GetOnlineInstancesByOrgIdRequest()

GetOnlineInstancesByOrgIdRequest

This request has no parameters.

GetOnlineInstancesByOrgIdRequest

This response has no parameters.

GetOnlineInstancesBySidecarId

curl 'https://adminv2.api.formalcloud.net/admin.v1.RegistryService/GetOnlineInstancesBySidecarId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "sidecarId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.registry_pb2 import GetOnlineInstancesBySidecarIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.RegistryClient.GetOnlineInstancesBySidecarId(
    GetOnlineInstancesBySidecarIdRequest("sidecar_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.RegistryServiceClient.GetOnlineInstancesBySidecarId(context.Background(), connect.NewRequest(
        &adminv1.GetOnlineInstancesBySidecarIdRequest{SidecarId: <string>},
    ))
}

{
    "sidecarId": <string>
}

GetOnlineInstancesBySidecarIdRequest(
    sidecar_id: <string>
)

GetOnlineInstancesBySidecarIdRequest(
    SidecarId <string>
)

GetOnlineInstancesBySidecarIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
sidecarId	sidecar_id	string

GetOnlineInstancesBySidecarIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
sidecarId	sidecar_id	string

OnlineInstance

Parameter	Python Attribute	Type
instanceId	instance_id	string
lastSeen	last_seen	google.protobuf.Timestamp
startTime	start_time	google.protobuf.Timestamp
version	version	string

OnlineSidecar

Parameter	Python Attribute	Type	Description	Is Optional
sidecarId	sidecar_id	string
instances	instances	OnlineInstance array

GetOnlineInstancesByOrgIdRequest

This message has no parameters.

GetOnlineInstancesByOrgIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
sidecars	sidecars	map<string, OnlineSidecar>

GetOnlineInstancesBySidecarIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
sidecarId	sidecar_id	string

GetOnlineInstancesBySidecarIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
instances	instances	OnlineInstance array

Satellite Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.SatelliteService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).SatelliteClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.SatelliteServiceClient
}

CreateSatellite

curl 'https://adminv2.api.formalcloud.net/admin.v1.SatelliteService/CreateSatellite' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.satellite_pb2 import CreateSatelliteRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SatelliteClient.CreateSatellite(
    CreateSatelliteRequest("name": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SatelliteServiceClient.CreateSatellite(context.Background(), connect.NewRequest(
        &adminv1.CreateSatelliteRequest{Name: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "id": <string>
}

CreateSatelliteResponse(
    id: <string>
)

CreateSatelliteResponse(
    Id <string>
)

CreateSatelliteRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string
terminationProtection	termination_protection	bool

CreateSatelliteResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSatelliteById

curl 'https://adminv2.api.formalcloud.net/admin.v1.SatelliteService/GetSatelliteById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.satellite_pb2 import GetSatelliteByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SatelliteClient.GetSatelliteById(
    GetSatelliteByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SatelliteServiceClient.GetSatelliteById(context.Background(), connect.NewRequest(
        &adminv1.GetSatelliteByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetSatelliteByIdRequest(
    id: <string>
)

GetSatelliteByIdRequest(
    Id <string>
)

GetSatelliteByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSatelliteByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSatellites

curl 'https://adminv2.api.formalcloud.net/admin.v1.SatelliteService/GetSatellites' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.satellite_pb2 import GetSatellitesRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SatelliteClient.GetSatellites(
    GetSatellitesRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SatelliteServiceClient.GetSatellites(context.Background(), connect.NewRequest(
        &adminv1.GetSatellitesRequest{},
    ))
}

{
    "satellites": <types.v1.Satellite[]>
}

GetSatellitesResponse(
    satellites: <types.v1.Satellite[]>
)

GetSatellitesResponse(
    Satellites <types.v1.Satellite[]>
)

GetSatellitesRequest

This request has no parameters.

GetSatellitesResponse

Parameter	Python Attribute	Type	Description	Is Optional
satellites	satellites	types.v1.Satellite array

GetSatelliteApiKey

curl 'https://adminv2.api.formalcloud.net/admin.v1.SatelliteService/GetSatelliteApiKey' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.satellite_pb2 import GetSatelliteApiKeyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SatelliteClient.GetSatelliteApiKey(
    GetSatelliteApiKeyRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SatelliteServiceClient.GetSatelliteApiKey(context.Background(), connect.NewRequest(
        &adminv1.GetSatelliteApiKeyRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetSatelliteApiKeyRequest(
    id: <string>
)

GetSatelliteApiKeyRequest(
    Id <string>
)

GetSatelliteApiKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSatelliteApiKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetOnlineInstancesBySatelliteId

curl 'https://adminv2.api.formalcloud.net/admin.v1.SatelliteService/GetOnlineInstancesBySatelliteId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.satellite_pb2 import GetOnlineInstancesBySatelliteIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SatelliteClient.GetOnlineInstancesBySatelliteId(
    GetOnlineInstancesBySatelliteIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SatelliteServiceClient.GetOnlineInstancesBySatelliteId(context.Background(), connect.NewRequest(
        &adminv1.GetOnlineInstancesBySatelliteIdRequest{Id: <string>},
    ))
}

{
    "instances": <SatelliteOnlineInstance[]>
}

GetOnlineInstancesBySatelliteIdResponse(
    instances: <SatelliteOnlineInstance[]>
)

GetOnlineInstancesBySatelliteIdResponse(
    Instances <SatelliteOnlineInstance[]>
)

GetOnlineInstancesBySatelliteIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetOnlineInstancesBySatelliteIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
instances	instances	SatelliteOnlineInstance array

UpdateSatellite

curl 'https://adminv2.api.formalcloud.net/admin.v1.SatelliteService/UpdateSatellite' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "name": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.satellite_pb2 import UpdateSatelliteRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SatelliteClient.UpdateSatellite(
    UpdateSatelliteRequest("id": <string>, 
        "name": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SatelliteServiceClient.UpdateSatellite(context.Background(), connect.NewRequest(
        &adminv1.UpdateSatelliteRequest{Id: <string>, 
            Name: <string>, 
            TerminationProtection: <bool>},
    ))
}

{}

UpdateSatelliteResponse()

UpdateSatelliteResponse()

UpdateSatelliteRequest

Parameter	Python Attribute	Type
id	id	string
name	name	string
terminationProtection	termination_protection	bool

UpdateSatelliteResponse

This response has no parameters.

DeleteSatellite

curl 'https://adminv2.api.formalcloud.net/admin.v1.SatelliteService/DeleteSatellite' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.satellite_pb2 import DeleteSatelliteRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SatelliteClient.DeleteSatellite(
    DeleteSatelliteRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SatelliteServiceClient.DeleteSatellite(context.Background(), connect.NewRequest(
        &adminv1.DeleteSatelliteRequest{Id: <string>},
    ))
}

{}

DeleteSatelliteResponse()

DeleteSatelliteResponse()

DeleteSatelliteRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteSatelliteResponse

This response has no parameters.

CreateSatelliteRequest

Parameter	Python Attribute	Type	Description	Is Optional
name	name	string
terminationProtection	termination_protection	bool

CreateSatelliteResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSatelliteByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSatelliteByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
satellite	satellite	types.v1.Satellite

GetSatellitesRequest

This message has no parameters.

GetSatellitesResponse

Parameter	Python Attribute	Type	Description	Is Optional
satellites	satellites	types.v1.Satellite array

GetSatelliteApiKeyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSatelliteApiKeyResponse

Parameter	Python Attribute	Type	Description	Is Optional
apiKey	api_key	string

UpdateSatelliteRequest

Parameter	Python Attribute	Type
id	id	string
name	name	string
terminationProtection	termination_protection	bool

UpdateSatelliteResponse

This message has no parameters.

DeleteSatelliteRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteSatelliteResponse

This message has no parameters.

SatelliteOnlineInstance

Parameter	Python Attribute	Type
instanceId	instance_id	string
lastSeen	last_seen	google.protobuf.Timestamp
startTime	start_time	google.protobuf.Timestamp
version	version	string

GetOnlineInstancesBySatelliteIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetOnlineInstancesBySatelliteIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
instances	instances	SatelliteOnlineInstance array

Search Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.SearchService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).SearchClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.SearchServiceClient
}

Search

curl 'https://adminv2.api.formalcloud.net/admin.v1.SearchService/Search' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "objectType": <string>, 
    "query": <string>, 
    "filterBy": <string>, 
    "sortBy": <string>, 
    "page": <int32>, 
    "limit": <int32>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.search_pb2 import SearchRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SearchClient.Search(
    SearchRequest("object_type": <string>, 
        "query": <string>, 
        "filter_by": <string>, 
        "sort_by": <string>, 
        "page": <int32>, 
        "limit": <int32>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SearchServiceClient.Search(context.Background(), connect.NewRequest(
        &adminv1.SearchRequest{ObjectType: <string>, 
            Query: <string>, 
            FilterBy: <string>, 
            SortBy: <string>, 
            Page: <int32>, 
            Limit: <int32>},
    ))
}

{
    "users": <WrappedSearchUser>,
    "groups": <WrappedSearchGroup>,
    "policies": <WrappedSearchPolicy>,
    "datastores": <WrappedSearchDatastore>,
    "sidecars": <WrappedSearchSidecar>,
    "inventories": <WrappedSearchInventory>,
    "found": <int32>,
    "page": <int32>,
    "outOf": <int32>,
    "searchTimeMs": <int32>,
    "searchCutoff": <bool>
}

SearchResponse(
    users: <WrappedSearchUser>,
    groups: <WrappedSearchGroup>,
    policies: <WrappedSearchPolicy>,
    datastores: <WrappedSearchDatastore>,
    sidecars: <WrappedSearchSidecar>,
    inventories: <WrappedSearchInventory>,
    found: <int32>,
    page: <int32>,
    out_of: <int32>,
    search_time_ms: <int32>,
    search_cutoff: <bool>
)

SearchResponse(
    Users <WrappedSearchUser>,
    Groups <WrappedSearchGroup>,
    Policies <WrappedSearchPolicy>,
    Datastores <WrappedSearchDatastore>,
    Sidecars <WrappedSearchSidecar>,
    Inventories <WrappedSearchInventory>,
    Found <int32>,
    Page <int32>,
    OutOf <int32>,
    SearchTimeMs <int32>,
    SearchCutoff <bool>
)

SearchRequest

Parameter	Python Attribute	Type
objectType	object_type	string
query	query	string
filterBy	filter_by	string
sortBy	sort_by	string
page	page	int32
limit	limit	int32

SearchResponse

Parameter	Python Attribute	Type
users	users	WrappedSearchUser
groups	groups	WrappedSearchGroup
policies	policies	WrappedSearchPolicy
datastores	datastores	WrappedSearchDatastore
sidecars	sidecars	WrappedSearchSidecar
inventories	inventories	WrappedSearchInventory
found	found	int32
page	page	int32
outOf	out_of	int32
searchTimeMs	search_time_ms	int32
searchCutoff	search_cutoff	bool

SearchRequest

Parameter	Python Attribute	Type
objectType	object_type	string
query	query	string
filterBy	filter_by	string
sortBy	sort_by	string
page	page	int32
limit	limit	int32

SearchResponse

Parameter	Python Attribute	Type
users	users	WrappedSearchUser
groups	groups	WrappedSearchGroup
policies	policies	WrappedSearchPolicy
datastores	datastores	WrappedSearchDatastore
sidecars	sidecars	WrappedSearchSidecar
inventories	inventories	WrappedSearchInventory
found	found	int32
page	page	int32
outOf	out_of	int32
searchTimeMs	search_time_ms	int32
searchCutoff	search_cutoff	bool

WrappedSearchUser

Parameter	Python Attribute	Type	Description	Is Optional
user	user	types.v1.SearchUser array

WrappedSearchGroup

Parameter	Python Attribute	Type	Description	Is Optional
group	group	types.v1.SearchGroup array

WrappedSearchPolicy

Parameter	Python Attribute	Type	Description	Is Optional
policy	policy	types.v1.SearchPolicy array

WrappedSearchDatastore

Parameter	Python Attribute	Type	Description	Is Optional
datastore	datastore	types.v1.SearchDatastore array

WrappedSearchSidecar

Parameter	Python Attribute	Type	Description	Is Optional
sidecar	sidecar	types.v1.SearchSidecar array

WrappedSearchInventory

Parameter	Python Attribute	Type	Description	Is Optional
inventory	inventory	types.v1.SearchInventory array

Sidecar Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).SidecarClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.SidecarServiceClient
}

ListSidecars

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/ListSidecars' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "limit": <int32>, 
    "cursor": <string>, 
    "order": <string>, 
    "search": <string>, 
    "searchFields": <string[]>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import ListSidecarsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.ListSidecars(
    ListSidecarsRequest("limit": <int32>, 
        "cursor": <string>, 
        "order": <string>, 
        "search": <string>, 
        "search_fields": <string[]>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.ListSidecars(context.Background(), connect.NewRequest(
        &adminv1.ListSidecarsRequest{Limit: <int32>, 
            Cursor: <string>, 
            Order: <string>, 
            Search: <string>, 
            SearchFields: <string[]>},
    ))
}

{
    "sidecars": <types.v1.Sidecar[]>,
    "listMetadata": <types.v1.ListMetadata>
}

ListSidecarsResponse(
    sidecars: <types.v1.Sidecar[]>,
    list_metadata: <types.v1.ListMetadata>
)

ListSidecarsResponse(
    Sidecars <types.v1.Sidecar[]>,
    ListMetadata <types.v1.ListMetadata>
)

ListSidecarsRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
search	search	string
searchFields	search_fields	string array

ListSidecarsResponse

Parameter	Python Attribute	Type	Description	Is Optional
sidecars	sidecars	types.v1.Sidecar array
listMetadata	list_metadata	types.v1.ListMetadata

GetSidecarVersions

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/GetSidecarVersions' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "technology": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import GetSidecarVersionsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.GetSidecarVersions(
    GetSidecarVersionsRequest("technology": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.GetSidecarVersions(context.Background(), connect.NewRequest(
        &adminv1.GetSidecarVersionsRequest{Technology: <string>},
    ))
}

{
    "technology": <string>
}

GetSidecarVersionsRequest(
    technology: <string>
)

GetSidecarVersionsRequest(
    Technology <string>
)

GetSidecarVersionsRequest

Parameter	Python Attribute	Type	Description	Is Optional
technology	technology	string

GetSidecarVersionsRequest

Parameter	Python Attribute	Type	Description	Is Optional
technology	technology	string

CreateSidecar

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/CreateSidecar' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "name": <string>, 
    "deploymentType": <string>, 
    "dataplaneId": <string>, 
    "datastoreId": <string>, 
    "failOpen": <bool>, 
    "globalKmsDecrypt": <bool>, 
    "formalHostname": <string>, 
    "version": <string>, 
    "networkType": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import CreateSidecarRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.CreateSidecar(
    CreateSidecarRequest("name": <string>, 
        "deployment_type": <string>, 
        "dataplane_id": <string>, 
        "datastore_id": <string>, 
        "fail_open": <bool>, 
        "global_kms_decrypt": <bool>, 
        "formal_hostname": <string>, 
        "version": <string>, 
        "network_type": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.CreateSidecar(context.Background(), connect.NewRequest(
        &adminv1.CreateSidecarRequest{Name: <string>, 
            DeploymentType: <string>, 
            DataplaneId: <string>, 
            DatastoreId: <string>, 
            FailOpen: <bool>, 
            GlobalKmsDecrypt: <bool>, 
            FormalHostname: <string>, 
            Version: <string>, 
            NetworkType: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "id": <string>
}

CreateSidecarResponse(
    id: <string>
)

CreateSidecarResponse(
    Id <string>
)

CreateSidecarRequest

Parameter	Python Attribute	Type
name	name	string
deploymentType	deployment_type	string
dataplaneId	dataplane_id	string
datastoreId	datastore_id	string
failOpen	fail_open	bool
globalKmsDecrypt	global_kms_decrypt	bool
formalHostname	formal_hostname	string
version	version	string
networkType	network_type	string
terminationProtection	termination_protection	bool

CreateSidecarResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSidecarById

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/GetSidecarById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import GetSidecarByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.GetSidecarById(
    GetSidecarByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.GetSidecarById(context.Background(), connect.NewRequest(
        &adminv1.GetSidecarByIdRequest{Id: <string>},
    ))
}

{
    "sidecar": <types.v1.Sidecar>
}

GetSidecarByIdResponse(
    sidecar: <types.v1.Sidecar>
)

GetSidecarByIdResponse(
    Sidecar <types.v1.Sidecar>
)

GetSidecarByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSidecarByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
sidecar	sidecar	types.v1.Sidecar

GetSidecarTlsCertificateById

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/GetSidecarTlsCertificateById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import GetSidecarTlsCertificateByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.GetSidecarTlsCertificateById(
    GetSidecarTlsCertificateByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.GetSidecarTlsCertificateById(context.Background(), connect.NewRequest(
        &adminv1.GetSidecarTlsCertificateByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetSidecarTlsCertificateByIdRequest(
    id: <string>
)

GetSidecarTlsCertificateByIdRequest(
    Id <string>
)

GetSidecarTlsCertificateByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSidecarTlsCertificateByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

UpdateSidecarName

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/UpdateSidecarName' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "name": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import UpdateSidecarNameRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.UpdateSidecarName(
    UpdateSidecarNameRequest("id": <string>, 
        "name": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.UpdateSidecarName(context.Background(), connect.NewRequest(
        &adminv1.UpdateSidecarNameRequest{Id: <string>, 
            Name: <string>},
    ))
}

{
    "id": <string>,
    "name": <string>
}

UpdateSidecarNameRequest(
    id: <string>,
    name: <string>
)

UpdateSidecarNameRequest(
    Id <string>,
    Name <string>
)

UpdateSidecarNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
name	name	string

UpdateSidecarNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
name	name	string

UpdateSidecarVersion

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/UpdateSidecarVersion' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "version": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import UpdateSidecarVersionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.UpdateSidecarVersion(
    UpdateSidecarVersionRequest("id": <string>, 
        "version": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.UpdateSidecarVersion(context.Background(), connect.NewRequest(
        &adminv1.UpdateSidecarVersionRequest{Id: <string>, 
            Version: <string>},
    ))
}

{
    "id": <string>,
    "version": <string>
}

UpdateSidecarVersionRequest(
    id: <string>,
    version: <string>
)

UpdateSidecarVersionRequest(
    Id <string>,
    Version <string>
)

UpdateSidecarVersionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
version	version	string

UpdateSidecarVersionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
version	version	string

UpdateSidecarFormalHostname

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/UpdateSidecarFormalHostname' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "hostname": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import UpdateSidecarFormalHostnameRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.UpdateSidecarFormalHostname(
    UpdateSidecarFormalHostnameRequest("id": <string>, 
        "hostname": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.UpdateSidecarFormalHostname(context.Background(), connect.NewRequest(
        &adminv1.UpdateSidecarFormalHostnameRequest{Id: <string>, 
            Hostname: <string>},
    ))
}

{
    "id": <string>,
    "hostname": <string>
}

UpdateSidecarFormalHostnameRequest(
    id: <string>,
    hostname: <string>
)

UpdateSidecarFormalHostnameRequest(
    Id <string>,
    Hostname <string>
)

UpdateSidecarFormalHostnameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
hostname	hostname	string

UpdateSidecarFormalHostnameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
hostname	hostname	string

UpdateSidecarKmsDecryptPolicy

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/UpdateSidecarKmsDecryptPolicy' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "enabled": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import UpdateSidecarKmsDecryptPolicyRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.UpdateSidecarKmsDecryptPolicy(
    UpdateSidecarKmsDecryptPolicyRequest("id": <string>, 
        "enabled": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.UpdateSidecarKmsDecryptPolicy(context.Background(), connect.NewRequest(
        &adminv1.UpdateSidecarKmsDecryptPolicyRequest{Id: <string>, 
            Enabled: <bool>},
    ))
}

{
    "id": <string>,
    "enabled": <bool>
}

UpdateSidecarKmsDecryptPolicyRequest(
    id: <string>,
    enabled: <bool>
)

UpdateSidecarKmsDecryptPolicyRequest(
    Id <string>,
    Enabled <bool>
)

UpdateSidecarKmsDecryptPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
enabled	enabled	bool

UpdateSidecarKmsDecryptPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
enabled	enabled	bool

UpdateTerminationProtection

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/UpdateTerminationProtection' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "enabled": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import UpdateTerminationProtectionRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.UpdateTerminationProtection(
    UpdateTerminationProtectionRequest("id": <string>, 
        "enabled": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.UpdateTerminationProtection(context.Background(), connect.NewRequest(
        &adminv1.UpdateTerminationProtectionRequest{Id: <string>, 
            Enabled: <bool>},
    ))
}

{
    "id": <string>,
    "enabled": <bool>
}

UpdateTerminationProtectionRequest(
    id: <string>,
    enabled: <bool>
)

UpdateTerminationProtectionRequest(
    Id <string>,
    Enabled <bool>
)

UpdateTerminationProtectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
enabled	enabled	bool

UpdateTerminationProtectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
enabled	enabled	bool

DeleteSidecar

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/DeleteSidecar' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import DeleteSidecarRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.DeleteSidecar(
    DeleteSidecarRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.DeleteSidecar(context.Background(), connect.NewRequest(
        &adminv1.DeleteSidecarRequest{Id: <string>},
    ))
}

{}

DeleteSidecarResponse()

DeleteSidecarResponse()

DeleteSidecarRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteSidecarResponse

This response has no parameters.

CreateSidecarDatastoreLink

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/CreateSidecarDatastoreLink' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>, 
    "sidecarId": <string>, 
    "port": <int32>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import CreateSidecarDatastoreLinkRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.CreateSidecarDatastoreLink(
    CreateSidecarDatastoreLinkRequest("datastore_id": <string>, 
        "sidecar_id": <string>, 
        "port": <int32>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.CreateSidecarDatastoreLink(context.Background(), connect.NewRequest(
        &adminv1.CreateSidecarDatastoreLinkRequest{DatastoreId: <string>, 
            SidecarId: <string>, 
            Port: <int32>, 
            TerminationProtection: <bool>},
    ))
}

{
    "datastoreId": <string>,
    "sidecarId": <string>,
    "port": <int32>,
    "terminationProtection": <bool>
}

CreateSidecarDatastoreLinkRequest(
    datastore_id: <string>,
    sidecar_id: <string>,
    port: <int32>,
    termination_protection: <bool>
)

CreateSidecarDatastoreLinkRequest(
    DatastoreId <string>,
    SidecarId <string>,
    Port <int32>,
    TerminationProtection <bool>
)

CreateSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
sidecarId	sidecar_id	string
port	port	int32
terminationProtection	termination_protection	bool

CreateSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
sidecarId	sidecar_id	string
port	port	int32
terminationProtection	termination_protection	bool

GetLinkById

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/GetLinkById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import GetLinkByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.GetLinkById(
    GetLinkByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.GetLinkById(context.Background(), connect.NewRequest(
        &adminv1.GetLinkByIdRequest{Id: <string>},
    ))
}

{
    "link": <types.v1.SidecarLink>
}

GetLinkByIdResponse(
    link: <types.v1.SidecarLink>
)

GetLinkByIdResponse(
    Link <types.v1.SidecarLink>
)

GetLinkByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLinkByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
link	link	types.v1.SidecarLink

GetLinksBySidecarId

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/GetLinksBySidecarId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "sidecarId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import GetLinksBySidecarIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.GetLinksBySidecarId(
    GetLinksBySidecarIdRequest("sidecar_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.GetLinksBySidecarId(context.Background(), connect.NewRequest(
        &adminv1.GetLinksBySidecarIdRequest{SidecarId: <string>},
    ))
}

{
    "sidecarId": <string>
}

GetLinksBySidecarIdRequest(
    sidecar_id: <string>
)

GetLinksBySidecarIdRequest(
    SidecarId <string>
)

GetLinksBySidecarIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
sidecarId	sidecar_id	string

GetLinksBySidecarIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
sidecarId	sidecar_id	string

GetLinksByDatastoreId

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/GetLinksByDatastoreId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "datastoreId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import GetLinksByDatastoreIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.GetLinksByDatastoreId(
    GetLinksByDatastoreIdRequest("datastore_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.GetLinksByDatastoreId(context.Background(), connect.NewRequest(
        &adminv1.GetLinksByDatastoreIdRequest{DatastoreId: <string>},
    ))
}

{
    "datastoreId": <string>
}

GetLinksByDatastoreIdRequest(
    datastore_id: <string>
)

GetLinksByDatastoreIdRequest(
    DatastoreId <string>
)

GetLinksByDatastoreIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string

GetLinksByDatastoreIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string

UpdateSidecarDatastoreLink

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/UpdateSidecarDatastoreLink' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>, 
    "terminationProtection": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import UpdateSidecarDatastoreLinkRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.UpdateSidecarDatastoreLink(
    UpdateSidecarDatastoreLinkRequest("id": <string>, 
        "termination_protection": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.UpdateSidecarDatastoreLink(context.Background(), connect.NewRequest(
        &adminv1.UpdateSidecarDatastoreLinkRequest{Id: <string>, 
            TerminationProtection: <bool>},
    ))
}

{
    "id": <string>,
    "terminationProtection": <bool>
}

UpdateSidecarDatastoreLinkRequest(
    id: <string>,
    termination_protection: <bool>
)

UpdateSidecarDatastoreLinkRequest(
    Id <string>,
    TerminationProtection <bool>
)

UpdateSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool		True

UpdateSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool		True

DeleteSidecarDatastoreLink

curl 'https://adminv2.api.formalcloud.net/admin.v1.SidecarService/DeleteSidecarDatastoreLink' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "linkId": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.sidecar_pb2 import DeleteSidecarDatastoreLinkRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.SidecarClient.DeleteSidecarDatastoreLink(
    DeleteSidecarDatastoreLinkRequest("link_id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.SidecarServiceClient.DeleteSidecarDatastoreLink(context.Background(), connect.NewRequest(
        &adminv1.DeleteSidecarDatastoreLinkRequest{LinkId: <string>},
    ))
}

{
    "linkId": <string>
}

DeleteSidecarDatastoreLinkRequest(
    link_id: <string>
)

DeleteSidecarDatastoreLinkRequest(
    LinkId <string>
)

DeleteSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
linkId	link_id	string

DeleteSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
linkId	link_id	string

ListSidecarsRequest

Parameter	Python Attribute	Type
limit	limit	int32
cursor	cursor	string
order	order	string
search	search	string
searchFields	search_fields	string array

ListSidecarsResponse

Parameter	Python Attribute	Type	Description	Is Optional
sidecars	sidecars	types.v1.Sidecar array
listMetadata	list_metadata	types.v1.ListMetadata

GetSidecarVersionsRequest

Parameter	Python Attribute	Type	Description	Is Optional
technology	technology	string

GetSidecarVersionsResponse

Parameter	Python Attribute	Type	Description	Is Optional
versions	versions	string array

CreateSidecarRequest

Parameter	Python Attribute	Type
name	name	string
deploymentType	deployment_type	string
dataplaneId	dataplane_id	string
datastoreId	datastore_id	string
failOpen	fail_open	bool
globalKmsDecrypt	global_kms_decrypt	bool
formalHostname	formal_hostname	string
version	version	string
networkType	network_type	string
terminationProtection	termination_protection	bool

CreateSidecarResponse

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSidecarByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSidecarByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
sidecar	sidecar	types.v1.Sidecar

GetSidecarTlsCertificateByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetSidecarTlsCertificateByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
secret	secret	string

UpdateSidecarNameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
name	name	string

UpdateSidecarNameResponse

This message has no parameters.

UpdateSidecarVersionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
version	version	string

UpdateSidecarVersionResponse

This message has no parameters.

UpdateSidecarFormalHostnameRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
hostname	hostname	string

UpdateSidecarFormalHostnameResponse

This message has no parameters.

UpdateSidecarKmsDecryptPolicyRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
enabled	enabled	bool

UpdateSidecarKmsDecryptPolicyResponse

This message has no parameters.

DeleteSidecarRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

DeleteSidecarResponse

This message has no parameters.

CreateSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
sidecarId	sidecar_id	string
port	port	int32
terminationProtection	termination_protection	bool

CreateSidecarDatastoreLinkResponse

Parameter	Python Attribute	Type	Description	Is Optional
linkId	link_id	string

DeleteSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
linkId	link_id	string

DeleteSidecarDatastoreLinkResponse

This message has no parameters.

GetLinkByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetLinkByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
link	link	types.v1.SidecarLink

GetLinksBySidecarIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
sidecarId	sidecar_id	string

GetLinksBySidecarIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
links	links	types.v1.SidecarLink array

GetLinksByDatastoreIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
datastoreId	datastore_id	string

GetLinksByDatastoreIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
links	links	types.v1.SidecarLink array

UpdateTerminationProtectionRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
enabled	enabled	bool

UpdateTerminationProtectionResponse

This message has no parameters.

UpdateSidecarDatastoreLinkRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
terminationProtection	termination_protection	bool		True

UpdateSidecarDatastoreLinkResponse

This message has no parameters.

DSync Service

url: 'https://adminv2.api.formalcloud.net/admin.v1.DSyncService/'

import os
import formal_sdk

api_key = os.environ.get('API_KEY')
formal_sdk.Client(api_key).DSyncClient

package main

import (
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    formalClient := client.DSyncServiceClient
}

GetDirectory

curl 'https://adminv2.api.formalcloud.net/admin.v1.DSyncService/GetDirectory' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.work_os_pb2 import GetDirectoryRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DSyncClient.GetDirectory(
    GetDirectoryRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DSyncServiceClient.GetDirectory(context.Background(), connect.NewRequest(
        &adminv1.GetDirectoryRequest{},
    ))
}

{
    "directory": <Directory>
}

GetDirectoryResponse(
    directory: <Directory>
)

GetDirectoryResponse(
    Directory <Directory>
)

GetDirectoryRequest

This request has no parameters.

GetDirectoryResponse

Parameter	Python Attribute	Type	Description	Is Optional
directory	directory	Directory

GetGroupsByDirectoryId

curl 'https://adminv2.api.formalcloud.net/admin.v1.DSyncService/GetGroupsByDirectoryId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.work_os_pb2 import GetGroupsByDirectoryIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DSyncClient.GetGroupsByDirectoryId(
    GetGroupsByDirectoryIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DSyncServiceClient.GetGroupsByDirectoryId(context.Background(), connect.NewRequest(
        &adminv1.GetGroupsByDirectoryIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetGroupsByDirectoryIdRequest(
    id: <string>
)

GetGroupsByDirectoryIdRequest(
    Id <string>
)

GetGroupsByDirectoryIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetGroupsByDirectoryIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUsersByDirectoryId

curl 'https://adminv2.api.formalcloud.net/admin.v1.DSyncService/GetUsersByDirectoryId' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.work_os_pb2 import GetUsersByDirectoryIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DSyncClient.GetUsersByDirectoryId(
    GetUsersByDirectoryIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DSyncServiceClient.GetUsersByDirectoryId(context.Background(), connect.NewRequest(
        &adminv1.GetUsersByDirectoryIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetUsersByDirectoryIdRequest(
    id: <string>
)

GetUsersByDirectoryIdRequest(
    Id <string>
)

GetUsersByDirectoryIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUsersByDirectoryIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetWorkOsGroupById

curl 'https://adminv2.api.formalcloud.net/admin.v1.DSyncService/GetWorkOsGroupById' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "id": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.work_os_pb2 import GetWorkOsGroupByIdRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DSyncClient.GetWorkOsGroupById(
    GetWorkOsGroupByIdRequest("id": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DSyncServiceClient.GetWorkOsGroupById(context.Background(), connect.NewRequest(
        &adminv1.GetWorkOsGroupByIdRequest{Id: <string>},
    ))
}

{
    "id": <string>
}

GetWorkOsGroupByIdRequest(
    id: <string>
)

GetWorkOsGroupByIdRequest(
    Id <string>
)

GetWorkOsGroupByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetWorkOsGroupByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetDirectoryGroups

curl 'https://adminv2.api.formalcloud.net/admin.v1.DSyncService/GetDirectoryGroups' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.work_os_pb2 import GetDirectoryGroupsRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DSyncClient.GetDirectoryGroups(
    GetDirectoryGroupsRequest()
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DSyncServiceClient.GetDirectoryGroups(context.Background(), connect.NewRequest(
        &adminv1.GetDirectoryGroupsRequest{},
    ))
}

{}

GetDirectoryGroupsRequest()

GetDirectoryGroupsRequest()

GetDirectoryGroupsRequest

This request has no parameters.

GetDirectoryGroupsRequest

This response has no parameters.

UpdateDirectoryGroupSync

curl 'https://adminv2.api.formalcloud.net/admin.v1.DSyncService/UpdateDirectoryGroupSync' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "fGroupId": <string>, 
    "dGroupId": <string>, 
    "deselectedUserIds": <bool>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.work_os_pb2 import UpdateDirectoryGroupSyncRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DSyncClient.UpdateDirectoryGroupSync(
    UpdateDirectoryGroupSyncRequest("f_group_id": <string>, 
        "d_group_id": <string>, 
        "deselected_user_ids": <bool>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DSyncServiceClient.UpdateDirectoryGroupSync(context.Background(), connect.NewRequest(
        &adminv1.UpdateDirectoryGroupSyncRequest{FGroupId: <string>, 
            DGroupId: <string>, 
            DeselectedUserIds: <bool>},
    ))
}

{
    "fGroupId": <string>,
    "dGroupId": <string>,
    "deselectedUserIds": <bool>
}

UpdateDirectoryGroupSyncRequest(
    f_group_id: <string>,
    d_group_id: <string>,
    deselected_user_ids: <bool>
)

UpdateDirectoryGroupSyncRequest(
    FGroupId <string>,
    DGroupId <string>,
    DeselectedUserIds <bool>
)

UpdateDirectoryGroupSyncRequest

Parameter	Python Attribute	Type
fGroupId	f_group_id	string
dGroupId	d_group_id	string
deselectedUserIds	deselected_user_ids	map<string, bool>

UpdateDirectoryGroupSyncRequest

Parameter	Python Attribute	Type
fGroupId	f_group_id	string
dGroupId	d_group_id	string
deselectedUserIds	deselected_user_ids	map<string, bool>

GetDSyncPortal

curl 'https://adminv2.api.formalcloud.net/admin.v1.DSyncService/GetDSyncPortal' \
-H 'x-api-key: {your_api_key}' \
-H 'content-type: application/json' \
--compressed \
--data-raw '
{
    "authToken": <string>
}'

import os
import formal_sdk

from formal_sdk.gen.admin.v1.work_os_pb2 import GetDSyncPortalRequest

api_key = os.environ.get('API_KEY')
formal_client = formal_sdk.Client(api_key)
formal_client.DSyncClient.GetDSyncPortal(
    GetDSyncPortalRequest("auth_token": <string>)
)

import (
    "context"

    adminv1 "buf.build/gen/go/formal/admin/protocolbuffers/go/admin/v1"
    "github.com/bufbuild/connect-go"
    "github.com/formalco/go-sdk/sdk"
)

func main() {
    client := sdk.New("apiKey")

    resp, err := client.DSyncServiceClient.GetDSyncPortal(context.Background(), connect.NewRequest(
        &adminv1.GetDSyncPortalRequest{AuthToken: <string>},
    ))
}

{
    "link": <string>
}

GetDSyncPortalResponse(
    link: <string>
)

GetDSyncPortalResponse(
    Link <string>
)

GetDSyncPortalRequest

Parameter	Python Attribute	Type	Description	Is Optional
authToken	auth_token	string

GetDSyncPortalResponse

Parameter	Python Attribute	Type	Description	Is Optional
link	link	string

GetDirectoryRequest

This message has no parameters.

GetDirectoryResponse

Parameter	Python Attribute	Type	Description	Is Optional
directory	directory	Directory

GetGroupsByDirectoryIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetGroupsByDirectoryIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
groups	groups	DirectorySyncGroup array

GetUsersByDirectoryIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetUsersByDirectoryIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
users	users	WorkUser array

GetWorkOsGroupByIdRequest

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string

GetWorkOsGroupByIdResponse

Parameter	Python Attribute	Type	Description	Is Optional
group	group	DirectorySyncGroup

DirectorySyncGroup

Parameter	Python Attribute	Type
id	id	string
name	name	string
idpId	idp_id	string
directoryId	directory_id	string
createdAt	created_at	string
updatedAt	updated_at	string
mappedFormalGroupId	mapped_formal_group_id	string

UserEmail

Parameter	Python Attribute	Type
primary	primary	bool
value	value	string
type	type	string

UserGroup

Parameter	Python Attribute	Type
object	object	string
id	id	string
name	name	string

WorkUser

Parameter	Python Attribute	Type
id	id	string
idpId	idp_id	string
directoryId	directory_id	string
username	username	string
emails	emails	UserEmail array
firstName	first_name	string
lastName	last_name	string
jobTitle	job_title	string
state	state	string
createdAt	created_at	string
updatedAt	updated_at	string

Users

Parameter	Python Attribute	Type	Description	Is Optional
users	users	WorkUser array

Group

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
active	active	bool
status	status	string
createdAt	created_at	google.protobuf.Timestamp
userIds	user_ids	string array
dsyncGroupId	dsync_group_id	string

GroupPair

Parameter	Python Attribute	Type	Description	Is Optional
fGroup	f_group	Group
dGroup	d_group	DirectorySyncGroup

GetDirectoryGroupsRequest

This message has no parameters.

GetDirectoryGroupsResponse

Parameter	Python Attribute	Type
directoryIds	directory_ids	string array
fGroups	f_groups	Group array
dGroups	d_groups	DirectorySyncGroup array
groupPairs	group_pairs	GroupPair array
dGroupUsers	d_group_users	map<string, Users>

UpdateDirectoryGroupSyncRequest

Parameter	Python Attribute	Type
fGroupId	f_group_id	string
dGroupId	d_group_id	string
deselectedUserIds	deselected_user_ids	map<string, bool>

UpdateDirectoryGroupSyncResponse

Parameter	Python Attribute	Type	Description	Is Optional
fGroupId	f_group_id	string

GetDSyncPortalRequest

Parameter	Python Attribute	Type	Description	Is Optional
authToken	auth_token	string

GetDSyncPortalResponse

Parameter	Python Attribute	Type	Description	Is Optional
link	link	string

Types.v1 Messages

types.v1.ETLGroup

Parameter	Python Attribute	Type
id	id	string
orgId	org_id	string
platformId	platform_id	string
name	name	string

types.v1.ETLConnector

Parameter	Python Attribute	Type
id	id	string
orgId	org_id	string
platformId	platform_id	string
destinationId	destination_id	string
groupId	group_id	string
connectorType	connector_type	string
serviceName	service_name	string
hostName	host_name	string
databaseName	database_name	string
lastSynced	last_synced	int32

types.v1.ETLDestination

Parameter	Python Attribute	Type
id	id	string
orgId	org_id	string
platformId	platform_id	string
groupId	group_id	string
destinationType	destination_type	string
serviceName	service_name	string
hostName	host_name	string
databaseName	database_name	string
lastSynced	last_synced	int32

types.v1.ETLSchemaLineage

Parameter	Python Attribute	Type
id	id	string
orgId	org_id	string
platformId	platform_id	string
connectorId	connector_id	string
destinationId	destination_id	string
sourceSchema	source_schema	string
destinationSchema	destination_schema	string
lastUpdated	last_updated	int32

types.v1.ETLTableLineage

Parameter	Python Attribute	Type
id	id	string
orgId	org_id	string
platformId	platform_id	string
connectorId	connector_id	string
destinationId	destination_id	string
schemaId	schema_id	string
sourceTable	source_table	string
destinationTable	destination_table	string
lastUpdated	last_updated	int32

types.v1.ETLColumnLineage

Parameter	Python Attribute	Type
id	id	string
orgId	org_id	string
platformId	platform_id	string
connectorId	connector_id	string
destinationId	destination_id	string
schemaId	schema_id	string
tableId	table_id	string
sourceColumn	source_column	string
destinationColumn	destination_column	string
sourceDataType	source_data_type	string
destinationDataType	destination_data_type	string
isPrimaryKey	is_primary_key	bool
isForeignKey	is_foreign_key	bool

types.v1.ETLMapping

Parameter	Python Attribute	Type
id	id	string
orgId	org_id	string
connectorId	connector_id	string
platformConnectorId	platform_connector_id	string
platformType	platform_type	string
lastSynced	last_synced	int32

types.v1.CodeRepo

Parameter	Python Attribute	Type
id	id	string
cloudProviderRepoId	cloud_provider_repo_id	int32
createdBy	created_by	string
type	type	string
name	name	string
hookId	hook_id	int32
status	status	string
active	active	bool
createdAt	created_at	string
updatedAt	updated_at	string
expireAt	expire_at	string

types.v1.SearchUser

Parameter	Python Attribute	Type
id	id	string
dbUsername	db_username	string
type	type	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
firstName	first_name	string
lastName	last_name	string
email	email	string
name	name	string
expireAt	expire_at	google.protobuf.Timestamp

types.v1.SearchGroup

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp

types.v1.SearchPolicy

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp

types.v1.SearchDatastore

Parameter	Python Attribute	Type
id	id	string
name	name	string
hostname	hostname	string
technology	technology	string
createdAt	created_at	google.protobuf.Timestamp

types.v1.SearchSidecar

Parameter	Python Attribute	Type
id	id	string
name	name	string
hostname	hostname	string
cloudProvider	cloud_provider	string
cloudRegion	cloud_region	string
deploymentType	deployment_type	string
failOpen	fail_open	bool
technology	technology	string
createdAt	created_at	google.protobuf.Timestamp

types.v1.SearchInventory

Parameter	Python Attribute	Type
id	id	string
datastoreId	datastore_id	string
path	path	string
tablePath	table_path	string
name	name	string
datastoreName	datastore_name	string
tablePhysicalId	table_physical_id	string
tableAttributeNumber	table_attribute_number	int32
dataType	data_type	string
dataLabels	data_labels	string array
dataLabel	data_label	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
validated	validated	bool
tags	tags	string array
encrypted	encrypted	bool

types.v1.User

Parameter	Python Attribute	Type
id	id	string
organizationId	organization_id	string
firstName	first_name	string
lastName	last_name	string
type	type	string
appType	app_type	string
role	role	string
name	name	string
dbUsername	db_username	string
email	email	string
idp	idp	string
idpUserId	idp_user_id	string
status	status	string
expireAt	expire_at	google.protobuf.Timestamp
createdAt	created_at	google.protobuf.Timestamp
externalIds	external_ids	ExternalId array
machineRoleAccessToken	machine_role_access_token	string
dsyncUserId	dsync_user_id	string
appId	app_id	string
admin	admin	bool
terminationProtection	termination_protection	bool

types.v1.TriggeredPolicy

Parameter	Python Attribute	Type
policyId	policy_id	string
owners	owners	string array
notify	notify	string
policyType	policy_type	PolicyType
reason	reason	string
contextualData	contextual_data	string
policyStatus	policy_status	string

types.v1.TriggeredFilterPolicy

Parameter	Python Attribute	Type
interval	interval	string
limit	limit	int64
count	count	int64

types.v1.TriggeredDecryptionPolicy

Parameter	Python Attribute	Type	Description	Is Optional
columnPath	column_path	string

types.v1.TriggeredMaskingPolicy

Parameter	Python Attribute	Type
columnPath	column_path	string
maskingType	masking_type	string
typesafe	typesafe	bool

types.v1.TriggeredBlockPolicy

Parameter	Python Attribute	Type
objectType	object_type	string
path	path	string
objectPaths	object_paths	string array
multiple	multiple	bool
action	action	string
datastoreIsDefaultBlock	datastore_is_default_block	bool

types.v1.TiggeredAllowPolicy

Parameter	Python Attribute	Type	Description	Is Optional
objectType	object_type	string
path	path	string

types.v1.LogRequest

Parameter	Python Attribute	Type
startTime	start_time	google.protobuf.Timestamp
endTime	end_time	google.protobuf.Timestamp
sidecarProcessingTime	sidecar_processing_time	google.protobuf.Duration
dataStoreStartTime	data_store_start_time	google.protobuf.Timestamp
dataStoreEndTime	data_store_end_time	google.protobuf.Timestamp
dataStoreProcessingTime	data_store_processing_time	google.protobuf.Duration
query	query	string
success	success	bool
errorMessage	error_message	string
stamentType	stament_type	string
returnedTables	returned_tables	string array
returnedColumns	returned_columns	Column array
dataVolume	data_volume	uint64
endUserId	end_user_id	string
endUserDbUserName	end_user_db_user_name	string
endUserExternalIds	end_user_external_ids	string array
policyAction	policy_action	string
returnedRowsCount	returned_rows_count	int64
returnedRowsCountByServer	returned_rows_count_by_server	int64
returnedRowsCountToUser	returned_rows_count_to_user	int64
filteredRowsCount	filtered_rows_count	int64
triggeredPolicies	triggered_policies	types.v1.TriggeredPolicy array
tenantId	tenant_id	string
rowLevelMetrics	row_level_metrics	types.v1.RowLevelMetric array
tenantIdColumnName	tenant_id_column_name	string
tenantMismatch	tenant_mismatch	string array
bucketName	bucket_name	string
s3Action	s3_action	string
returnedObjects	returned_objects	types.v1.S3Object array
sshAwsConnectionType	ssh_aws_connection_type	string
sshAwsArn	ssh_aws_arn	string
endUserGroups	end_user_groups	string array
userGroups	user_groups	string array
groups	groups	string array
fingerprint	fingerprint	string
dataDomains	data_domains	Domain array
requestBody	request_body	string
responseBody	response_body	string
requestBodyEncrypted	request_body_encrypted	bool
responseBodyEncrypted	response_body_encrypted	bool
requestBodyPostPoliciesAction	request_body_post_policies_action	string
responseBodyPostPoliciesAction	response_body_post_policies_action	string
requestBodyPostPoliciesDryRun	request_body_post_policies_dry_run	string
responseBodyPostPoliciesDryRun	response_body_post_policies_dry_run	string

types.v1.Session

Parameter	Python Attribute	Type
id	id	string
startTime	start_time	int64
datastoreId	datastore_id	string
datastoreName	datastore_name	string
datastoreTechnology	datastore_technology	string
datastoreDeploymentType	datastore_deployment_type	string
serverIpAddress	server_ip_address	string
clientIpAddress	client_ip_address	string
userId	user_id	string
userType	user_type	string
dbUser	db_user	string
dbName	db_name	string
applicationName	application_name	string
schemas	schemas	string array
nativeRoleId	native_role_id	string
nativeRoleAssignment	native_role_assignment	string
sidecarId	sidecar_id	string
sidecarName	sidecar_name	string
sidecarTechnology	sidecar_technology	string
awsAccountId	aws_account_id	string
awsRegion	aws_region	string
awsEc2InstanceId	aws_ec2_instance_id	string
awsEcsClusterName	aws_ecs_cluster_name	string
awsEcsClusterArn	aws_ecs_cluster_arn	string
awsEcsServiceName	aws_ecs_service_name	string
awsEcsServiceArn	aws_ecs_service_arn	string
awsEcsTaskId	aws_ecs_task_id	string
awsEcsTaskArn	aws_ecs_task_arn	string
containerName	container_name	string

types.v1.FormalLog

Parameter	Python Attribute	Type
id	id	string
datastoreId	datastore_id	string
session	session	types.v1.Session
request	request	types.v1.LogRequest
createdAt	created_at	string
timestamp	timestamp	google.protobuf.Timestamp
total	total	int64

types.v1.TenantLogsInfra

Parameter	Python Attribute	Type
uri	uri	string
password	password	string
username	username	string
metricsRolePwd	metrics_role_pwd	string

types.v1.LogStorageS3

Parameter	Python Attribute	Type	Description	Is Optional
s3FirehoseStreamArn	s3_firehose_stream_arn	string

types.v1.CsvOrParquetColumn

Parameter	Python Attribute	Type
colIndex	col_index	int32
name	name	string
dataType	data_type	string

types.v1.Image

Parameter	Python Attribute	Type
name	name	string
facesCount	faces_count	int32
width	width	int32
height	height	int32
type	type	string
policyAction	policy_action	string

types.v1.S3Object

Parameter	Python Attribute	Type
name	name	string
contentType	content_type	string
contentLength	content_length	int64
columns	columns	types.v1.CsvOrParquetColumn array
image	image	types.v1.Image

types.v1.RowLevelMetric

Parameter	Python Attribute	Type
datastoreId	datastore_id	string
datastoreName	datastore_name	string
endUserId	end_user_id	string
endUserDbUsername	end_user_db_username	string
userId	user_id	string
dbUser	db_user	string
dbName	db_name	string
schemaName	schema_name	string
tableName	table_name	string
path	path	string
hashedRowLevelValue	hashed_row_level_value	string
clearTextRowLevelValue	clear_text_row_level_value	string
ts	ts	google.protobuf.Timestamp
counter	counter	int64
returnedRows	returned_rows	int64
timebucket	timebucket	google.protobuf.Timestamp

types.v1.Connection

Parameter	Python Attribute	Type
id	id	string
status	status	ConnectionStatus
state	state	ConnectionState
name	name	string
connectionType	connection_type	ConnectionType
organizationId	organization_id	string
domains	domains	types.v1.ConnectionDomain array
createdAt	created_at	string
updatedAt	updated_at	string

types.v1.ConnectionDomain

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
domain	domain	string

types.v1.Policy

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
code	code	string
ast	ast	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
active	active	bool
terminationProtection	termination_protection	bool
id	id	string
name	name	string
description	description	string
code	code	string
ast	ast	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
active	active	bool
terminationProtection	termination_protection	bool

types.v1.PolicyV2

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
code	code	string
ast	ast	string
notification	notification	string
owners	owners	string array
sourceType	source_type	string
createdAt	created_at	google.protobuf.Timestamp
updatedAt	updated_at	google.protobuf.Timestamp
active	active	bool
terminationProtection	termination_protection	bool

types.v1.Datahub

Parameter	Python Attribute	Type
id	id	string
webhookSecret	webhook_secret	string
organizationId	organization_id	string
name	name	string
active	active	bool
generalizedMetadataServiceUrl	generalized_metadata_service_url	string
syncDirection	sync_direction	string
syncedEntities	synced_entities	string array
createdAt	created_at	google.protobuf.Timestamp

types.v1.Datastore

Parameter	Python Attribute	Type	Is Optional
id	id	string
createdAt	created_at	int64
datastoreId	datastore_id	string
name	name	string
originalHostname	original_hostname	string
port	port	int32
technology	technology	string
healthCheckDbName	health_check_db_name	string
defaultAccessBehavior	default_access_behavior	string
dbDiscoveryJobWaitTime	db_discovery_job_wait_time	string
dbDiscoveryNativeRoleId	db_discovery_native_role_id	string
username	username	string	True
password	password	string	True
environment	environment	string

types.v1.Column

Parameter	Python Attribute	Type
createdAt	created_at	int64
updatedAt	updated_at	int64
datastoreId	datastore_id	string
datastoreName	datastore_name	string
path	path	string
tablePhysicalId	table_physical_id	string
tableAttributeNumber	table_attribute_number	uint64
name	name	string
alias	alias	string
tablePath	table_path	string
dataLabel	data_label	string
dataType	data_type	string
dataTypeOid	data_type_oid	uint32
dataLabelLockedForSidecar	data_label_locked_for_sidecar	bool
tags	tags	string array
encrypted	encrypted	bool
policyAction	policy_action	string
decryptedAtQueryTime	decrypted_at_query_time	bool
decryptionPolicyId	decryption_policy_id	string
dataDomainIds	data_domain_ids	string array

types.v1.Group

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
active	active	bool
status	status	string
roles	roles	types.v1.DbUser array
createdAt	created_at	google.protobuf.Timestamp
userIds	user_ids	string array
dsyncGroupId	dsync_group_id	string
terminationProtection	termination_protection	bool

types.v1.DbUser

Parameter	Python Attribute	Type
id	id	string
dbUsername	db_username	string
active	active	bool
status	status	string
type	type	string
expireAt	expire_at	int64
createdAt	created_at	int64
updatedAt	updated_at	int64
dsyncUserId	dsync_user_id	string

types.v1.OutputRecord

Parameter	Python Attribute	Type
id	id	string
itemId	item_id	string
message	message	string
createdAt	created_at	google.protobuf.Timestamp
logLevel	log_level	string

types.v1.PolicyLink

Parameter	Python Attribute	Type
id	id	string
policyId	policy_id	string
organisationId	organisation_id	string
itemId	item_id	string
type	type	string
ttl	ttl	string
active	active	bool
expireAt	expire_at	string

types.v1.Satellite

Parameter	Python Attribute	Type
id	id	string
name	name	string
status	status	string
terminationProtection	termination_protection	bool

types.v1.GithubRepository

Parameter	Python Attribute	Type
id	id	int32
fullName	full_name	string
htmlUrl	html_url	string

types.v1.DefaultFieldEncryptionPolicy

Parameter	Python Attribute	Type
kmsKeyId	kms_key_id	string
encryptionAlg	encryption_alg	string
dataKeyStorage	data_key_storage	string
updatedAt	updated_at	int32

types.v1.Sidecar

Parameter	Python Attribute	Type
id	id	string
name	name	string
cloudAccountId	cloud_account_id	string
cloudProvider	cloud_provider	CloudProvider
cloudRegion	cloud_region	string
technology	technology	string
deploymentType	deployment_type	string
networkType	network_type	string
dataplaneId	dataplane_id	string
datastoreId	datastore_id	string
deployed	deployed	bool
version	version	string
formalHostname	formal_hostname	string
serverConnectionStatus	server_connection_status	string
proxyStatus	proxy_status	string
failOpen	fail_open	bool
globalKmsDecrypt	global_kms_decrypt	bool
sshRsaKey	ssh_rsa_key	bytes
serverErrorMessage	server_error_message	string
createdAt	created_at	google.protobuf.Timestamp
terminationProtection	termination_protection	bool

types.v1.Domain

Parameter	Python Attribute	Type
id	id	string
name	name	string
description	description	string
owners	owners	types.v1.Owner array
excludedPaths	excluded_paths	string array
includedPaths	included_paths	string array

types.v1.Owner

Parameter	Python Attribute	Type	Description	Is Optional
objectType	object_type	string
objectId	object_id	string

types.v1.Organization

Parameter	Python Attribute	Type
id	id	string
name	name	string
allowProfilesOutsideOrganization	allow_profiles_outside_organization	bool
domains	domains	types.v1.OrganizationDomain array
createdAt	created_at	string
updatedAt	updated_at	string

types.v1.OrganizationDomain

Parameter	Python Attribute	Type	Description	Is Optional
id	id	string
domain	domain	string

types.v1.ExternalId

Parameter	Python Attribute	Type
id	id	string
externalId	external_id	string
appId	app_id	string
dbUserId	db_user_id	string
description	description	string
createdAt	created_at	google.protobuf.Timestamp

types.v1.LogLinkItem

Parameter	Python Attribute	Type
id	id	string
integrationLogId	integration_log_id	string
datastoreId	datastore_id	string

types.v1.FlatDataplane

Parameter	Python Attribute	Type
id	id	string
name	name	string
region	region	string
customerVpcId	customer_vpc_id	string
originalCustomerVpcId	original_customer_vpc_id	string
cloudAccountId	cloud_account_id	string
availabilityZone	availability_zone	int32
vpcPeeringConnectionId	vpc_peering_connection_id	string
formalR53PrivateHostedZoneId	formal_r53_private_hosted_zone_id	string
formalVpcFlowLogsGroupArn	formal_vpc_flow_logs_group_arn	string
formalVpcFlowLogGroupName	formal_vpc_flow_log_group_name	string
formalVpcFlowLogsIamRoleArn	formal_vpc_flow_logs_iam_role_arn	string
formalVpcFlowLogsIamPolicyArn	formal_vpc_flow_logs_iam_policy_arn	string
formalVpcIgwId	formal_vpc_igw_id	string
egressOnlyIgw	egress_only_igw	string
formalVpcPrivateSubnetsIds	formal_vpc_private_subnets_ids	map<string, string>
formalVpcPublicSubnetsIds	formal_vpc_public_subnets_ids	map<string, string>
formalPublicSubnets	formal_public_subnets	string array
formalPrivateSubnets	formal_private_subnets	string array
formalVpcPublicRouteTableId	formal_vpc_public_route_table_id	string
customerVpcRouteTables	customer_vpc_route_tables	string array
formalVpcNatgIds	formal_vpc_natg_ids	map<string, string>
formalVpcNatgEips	formal_vpc_natg_eips	map<string, string>
formalVpcPublicRouteTables	formal_vpc_public_route_tables	string
formalVpcPrivateRouteTableRoutes	formal_vpc_private_route_table_routes	string array
formalVpcId	formal_vpc_id	string
formalVpcCidrBlock	formal_vpc_cidr_block	string
ecsClusterName	ecs_cluster_name	string
ecsClusterArn	ecs_cluster_arn	string
status	status	string
vpcPeering	vpc_peering	bool

types.v1.DataplaneTransitGatewayRoutes

Parameter	Python Attribute	Type
id	id	string
dataplaneId	dataplane_id	string
destinationCidrBlock	destination_cidr_block	string
transitGatewayId	transit_gateway_id	string
vpcPeeringConnectionId	vpc_peering_connection_id	string
deployed	deployed	bool

types.v1.CloudIntegration

Parameter	Python Attribute	Type
id	id	string
awsFormalId	aws_formal_id	string
cloudAccountName	cloud_account_name	string
url	url	string
cloudProvider	cloud_provider	string
awsAccountId	aws_account_id	string
awsFormalIamRole	aws_formal_iam_role	string
awsFormalHandshakeId	aws_formal_handshake_id	string
gcpProjectId	gcp_project_id	string
templateBody	template_body	string
awsFormalUserName	aws_formal_user_name	string
awsFormalPingbackArn	aws_formal_pingback_arn	string
awsFormalStackName	aws_formal_stack_name	string
awsCloudRegion	aws_cloud_region	string
awsFormalR53PrivateHostedZoneId	aws_formal_r53_private_hosted_zone_id	string
stacks	stacks	types.v1.FlatDataplane array
createdAt	created_at	string

types.v1.ListMetadata

Parameter	Python Attribute	Type
after	after	string
before	before	string
count	count	int32
nextCursor	next_cursor	string

types.v1.IntegrationLogs

Parameter	Python Attribute	Type
id	id	string
name	name	string
type	type	string
createdAt	created_at	int32
ddSite	dd_site	string
ddAccountId	dd_account_id	string
splunkUrl	splunk_url	string
awsS3BucketName	aws_s3_bucket_name	string

types.v1.IntegrationApp

Parameter	Python Attribute	Type
id	id	string
name	name	string
type	type	string
createdAt	created_at	int32
metabaseHostname	metabase_hostname	string
metabaseUsername	metabase_username	string
metabasePassword	metabase_password	string
linkedDbUserId	linked_db_user_id	string
fivetranApiKey	fivetran_api_key	string
fivetranApiSecret	fivetran_api_secret	string

types.v1.Key

Parameter	Python Attribute	Type
id	id	string
cloudRegion	cloud_region	string
keyId	key_id	string
keyArn	key_arn	string
active	active	bool
managedBy	managed_by	string
keyType	key_type	string
name	name	string
cloudAccountId	cloud_account_id	string
createdAt	created_at	string
updatedAt	updated_at	string

types.v1.SidecarLink

Parameter	Python Attribute	Type
id	id	string
sidecarId	sidecar_id	string
datastoreId	datastore_id	string
port	port	int32
datastoreName	datastore_name	string
terminationProtection	termination_protection	bool

types.v1.IncidentAccount

Parameter	Python Attribute	Type
id	id	string
name	name	string
type	type	string
logo	logo	string
apiKey	api_key	string