published on Sunday, Oct 11, 2026 by Descope
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:
- 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.
- 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.
- 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.
- 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 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 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 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.
- 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 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) -> UnibeamConnectorfunc 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.
- 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.
- 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.
- 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.
- 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 Boolean
- 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.
- 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 boolean
- 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.
- 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.
- 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 Boolean
- 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.
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