Terraform Provider for SAP BTP

https://registry.terraform.io/providers/SAP/btp/latest/docs
Admin
The Terraform provider for SAP BTP enables you to automate the provisioning, management, and...
Tokens:1,147
Snippets:20
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Setting Custom User-Agent Information (Bash)

Source: https://registry.terraform.io/providers/SAP/btp/latest/docs/index

Example of how to set the `BTP_APPEND_USER_AGENT` environment variable in Bash to add custom information to the User-Agent header for HTTP requests made by the BTP provider.

```bash
% export BTP_APPEND_USER_AGENT="Optional_Extra_Information"
```

--------------------------------

### Terraform BTP Provider with Username and Password Authentication

Source: https://registry.terraform.io/providers/SAP/btp/latest/docs/index

This configuration shows how to set up the Terraform BTP provider using username and password authentication. It highlights the recommendation to source credentials from environment variables for security. This is a common setup for default SAP BTP identity providers.

```Terraform
# Configure the BTP Provider
# We recommend to source username and password from environment variables
provider "btp" {
  globalaccount = "my-global-account-subdomain"
  username      = var.username
  password      = var.password
}
```

--------------------------------

### Terraform BTP Provider Configuration

Source: https://registry.terraform.io/providers/SAP/btp/latest/docs/index

This snippet demonstrates the basic configuration of the Terraform BTP provider, including specifying the source and version of the provider and setting the global account. It's essential for any Terraform project managing SAP BTP resources.

```Terraform
terraform {
  required_providers {
    btp = {
      source  = "SAP/btp"
      version = "1.17.0"
    }
  }
}

# Configure the BTP Provider
provider "btp" {
  globalaccount = "my-global-account-subdomain"
}
```

--------------------------------

### SAP BTP Provider Configuration

Source: https://registry.terraform.io/providers/SAP/btp/latest/docs/index

This section outlines the configuration of the SAP BTP Terraform provider, including required and optional parameters for authentication and resource management.

```APIDOC
## Provider Configuration

### Description
This provider allows you to manage resources within SAP Business Technology Platform (BTP). It requires specific configuration parameters for authentication and to target your BTP environment.

### Method
Configuration block within Terraform files.

### Endpoint
N/A (Provider Configuration)

### Parameters
#### Required
- **globalaccount** (String) - The subdomain of the global account in which you want to manage resources. To be found in the cockpit, in the global account view.

#### Optional
- **assertion** (String, Sensitive) - A valid assertion JWT token. Can be sourced from the `BTP_ASSERTION` environment variable. Supported when using a custom Identity Provider (IdP).
- **cli_server_url** (String) - The URL of the BTP CLI server. Defaults to `https://cli.btp.cloud.sap`.
- **idp** (String) - The identity provider to be used for authentication (only required for custom idp).
- **idtoken** (String, Sensitive) - A valid id token. Can be sourced from the `BTP_IDTOKEN` environment variable. (SAP-internal usage only)
- **password** (String, Sensitive) - Your password. Note that two-factor authentication is not supported. Can be sourced from the `BTP_PASSWORD` environment variable.
- **tls_client_certificate** (String) - PEM encoded certificate (only required for x509 auth).
- **tls_client_key** (String) - PEM encoded private key (only required for x509 auth).
- **tls_idp_url** (String) - The URL of the identity provider to be used for authentication (only required for x509 auth).
- **username** (String) - Your user name, usually an e-mail address. Can be sourced from the `BTP_USERNAME` environment variable.

### Request Example
```hcl
terraform {
  required_providers {
    btp = {
      source  = "SAP/btp"
      version = "1.17.0"
    }
  }
}

provider "btp" {
  globalaccount = "my-global-account-subdomain"
  # username      = var.username
  # password      = var.password
  # idp           = "my-custom-idp"
}
```

### Response
#### Success Response (Configuration Applied)
N/A (Provider configuration does not return a direct response in this context, but enables subsequent resource management).

#### Response Example
N/A
```

--------------------------------

### BTP Provider Authentication with X509 Certificates (Terraform)

Source: https://registry.terraform.io/providers/SAP/btp/latest/docs/index

Configures the BTP Terraform provider using X509 certificates for authentication. This method requires the certificate and private key to be stored in PEM-encoded files (e.g., `btp-tech-user-cert.pem`, `btp-tech-user-key.pem`) and referenced using the Terraform `file()` function.

```terraform
# Configure the BTP Provider
provider "btp" {
  globalaccount          = "my-global-account-subdomain"
  idp                    = "customerTenant.accounts.ondemand.com"
  username               = "btp-tech-user@customer-domain.de"
  tls_client_certificate = file("PATH_TO_FILE/btp-tech-user-cert.pem")
  tls_client_key         = file("PATH_TO_FILE/btp-tech-user-key.pem")
  tls_idp_url            = "https://customerTenant.accounts.ondemand.com"
}
```

--------------------------------

### BTP Provider Authentication with Username and Password (Terraform)

Source: https://registry.terraform.io/providers/SAP/btp/latest/docs/index

Configures the BTP Terraform provider using username and password. It's recommended to source these credentials from environment variables (`BTP_USERNAME`, `BTP_PASSWORD`) or use Terraform variables, ensuring sensitive data is not committed to source control.

```terraform
provider "btp" {
  globalaccount = "my-global-account-subdomain"
  idp           = "customerTenant.accounts.ondemand.com"
  username      = var.username
  password      = var.password
}
```

--------------------------------

### Terraform BTP Provider with Custom Identity Provider

Source: https://registry.terraform.io/providers/SAP/btp/latest/docs/index

This Terraform configuration illustrates setting up the BTP provider when using a custom identity provider. It includes the `idp` parameter in addition to the global account, which is required for custom identity provider authentication flows.

```Terraform
# Configure the BTP Provider

```

--------------------------------

### BTP Provider Authentication with JWT Bearer Assertion (Terraform)

Source: https://registry.terraform.io/providers/SAP/btp/latest/docs/index

Configures the BTP Terraform provider using the JWT Bearer Assertion flow. This requires a custom identity provider and the JWT token can be sourced from the `BTP_ASSERTION` environment variable.

```terraform
provider "btp" {
  globalaccount = "my-global-account-subdomain"
  idp           = "customerTenant.accounts.ondemand.com"
  assertion    = "yourJWTtoken"
 }
```
Tokens:
Raw