1. Docs
  2. Reference
  3. API
  4. Keycloak
  5. authentication
  6. Subflow

Subflow

Create a Subflow Resource

new Subflow(name: string, args: SubflowArgs, opts?: CustomResourceOptions);
def Subflow(resource_name, opts=None, alias=None, authenticator=None, description=None, parent_flow_alias=None, provider_id=None, realm_id=None, requirement=None, __props__=None);
func NewSubflow(ctx *Context, name string, args SubflowArgs, opts ...ResourceOption) (*Subflow, error)
public Subflow(string name, SubflowArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args SubflowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args SubflowArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SubflowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Subflow Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Subflow resource accepts the following input properties:

Alias string
ParentFlowAlias string
RealmId string
Authenticator string

Might be needed to be set with certain custom subflow with specific authenticator, in general this will remain empty

Description string
ProviderId string
Requirement string
Alias string
ParentFlowAlias string
RealmId string
Authenticator string

Might be needed to be set with certain custom subflow with specific authenticator, in general this will remain empty

Description string
ProviderId string
Requirement string
alias string
parentFlowAlias string
realmId string
authenticator string

Might be needed to be set with certain custom subflow with specific authenticator, in general this will remain empty

description string
providerId string
requirement string
alias str
parent_flow_alias str
realm_id str
authenticator str

Might be needed to be set with certain custom subflow with specific authenticator, in general this will remain empty

description str
provider_id str
requirement str

Outputs

All input properties are implicitly available as output properties. Additionally, the Subflow 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing Subflow Resource

Get an existing Subflow 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?: SubflowState, opts?: CustomResourceOptions): Subflow
static get(resource_name, id, opts=None, alias=None, authenticator=None, description=None, parent_flow_alias=None, provider_id=None, realm_id=None, requirement=None, __props__=None);
func GetSubflow(ctx *Context, name string, id IDInput, state *SubflowState, opts ...ResourceOption) (*Subflow, error)
public static Subflow Get(string name, Input<string> id, SubflowState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Alias string
Authenticator string

Might be needed to be set with certain custom subflow with specific authenticator, in general this will remain empty

Description string
ParentFlowAlias string
ProviderId string
RealmId string
Requirement string
Alias string
Authenticator string

Might be needed to be set with certain custom subflow with specific authenticator, in general this will remain empty

Description string
ParentFlowAlias string
ProviderId string
RealmId string
Requirement string
alias string
authenticator string

Might be needed to be set with certain custom subflow with specific authenticator, in general this will remain empty

description string
parentFlowAlias string
providerId string
realmId string
requirement string
alias str
authenticator str

Might be needed to be set with certain custom subflow with specific authenticator, in general this will remain empty

description str
parent_flow_alias str
provider_id str
realm_id str
requirement str

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.