1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. AdminPortal
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 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:

    ProjectId 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 widgets attribute when this is set to true.
    StyleId string
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    Widgets List<Descope.AdminPortalWidget>
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, e.g., widgetId = descope_widget.mywidget.widget_id.
    ProjectId 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 widgets attribute when this is set to true.
    StyleId string
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    Widgets []AdminPortalWidgetArgs
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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 widgets attribute when this is set to true.
    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.Styles resource. When left empty, the default style is used.
    widgets list(object)
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, e.g., widgetId = descope_widget.mywidget.widget_id.
    projectId 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 widgets attribute when this is set to true.
    styleId String
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    widgets List<AdminPortalWidget>
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, e.g., widgetId = descope_widget.mywidget.widget_id.
    projectId 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 widgets attribute when this is set to true.
    styleId string
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    widgets AdminPortalWidget[]
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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 widgets attribute when this is set to true.
    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.Styles resource. When left empty, the default style is used.
    widgets Sequence[AdminPortalWidgetArgs]
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, e.g., widgetId = descope_widget.mywidget.widget_id.
    projectId 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 widgets attribute when this is set to true.
    styleId String
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    widgets List<Property Map>
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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) -> AdminPortal
    func 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.
    The following state arguments are supported:
    Enabled bool
    Whether the Admin Portal is enabled. At least one widget must be listed in the widgets attribute when this is set to true.
    ProjectId string
    The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
    StyleId string
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    Widgets List<Descope.AdminPortalWidget>
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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 widgets attribute when this is set to true.
    ProjectId string
    The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
    StyleId string
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    Widgets []AdminPortalWidgetArgs
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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 widgets attribute when this is set to true.
    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.Styles resource. When left empty, the default style is used.
    widgets list(object)
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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 widgets attribute when this is set to true.
    projectId String
    The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
    styleId String
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    widgets List<AdminPortalWidget>
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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 widgets attribute when this is set to true.
    projectId string
    The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
    styleId string
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    widgets AdminPortalWidget[]
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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 widgets attribute when this is set to true.
    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.Styles resource. When left empty, the default style is used.
    widgets Sequence[AdminPortalWidgetArgs]
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, 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 widgets attribute when this is set to true.
    projectId String
    The ID of the project that this configuration belongs to. Changing this value will require the resource to be deleted and recreated.
    styleId String
    The name of the style the Admin Portal uses. Styles are defined in the project theme, which can be managed with the descope.Styles resource. When left empty, the default style is used.
    widgets List<Property Map>
    The widgets to show in the Admin Portal, in display order. The widgetId values usually reference widgets managed with the descope.Widget resource, e.g., widgetId = descope_widget.mywidget.widget_id.

    Supporting Types

    AdminPortalWidget, AdminPortalWidgetArgs

    Type string
    The type of the Widget
    WidgetId string
    The unique identifier of the Widget
    Type string
    The type of the Widget
    WidgetId string
    The unique identifier of the Widget
    type string
    The type of the Widget
    widget_id string
    The unique identifier of the Widget
    type String
    The type of the Widget
    widgetId String
    The unique identifier of the Widget
    type string
    The type of the Widget
    widgetId string
    The unique identifier of the Widget
    type str
    The type of the Widget
    widget_id str
    The unique identifier of the Widget
    type String
    The type of the Widget
    widgetId String
    The unique identifier of the Widget

    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