https://github.com/netlify/netlify-plugin-identity-sso

UNOFFICIAL - allows easily adding SSO access control to a Netlify site
https://github.com/netlify/netlify-plugin-identity-sso

access-control identity jamstack netlify netlify-deployment sso

Last synced: about 2 months ago
JSON representation

UNOFFICIAL - allows easily adding SSO access control to a Netlify site

• Host: GitHub
• URL: https://github.com/netlify/netlify-plugin-identity-sso
• Owner: netlify
• License: mit
• Created: 2020-12-09T22:29:00.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T16:42:16.000Z (8 months ago)
• Last Synced: 2024-05-22T17:54:59.015Z (8 months ago)
• Topics: access-control, identity, jamstack, netlify, netlify-deployment, sso
• Language: JavaScript
• Homepage:
• Size: 1.13 MB
• Stars: 2
• Watchers: 3
• Forks: 6
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Netlify Build plugin identity-sso - Protect a site with SSO via identity.

## Install

The recommended way to install this right now is using a git npm dependency:

`package.json`

```js

{

  // ...

  "dependencies": {

    "netlify-plugin-identity-sso": "netlify/netlify-plugin-identity-sso#v0.1.0"

  }

}

```

`netlify.toml`

```toml

[[plugins]]

package = "netlify-plugin-identity-sso"

```

### Identity Setup

- Go to `Settings -> Identity` on your site and click `Enable Identity`

- Add a third-party auth provider, e.g. Google

- Setup the identity webhook:

  - URL: `https://.netlify.app/.netlify/functions/sso-auth`

  - Secret: _Generate a long random string_

  - Events: _Tick all boxes_

- Set the webhook secret as a build environment variable `WEBHOOK_SECRET` for

  use in the function

## Gotchas

- **Do not use a cached directory for publishing.** For some reason this breaks

  writing of a custom `netlify.toml` as part of the build.

- This is hardcoded to allow any user with a `@netlify.com` email address.