API Reference

Zero Trust

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Casb

CasbApplications

List applications

zero_trust.casb.applications.list(ApplicationListParams**kwargs) -> ApplicationListResponse

GET/accounts/{account_id}/one/applications

Get application details

zero_trust.casb.applications.get(Literal["GITHUB", "GOOGLE_WORKSPACE", "MICROSOFT_INTERNAL", 2 more]slug, ApplicationGetParams**kwargs) -> ApplicationGetResponse

GET/accounts/{account_id}/one/applications/{slug}

ModelsExpand Collapse

List[ApplicationListResponseItem]

auth_methods: List[ApplicationListResponseItemAuthMethod]

Available auth methods.

display_name: str

Human-readable auth method name.

slug: str

Auth method identifier.

category: str

Vendor category (e.g. Productivity, AI).

description: str

Brief description of the integration.

display_name: str

Human-readable vendor name.

dlp_enabled: bool

Whether DLP scanning is supported.

logo: Optional[str]

Logo path.

permissions: List[ApplicationListResponseItemPermission]

All permissions with severity.

display_name: str

Human-readable permission name.

scope: str

Vendor-native scope identifier.

severity: Literal["low", "medium", "high", "critical"]

Permission sensitivity level.

• low - low
• medium - medium
• high - high
• critical - critical

One of the following:

"low"

"medium"

"high"

"critical"

slug: Literal["GITHUB", "GOOGLE_WORKSPACE", "MICROSOFT_INTERNAL", 2 more]

Vendor identifier (e.g. microsoft_internal, google_workspace).

• GITHUB - GITHUB
• GOOGLE_WORKSPACE - GOOGLE_WORKSPACE
• MICROSOFT_INTERNAL - MICROSOFT_INTERNAL
• SALESFORCE - SALESFORCE
• SLACK - SLACK

One of the following:

"GITHUB"

"GOOGLE_WORKSPACE"

"MICROSOFT_INTERNAL"

"SALESFORCE"

"SLACK"

supported_environments: List[str]

Environments this vendor supports (standard, fedramp).

use_cases: List[ApplicationListResponseItemUseCase]

Supported use cases.

display_name: str

Human-readable use case name.

slug: str

Use case identifier (e.g. casb, ces).

class ApplicationGetResponse: …

Full application detail for onboarding UI.

auth_methods: List[AuthMethod]

Available authentication methods.

display_name: str

Human-readable auth method name.

is_default: bool

Whether this is the default auth method.

slug: str

Auth method identifier.

supported_environments: List[str]

Environments this auth method supports.

category: str

Vendor category.

description: str

Brief description.

display_name: str

Human-readable vendor name.

dlp_enabled: bool

Whether DLP scanning is supported.

instructions: Optional[str]

Setup instructions for the user.

logo: Optional[str]

Logo path.

slug: Literal["GITHUB", "GOOGLE_WORKSPACE", "MICROSOFT_INTERNAL", 2 more]

Vendor identifier.

• GITHUB - GITHUB
• GOOGLE_WORKSPACE - GOOGLE_WORKSPACE
• MICROSOFT_INTERNAL - MICROSOFT_INTERNAL
• SALESFORCE - SALESFORCE
• SLACK - SLACK

One of the following:

"GITHUB"

"GOOGLE_WORKSPACE"

"MICROSOFT_INTERNAL"

"SALESFORCE"

"SLACK"

use_cases: List[UseCase]

Use cases with full scope details.

base_scopes: List[UseCaseBaseScope]

Scopes always required for this use case.

display_name: str

Human-readable permission name.

scope: str

Vendor-native scope identifier.

severity: Literal["low", "medium", "high", "critical"]

Permission sensitivity level.

• low - low
• medium - medium
• high - high
• critical - critical

One of the following:

"low"

"medium"

"high"

"critical"

description: str

Use case description.

display_name: str

Human-readable use case name.

features: List[UseCaseFeature]

Optional features with extra scopes.

description: str

Feature description.

display_name: str

Human-readable feature name.

scopes: List[UseCaseFeatureScope]

Additional scopes when feature is enabled.

display_name: str

Human-readable permission name.

scope: str

Vendor-native scope identifier.

severity: Literal["low", "medium", "high", "critical"]

Permission sensitivity level.

• low - low
• medium - medium
• high - high
• critical - critical

One of the following:

"low"

"medium"

"high"

"critical"

slug: str

Feature identifier.

slug: str

Use case identifier.

CasbApplicationsSetup Flows

