Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Cloudflare Access supports social identity providers that do not require adminis

Adding an identity provider as a login method requires configuration both on the [Teams dashboard](https://dash.teams.cloudflare.com) and with the identity provider. Consult our IdP-specific documentation to learn more about what you need to set up.

## Setting up IdPs on the Teams dashboard
## Set up IdPs on the Teams dashboard

1. Navigate to **Access > Authentication** on the [Teams dashboard](https://dash.teams.cloudflare.com).
2. In the **Login methods** card, click *+Add*.
Expand All @@ -23,30 +23,28 @@ Adding an identity provider as a login method requires configuration both on the

Each identity provider will have different required fields for you to fill in. If you need help, step-by-step instructions can be expanded below the input form.


![IdP Setup Fields](../../static/summary/idp-setup-card.png)

If you do not see your identity provider listed, but they support SAML or OAuth, these providers can typically still be enabled. If they support SAML select the SAML option. If they support OAuth select the **OpenID Connect** option.

4. Once you have filled in the necessary fields, click **Save**.

### Using The API
## Test IdPs on the Teams dashboard

To test if an IdP is correctly configured, click on **Authentication** > **Login Methods** > **Test**. This will attempt to connect to the IdP to verify if a valid connection is established.

We recommend that you use our dashboard to configure your identity providers. However, if you would like to use the [Cloudflare API](https://api.cloudflare.com/), each of the identity provider topics covered here include an example API configuration snippet as well.
![Test and Edit IdPs](../../static/identity-index/auth-home.png)

## Customize the Login Page
### Your provider is connected

You can customize the page users will see when attempting to visit an application that is behind Access.
If your provider is connected, another window will open in your browser, with this message:

To do so:
![Connected IdP](../../static/identity-index/connected-idp.png)

### Your provider is not connected

1. On the Teams dash, navigate to **Authentication > Login Page**.
If your provider is not connected, another window will open in your browser. Along with an error message, you will receive a detailed explanation of why the test has failed.

2. Click **Customize**.
## Using The API

3. In the **Configuration card** you will be able to:
* Choose an *Organization name*.
* Link to a *custom logo*.
* Choose a *custom header text*.
* Choose a *custom footer text*.
* Choose a *background color*.
We recommend that you use our dashboard to configure your identity providers. However, if you would like to use the [Cloudflare API](https://api.cloudflare.com/), each of the identity provider topics covered here include an example API configuration snippet as well.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.