published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages the project’s admin portal configuration. This is a singleton resource, and its id is always the project ID.
Create AdminPortal Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AdminPortal(name: string, args: AdminPortalArgs, opts?: CustomResourceOptions);@overload
def AdminPortal(resource_name: str,
args: AdminPortalArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AdminPortal(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
enabled: Optional[bool] = None,
style_id: Optional[str] = None,
widgets: Optional[Sequence[AdminPortalWidgetArgs]] = None)func NewAdminPortal(ctx *Context, name string, args AdminPortalArgs, opts ...ResourceOption) (*AdminPortal, error)public AdminPortal(string name, AdminPortalArgs args, CustomResourceOptions? opts = null)
public AdminPortal(String name, AdminPortalArgs args)
public AdminPortal(String name, AdminPortalArgs args, CustomResourceOptions options)
type: descope:AdminPortal
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_admin_portal" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AdminPortalArgs
- 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 AdminPortalArgs
- 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 AdminPortalArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AdminPortalArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AdminPortalArgs
- 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 adminPortalResource = new Descope.AdminPortal("adminPortalResource", new()
{
ProjectId = "string",
Enabled = false,
StyleId = "string",
Widgets = new[]
{
new Descope.Inputs.AdminPortalWidgetArgs
{
Type = "string",
WidgetId = "string",
},
},
});
example, err := descope.NewAdminPortal(ctx, "adminPortalResource", &descope.AdminPortalArgs{
ProjectId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
StyleId: pulumi.String("string"),
Widgets: descope.AdminPortalWidgetArray{
&descope.AdminPortalWidgetArgs{
Type: pulumi.String("string"),
WidgetId: pulumi.String("string"),
},
},
})
resource "descope_admin_portal" "adminPortalResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
enabled = false
style_id = "string"
widgets {
type = "string"
widget_id = "string"
}
}
var adminPortalResource = new AdminPortal("adminPortalResource", AdminPortalArgs.builder()
.projectId("string")
.enabled(false)
.styleId("string")
.widgets(AdminPortalWidgetArgs.builder()
.type("string")
.widgetId("string")
.build())
.build());
admin_portal_resource = descope.AdminPortal("adminPortalResource",
project_id="string",
enabled=False,
style_id="string",
widgets=[{
"type": "string",
"widget_id": "string",
}])
const adminPortalResource = new descope.AdminPortal("adminPortalResource", {
projectId: "string",
enabled: false,
styleId: "string",
widgets: [{
type: "string",
widgetId: "string",
}],
});
type: descope:AdminPortal
properties:
enabled: false
projectId: string
styleId: string
widgets:
- type: string
widgetId: string
AdminPortal 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 AdminPortal resource accepts the following input properties:
- Project
Id string - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- Enabled bool
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - Style
Id string - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - Widgets
List<Descope.
Admin Portal Widget> - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- Project
Id string - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- Enabled bool
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - Style
Id string - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - Widgets
[]Admin
Portal Widget Args - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- project_
id string - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- enabled bool
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - style_
id string - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets list(object)
- The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- project
Id String - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- enabled Boolean
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - style
Id String - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets
List<Admin
Portal Widget> - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- project
Id string - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- enabled boolean
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - style
Id string - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets
Admin
Portal Widget[] - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- project_
id str - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- enabled bool
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - style_
id str - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets
Sequence[Admin
Portal Widget Args] - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- project
Id String - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- enabled Boolean
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - style
Id String - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets List<Property Map>
- The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
Outputs
All input properties are implicitly available as output properties. Additionally, the AdminPortal 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 AdminPortal Resource
Get an existing AdminPortal 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?: AdminPortalState, opts?: CustomResourceOptions): AdminPortal@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
project_id: Optional[str] = None,
style_id: Optional[str] = None,
widgets: Optional[Sequence[AdminPortalWidgetArgs]] = None) -> AdminPortalfunc GetAdminPortal(ctx *Context, name string, id IDInput, state *AdminPortalState, opts ...ResourceOption) (*AdminPortal, error)public static AdminPortal Get(string name, Input<string> id, AdminPortalState? state, CustomResourceOptions? opts = null)public static AdminPortal get(String name, Output<String> id, AdminPortalState state, CustomResourceOptions options)resources: _: type: descope:AdminPortal get: id: ${id}import {
to = descope_admin_portal.example
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.
- Enabled bool
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - Project
Id string - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- Style
Id string - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - Widgets
List<Descope.
Admin Portal Widget> - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- Enabled bool
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - Project
Id string - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- Style
Id string - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - Widgets
[]Admin
Portal Widget Args - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- enabled bool
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - project_
id string - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- style_
id string - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets list(object)
- The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- enabled Boolean
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - project
Id String - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- style
Id String - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets
List<Admin
Portal Widget> - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- enabled boolean
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - project
Id string - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- style
Id string - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets
Admin
Portal Widget[] - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- enabled bool
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - project_
id str - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- style_
id str - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets
Sequence[Admin
Portal Widget Args] - The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
- enabled Boolean
- Whether the Admin Portal is enabled. At least one widget must be listed in the
widgetsattribute when this is set totrue. - project
Id String - The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
- style
Id String - The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the
descope.Stylesresource. When left empty, the default style is used. - widgets List<Property Map>
- The widgets to show in the Admin Portal, in display order. The
widgetIdvalues usually reference widgets managed with thedescope.Widgetresource, e.g.,widgetId = descope_widget.mywidget.widget_id.
Supporting Types
AdminPortalWidget, AdminPortalWidgetArgs
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