Get application setup flows

zero_trust.casb.applications.setup_flows.list(strslug, SetupFlowListParams**kwargs) -> SetupFlowListResponse

GET/accounts/{account_id}/one/applications/{slug}/setup-flows

ModelsExpand Collapse

List[SetupFlowListResponseItem]

id: str

Setup flow identifier.

default: bool

Whether this is the default auth method.

description: str

Flow description.

name: str

Human-readable flow name.

steps: List[SetupFlowListResponseItemStep]

Ordered list of setup steps.

type: Literal["component", "instruction", "form_input", "oauth_redirect"]

Step type.

• component - component
• instruction - instruction
• form_input - form_input
• oauth_redirect - oauth_redirect

One of the following:

"component"

"instruction"

"form_input"

"oauth_redirect"

component_id: Optional[str]

Component identifier (for component type).

description: Optional[str]

Step description with markdown support.

dynamic_content: Optional[List[SetupFlowListResponseItemStepDynamicContent]]

Dynamic content blocks (for instruction/form_input).

label: str

Display label.

type: Literal["copy_block", "external_link"]

Content type.

• copy_block - copy_block
• external_link - external_link

One of the following:

"copy_block"

"external_link"

url_template: Optional[str]

URL template with {{ variable }} interpolation (for external_link).

value_from: Optional[str]

Field path to get value from (for copy_block).

form_fields: Optional[List[SetupFlowListResponseItemStepFormField]]

Form fields (for form_input).

label: str

Human-readable field label.

name: str

Field identifier (maps to credentials key).

placeholder: Optional[str]

Placeholder text.

required: bool

Whether field is required.

supported_file_types: Optional[List[str]]

Allowed file extensions for file_upload type.

type: Literal["text", "password", "email", "file_upload"]

Field input type.

• text - text
• password - password
• email - email
• file_upload - file_upload

One of the following:

"text"

"password"

"email"

"file_upload"

is_required: Optional[bool]

Whether step is required (for form_input).

parameters: Optional[Dict[str, str]]

Component parameters (for component type).

title: Optional[str]

Step title (for instruction/form_input/oauth_redirect).

supported_environments: List[str]

Environments this auth method supports (standard, fedramp).

auth_config: Optional[SetupFlowListResponseItemAuthConfig]

OAuth configuration (present for OAuth-based flows).

authorization_url: Optional[str]

Authorization URL for the requested environment.

client_id: Optional[str]

OAuth client ID.

requires_pkce: bool

Whether PKCE is required.

scopes: List[str]

OAuth scopes to request.

url_placeholders: List[str]

Placeholders in authorization URL that frontend must fill.

CasbIntegrations

List integrations

zero_trust.casb.integrations.list(IntegrationListParams**kwargs) -> object

GET/accounts/{account_id}/one/integrations

Get integration details

zero_trust.casb.integrations.get(strid, IntegrationGetParams**kwargs) -> IntegrationGetResponse

GET/accounts/{account_id}/one/integrations/{id}

Create integration

zero_trust.casb.integrations.create(IntegrationCreateParams**kwargs) -> IntegrationCreateResponse

POST/accounts/{account_id}/one/integrations

Update integration

zero_trust.casb.integrations.update(strid, IntegrationUpdateParams**kwargs) -> IntegrationUpdateResponse

PATCH/accounts/{account_id}/one/integrations/{id}

Delete integration

zero_trust.casb.integrations.delete(strid, IntegrationDeleteParams**kwargs)

DELETE/accounts/{account_id}/one/integrations/{id}

Pause integration

zero_trust.casb.integrations.pause(strid, IntegrationPauseParams**kwargs) -> IntegrationPauseResponse

POST/accounts/{account_id}/one/integrations/{id}/pause

Resume integration

zero_trust.casb.integrations.resume(strid, IntegrationResumeParams**kwargs) -> IntegrationResumeResponse

POST/accounts/{account_id}/one/integrations/{id}/resume

ModelsExpand Collapse

class IntegrationGetResponse: …

Serializer for v2 integration detail response with use cases.

id: str

Integration ID.

formatuuid

application: Dict[str, Optional[str]]

auth_method: Optional[Dict[str, str]]

The integration’s authentication method.

authorization_link: Optional[AuthorizationLink]

Authorization link for the integration.

components: Optional[Dict[str, object]]

link: Optional[str]

created: datetime

When the integration was created.

formatdate-time

credentials_expiry: datetime

Credentials expiry time.

formatdate-time

dlp_profiles: List[str]

