Pulumi Provider
In many software development methodologies, there is a need to manage and automate development, testing, and production environments. This need arises from the understanding that all resources deployed in an environment—whether cloud-based or hosted on local servers—eventually reach a stable configuration, often referred to as the "desired state", which primarily includes the configuration of all deployed services.
With tools like Pulumi, the manual effort required to maintain this state decreases. Pulumi, along with other infrastructure-as-code solutions, streamlines the process by enabling a code-first approach to automating environments. To read more about Pulumi and this approach, click here.
Descope provides a pulumi package that allows managing Descope projects and configuration.
Prerequisites
Note
The pulumi package works with "Pro" or "Enterprise" type license. If you are having trouble with licensing, please contant the developer success team.
- A project already created in Descope.
Management Key
. Create One on the Company Settings. If you intend to create a new project, make sure the key is scoped for use in all projects.
Installation
This package is available for several languages/platforms:
Node.js (JavaScript/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either npm:
Or yarn:
Python
To use from Python, install using pip:
Go
To use from Go, use go get to grab the latest version of the library:
.NET
To use from .NET, install using dotnet add package:
Configuration
The following configuration points are available for the descope
provider:
- descope:projectId (environment: DESCOPE_PROJECT_ID) - Descope Project ID
- descope:managementKey (environment: DESCOPE_MANAGEMENT_KEY) - Descope Management Key
- descope:baseUrl (environment: DESCOPE_BASE_URL) - Descope Base URL, for
EU
based projects, useapi.euc1.descope.com
Reference
For detailed reference documentation, please visit the Pulumi registry.
Examples
Type | Example Repository |
---|---|
JavaScript/TypeScript | Click Here |
Python | Click Here |
Golang | Click Here |