Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 3.87 KB

adapters.md

File metadata and controls

87 lines (65 loc) · 3.87 KB
Raw

Adapter Setup

ZEP Adapter Setup

The ZEP Adapter just the Username and Password as well as the ZEP Endpoint as configuration parameters:

source:
  adapter:
    type: "zep"
    calendar: "absences"
    config:
      username: [email protected]
      password: superSuperSecret1337
      endpoint: "https://zep.company.com/zep/sync/dav.php/calendars"

The ZEP adapter is only supported as a source.

Outlook Adapter Setup

The Outlook calendar is synchronized via Microsoft Graph API. You will need to register an application on Azure. The application needs the following permissions:

  • Calendar.ReadWrite

The User.read permission should be assigned by default. To assign the Calendar.ReadWrite permission, click on "API Permissions" and add the permission to the "Microsoft Graph API".

You also need to setup a platform specific configuration. This can be done in the "Authentication" menu. Add a "mobile and desktop application" platform configuration and add http://localhost/redirect as a valid redirect uri.

The Outlook adapter can be configured as a source using the tenant-id and client-id of the registered Azure app. Both tenant-id and client-id can be found in the Azure portal "Overview" tab of the previously registered Azure app. If you want to use the adapter to access personal Microsoft accounts, you need to use the tenant common.

source:
  adapter:
    type: "outlook_http"
    calendar: "[base64-format string here]"
    config:
      tenantId: "[UUID-format string here]"
      clientId: "[UUID-format string here]"

To get your calendar ID, use the Microsoft Graph Explorer and query GET https://graph.microsoft.com/v1.0/me/calendar.

Google Adapter Setup

  • Open the Google Cloud Console and login.
  • Now you can either select New Project at the top left of the screen or just click here
  • Create a new project, name it as you like but make sure that the Billing Account is set correctly.

new-project

  • Now you should be able to select the project in the top left corner. Most likely the project will already be selected now.
  • Either follow the enable calendar API link or follow the steps below.
    • In the search bar, look for google calendar and select the Google Calendar API
    • You'll be redirected to the API description. Hit the Enable button.
  • Once the API is enabled, you'll be redirected again to the API management overview.
  • Click on Credentials in the sidebar and then on Create Credentials
  • We will need to create an OAuth client ID
    • Select Desktop app as application type and give it a name of your liking (calendarsync-dev maybe?)
  • Once The client ID is created you will see it in the overview.
  • Click on the download icon of the created client
    • You'll see a popup open. Here you can simply Download JSON. This will download the credentials.json file required.

client-id-popup

sink:
  adapter:
    type: google
    calendar: "[email protected]"
    oAuth:
      clientId: "<clientID>"
      clientKey: "<clientSecret>"

Important: When retrieving the credentials from Google, you'll get a clientId and a clientSecret. Make sure to add the clientSecret to the clientKey setting in your CalendarSync configuration.

If you want to use the created OAuth Application also with accounts outside of your Google Workspace, make sure to set the Usertype to external in the OAuth Consent Screen Menu.