published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a single permission scoped to a federated application. Permissions are referenced by id from descope.AppRole resources.
Create AppPermission Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppPermission(name: string, args: AppPermissionArgs, opts?: CustomResourceOptions);@overload
def AppPermission(resource_name: str,
args: AppPermissionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AppPermission(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
project_id: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None)func NewAppPermission(ctx *Context, name string, args AppPermissionArgs, opts ...ResourceOption) (*AppPermission, error)public AppPermission(string name, AppPermissionArgs args, CustomResourceOptions? opts = null)
public AppPermission(String name, AppPermissionArgs args)
public AppPermission(String name, AppPermissionArgs args, CustomResourceOptions options)
type: descope:AppPermission
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_app_permission" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AppPermissionArgs
- 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 AppPermissionArgs
- 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 AppPermissionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppPermissionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppPermissionArgs
- 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 appPermissionResource = new Descope.AppPermission("appPermissionResource", new()
{
AppId = "string",
ProjectId = "string",
Description = "string",
Name = "string",
});
example, err := descope.NewAppPermission(ctx, "appPermissionResource", &descope.AppPermissionArgs{
AppId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "descope_app_permission" "appPermissionResource" {
lifecycle {
create_before_destroy = true
}
app_id = "string"
project_id = "string"
description = "string"
name = "string"
}
var appPermissionResource = new AppPermission("appPermissionResource", AppPermissionArgs.builder()
.appId("string")
.projectId("string")
.description("string")
.name("string")
.build());
app_permission_resource = descope.AppPermission("appPermissionResource",
app_id="string",
project_id="string",
description="string",
name="string")
const appPermissionResource = new descope.AppPermission("appPermissionResource", {
appId: "string",
projectId: "string",
description: "string",
name: "string",
});
type: descope:AppPermission
properties:
appId: string
description: string
name: string
projectId: string
AppPermission 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 AppPermission resource accepts the following input properties:
- App
Id string - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). Changing this value will require the resource to be deleted and recreated. - 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- App
Id string - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). Changing this value will require the resource to be deleted and recreated. - 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- app_
id string - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). Changing this value will require the resource to be deleted and recreated. - 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- app
Id String - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). Changing this value will require the resource to be deleted and recreated. - 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- app
Id string - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). Changing this value will require the resource to be deleted and recreated. - 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- app_
id str - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). Changing this value will require the resource to be deleted and recreated. - 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- app
Id String - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). Changing this value will require the resource to be deleted and recreated. - 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
Outputs
All input properties are implicitly available as output properties. Additionally, the AppPermission 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 AppPermission Resource
Get an existing AppPermission 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?: AppPermissionState, opts?: CustomResourceOptions): AppPermission@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None) -> AppPermissionfunc GetAppPermission(ctx *Context, name string, id IDInput, state *AppPermissionState, opts ...ResourceOption) (*AppPermission, error)public static AppPermission Get(string name, Input<string> id, AppPermissionState? state, CustomResourceOptions? opts = null)public static AppPermission get(String name, Output<String> id, AppPermissionState state, CustomResourceOptions options)resources: existingAppPermission: type: descope:AppPermission get: id: ${id}import {
to = descope_app_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 AppPermissionState
- 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 AppPermissionState
- 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 AppPermissionState
- 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 AppPermissionState
- 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.
- App
Id string - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- 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.
- App
Id string - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- 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.
- app_
id string - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- 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.
- app
Id String - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- 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.
- app
Id string - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- 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.
- app_
id str - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- 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.
- app
Id String - The ID of the federated application that this permission is scoped to. Reference the
idattribute of the application resource (e.g.,descope_oidc_app.example.id). 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 per application, and a permission can be renamed freely without affecting roles that reference it. Note that if a permission is deleted, it is silently removed from any application roles that still reference it.
- 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.
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