Auth0 API

Flows

flows

Methods

Create A Flow -> { id, created_at, name, 3 more... }
post/flows

Create a flow

Delete A Flow ->
delete/flows/{id}

Delete a flow

Get Flows -> FlowsPageNumberPage<{ id, created_at, name, 2 more... }>
get/flows

Get flows

Get A Flow ->
Flow
get/flows/{id}

Get a flow

Update A Flow -> { id, created_at, name, 3 more... }
patch/flows/{id}

Update a flow

Domain types

Flow = { id, created_at, name, 3 more... }
Flows

Executions

flows.executions

Methods

Delete A Flow Execution ->
delete/flows/{flow_id}/executions/{execution_id}

Delete a flow execution

Get Flow Executions -> FlowsExecutionsPageNumberPage<{ id, created_at, status, 5 more... }>
get/flows/{flow_id}/executions

Get flow executions

Get A Flow Execution ->
FlowExecution
get/flows/{flow_id}/executions/{execution_id}

Get a flow execution

Domain types

FlowExecution = { id, created_at, status, 6 more... }
Flows

Vault Connections

flows.vault_connections

Methods

Delete A Flows Vault Connection ->
delete/flows/vault/connections/{id}

Delete a Flows Vault connection

Get A Flows Vault Connection ->
VaultConnection
get/flows/vault/connections/{id}

Get a Flows Vault connection

Update A Flows Vault Connection -> { id, app_id, created_at, 7 more... }
patch/flows/vault/connections/{id}

Update a Flows Vault connection

Security

Example: Authorization: Bearer My Bearer Token

Parameters
id: string
Response fields
id: string
(maxLength: 30, format: flows-vault-connections-id)

Flows Vault Connection identifier.

app_id: string
(minLength: 1, maxLength: 55)

Flows Vault Connection app identifier.

created_at: string
(format: date-time)

The ISO 8601 formatted date when this Flows Vault Connection was created.

fingerprint: string
(minLength: 1)
name: string
(minLength: 1, maxLength: 150)

Flows Vault Connection name.

ready: boolean

Whether the Flows Vault Connection is configured.

updated_at: string
(format: date-time)

The ISO 8601 formatted date when this Flows Vault Connection was updated.

account_name: string
Optional
(minLength: 1, maxLength: 150)

Flows Vault Connection custom account name.

environment: string
Optional
(minLength: 1, maxLength: 55)

Flows Vault Connection environment.

refreshed_at: string
Optional
(format: date-time)

The ISO 8601 formatted date when this Flows Vault Connection was refreshed.

Request example
200Example

Domain types

VaultConnection = { id, app_id, created_at, 7 more... }