1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. UnibeamConnector
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 Unibeam connector and its configuration in a Descope project. SIM-based authentication and approval using Unibeam’s OnSim technology for passwordless authentication and transaction approval.

    Create UnibeamConnector Resource

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

    Constructor syntax

    new UnibeamConnector(name: string, args: UnibeamConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def UnibeamConnector(resource_name: str,
                         args: UnibeamConnectorArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def UnibeamConnector(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         base_url: Optional[str] = None,
                         client_id: Optional[str] = None,
                         client_secret: Optional[str] = None,
                         customer_id: Optional[str] = None,
                         hmac_secret: Optional[str] = None,
                         project_id: Optional[str] = None,
                         default_message: Optional[str] = None,
                         description: Optional[str] = None,
                         disabled: Optional[bool] = None,
                         name: Optional[str] = None)
    func NewUnibeamConnector(ctx *Context, name string, args UnibeamConnectorArgs, opts ...ResourceOption) (*UnibeamConnector, error)
    public UnibeamConnector(string name, UnibeamConnectorArgs args, CustomResourceOptions? opts = null)
    public UnibeamConnector(String name, UnibeamConnectorArgs args)
    public UnibeamConnector(String name, UnibeamConnectorArgs args, CustomResourceOptions options)
    
    type: descope:UnibeamConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_unibeam_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args UnibeamConnectorArgs
    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 UnibeamConnectorArgs
    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 UnibeamConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UnibeamConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UnibeamConnectorArgs
    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 unibeamConnectorResource = new Descope.UnibeamConnector("unibeamConnectorResource", new()
    {
        BaseUrl = "string",
        ClientId = "string",
        ClientSecret = "string",
        CustomerId = "string",
        HmacSecret = "string",
        ProjectId = "string",
        DefaultMessage = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
    });
    
    example, err := descope.NewUnibeamConnector(ctx, "unibeamConnectorResource", &descope.UnibeamConnectorArgs{
    	BaseUrl:        pulumi.String("string"),
    	ClientId:       pulumi.String("string"),
    	ClientSecret:   pulumi.String("string"),
    	CustomerId:     pulumi.String("string"),
    	HmacSecret:     pulumi.String("string"),
    	ProjectId:      pulumi.String("string"),
    	DefaultMessage: pulumi.String("string"),
    	Description:    pulumi.String("string"),
    	Disabled:       pulumi.Bool(false),
    	Name:           pulumi.String("string"),
    })
    
    resource "descope_unibeam_connector" "unibeamConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      base_url        = "string"
      client_id       = "string"
      client_secret   = "string"
      customer_id     = "string"
      hmac_secret     = "string"
      project_id      = "string"
      default_message = "string"
      description     = "string"
      disabled        = false
      name            = "string"
    }
    
    var unibeamConnectorResource = new UnibeamConnector("unibeamConnectorResource", UnibeamConnectorArgs.builder()
        .baseUrl("string")
        .clientId("string")
        .clientSecret("string")
        .customerId("string")
        .hmacSecret("string")
        .projectId("string")
        .defaultMessage("string")
        .description("string")
        .disabled(false)
        .name("string")
        .build());
    
    unibeam_connector_resource = descope.UnibeamConnector("unibeamConnectorResource",
        base_url="string",
        client_id="string",
        client_secret="string",
        customer_id="string",
        hmac_secret="string",
        project_id="string",
        default_message="string",
        description="string",
        disabled=False,
        name="string")
    
    const unibeamConnectorResource = new descope.UnibeamConnector("unibeamConnectorResource", {
        baseUrl: "string",
        clientId: "string",
        clientSecret: "string",
        customerId: "string",
        hmacSecret: "string",
        projectId: "string",
        defaultMessage: "string",
        description: "string",
        disabled: false,
        name: "string",
    });
    
    type: descope:UnibeamConnector
    properties:
        baseUrl: string
        clientId: string
        clientSecret: string
        customerId: string
        defaultMessage: string
        description: string
        disabled: false
        hmacSecret: string
        name: string
        projectId: string
    

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

    BaseUrl string
    Unibeam API base URL.
    ClientId string
    OAuth2 client ID for authentication.
    ClientSecret string
    OAuth2 client secret for authentication.
    CustomerId string
    Your Unibeam customer ID.
    HmacSecret string
    HMAC secret supplied by Unibeam for securing communications.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    DefaultMessage string
    Default message to display when no message is provided in the command.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    BaseUrl string
    Unibeam API base URL.
    ClientId string
    OAuth2 client ID for authentication.
    ClientSecret string
    OAuth2 client secret for authentication.
    CustomerId string
    Your Unibeam customer ID.
    HmacSecret string
    HMAC secret supplied by Unibeam for securing communications.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    DefaultMessage string
    Default message to display when no message is provided in the command.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    base_url string
    Unibeam API base URL.
    client_id string
    OAuth2 client ID for authentication.
    client_secret string
    OAuth2 client secret for authentication.
    customer_id string
    Your Unibeam customer ID.
    hmac_secret string
    HMAC secret supplied by Unibeam for securing communications.
    project_id string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    default_message string
    Default message to display when no message is provided in the command.
    description string
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    baseUrl String
    Unibeam API base URL.
    clientId String
    OAuth2 client ID for authentication.
    clientSecret String
    OAuth2 client secret for authentication.
    customerId String
    Your Unibeam customer ID.
    hmacSecret String
    HMAC secret supplied by Unibeam for securing communications.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    defaultMessage String
    Default message to display when no message is provided in the command.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    baseUrl string
    Unibeam API base URL.
    clientId string
    OAuth2 client ID for authentication.
    clientSecret string
    OAuth2 client secret for authentication.
    customerId string
    Your Unibeam customer ID.
    hmacSecret string
    HMAC secret supplied by Unibeam for securing communications.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    defaultMessage string
    Default message to display when no message is provided in the command.
    description string
    A description of what your connector is used for.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    base_url str
    Unibeam API base URL.
    client_id str
    OAuth2 client ID for authentication.
    client_secret str
    OAuth2 client secret for authentication.
    customer_id str
    Your Unibeam customer ID.
    hmac_secret str
    HMAC secret supplied by Unibeam for securing communications.
    project_id str
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    default_message str
    Default message to display when no message is provided in the command.
    description str
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name str
    A custom name for your connector.
    baseUrl String
    Unibeam API base URL.
    clientId String
    OAuth2 client ID for authentication.
    clientSecret String
    OAuth2 client secret for authentication.
    customerId String
    Your Unibeam customer ID.
    hmacSecret String
    HMAC secret supplied by Unibeam for securing communications.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    defaultMessage String
    Default message to display when no message is provided in the command.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.

    Outputs

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

    Get an existing UnibeamConnector 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?: UnibeamConnectorState, opts?: CustomResourceOptions): UnibeamConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            base_url: Optional[str] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            customer_id: Optional[str] = None,
            default_message: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            hmac_secret: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None) -> UnibeamConnector
    func GetUnibeamConnector(ctx *Context, name string, id IDInput, state *UnibeamConnectorState, opts ...ResourceOption) (*UnibeamConnector, error)
    public static UnibeamConnector Get(string name, Input<string> id, UnibeamConnectorState? state, CustomResourceOptions? opts = null)
    public static UnibeamConnector get(String name, Output<String> id, UnibeamConnectorState state, CustomResourceOptions options)
    resources:  existingUnibeamConnector:    type: descope:UnibeamConnector    get:      id: ${id}
    import {
      to = descope_unibeam_connector.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 UnibeamConnectorState
    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 UnibeamConnectorState
    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 UnibeamConnectorState
    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 UnibeamConnectorState
    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:
    BaseUrl string
    Unibeam API base URL.
    ClientId string
    OAuth2 client ID for authentication.
    ClientSecret string
    OAuth2 client secret for authentication.
    CustomerId string
    Your Unibeam customer ID.
    DefaultMessage string
    Default message to display when no message is provided in the command.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    HmacSecret string
    HMAC secret supplied by Unibeam for securing communications.
    Name string
    A custom name for your connector.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    BaseUrl string
    Unibeam API base URL.
    ClientId string
    OAuth2 client ID for authentication.
    ClientSecret string
    OAuth2 client secret for authentication.
    CustomerId string
    Your Unibeam customer ID.
    DefaultMessage string
    Default message to display when no message is provided in the command.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    HmacSecret string
    HMAC secret supplied by Unibeam for securing communications.
    Name string
    A custom name for your connector.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    base_url string
    Unibeam API base URL.
    client_id string
    OAuth2 client ID for authentication.
    client_secret string
    OAuth2 client secret for authentication.
    customer_id string
    Your Unibeam customer ID.
    default_message string
    Default message to display when no message is provided in the command.
    description string
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    hmac_secret string
    HMAC secret supplied by Unibeam for securing communications.
    name string
    A custom name for your connector.
    project_id string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    baseUrl String
    Unibeam API base URL.
    clientId String
    OAuth2 client ID for authentication.
    clientSecret String
    OAuth2 client secret for authentication.
    customerId String
    Your Unibeam customer ID.
    defaultMessage String
    Default message to display when no message is provided in the command.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    hmacSecret String
    HMAC secret supplied by Unibeam for securing communications.
    name String
    A custom name for your connector.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    baseUrl string
    Unibeam API base URL.
    clientId string
    OAuth2 client ID for authentication.
    clientSecret string
    OAuth2 client secret for authentication.
    customerId string
    Your Unibeam customer ID.
    defaultMessage string
    Default message to display when no message is provided in the command.
    description string
    A description of what your connector is used for.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    hmacSecret string
    HMAC secret supplied by Unibeam for securing communications.
    name string
    A custom name for your connector.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    base_url str
    Unibeam API base URL.
    client_id str
    OAuth2 client ID for authentication.
    client_secret str
    OAuth2 client secret for authentication.
    customer_id str
    Your Unibeam customer ID.
    default_message str
    Default message to display when no message is provided in the command.
    description str
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    hmac_secret str
    HMAC secret supplied by Unibeam for securing communications.
    name str
    A custom name for your connector.
    project_id str
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    baseUrl String
    Unibeam API base URL.
    clientId String
    OAuth2 client ID for authentication.
    clientSecret String
    OAuth2 client secret for authentication.
    customerId String
    Your Unibeam customer ID.
    defaultMessage String
    Default message to display when no message is provided in the command.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    hmacSecret String
    HMAC secret supplied by Unibeam for securing communications.
    name String
    A custom name for your connector.
    projectId String
    The ID of the Descope project that the connector 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