Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svycal/ueberauth_zoom
Zoom OAuth2 Strategy for Überauth
https://github.com/svycal/ueberauth_zoom
elixir oauth2 zoom
Last synced: about 1 month ago
JSON representation
Zoom OAuth2 Strategy for Überauth
- Host: GitHub
- URL: https://github.com/svycal/ueberauth_zoom
- Owner: svycal
- License: mit
- Created: 2020-07-17T16:29:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-17T16:59:01.000Z (about 1 year ago)
- Last Synced: 2024-10-19T20:54:35.877Z (3 months ago)
- Topics: elixir, oauth2, zoom
- Language: Elixir
- Homepage: https://hexdocs.pm/ueberauth_zoom
- Size: 40 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Überauth Zoom [](https://hex.pm/packages/ueberauth_zoom)
> Zoom OAuth2 strategy for Überauth.
## Installation
1. Setup your application at [Zoom App Marketplace](https://marketplace.zoom.us/).
1. Add `:ueberauth_zoom` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:ueberauth_zoom, "~> 0.2.0"}]
end
```
1. Add the strategy to your applications:
```elixir
def application do
[applications: [:ueberauth_zoom]]
end
```
1. Add Zoom to your Überauth configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
zoom: {Ueberauth.Strategy.Zoom, []}
]
```
1. Update your provider configuration:
Use that if you want to read client ID/secret from the environment
variables in the compile time:
```elixir
config :ueberauth, Ueberauth.Strategy.Zoom.OAuth,
client_id: System.get_env("ZOOM_CLIENT_ID"),
client_secret: System.get_env("ZOOM_CLIENT_SECRET")
```
Use that if you want to read client ID/secret from the environment
variables in the run time:
```elixir
config :ueberauth, Ueberauth.Strategy.Zoom.OAuth,
client_id: {System, :get_env, ["ZOOM_CLIENT_ID"]},
client_secret: {System, :get_env, ["ZOOM_CLIENT_SECRET"]}
```
1. Include the Überauth plug in your controller:
```elixir
defmodule MyApp.AuthController do
use MyApp.Web, :controller
plug Ueberauth
...
end
```
1. Create the request and callback routes if you haven't already:
```elixir
scope "/auth", MyApp do
pipe_through :browser
get "/:provider", AuthController, :request
get "/:provider/callback", AuthController, :callback
end
```
1. Your controller needs to implement callbacks to deal with `Ueberauth.Auth` and `Ueberauth.Failure` responses.
For an example implementation see the [Überauth Example](https://github.com/ueberauth/ueberauth_example) application.
## Calling
Depending on the configured url you can initiate the request through:
/auth/zoom
## License
Please see [LICENSE](https://github.com/svycal/ueberauth_zoom/blob/main/LICENSE.md) for licensing details.