Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prefect Provider
  3. API Docs
  4. WorkspaceRole
prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
prefecthq/terraform-provider-prefect

prefect.WorkspaceRole

Explore with Pulumi AI

prefect logo
prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
prefecthq/terraform-provider-prefect

    The resource workspace_role represents a Prefect Cloud Workspace Role. Workspace Roles hold a set of permissions to a specific Workspace, and can be attached to an accessor (User or Service Account) to grant access to the Workspace.

    To obtain a list of available scopes, please refer to the GET /api/workspace_scopes API.

    For more information, see manage workspaces.

    This feature is available in the following product plan(s): Prefect Cloud (Pro), Prefect Cloud (Enterprise).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as prefect from "@pulumi/prefect";

const example = new prefect.WorkspaceRole("example", {scopes: [
    "manage_blocks",
    "see_flows",
]});

    import pulumi
import pulumi_prefect as prefect

example = prefect.WorkspaceRole("example", scopes=[
    "manage_blocks",
    "see_flows",
])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prefect/v2/prefect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := prefect.NewWorkspaceRole(ctx, "example", &prefect.WorkspaceRoleArgs{
			Scopes: pulumi.StringArray{
				pulumi.String("manage_blocks"),
				pulumi.String("see_flows"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prefect = Pulumi.Prefect;

return await Deployment.RunAsync(() => 
{
    var example = new Prefect.WorkspaceRole("example", new()
    {
        Scopes = new[]
        {
            "manage_blocks",
            "see_flows",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prefect.WorkspaceRole;
import com.pulumi.prefect.WorkspaceRoleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new WorkspaceRole("example", WorkspaceRoleArgs.builder()
            .scopes(            
                "manage_blocks",
                "see_flows")
            .build());

    }
}

    resources:
  example:
    type: prefect:WorkspaceRole
    properties:
      scopes:
        - manage_blocks
        - see_flows

    Create WorkspaceRole Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkspaceRole(name: string, args?: WorkspaceRoleArgs, opts?: CustomResourceOptions);
    @overload
def WorkspaceRole(resource_name: str,
                  args: Optional[WorkspaceRoleArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceRole(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  inherited_role_id: Optional[str] = None,
                  name: Optional[str] = None,
                  scopes: Optional[Sequence[str]] = None)
    func NewWorkspaceRole(ctx *Context, name string, args *WorkspaceRoleArgs, opts ...ResourceOption) (*WorkspaceRole, error)
    public WorkspaceRole(string name, WorkspaceRoleArgs? args = null, CustomResourceOptions? opts = null)
    public WorkspaceRole(String name, WorkspaceRoleArgs args)
public WorkspaceRole(String name, WorkspaceRoleArgs args, CustomResourceOptions options)

    type: prefect:WorkspaceRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkspaceRoleArgs
    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 WorkspaceRoleArgs
    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 WorkspaceRoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceRoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceRoleArgs
    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 workspaceRoleResource = new Prefect.WorkspaceRole("workspaceRoleResource", new()
{
    Description = "string",
    InheritedRoleId = "string",
    Name = "string",
    Scopes = new[]
    {
        "string",
    },
});

    example, err := prefect.NewWorkspaceRole(ctx, "workspaceRoleResource", &prefect.WorkspaceRoleArgs{
Description: pulumi.String("string"),
InheritedRoleId: pulumi.String("string"),
Name: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
})

    var workspaceRoleResource = new WorkspaceRole("workspaceRoleResource", WorkspaceRoleArgs.builder()
    .description("string")
    .inheritedRoleId("string")
    .name("string")
    .scopes("string")
    .build());

    workspace_role_resource = prefect.WorkspaceRole("workspaceRoleResource",
    description="string",
    inherited_role_id="string",
    name="string",
    scopes=["string"])

    const workspaceRoleResource = new prefect.WorkspaceRole("workspaceRoleResource", {
    description: "string",
    inheritedRoleId: "string",
    name: "string",
    scopes: ["string"],
});

    type: prefect:WorkspaceRole
properties:
    description: string
    inheritedRoleId: string
    name: string
    scopes:
        - string

    WorkspaceRole 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 WorkspaceRole resource accepts the following input properties:

    Description string
    Description of the Workspace Role
    InheritedRoleId string
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    Name string
    Name of the Workspace Role
    Scopes List<string>
    List of scopes linked to the Workspace Role
    Description string
    Description of the Workspace Role
    InheritedRoleId string
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    Name string
    Name of the Workspace Role
    Scopes []string
    List of scopes linked to the Workspace Role
    description String
    Description of the Workspace Role
    inheritedRoleId String
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    name String
    Name of the Workspace Role
    scopes List<String>
    List of scopes linked to the Workspace Role
    description string
    Description of the Workspace Role
    inheritedRoleId string
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    name string
    Name of the Workspace Role
    scopes string[]
    List of scopes linked to the Workspace Role
    description str
    Description of the Workspace Role
    inherited_role_id str
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    name str
    Name of the Workspace Role
    scopes Sequence[str]
    List of scopes linked to the Workspace Role
    description String
    Description of the Workspace Role
    inheritedRoleId String
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    name String
    Name of the Workspace Role
    scopes List<String>
    List of scopes linked to the Workspace Role

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkspaceRole resource produces the following output properties:

    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    Created string
    Timestamp of when the resource was created (RFC3339)
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    Created string
    Timestamp of when the resource was created (RFC3339)
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    created String
    Timestamp of when the resource was created (RFC3339)
    id String
    The provider-assigned unique ID for this managed resource.
    updated String
    Timestamp of when the resource was updated (RFC3339)
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    created string
    Timestamp of when the resource was created (RFC3339)
    id string
    The provider-assigned unique ID for this managed resource.
    updated string
    Timestamp of when the resource was updated (RFC3339)
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    created str
    Timestamp of when the resource was created (RFC3339)
    id str
    The provider-assigned unique ID for this managed resource.
    updated str
    Timestamp of when the resource was updated (RFC3339)
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    created String
    Timestamp of when the resource was created (RFC3339)
    id String
    The provider-assigned unique ID for this managed resource.
    updated String
    Timestamp of when the resource was updated (RFC3339)

    Look up Existing WorkspaceRole Resource

    Get an existing WorkspaceRole 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?: WorkspaceRoleState, opts?: CustomResourceOptions): WorkspaceRole
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        created: Optional[str] = None,
        description: Optional[str] = None,
        inherited_role_id: Optional[str] = None,
        name: Optional[str] = None,
        scopes: Optional[Sequence[str]] = None,
        updated: Optional[str] = None) -> WorkspaceRole
    func GetWorkspaceRole(ctx *Context, name string, id IDInput, state *WorkspaceRoleState, opts ...ResourceOption) (*WorkspaceRole, error)
    public static WorkspaceRole Get(string name, Input<string> id, WorkspaceRoleState? state, CustomResourceOptions? opts = null)
    public static WorkspaceRole get(String name, Output<String> id, WorkspaceRoleState state, CustomResourceOptions options)
    resources:  _:    type: prefect:WorkspaceRole    get:      id: ${id}
    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.
    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:
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    Created string
    Timestamp of when the resource was created (RFC3339)
    Description string
    Description of the Workspace Role
    InheritedRoleId string
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    Name string
    Name of the Workspace Role
    Scopes List<string>
    List of scopes linked to the Workspace Role
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    Created string
    Timestamp of when the resource was created (RFC3339)
    Description string
    Description of the Workspace Role
    InheritedRoleId string
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    Name string
    Name of the Workspace Role
    Scopes []string
    List of scopes linked to the Workspace Role
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    created String
    Timestamp of when the resource was created (RFC3339)
    description String
    Description of the Workspace Role
    inheritedRoleId String
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    name String
    Name of the Workspace Role
    scopes List<String>
    List of scopes linked to the Workspace Role
    updated String
    Timestamp of when the resource was updated (RFC3339)
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    created string
    Timestamp of when the resource was created (RFC3339)
    description string
    Description of the Workspace Role
    inheritedRoleId string
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    name string
    Name of the Workspace Role
    scopes string[]
    List of scopes linked to the Workspace Role
    updated string
    Timestamp of when the resource was updated (RFC3339)
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    created str
    Timestamp of when the resource was created (RFC3339)
    description str
    Description of the Workspace Role
    inherited_role_id str
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    name str
    Name of the Workspace Role
    scopes Sequence[str]
    List of scopes linked to the Workspace Role
    updated str
    Timestamp of when the resource was updated (RFC3339)
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    created String
    Timestamp of when the resource was created (RFC3339)
    description String
    Description of the Workspace Role
    inheritedRoleId String
    Workspace Role ID (UUID), whose permissions are inherited by this Workspace Role
    name String
    Name of the Workspace Role
    scopes List<String>
    List of scopes linked to the Workspace Role
    updated String
    Timestamp of when the resource was updated (RFC3339)

    Import

    Prefect Workspace Roles can be imported using the workspace role’s UUID

    $ pulumi import prefect:index/workspaceRole:WorkspaceRole example 00000000-0000-0000-0000-000000000000

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    prefect prefecthq/terraform-provider-prefect
    License
    Notes
    This Pulumi package is based on the prefect Terraform Provider.
    prefect logo
    prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
    prefecthq/terraform-provider-prefect