DLP Profiles enabled for the integration.

health_details: List[Dict[str, object]]

Health details with remediation hints.

is_paused: bool

Whether the user paused the integration.

last_hydrated: datetime

Last time the integration was hydrated.

formatdate-time

name: str

Name of the integration.

organization_id: int

Organization ID.

status: str

Integration status.

updated: datetime

When the integration was last updated.

formatdate-time

use_cases: List[Dict[str, object]]

Use cases enabled for the integration.

class IntegrationCreateResponse: …

Serializer for v2 integration detail response with use cases.

id: str

Integration ID.

formatuuid

application: Dict[str, Optional[str]]

auth_method: Optional[Dict[str, str]]

The integration’s authentication method.

authorization_link: Optional[AuthorizationLink]

Authorization link for the integration.

components: Optional[Dict[str, object]]

link: Optional[str]

created: datetime

When the integration was created.

formatdate-time

credentials_expiry: datetime

Credentials expiry time.

formatdate-time

dlp_profiles: List[str]

DLP Profiles enabled for the integration.

health_details: List[Dict[str, object]]

Health details with remediation hints.

is_paused: bool

Whether the user paused the integration.

last_hydrated: datetime

Last time the integration was hydrated.

formatdate-time

name: str

Name of the integration.

organization_id: int

Organization ID.

status: str

Integration status.

updated: datetime

When the integration was last updated.

formatdate-time

use_cases: List[Dict[str, object]]

Use cases enabled for the integration.

class IntegrationUpdateResponse: …

Serializer for v2 integration detail response with use cases.

id: str

Integration ID.

formatuuid

application: Dict[str, Optional[str]]

auth_method: Optional[Dict[str, str]]

The integration’s authentication method.

authorization_link: Optional[AuthorizationLink]

Authorization link for the integration.

components: Optional[Dict[str, object]]

link: Optional[str]

created: datetime

When the integration was created.

formatdate-time

credentials_expiry: datetime

Credentials expiry time.

formatdate-time

dlp_profiles: List[str]

DLP Profiles enabled for the integration.

health_details: List[Dict[str, object]]

Health details with remediation hints.

is_paused: bool

Whether the user paused the integration.

last_hydrated: datetime

Last time the integration was hydrated.

formatdate-time

name: str

Name of the integration.

organization_id: int

Organization ID.

status: str

Integration status.

updated: datetime

When the integration was last updated.

formatdate-time

use_cases: List[Dict[str, object]]

Use cases enabled for the integration.

class IntegrationPauseResponse: …

Serializer for v2 integration detail response with use cases.

id: str

Integration ID.

formatuuid

application: Dict[str, Optional[str]]

auth_method: Optional[Dict[str, str]]

The integration’s authentication method.

authorization_link: Optional[AuthorizationLink]

Authorization link for the integration.

components: Optional[Dict[str, object]]

link: Optional[str]

created: datetime

When the integration was created.

formatdate-time

credentials_expiry: datetime

Credentials expiry time.

formatdate-time

dlp_profiles: List[str]

DLP Profiles enabled for the integration.

health_details: List[Dict[str, object]]

Health details with remediation hints.

is_paused: bool

Whether the user paused the integration.

last_hydrated: datetime

Last time the integration was hydrated.

formatdate-time

name: str

Name of the integration.

organization_id: int

Organization ID.

status: str

Integration status.

updated: datetime

When the integration was last updated.

formatdate-time

use_cases: List[Dict[str, object]]

Use cases enabled for the integration.

class IntegrationResumeResponse: …

Serializer for v2 integration detail response with use cases.

id: str

Integration ID.

formatuuid

application: Dict[str, Optional[str]]

auth_method: Optional[Dict[str, str]]

The integration’s authentication method.

authorization_link: Optional[AuthorizationLink]

Authorization link for the integration.

components: Optional[Dict[str, object]]

link: Optional[str]

created: datetime

When the integration was created.

formatdate-time

credentials_expiry: datetime

Credentials expiry time.

formatdate-time

dlp_profiles: List[str]

DLP Profiles enabled for the integration.

health_details: List[Dict[str, object]]

Health details with remediation hints.

is_paused: bool

Whether the user paused the integration.

last_hydrated: datetime

Last time the integration was hydrated.

formatdate-time

name: str

Name of the integration.

organization_id: int

Organization ID.

status: str

Integration status.

updated: datetime

When the integration was last updated.

formatdate-time

use_cases: List[Dict[str, object]]

Use cases enabled for the integration.