1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. Permission
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope

    Manages a single custom permission in a Descope project. Permissions are referenced by name from descope.Role resources.

    Create Permission Resource

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

    Constructor syntax

    new Permission(name: string, args: PermissionArgs, opts?: CustomResourceOptions);
    @overload
    def Permission(resource_name: str,
                   args: PermissionArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Permission(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   project_id: Optional[str] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None)
    func NewPermission(ctx *Context, name string, args PermissionArgs, opts ...ResourceOption) (*Permission, error)
    public Permission(string name, PermissionArgs args, CustomResourceOptions? opts = null)
    public Permission(String name, PermissionArgs args)
    public Permission(String name, PermissionArgs args, CustomResourceOptions options)
    
    type: descope:Permission
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_permission" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PermissionArgs
    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 PermissionArgs
    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 PermissionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PermissionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PermissionArgs
    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 permissionResource = new Descope.Permission("permissionResource", new()
    {
        ProjectId = "string",
        Description = "string",
        Name = "string",
    });
    
    example, err := descope.NewPermission(ctx, "permissionResource", &descope.PermissionArgs{
    	ProjectId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    resource "descope_permission" "permissionResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id  = "string"
      description = "string"
      name        = "string"
    }
    
    var permissionResource = new Permission("permissionResource", PermissionArgs.builder()
        .projectId("string")
        .description("string")
        .name("string")
        .build());
    
    permission_resource = descope.Permission("permissionResource",
        project_id="string",
        description="string",
        name="string")
    
    const permissionResource = new descope.Permission("permissionResource", {
        projectId: "string",
        description: "string",
        name: "string",
    });
    
    type: descope:Permission
    properties:
        description: string
        name: string
        projectId: string
    

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

    ProjectId string
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    Description string
    An optional description for the permission.
    Name string
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    ProjectId string
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    Description string
    An optional description for the permission.
    Name string
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    project_id string
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description string
    An optional description for the permission.
    name string
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    projectId String
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description String
    An optional description for the permission.
    name String
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    projectId string
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description string
    An optional description for the permission.
    name string
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    project_id str
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description str
    An optional description for the permission.
    name str
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    projectId String
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description String
    An optional description for the permission.
    name String
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Permission 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 Permission Resource

    Get an existing Permission 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?: PermissionState, opts?: CustomResourceOptions): Permission
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None) -> Permission
    func GetPermission(ctx *Context, name string, id IDInput, state *PermissionState, opts ...ResourceOption) (*Permission, error)
    public static Permission Get(string name, Input<string> id, PermissionState? state, CustomResourceOptions? opts = null)
    public static Permission get(String name, Output<String> id, PermissionState state, CustomResourceOptions options)
    resources:  existingPermission:    type: descope:Permission    get:      id: ${id}
    import {
      to = descope_permission.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 PermissionState
    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 PermissionState
    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 PermissionState
    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 PermissionState
    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.
    The following state arguments are supported:
    Description string
    An optional description for the permission.
    Name string
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    ProjectId string
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    Description string
    An optional description for the permission.
    Name string
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    ProjectId string
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description string
    An optional description for the permission.
    name string
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    project_id string
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description String
    An optional description for the permission.
    name String
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    projectId String
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description string
    An optional description for the permission.
    name string
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    projectId string
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description str
    An optional description for the permission.
    name str
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    project_id str
    The ID of the project that this permission belongs to. Changing this value will require the resource to be deleted and recreated.
    description String
    An optional description for the permission.
    name String
    The name of the permission. Permission names must be unique in the project, and roles reference permissions by name. The names of the system permissions that are created in every project are reserved and cannot be used: Impersonate, SSO Admin, Super User, and User Admin.
    projectId String
    The ID of the project that this permission 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 descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial