Fact
- PhenixID Identity Provisioning 5.1.0 or later
System Requirements
- Account in Google Apps
- Service Account with credentials, described in PSD1195 – Google Apps Service Account Configuration
Situation
Use PhenixID Identity Provisioning to setup automatic calendar and event modifications to Google Calendar.
Solution
This document will show the steps that are necessary to configure PhenixID Identity Provisioning to automatically list/create/update/delete calendar and event information for Google Calendar users.
Download and install the action package
Download the zip file:
GoogleCalendarActionPackage.zip
For instruction of how to install the action package, read PSD1149.
Common Action Parameters
Multiple actions are included in the package, but they all have some parameters in common.
| Parameter | Description | Example |
| Credentials file path | The file path to the json credentials file. No default value. | C:\MySecretFiles\credentials.json |
| Service Account User | The service account user, i.e. the owner of the calendar. Default is the value in global parameter ‘ServiceAccountUser’. | |
| Error Message Attribute | [Optional] The name of the session attribute that will contain the error message, no default value. This attribute will be set if any error occurs for the specific session object. | errorMessage |
| No of Simultaneous Calls | The action can create multiple threads to create multiple calls to Google asynchronously. Enter the number of threads to create. Maximum is 100. Default: 1. | 10 |
Actions for handling Calendars
Google Calendar List Calendars
List calendars in Google Calendar. No action specific parameters to set.
Google Calendar Insert Calendar
Create a calendar in Google Calendar.
| Parameter | Description | Example |
| Attributes to set on calendar object | Comma separated list of the attributes to set on calendar in Google Calendar. Use | to map the session attribute name with the Google Calendar attribute name, e.g. googleAttribute|myAttributeName. See * Supported calendar attributes | |
| Calendar Id Attribute | Attribute for the newly created calendar id. If not set, no status attribute will be created. Defaults to ‘calendarId’. | calendarId |
Google Calendar Delete Calendar
Delete a calendar in Google Calendar.
| Parameter | Description | Example |
| Calendar Name Attribute | Attribute for the calendar name. Defaults to ‘calendarId’. |
Google Calendar Get Calendar
Get a calendar in Google Calendar.
| Parameter | Description | Example |
| Calendar Name Attribute | Attribute for the calendar name. Defaults to ‘calendarId’. |
* Supported calendar attributes
All attributes are of type string.
- summary
- location
- description
- timezone
- kind
Actions for handling Events
Google Calendar List Events
List events in Google Calendar.
| Parameter | Description | Example |
| Calendar name | The Google calendar name. Example: ‘primary’. Default is the value in global parameter ‘CalendarName’. | primary |
| Max results | Max number of events to be fetched. | 50 |
Google Calendar Get Event
Get an event in Google Calendar.
| Parameter | Description | Example |
| Calendar name | The Google calendar name. Example: ‘primary’. Default is the value in global parameter ‘CalendarName’. | primary |
| Event Id Attribute | Attribute for the event id. Defaults to ‘eventId’. |
Google Calendar Insert Event
Create an event in Google Calendar.
| Parameter | Description | Example |
| Calendar name | The Google calendar name. Example: ‘primary’. Default is the value in global parameter ‘CalendarName’. | primary |
| Event Id Attribute | Attribute for the event id. Defaults to ‘eventId’. | |
| Attributes to set on event object | Comma separated list of the attributes to set on events in Google Calendar. Use | to map the session attribute name with the Google Calendar attribute name, e.g. googleAttribute|myAttributeName. See * Supported event attributes | |
| Send Updates | Allowed values: [all, externalonly, none], Supports SESSION() and GLOBAL(). Default is the value in global parameter ‘SendUpdates’. | |
| Supports Attachments | Supports Attachments. Default is the value in global parameter ‘SupportsAttachments’. |
Google Calendar Update Event
Update an event in Google Calendar.
| Parameter | Description | Example |
| Calendar name | The Google calendar name. Example: ‘primary’. Default is the value in global parameter ‘CalendarName’. | primary |
| Event Id Attribute | Attribute for the event id. Defaults to ‘eventId’. | |
| Attributes to set on event object | Comma separated list of the attributes to set on events in Google Calendar. Use | to map the session attribute name with the Google Calendar attribute name, e.g. googleAttribute|myAttributeName. See * Supported event attributes | |
| Send Updates | Allowed values: [all, externalonly, none], Supports SESSION() and GLOBAL(). Default is the value in global parameter ‘SendUpdates’. | |
| Supports Attachments | Supports Attachments. Default is the value in global parameter ‘SupportsAttachments’. |
Google Calendar Delete Event
Delete an event in Google Calendar.
| Parameter | Description | Example |
| Calendar name | The Google calendar name. Example: ‘primary’. Default is the value in global parameter ‘CalendarName’. | primary |
| Event Id Attribute | Attribute for the event id. Defaults to ‘eventId’. |
* Supported event attributes
All attributes are of type string.
- summary
- location
- startdate (Date-time formatted string)
- enddate (Date-time formatted string)
- description
- recurrence (multivalue sessionattribute possible)
- attendees (multivalue sessionattribute possible)
- attendee.responsestatus – possible values [needsAction (default), declined, accepted, tentative]
- guestscanmodify
DISCLAIMER
Information provided in this document is for your information only. PhenixID makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.The origin of this information may be internal or external to PhenixID. PhenixID makes all reasonable efforts to verify this information.
PhenixID - support.phenixid.se