published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a single flow in a Descope project via its exported JSON representation, the same format produced by exporting a flow in the Descope console.
Create Flow Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Flow(name: string, args: FlowArgs, opts?: CustomResourceOptions);@overload
def Flow(resource_name: str,
args: FlowArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Flow(resource_name: str,
opts: Optional[ResourceOptions] = None,
data: Optional[str] = None,
flow_id: Optional[str] = None,
project_id: Optional[str] = None)func NewFlow(ctx *Context, name string, args FlowArgs, opts ...ResourceOption) (*Flow, error)public Flow(string name, FlowArgs args, CustomResourceOptions? opts = null)type: descope:Flow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_flow" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args FlowArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FlowArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FlowArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlowArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FlowArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var flowResource = new Descope.Flow("flowResource", new()
{
Data = "string",
FlowId = "string",
ProjectId = "string",
});
example, err := descope.NewFlow(ctx, "flowResource", &descope.FlowArgs{
Data: pulumi.String("string"),
FlowId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
})
resource "descope_flow" "flowResource" {
lifecycle {
create_before_destroy = true
}
data = "string"
flow_id = "string"
project_id = "string"
}
var flowResource = new Flow("flowResource", FlowArgs.builder()
.data("string")
.flowId("string")
.projectId("string")
.build());
flow_resource = descope.Flow("flowResource",
data="string",
flow_id="string",
project_id="string")
const flowResource = new descope.Flow("flowResource", {
data: "string",
flowId: "string",
projectId: "string",
});
type: descope:Flow
properties:
data: string
flowId: string
projectId: string
Flow Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Flow resource accepts the following input properties:
- Data string
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - Flow
Id string - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - Project
Id string - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- Data string
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - Flow
Id string - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - Project
Id string - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data string
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow_
id string - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project_
id string - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data String
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow
Id String - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project
Id String - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data string
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow
Id string - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project
Id string - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data str
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow_
id str - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project_
id str - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data String
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow
Id String - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project
Id String - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
Outputs
All input properties are implicitly available as output properties. Additionally, the Flow resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Flow Resource
Get an existing Flow resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FlowState, opts?: CustomResourceOptions): Flow@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
data: Optional[str] = None,
flow_id: Optional[str] = None,
project_id: Optional[str] = None) -> Flowfunc GetFlow(ctx *Context, name string, id IDInput, state *FlowState, opts ...ResourceOption) (*Flow, error)public static Flow Get(string name, Input<string> id, FlowState? state, CustomResourceOptions? opts = null)public static Flow get(String name, Output<String> id, FlowState state, CustomResourceOptions options)resources: existingFlow: type: descope:Flow get: id: ${id}import {
to = descope_flow.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state FlowState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state FlowState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state FlowState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state FlowState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Data string
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - Flow
Id string - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - Project
Id string - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- Data string
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - Flow
Id string - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - Project
Id string - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data string
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow_
id string - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project_
id string - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data String
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow
Id String - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project
Id String - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data string
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow
Id string - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project
Id string - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data str
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow_
id str - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project_
id str - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
- data String
- The JSON data of the flow in its exported representation, including its metadata, contents, and references. This will usually be exported as a
.jsonfile from the Descope console, and set in the.tffile using thedata = file("...")syntax. - flow
Id String - The machine identifier of the flow (e.g.,
sign-up-or-in), used to run the flow and to reference it in other resources. Changing this value will require the resource to be deleted and recreated. - project
Id String - The ID of the project that the flow belongs to. Changing this value will require the resource to be deleted and recreated.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope