|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "supabase_third_party_auth Resource - terraform-provider-supabase" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Third-party auth resource |
| 7 | +--- |
| 8 | + |
| 9 | +# supabase_third_party_auth (Resource) |
| 10 | + |
| 11 | +Third-party auth resource |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +resource "supabase_third_party_auth" "oidc" { |
| 17 | + project_ref = "mayuaycdtijbctgqbycg" |
| 18 | + oidc_issuer_url = "https://issuer.example.com" |
| 19 | +} |
| 20 | +
|
| 21 | +resource "supabase_third_party_auth" "jwks_url" { |
| 22 | + project_ref = "mayuaycdtijbctgqbycg" |
| 23 | + jwks_url = "https://issuer.example.com/.well-known/jwks.json" |
| 24 | +} |
| 25 | +
|
| 26 | +resource "supabase_third_party_auth" "custom_jwks" { |
| 27 | + project_ref = "mayuaycdtijbctgqbycg" |
| 28 | +
|
| 29 | + # custom_jwks must contain public JWKS material only. |
| 30 | + custom_jwks = jsonencode({ |
| 31 | + keys = [ |
| 32 | + { |
| 33 | + kty = "RSA" |
| 34 | + kid = "example-key" |
| 35 | + n = "example-modulus" |
| 36 | + e = "AQAB" |
| 37 | + } |
| 38 | + ] |
| 39 | + }) |
| 40 | +} |
| 41 | +``` |
| 42 | + |
| 43 | +<!-- schema generated by tfplugindocs --> |
| 44 | +## Schema |
| 45 | + |
| 46 | +### Required |
| 47 | + |
| 48 | +- `project_ref` (String) Project reference ID |
| 49 | + |
| 50 | +### Optional |
| 51 | + |
| 52 | +- `custom_jwks` (String) Custom public JWKS as serialised JSON. Exactly one of `oidc_issuer_url`, `jwks_url`, or `custom_jwks` must be configured. This field follows Terraform provider industry practice for public verification keys and is not marked sensitive; do not include private or symmetric JWK material. |
| 53 | +- `jwks_url` (String) JWKS URL. Exactly one of `oidc_issuer_url`, `jwks_url`, or `custom_jwks` must be configured. |
| 54 | +- `oidc_issuer_url` (String) OIDC issuer URL. Exactly one of `oidc_issuer_url`, `jwks_url`, or `custom_jwks` must be configured. |
| 55 | +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) |
| 56 | + |
| 57 | +### Read-Only |
| 58 | + |
| 59 | +- `id` (String) Third-party auth integration identifier |
| 60 | +- `inserted_at` (String) Timestamp when the integration was created |
| 61 | +- `resolved_at` (String) Timestamp when JWKS was last resolved |
| 62 | +- `resolved_jwks` (String) Resolved JWKS as serialised JSON |
| 63 | +- `type` (String) Third-party auth integration type |
| 64 | +- `updated_at` (String) Timestamp when the integration was last updated |
| 65 | + |
| 66 | +<a id="nestedblock--timeouts"></a> |
| 67 | +### Nested Schema for `timeouts` |
| 68 | + |
| 69 | +Optional: |
| 70 | + |
| 71 | +- `create` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). |
| 72 | + |
| 73 | +## Import |
| 74 | + |
| 75 | +Import is supported using the following syntax: |
| 76 | + |
| 77 | +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: |
| 78 | + |
| 79 | +```shell |
| 80 | +# Third-party auth integrations can be imported using the project reference and |
| 81 | +# the third-party auth integration ID, separated by a '/'. |
| 82 | +# |
| 83 | +# - project_ref: Found in the Supabase dashboard under Project Settings -> General, |
| 84 | +# or in the project's URL: https://supabase.com/dashboard/project/<project_ref> |
| 85 | +# - third_party_auth_id: The UUID of the third-party auth integration. |
| 86 | +terraform import supabase_third_party_auth.oidc <project_ref>/<third_party_auth_id> |
| 87 | +``` |
0 commit comments