Authentication
Our API offers two forms of authentication:
- Workspace Token - A workspace scoped access token.
- OAuth 2.0 - An user scoped authentication. It's possible to perform action on multiple workspaces. (NOT AVAILABLE YET)
Workspace Token
Include your workspace token in the x-api-key header when making requests.
OAuth 2.0
We use the Authorization Code OAuth 2.0 flow.
- Authorization URL: https://login.pigeonholelive.com/authorize
- Token URL: https://login.pigeonholelive.com/oauth/token
We provide the following scopes:
| Scope | Required | Description |
|---|---|---|
openId | true | It's to indicate that the application intend to use OpenID Connect to verify the user's identity |
profile | false | Require access to the user profile info (name, lastname etc.) |
email | false | Require access to the user email |
offline_access | false | Include this scope to get a Refresh Token |