v5.18.0/website/docs/r/iap_brand.html.markdown

---
# ----------------------------------------------------------------------------
#
#     ***     AUTO GENERATED CODE    ***    Type: MMv1     ***
#
# ----------------------------------------------------------------------------
#
#     This file is automatically generated by Magic Modules and manual
#     changes will be clobbered when the file is regenerated.
#
#     Please read more about how to change this file in
#     .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
subcategory: "Identity-Aware Proxy"
description: |-
  OAuth brand data.
---

# google\_iap\_brand

OAuth brand data. Only "Organization Internal" brands can be created
programmatically via API. To convert it into an external brands
please use the GCP Console.


~> **Note:** Brands can only be created once for a Google Cloud
project and the underlying Google API doesn't not support DELETE or PATCH methods.
Destroying a Terraform-managed Brand will remove it from state
but *will not delete it from Google Cloud.*


To get more information about Brand, see:

* [API documentation](https://cloud.google.com/iap/docs/reference/rest/v1/projects.brands)
* How-to Guides
    * [Setting up IAP Brand](https://cloud.google.com/iap/docs/tutorial-gce#set_up_iap)

## Example Usage - Iap Brand


```hcl
resource "google_project" "project" {
  project_id = "my-project"
  name       = "my-project"
  org_id     = "123456789"
}

resource "google_project_service" "project_service" {
  project = google_project.project.project_id
  service = "iap.googleapis.com"
}

resource "google_iap_brand" "project_brand" {
  support_email     = "support@example.com"
  application_title = "Cloud IAP protected Application"
  project           = google_project_service.project_service.project
}
```

## Argument Reference

The following arguments are supported:


* `support_email` -
  (Required)
  Support email displayed on the OAuth consent screen. Can be either a
  user or group email. When a user email is specified, the caller must
  be the user with the associated email address. When a group email is
  specified, the caller can be either a user or a service account which
  is an owner of the specified group in Cloud Identity.

* `application_title` -
  (Required)
  Application name displayed on OAuth consent screen.


- - -


* `project` - (Optional) The ID of the project in which the resource belongs.
    If it is not provided, the provider project is used.


## Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

* `id` - an identifier for the resource with format `{{name}}`

* `org_internal_only` -
  Whether the brand is only intended for usage inside the GSuite organization only.

* `name` -
  Output only. Identifier of the brand, in the format `projects/{project_number}/brands/{brand_id}`
  NOTE: The name can also be expressed as `projects/{project_id}/brands/{brand_id}`, e.g. when importing.
  NOTE: The brand identification corresponds to the project number as only one
  brand can be created per project.


## Timeouts

This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:

- `create` - Default is 20 minutes.
- `delete` - Default is 20 minutes.

## Import


Brand can be imported using any of these accepted formats:

* `projects/{{project_id}}/brands/{{brand_id}}`
* `projects/{{project_number}}/brands/{{brand_id}}`
* `{{project_number}}/{{brand_id}}`


In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Brand using one of the formats above. For example:

```tf
import {
  id = "projects/{{project_id}}/brands/{{brand_id}}"
  to = google_iap_brand.default
}
```

When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Brand can be imported using one of the formats above. For example:

```
$ terraform import google_iap_brand.default projects/{{project_id}}/brands/{{brand_id}}
$ terraform import google_iap_brand.default projects/{{project_number}}/brands/{{brand_id}}
$ terraform import google_iap_brand.default {{project_number}}/{{brand_id}}
```

## User Project Overrides

This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).