Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Casb
Applications

Setup 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.