Skip to content

Commit

Permalink
add website documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobbednarz committed Feb 12, 2020
1 parent 1745f01 commit eda5fa8
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 0 deletions.
3 changes: 3 additions & 0 deletions website/cloudflare.erb
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@
<li<%= sidebar_current("docs-cloudflare-resource-access-application") %>>
<a href="/docs/providers/cloudflare/r/access_application.html">cloudflare_access_application</a>
</li>
<li<%= sidebar_current("docs-cloudflare-resource-access-identity-provider") %>>
<a href="/docs/providers/cloudflare/r/access_identity_provider.html">cloudflare_access_identity_provider</a>
</li>
<li<%= sidebar_current("docs-cloudflare-resource-access-policy") %>>
<a href="/docs/providers/cloudflare/r/access_policy.html">cloudflare_access_policy</a>
</li>
Expand Down
82 changes: 82 additions & 0 deletions website/docs/r/access_identity_provider.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
layout: "cloudflare"
page_title: "Cloudflare: cloudflare_access_identity_provider"
sidebar_current: "docs-cloudflare-resource-access-identity-provider"
description: |-
Provides a Cloudflare Access Identity Provider resource.
---

# cloudflare_access_identity_provider

Provides a Cloudflare Access Identity Provider resource. Identity Providers are
used as an authentication or authorisation source within Access.

## Example Usage

```hcl
# one time pin
resource "cloudflare_access_identity_provider" "pin_login" {
account_id = "1d5fdc9e88c8a8c4518b068cd94331fe"
name = "PIN login"
type = "onetimepin"
}
# oauth
resource "cloudflare_access_identity_provider" "github_oauth" {
account_id = "1d5fdc9e88c8a8c4518b068cd94331fe"
name = "GitHub OAuth"
type = "github"
config {
client_id = "example"
client_secret = "secret_key"
}
}
# saml
resource "cloudflare_access_identity_provider" "jumpcloud_saml" {
account_id = "1d5fdc9e88c8a8c4518b068cd94331fe"
name = "JumpCloud SAML"
type = "saml"
config {
issuer_url = "jumpcloud"
sso_target_url = "https://sso.myexample.jumpcloud.com/saml2/cloudflareaccess"
attributes = [ "email", "username" ]
sign_request = false
idp_public_cert = "MIIDpDCCAoygAwIBAgIGAV2ka+55MA0GCSqGSIb3DQEBCwUAMIGSMQswCQ...GF/Q2/MHadws97cZg\nuTnQyuOqPuHbnN83d/2l1NSYKCbHt24o"
}
}
```

Please refer to the [developers.cloudflare.com Access documentation][access_identity_provider_guide]
for full reference on what is available and how to configure your provider.

## Argument Reference

The following arguments are supported:

* `account` - (Required) The account ID the provider should be associated with.
* `name` - (Required) Friendly name of the Access Identity Provider configuration.
* `type` - (Required) The provider type to use. Must be one of: `"centrify"`,
`"facebook"`, `"google-apps"`, `"oidc"`, `"github"`, `"google"`, `"saml"`,
`"linkedin"`, `"azureAD"`, `"okta"`, `"onetimepin"`, `"onelogin"`, `"yandex"`.
* `config` - (Optional) Provider configuration from the [developer documentation][access_identity_provider_guide].

## Attributes Reference

The following additional attributes are exported:

* `id` - ID of the Access Identity Provider
* `name` - Friendly name of the Access Identity Provider configuration.
* `type` - The provider type to use.
* `config` - Access Identity Provider configuration.

## Import

Access Identity Providers can be imported using a composite ID formed of account
ID and Access Identity Provider ID.

```
$ terraform import cloudflare_access_identity_provider.my_idp cb029e245cfdd66dc8d2e570d5dd3322/e00e1c13-e350-44fe-96c5-fb75c954871c
```

[access_identity_provider_guide]: https://developers.cloudflare.com/access/configuring-identity-providers/

0 comments on commit eda5fa8

Please sign in to comment.