Google Workspace

the google workspace connector facilitates automation of tasks across various google services, enabling efficient workflow management and data processing google workspace, formerly known as g suite, offers a suite of cloud based productivity and collaboration tools this connector enables seamless integration with google workspace services, allowing users to automate tasks across various applications such as gmail, drive, calendar, and chat by leveraging this connector, swimlane turbine users can streamline workflows, enhance data management, and improve response times for security related actions within their google workspace environment google cloud platform and google admin provisioning prerequisites to utilize the google workspace connector within swimlane, ensure you have the following prerequisites google oauth2 authentication with the following parameters client id the unique identifier for your google api client application client secret a secret key associated with the client id to authenticate the application scopes specific permissions that define the level of access to google workspace data authorization url the endpoint for initiating the oauth2 authorization flow token url the endpoint for exchanging the authorization code for an access token refresh token a token used to obtain a new access token when the current one expires gcp project creation log in to gcp console here https //console cloud google com/ navigate to this link to create a new project https //console cloud google com/projectcreate name your project and click create we recommend specific and recognizable project names navigate to your projects, and select your new project enabling individual apis by default, when creating a new project, there are several apis that are enabled default enabled apis are bigquery api bigquery storage api cloud datastore api cloud debugger api cloud logging api cloud monitoring api cloud sql cloud storage cloud storage api cloud trace api google cloud apis google cloud storage json api google chat api google sheets api service management api and so on you will need to navigate to these links and enable the following apis google drive api https //console cloud google com/apis/library/drive googleapis com enabling google drive api example pictured below this will bring up the individual api dashboard when successfully enabled continue through the links provided below until all are enabled if the links become deprecated, make sure you use the explicit names provided gmail api https //console cloud google com/apis/library/gmail googleapis com google workspace alert center api https //console cloud google com/apis/library/alertcenter googleapis com g suite vault api https //console cloud google com/apis/library/vault googleapis com admin sdk api https //console cloud google com/apis/library/admin googleapis com google chat api https //console cloud google com/apis/library/chat googleapis com google sheets api https //console cloud google com/apis/library/sheets googleapis com after this, navigate back to the apis and services dashboard and verify that all apis are listed, either by using the filter or looking at the list if any apis are missing, go back and enable them configuring a service account google workspace connector requires a google service account to authenticate open https //console developers google com/iam admin/serviceaccounts select the appropriate project click + create new service account assign a name for the service account and add a description, click create and continue click the select a role dropdown and type “owner” in the filter choose owner and click continue for the menu specifying grant users access to this service account (optional) you may select users or skip and click done this is not required for the connector click on the newly created service account email navigate to the keys menu click add key , select create new key , select json format, and click create make sure you download the json file presented this file will be needed when configuring the asset in swimlane navigate to the details menu at the top of the screen copy down the unique id to be used in the setting api scopes step below oauth 2 0 to configure oauth 2 0 for the swimlane google workspace connector, follow these steps navigate to the https //console cloud google com/ select your project from the top menu in the left sidebar, select "apis & services" > "credentials " click the "+ create credentials" button and select "oauth 2 0 client id " under "application type," select "web application " enter a name for the oauth 2 0 client click "create " a dialog with your client id and client secret will appear click "ok" to close the dialog next to the oauth 2 0 client you just created, click on the pencil icon to edit the client under "scopes for google apis," add the necessary scopes that are required for your connector (as specified in the "setting api scopes" section of this readme) click "save " your oauth 2 0 client is now configured and ready to be used with the swimlane google workspace connector once this is configured, you need to retrieve a refresh token the refresh token, client id, and client secret are needed for configuring the asset to retrieve the refresh token, please reach out to swimlane support for the requirements txt and get refresh token py files you will also need python3 installed on your local system given those, run the following commands python3 m pip install r requiremments txt python3 get refresh token py the script will prompt for a client id and client secret prompt for additional scopes by default the requested scopes are gmail send and gmail modify, which are required for sending/reading gmail emails if no other scopes are needed, respond "no" direct the user to gmail authentication and approval in a browser redirect the user to a blank page at https //localhost copy the full url for the https //localhost address and provide it to the script, at which point it will provide the user with the refresh token delegating domain wide authority (recommended) in order to support accessing multiple user's accounts, domain wide authority must be enabled before creating a service account choosing not to delegate domain wide authority will heavily limit the scope of what this connector can do if the connector will only operate against a single account, the next section (setting api scopes) can be skipped setting api scopes after creating a service account, the necessary api scopes required to be authorized must be set from https //admin google com/ , navigate to security > api controls and then click manage domain wide delegation at the bottom of the window click add new in the client id field, enter the unique id from the service account details menu enter the following csv value into the oauth scopes (comma delimited) input https //mail google com/,https //www googleapis com/auth/admin directory device mobile,https //www googleapis com/auth/admin directory device mobile action,https //www googleapis com/auth/admin directory group,https //www googleapis com/auth/admin directory group member,https //www googleapis com/auth/admin directory orgunit,https //www googleapis com/auth/admin directory user,https //www googleapis com/auth/admin directory user security,https //www googleapis com/auth/admin directory user alias,https //www googleapis com/auth/admin directory userschema,https //www googleapis com/auth/apps alerts,https //www googleapis com/auth/devstorage read only,https //www googleapis com/auth/drive,https //www googleapis com/auth/ediscovery,https //www googleapis com/auth/chat bot,https //www googleapis com/auth/spreadsheets click authorize swimlane asset setup prerequisites admin swimlane account and file downloaded from apphub json file downloaded when service account key was created asset configuration credentials the contents of the json credentials key file downloaded when creating a service account must be base64 encoded when creating the swimlane google workspace asset for linux and mac $ cat \<path to credentials json> | base64 for windows using powershell \[convert] tobase64string((get content path "your file path" encoding byte)) now copy the base64 encoded string and paste it into the service account json field delegate account the delegate account value is used to determine which account to operate as when running actions this value should be the email address for the target account (the mailbox you are trying to read/write) some actions provide an optional input to override the asset value in most if not all cases an admin account of the google workspace should be used it should not be the service account email customer id the unique id for the customer's google workspace account as an account administrator, you can also use the my customer alias to represent your account's customerid the customerid is also returned as part of the users resource in order to get this value, navigate to https //admin google com then go to account account settings , and you will find it listed limitations when not using a delegated account while service accounts can perform many of the same actions as regular user accounts, they have some limitations when it comes to interacting with user data in particular, a service account with its own gmail setup may not be able to interact with user data in the same way a regular user would for example, it might not be able to access a user's emails, contacts, or google drive files services drive https //drive google com/ required apis google drive api google drive connector allow swimlane to query against existing files, get file metadata, get file contents, get file by id, and delete files querying querying allows you to query against file metadata the following url has common examples of query values that can be used in this connector https //developers google com/drive/api/v3/reference/query ref note file id can be found in the file url through the browser, or in the metadata returned from the 'drive retrieve files' action note you can find the folder id in the folder url through the browser, or you can see it returned as an output from the create a folder action note the file upload action receives an optional media type input, official media types can be found https //www iana org/assignments/media types/media types xhtml note to create drive folders use the file upload action and set the mimetype input to application/vnd google apps folder gmail available https //developers google com/gmail/api/auth/scopes the gmail api must be enabled https //console developers google com/apis/library/gmail googleapis com , and the full scope is expected for swimlane connectors to function scope = https //mail google com/ attached eml files if you will be attaching eml files to emails, the eml file must be zipped first enable the "unzip attachments" feature in get emails configuration inputs to extract the eml file from the zip file for swimlane sending inline images to send inline images using the swimlane google workspace connector, you need to follow these steps ensure the image you want to send is part of the attachments you are including in your email in the body of your email, reference the image using the content id (cid), which should be the same as the image's filename for example, if your image's filename is "image1 png", reference it in your email body like this for html email \<img src="cid\ image1 png" alt="my inline image"> for plain text email \[image image1 png] note that the name of the image file in the attachments and the name used in the content id (cid) must match exactly, including the file extension capabilities add row or data to google sheets alertcenter batch delete alerts alertcenter batch undelete alerts alertcenter delete alert alertcenter list alerts alertcenter undelete alert alertcenter alerts get calendar create event calendar delete event calendar get event calendar list events chat create a message chat list spaces deprovision or disable a chrome device drive delete file and so on alert center note to use google workspace alert center, you must have the api scope https //www googleapis com/auth/apps alerts see the csv of all expected scopes below for details you can find the prerequisites for using alert center https //developers google com/admin sdk/alertcenter/guides/prerequisites for alert details and to see the different alert types click https //support google com/a/answer/9104585 query filters and state query filters for information on using the query filter, see https //developers google com/admin sdk/alertcenter/guides/query filters vault https //ediscovery google com/ note using "organization path" input for most vault actions will work for all but root ou as "/full/path/to/unit" root ou must be specified in "id 03tw28tw32rivbq " format custom schemas you can use schemas to add custom fields to user profiles you can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs users the directory api allows you to create and manage your account's users and user aliases groups google groups provide your users the ability to send messages to groups of people using the group's email address memberships a google groups member can be a user or another group this member can be inside or outside of your account's domains mobile devices google workspace mobile management includes android, google sync, and ios devices required apis google workspace vault api admin sdk google cloud storage json api matters create, pull, and close matters holds create mail holds exports create new exports general notes chat the google chat api enables you to both create messages and list spaces within the google chat space notes https //developers google com/workspace/chat/api/reference/rest/v1/spaces messages/create https //developers google com/workspace/chat/api/reference/rest/v1/spaces/list https //developers google com/admin sdk/directory/reference/rest/v1/chromeosdevices/get https //developers google com/resources/api libraries/documentation/admin/directory v1/python/latest/admin directory v1 chromeosdevices html#action https //googleapis github io/google api python client/docs/dyn/admin directory v1 customer devices chromeos html#batchchangestatus sheets the google sheet api allows you to add a row or add data to a google sheets notes https //developers google com/sheets/api/reference/rest/v4/spreadsheets/batchupdate here is a csv list of all expected scopes that will enable everything for alert center, custom users schemas, devices, drive, gmail, google, groups, memberships, mobile, vault, google chat and google sheets https //mail google com/,https //www googleapis com/auth/admin directory device mobile,https //www googleapis com/auth/admin directory device mobile action,https //www googleapis com/auth/admin directory group,https //www googleapis com/auth/admin directory group member,https //www googleapis com/auth/admin directory orgunit,https //www googleapis com/auth/admin directory user,https //www googleapis com/auth/admin directory user security,https //www googleapis com/auth/admin directory user alias,https //www googleapis com/auth/admin directory userschema,https //www googleapis com/auth/apps alerts,https //www googleapis com/auth/devstorage read only,https //www googleapis com/auth/drive,https //www googleapis com/auth/ediscovery,https //www googleapis com/auth/chat bot,https //www googleapis com/auth/spreadsheets notes while adding an asset, you must provide either credentials or a client id and client secret if both are provided, the client id takes precedence configurations google authentication authenticates using google credentials configuration parameters parameter description type required credentials base64 encoded contents from service account json credentials file see readme for setup instructions string optional delegate account account to execute integrations under if not specified, the integration will run as a service account using a service account will introduce limitations see readme string optional client id the client id for the oauth 2 0 application string optional client secret the client secret for the oauth 2 0 application string optional refresh token oauth 2 0 refresh token used to obtain new access tokens if using a refresh token, you must also provide a client id and secret string optional actions add row or data to google sheets appends or updates data in a specified google sheets spreadsheet using the provided spreadsheetid and body input argument name type required description spreadsheetid string required the spreadsheet to apply the updates to body object required request body data body requests array optional a list of updates to apply to the spreadsheet requests will be applied in the order they are specified if any request is not valid, no requests will be applied body requests insertdimension object optional inserts new rows or columns in a sheet body requests insertdimension range object optional the dimensions to insert both the start and end indexes must be bounded body requests insertdimension range sheetid number optional the sheet this span is on body requests insertdimension range dimension string optional the dimension of the span body requests insertdimension range startindex number optional the start (inclusive) of the span, or not set if unbounded body requests insertdimension range endindex number optional the end (exclusive) of the span, or not set if unbounded body requests insertdimension inheritfrombefore boolean optional whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions true to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after body requests pastedata object optional pastes data (html or delimited) into a sheet body requests pastedata coordinate object optional the coordinate at which the data should start being inserted body requests pastedata coordinate sheetid number optional the sheet this coordinate is on body requests pastedata coordinate rowindex number optional the row index of the coordinate body requests pastedata coordinate columnindex number optional the column index of the coordinate body requests pastedata data string optional the data to insert body requests pastedata type string optional how the data should be pasted body requests pastedata delimiter string optional the delimiter in the data body requests pastedata html boolean optional true if the data is html body requests insertrange object optional inserts new cells in a sheet, shifting the existing cells body requests insertrange range object optional the range to insert new cells into body requests insertrange range sheetid number optional the sheet this range is on body requests insertrange range startrowindex number optional the start row (inclusive) of the range, or not set if unbounded body requests insertrange range endrowindex number optional the end row (exclusive) of the range, or not set if unbounded body requests insertrange range startcolumnindex number optional the start column (inclusive) of the range, or not set if unbounded input example {"body" {"requests" \[{"insertdimension" {"range" {"sheetid" 1234567890,"dimension" "rows","startindex" 0,"endindex" 1},"inheritfrombefore"\ true}},{"pastedata" {"coordinate" {"sheetid" 1234567890,"rowindex" 0,"columnindex" 1},"data" "string","type" "paste normal","delimiter" "string","html"\ true}},{"insertrange" {"range" {"sheetid" 1234567890,"startrowindex" 0,"endrowindex" 1,"startcolumnindex" 1,"endcolumnindex" 2},"shiftdimension" "rows"}}],"includespreadsheetinresponse"\ true,"responseranges" \["string"],"responseincludegriddata"\ true}} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response spreadsheetid string unique identifier response replies array output field response replies response updatedspreadsheet object output field response updatedspreadsheet output example {"status code" 200,"response headers" {},"reason" "ok","response" {"spreadsheetid" "string","replies" \[{}],"updatedspreadsheet" {}}} alertcenter batch delete alerts deletes multiple alerts simultaneously in google workspace's alert center using the specified body parameter input argument name type required description body object required request body data body alertid array required request body data body customerid string optional request body data x xgafv string optional parameter for alertcenter batch delete alerts input example {"body" {"alertid" \["e44b7458 e1af 4d13 beb5 bcc5d2ce3fb4"],"customerid" "02xtqyl8"},"x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response output example {} alertcenter batch undelete alerts restores multiple deleted alerts in google workspace alert center using a specified 'body' input with alert details input argument name type required description body object required request body data body alertid array required request body data body customerid string optional request body data x xgafv string optional parameter for alertcenter batch undelete alerts input example {"body" {"alertid" \["e44b7458 e1af 4d13 beb5 bcc5d2ce3fb4"],"customerid" "02xtqyl8"},"x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response output example {} alertcenter delete alert marks a specified alert for deletion in google workspace using the provided alertid input argument name type required description customerid string optional unique identifier alertid string required unique identifier x xgafv string optional parameter for alertcenter delete alert input example {"customerid" "02xtqyl8","alertid" "e44b7458 e1af 4d13 beb5 bcc5d2ce3fb4","x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response output example {} alertcenter alerts get retrieves detailed information for a specified alert from the google workspace alert center input argument name type required description alertid string optional the identifier of the alert to retrieve customerid string optional the unique identifier of the google workspace account of the customer the alert is associated with x xgafv string optional parameter for alertcenter alerts get input example {"alertid" "e44b7458 e1af 4d13 beb5 bcc5d2ce3fb4","customerid" "02xtqyl8","x xgafv" "1"} output parameter type description alertid string unique identifier createtime string time value customerid string unique identifier data object response data data a key string response data deleted boolean output field deleted endtime string time value etag string output field etag metadata object response data metadata assignee string response data metadata customerid string response data metadata etag string response data metadata severity string response data metadata status string response data metadata updatetime string response data securityinvestigationtoollink string output field securityinvestigationtoollink source string output field source starttime string time value type string type of the resource updatetime string time value output example {"alertid" "string","createtime" "string","customerid" "a string","data" {"a key" ""},"deleted"\ true,"endtime" "a string","etag" "string","metadata" {"assignee" "a string","customerid" "a string","etag" "a string","severity" "low","status" "closed","updatetime" "a string"},"securityinvestigationtoollink" "a string","source" "a string","starttime" "a string","type" "a string","updatetime" "a string"} alertcenter list alerts retrieve a list of security alerts from google workspace alert center to identify potential security issues input argument name type required description customerid string optional unique identifier filter string optional parameter for alertcenter list alerts orderby string optional parameter for alertcenter list alerts pagesize number optional parameter for alertcenter list alerts pagetoken string optional parameter for alertcenter list alerts x xgafv string optional parameter for alertcenter list alerts input example {"customerid" "c02xtqyl8","pagesize" 100,"x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response alerts array output field response alerts response alerts customerid string unique identifier response alerts alertid string unique identifier response alerts createtime string time value response alerts starttime string time value response alerts endtime string time value response alerts type string type of the resource response alerts source string output field response alerts source response alerts data object response data response alerts data \@type string response data response alerts data email string response data response alerts data logindetails object response data response alerts data logindetails ipaddress string response data response alerts securityinvestigationtoollink string output field response alerts securityinvestigationtoollink response alerts metadata object response data response alerts metadata customerid string response data response alerts metadata alertid string response data response alerts metadata status string response data response alerts metadata updatetime string response data response alerts metadata severity string response data response alerts metadata etag string response data response alerts updatetime string time value output example {"response" {"alerts" \[{}]}} alertcenter undelete alert restores a deleted google workspace alert within 30 days using the specified 'alertid' input argument name type required description alertid string required unique identifier body object optional request body data body customerid string optional request body data x xgafv string optional parameter for alertcenter undelete alert input example {"alertid" "e44b7458 e1af 4d13 beb5 bcc5d2ce3fb4","body" {"customerid" "02xtqyl8"},"x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response customerid string unique identifier response alertid string unique identifier response createtime string time value response starttime string time value response endtime string time value response type string type of the resource response source string output field response source response data object response data response data \@type string response data response data email string response data response data logindetails object response data response data logindetails ipaddress string response data response metadata object response data response metadata customerid string response data response metadata alertid string response data response metadata status string response data response metadata updatetime string response data response metadata severity string response data response metadata etag string response data response updatetime string time value response etag string output field response etag output example {"response" {"customerid" "string","alertid" "string","createtime" "string","starttime" "string","endtime" "string","type" "string","source" "string","data" {"@type" "string","email" "user\@example com","logindetails" {}},"metadata" {"customerid" "string","alertid" "string","status" "active","updatetime" "string","severity" "string","etag" "string"},"updatetime" "string","etag" "string"}} calendar create event creates a new event in the user's google calendar with the provided details endpoint method post input argument name type required description event object optional parameter for calendar create event event summary string optional parameter for calendar create event event location string optional parameter for calendar create event event description string optional parameter for calendar create event event start object optional parameter for calendar create event event start datetime string optional time value event start timezone string optional parameter for calendar create event event end object optional parameter for calendar create event event end datetime string optional time value event end timezone string optional parameter for calendar create event event reminders object optional parameter for calendar create event event reminders usedefault boolean optional parameter for calendar create event event reminders overrides array optional unique identifier event reminders overrides method string optional http method to use event reminders overrides minutes number optional unique identifier override event object optional if you want to override the event object, you can do so here this will override the event object in the inputs input example {"event" {"summary" "test event","location" "800 howard st , san francisco, ca 94103","description" "a test event ","start" {"datetime" "2023 06 28t09 00 00 07 00","timezone" "america/los angeles"},"end" {"datetime" "2023 06 28t17 00 00 07 00","timezone" "america/los angeles"},"reminders" {"usedefault"\ false,"overrides" \[{"method" "email","minutes" 1440},{"method" "popup","minutes" 10}]}},"override event" {}} output parameter type description response object output field response response kind string output field response kind response etag string output field response etag response id string unique identifier response status string status value response htmllink string output field response htmllink response created string output field response created response updated string output field response updated response summary string output field response summary response description string output field response description response location string output field response location response creator object output field response creator response creator email string output field response creator email response creator self boolean output field response creator self response organizer object output field response organizer response organizer email string output field response organizer email response organizer self boolean output field response organizer self response start object output field response start response start datetime string time value response start timezone string output field response start timezone response end object output field response end response end datetime string time value response end timezone string output field response end timezone response icaluid string unique identifier response sequence number output field response sequence output example {"response" {"kind" "string","etag" "string","id" "12345678 1234 1234 1234 123456789abc","status" "active","htmllink" "string","created" "2024 01 01t00 00 00z","updated" "2024 01 01t00 00 00z","summary" "string","description" "string","location" "string","creator" {"email" "user\@example com","self"\ true},"organizer" {"email" "user\@example com","self"\ true},"start" {"datetime" "string","timezone" "string"},"end" {"datetime" "string","timezone" "string"},"icaluid" "string"}} calendar delete event removes an event from the google workspace calendar by utilizing the specified calendarid and eventid endpoint method post input argument name type required description calendarid string required unique identifier eventid string required unique identifier input example {"calendarid" "primary","eventid" "b0f8bhf6t51aldhs6d1f5fhsis"} output parameter type description response object output field response response success string whether the operation was successful output example {"response" {"success" "true"}} calendar get event retrieve a specific event from google workspace calendar by specifying calendarid and eventid endpoint method get input argument name type required description calendarid string required unique identifier eventid string required unique identifier input example {"calendarid" "primary","eventid" "b0f8bhf6t51aldhs6d1f5fhsis"} output parameter type description response object output field response response kind string output field response kind response etag string output field response etag response id string unique identifier response status string status value response htmllink string output field response htmllink response created string output field response created response updated string output field response updated response summary string output field response summary response description string output field response description response location string output field response location response creator object output field response creator response creator email string output field response creator email response creator self boolean output field response creator self response organizer object output field response organizer response organizer email string output field response organizer email response organizer self boolean output field response organizer self response start object output field response start response start datetime string time value response start timezone string output field response start timezone response end object output field response end response end datetime string time value response end timezone string output field response end timezone response icaluid string unique identifier response sequence number output field response sequence output example {"response" {"kind" "string","etag" "string","id" "12345678 1234 1234 1234 123456789abc","status" "active","htmllink" "string","created" "2024 01 01t00 00 00z","updated" "2024 01 01t00 00 00z","summary" "string","description" "string","location" "string","creator" {"email" "user\@example com","self"\ true},"organizer" {"email" "user\@example com","self"\ true},"start" {"datetime" "string","timezone" "string"},"end" {"datetime" "string","timezone" "string"},"icaluid" "string"}} calendar list events retrieves a list of events from the specified google workspace calendar using the provided calendarid endpoint method get input argument name type required description calendarid string required the id of the calendar to list events from "primary" is the default calendar timemin string optional parameter for calendar list events timemax string optional parameter for calendar list events maxresults number optional result of the operation singleevents boolean optional parameter for calendar list events orderby string optional parameter for calendar list events q string optional parameter for calendar list events showdeleted boolean optional parameter for calendar list events showhiddeninvitations boolean optional unique identifier timezone string optional parameter for calendar list events updatedmin string optional parameter for calendar list events input example {"calendarid" "primary","timemin" "2023 06 05t00 00 00z","timemax" "2023 06 06t00 00 00z","maxresults" 10,"singleevents"\ true,"orderby" "starttime","q" "meeting","showdeleted"\ false,"showhiddeninvitations"\ true,"timezone" "america/los angeles","updatedmin" "2023 06 01t00 00 00z"} output parameter type description response object output field response response kind string output field response kind response etag string output field response etag response summary string output field response summary response updated string output field response updated response timezone string output field response timezone response accessrole string output field response accessrole response defaultreminders array output field response defaultreminders response defaultreminders method string http method to use response defaultreminders minutes number output field response defaultreminders minutes response items array output field response items response items kind string output field response items kind response items etag string output field response items etag response items id string unique identifier response items status string status value response items htmllink string output field response items htmllink response items created string output field response items created response items updated string output field response items updated response items summary string output field response items summary response items description string output field response items description response items location string output field response items location response items creator object output field response items creator response items creator email string output field response items creator email response items creator self boolean output field response items creator self response items organizer object output field response items organizer output example {"response" {"kind" "string","etag" "string","summary" "string","updated" "2024 01 01t00 00 00z","timezone" "string","accessrole" "string","defaultreminders" \[{}],"items" \[{}]}} chat create a message creates a google chat message within a specified space, requiring 'parent' and 'body' parameters for execution input argument name type required description parent string required the resource name of the space in which to create a message format spaces/{space} requestid string optional a unique request id for this message specifying an existing request id returns the message created with that id instead of creating a new message messagereplyoption string optional specifies whether a message starts a thread or replies to one only supported in named spaces messageid string optional a custom id for a message lets chat apps get, update, or delete a message without needing to store the system assigned id in the message's resource name (represented in the message name field) body object required request body data body text string optional plain text body of the message the first link to an image, video, or web page generates a preview chip body cardsv2 array optional request body data body cardsv2 cardid string optional required if the message contains multiple cards a unique identifier for a card in a message a card in a google chat message only chat apps can create cards body cardsv2 card object optional request body data body cardsv2 card header object optional the header of the card a header usually contains a leading image and a title headers always appear at the top of a card body cardsv2 card header title string optional the title of the card header the header has a fixed height if both a title and subtitle are specified, each takes up one line if only the title is specified, it takes up both lines body cardsv2 card header subtitle string optional the subtitle of the card header if specified, appears on its own line below the title body cardsv2 card header imageurl string optional the https url of the image in the card header body cardsv2 card header imagetype string optional the shape used to crop the image body cardsv2 card header imagealttext string optional the alternative text of this image that's used for accessibility body cardsv2 card sections array optional a section contains a collection of widgets that are rendered vertically in the order that they're specified body cardsv2 card sections header string optional text that appears at the top of a section supports simple html formatted text body cardsv2 card sections collapsible boolean optional indicates whether this section is collapsible body cardsv2 card sections uncollapsiblewidgetscount number optional the number of uncollapsible widgets which remain visible even when a section is collapsed body cardsv2 card sections widgets array optional all the widgets in the section must contain at least one widget body cardsv2 card sectiondividerstyle string optional the divider style between sections body cardsv2 card cardactions array optional the card's actions actions are added to the card's toolbar menu body cardsv2 card cardactions actionlabel string optional the label that displays as the action menu item body cardsv2 card cardactions onclick object optional the onclick action for this action item body cardsv2 card name string optional name of the card used as a card identifier in card navigation input example {"messagereplyoption" "message reply option unspecified"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response output example {"status code" 200,"response headers" {},"reason" "ok","response" {}} chat list spaces retrieves a list of spaces the user is part of within google workspace, excluding group chats and empty direct messages input argument name type required description pagesize number optional the maximum number of spaces to return the service might return fewer than this value if unspecified, at most 100 spaces are returned the maximum value is 1000 pagetoken string optional a page token, received from a previous list spaces call provide this parameter to retrieve the subsequent page filter string optional a query filter you can filter spaces by the space type to filter by space type, you must specify valid enum value, such as space, space type unspecified, space, group chat, direct message input example {"pagesize" 1000,"filter" "spacetype = 'space' or spacetype = 'group chat'"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response spaces array output field response spaces response spaces name string name of the resource response spaces type string type of the resource response spaces spacetype string type of the resource response spaces singleuserbotdm boolean output field response spaces singleuserbotdm response spaces threaded boolean output field response spaces threaded response spaces displayname string name of the resource response spaces externaluserallowed boolean output field response spaces externaluserallowed response spaces spacethreadingstate string output field response spaces spacethreadingstate response spaces spacedetails object output field response spaces spacedetails response spaces spacedetails description string output field response spaces spacedetails description response spaces spacedetails guidelines string unique identifier response spaces spacehistorystate string output field response spaces spacehistorystate response spaces importmode boolean output field response spaces importmode response spaces createtime string time value response spaces admininstalled boolean output field response spaces admininstalled response spaces accesssettings object output field response spaces accesssettings response spaces accesssettings accessstate string output field response spaces accesssettings accessstate response spaces accesssettings audience string output field response spaces accesssettings audience response spaces spaceuri string output field response spaces spaceuri response nextpagetoken string output field response nextpagetoken output example {"status code" 200,"response headers"\ null,"reason" "ok","response" {"spaces" \[{}],"nextpagetoken" "string"}} deprovision or disable a chrome device deprovision or disable a specific chrome device within google workspace using the provided customerid endpoint method post input argument name type required description customerid string required the unique id for the customer's google workspace account body object optional request body data body deviceids array required list of the ids of the chromeos devices to change maximum 50 body changechromeosdevicestatusaction string required the action to take on the chromeos device in order to change its status body deprovisionreason string optional the reason for deprovisioning the device input example {"customerid" "c01bv75zr","body" {"deviceids" \["device id1"],"changechromeosdevicestatusaction" "change chrome os device status action unspecified","deprovisionreason" "deprovision reason unspecified"}} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response changechromeosdevicestatusresults array status value response changechromeosdevicestatusresults deviceid string unique identifier response changechromeosdevicestatusresults response object status value response changechromeosdevicestatusresults response code number status value response changechromeosdevicestatusresults response message string status value response changechromeosdevicestatusresults response details array status value response changechromeosdevicestatusresults response details \@type string type of the resource output example {"status code" 200,"response headers" {},"reason" "ok","response" {"changechromeosdevicestatusresults" \[{}]}} drive delete file permanently deletes a file from google workspace drive using the provided unique file id input argument name type required description id string required unique identifier input example {"id" "1 3r9tzkeyyr5biibhhih1wzkdetonbgp"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response success boolean whether the operation was successful output example {"response" {"success"\ true}} drive list files retrieve a list of files from google workspace drive, enabling organized access to documents stored in the cloud input argument name type required description q string optional parameter for drive list files input example {"q" "\\"root\\" in parents and trashed=false"} output parameter type description status code number http status code of the response reason string response reason phrase response array output field response response kind string output field response kind response userpermission object output field response userpermission response userpermission id string unique identifier response userpermission type string type of the resource response userpermission role string output field response userpermission role response userpermission kind string output field response userpermission kind response userpermission selflink string output field response userpermission selflink response userpermission etag string output field response userpermission etag response userpermission pendingowner boolean output field response userpermission pendingowner response fileextension string output field response fileextension response md5checksum string output field response md5checksum response selflink string output field response selflink response ownernames array name of the resource response lastmodifyingusername string name of the resource response editable boolean output field response editable response writerscanshare boolean output field response writerscanshare response downloadurl string url endpoint for the request response mimetype string type of the resource response parents array output field response parents response parents selflink string output field response parents selflink response parents id string unique identifier response parents isroot boolean output field response parents isroot output example {"response" \[]} drive file upload upload files to google drive for cloud storage, easy sharing, and collaboration enhancement input argument name type required description attachments array optional file to be uploaded attachments file string optional parameter for drive file upload attachments file name string optional name of the resource attachments description string optional parameter for drive file upload title string optional parameter for drive file upload mimetype string optional type of the resource parents array optional parameter for drive file upload parents id string optional unique identifier input example {"title" "7dbc0541 a8de 42a9 b7fa e264c05f981e txt","mimetype" "text/plain","parents" \[{"id" "drive folder id"}]} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response title string output field response title response mime type string type of the resource response mimetype string type of the resource response kind string output field response kind response id string unique identifier response etag string output field response etag response selflink string output field response selflink response webcontentlink string response content response alternatelink string output field response alternatelink response embedlink string output field response embedlink response iconlink string output field response iconlink response thumbnaillink string output field response thumbnaillink response labels object output field response labels response labels starred boolean output field response labels starred response labels hidden boolean unique identifier response labels trashed boolean output field response labels trashed response labels restricted boolean output field response labels restricted response labels viewed boolean output field response labels viewed response copyrequireswriterpermission boolean output field response copyrequireswriterpermission response createddate string date value response modifieddate string date value response modifiedbymedate string date value output example {"response" {"title" "string","mime type" "string","mimetype" "string","kind" "string","id" "12345678 1234 1234 1234 123456789abc","etag" "string","selflink" "string","webcontentlink" "string","alternatelink" "string","embedlink" "string","iconlink" "string","thumbnaillink" "string","labels" {"starred"\ true,"hidden"\ true,"trashed"\ true,"restricted"\ true,"viewed"\ true},"copyrequireswriterpermission"\ true,"createddate" "string"}} gmail get email attachment retrieves a specified email attachment from google workspace using the unique 'id' and 'messageid' input argument name type required description userid string optional unique identifier messageid string required unique identifier id string required unique identifier attachment name string optional name of the resource unzip boolean optional parameter for gmail get email attachment format string optional parameter for gmail get email attachment metadataheaders string optional response data input example {"userid" "me","messageid" "1847c9d89529d0cb","id" "1847c9d89529d0cb","attachment name" "1847c9d89529d0cb","unzip"\ true,"format" "raw","metadataheaders" "metadataheaders"} output parameter type description status code number http status code of the response reason string response reason phrase file array output field file output example {"file" {"file" "string","filename" "example name"}} gmail delete email permanently deletes an email in google workspace's gmail using the specified message id input argument name type required description userid string optional unique identifier id string required unique identifier input example {"userid" "me","id" "1847c9d89529d0cb"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response output example {} gmail get email by id retrieves a specific email from google workspace's gmail using the provided unique identifier input argument name type required description userid string optional unique identifier id string required unique identifier format string optional parameter for gmail get email by id raw extension string optional parameter for gmail get email by id metadataheaders string optional response data input example {"userid" "me","id" "1847c9d89529d0cb","metadataheaders" "metadataheaders"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response id string unique identifier response threadid string unique identifier response labelids array unique identifier response snippet string output field response snippet response payload object output field response payload response payload partid string unique identifier response payload mimetype string type of the resource response payload filename string name of the resource response payload headers array http headers for the request response payload headers name string http headers for the request response payload headers value string http headers for the request response payload body object request body data response payload body size number request body data response payload parts array output field response payload parts response payload parts partid string unique identifier response payload parts mimetype string type of the resource response payload parts filename string name of the resource response payload parts headers array http headers for the request response payload parts headers name string http headers for the request response payload parts headers value string http headers for the request response payload parts body object request body data response payload parts body attachmentid string request body data output example {"response" {"id" "12345678 1234 1234 1234 123456789abc","threadid" "string","labelids" \["string"],"snippet" "string","payload" {"partid" "string","mimetype" "string","filename" "example name","headers" \[],"body" {},"parts" \[]},"sizeestimate" 123,"historyid" "string","internaldate" "string"}} gmail list emails retrieve a list of email messages from the user's gmail account through google workspace integration input argument name type required description userid string optional unique identifier includespamtrash boolean optional parameter for gmail list emails labelids string optional unique identifier maxresults number optional result of the operation pagetoken string optional parameter for gmail list emails q string optional the search query ie from \ someuser @example com rfc822msgid is \ unread input example {"userid" "me","includespamtrash"\ false,"labelids" "chat","maxresults" 100,"pagetoken" "page token","q" "from\ someuser\@example com rfc822msgid is\ unread"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response messages array response message response messages id string unique identifier response messages threadid string unique identifier response nextpagetoken string output field response nextpagetoken response resultsizeestimate number result of the operation output example {"response" {"messages" \[{}],"nextpagetoken" "string","resultsizeestimate" 123}} gmail send email enables sending an email via google workspace with customizable fields like to, cc, and bcc input argument name type required description to array optional parameter for gmail send email cc array optional parameter for gmail send email bcc array optional parameter for gmail send email from string optional parameter for gmail send email sender name string optional name to use as the sender alias email string optional email address to use as an alias for the sender alias name string optional name to use as an alias for the sender subject string optional parameter for gmail send email message text string optional response message reply to string optional parameter for gmail send email is html boolean optional parameter for gmail send email in reply to string optional parameter for gmail send email references array optional parameter for gmail send email override headers string optional http headers for the request additional headers string optional additonal headers in json string format attachments array optional email attachment attachments file string optional parameter for gmail send email attachments file name string optional name of the resource attachments description string optional parameter for gmail send email input example {"to" \["demo\@swimlane co","agustin firpo\@swimlane com"],"cc" \["agustin firpo\@swimlane com"],"bcc" \["agustin firpo\@swimlane com"],"from" "me","sender name" "demo sender","alias email" "demo\@swimlane co","alias name" "demo alias","subject" "hello","message text" "\<h1>hello\</h1>\<p>this is a test email \</p>\<img src='cid\ image1 png'>","reply to" "demo\@swimlane co","is html"\ true,"in reply to" "1234","references" \["1234","5678"],"override headers" "{'x my header' 'value'}","additional headers" "{\\"x my header\\" \\"value\\"}"} output parameter type description id string unique identifier threatid string unique identifier labelids array unique identifier output example {"id" "18956e9b68fddc0","threatid" "18956e9b68fddc0","labelids" \["unread","sent","inbox"]} gmail list labels retrieve all labels from a specified gmail account to facilitate structured email organization and management input argument name type required description userid string optional unique identifier input example {"userid" "me"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response labels array output field response labels response labels id string unique identifier response labels name string name of the resource response labels messagelistvisibility string response message response labels labellistvisibility string output field response labels labellistvisibility response labels type string type of the resource output example {"response" {"labels" \[{}]}} gmail modify labels modifies labels on a specified gmail message, requiring the message 'id' and label details in the 'body' input argument name type required description userid string optional unique identifier id string required unique identifier body string required request body data input example {"userid" "me","id" "1841b77d6c070889","body" "{\\"removelabelids\\" \[\\"unread\\"]}"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response id string unique identifier response threadid string unique identifier response labelids array unique identifier response snippet string output field response snippet response sizeestimate number output field response sizeestimate response historyid string unique identifier response internaldate string date value output example {"response" {"id" "12345678 1234 1234 1234 123456789abc","threadid" "string","labelids" \["string"],"snippet" "string","sizeestimate" 123,"historyid" "string","internaldate" "string"}} gmail set read status mark an email as read or unread in google workspace, aiding efficient inbox management endpoint method get input argument name type required description userid string optional unique identifier read status string optional status value id string optional unique identifier input example {"userid" "me","read status" "unread","id" "186dbcc763da26a5"} output parameter type description id string unique identifier threadid string unique identifier labelids array unique identifier snippet string output field snippet sizeestimate number output field sizeestimate historyid string unique identifier internaldate string date value output example {"id" "186dbcc763da26a5","threadid" "186dbcc763da26a5","labelids" \["unread","category personal","inbox"],"snippet" "please find attached a zipped eml attachment which is suspicious if you would li ","sizeestimate" 15887,"historyid" "112521","internaldate" "1678724843000"} gmail get email by id retrieves a specific gmail thread from google workspace using the provided unique identifier input argument name type required description userid string optional unique identifier id string required unique identifier input example {"userid" "me"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response historyid string unique identifier response id string unique identifier response messages array response message response messages historyid string unique identifier response messages id string unique identifier response messages internaldate string response message response messages labelids array unique identifier response messages payload object response message response messages payload body object request body data response messages payload body attachmentid string request body data response messages payload body data string response data response messages payload body size number request body data response messages payload filename string name of the resource response messages payload headers array http headers for the request response messages payload headers name string http headers for the request response messages payload headers value string http headers for the request response messages payload mimetype string type of the resource response messages payload partid string unique identifier response messages payload parts array response message response messages payload parts file name string name of the resource response messages payload parts file string response message response messages raw string response message output example {"response" {"historyid" "string","id" "12345678 1234 1234 1234 123456789abc","messages" \[{}],"snippet" "string"}} mobile devices action executes a specified action on a google workspace mobile device using provided customer and resource ids input argument name type required description customerid string required unique identifier resourceid string required unique identifier body object required request body data body action string required request body data x xgafv string optional parameter for mobile devices action input example {"customerid" "c02xtqyl8","resourceid" "afiqxq cj6tblmkhvoyxy5vg8gyf eugglxcrhok8djrgfnargpa2zzscyb0mgaomq iqolberx7rdef8xznp71 omnq4zi wyr73xxpbcindkfsg6l5ysdu5 hjlauxutbfqy4bqwwxgodrgdux c v2pxb0y4nwasmpzss vesqwd8ahkxwkr i3y8zllaatie7hf 96chxa4x hfrimpbwkg7dx9g7nmtmzf6vrlnvw9 fxi5hbw","body" {"action" "approve"},"x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response string output field response output example {"response" "string"} mobile devices delete removes a specified mobile device from google workspace using the provided customerid and resourceid input argument name type required description customerid string required unique identifier resourceid string required unique identifier x xgafv string optional parameter for mobile devices delete input example {"customerid" "c02xtqyl8","resourceid" "afiqxq cj6tblmkhvoyxy5vg8gyf eugglxcrhok8djrgfnargpa2zzscyb0mgaomq iqolberx7rdef8xznp71 omnq4zi wyr73xxpbcindkfsg6l5ysdu5 hjlauxutbfqy4bqwwxgodrgdux c v2pxb0y4nwasmpzss vesqwd8ahkxwkr i3y8zllaatie7hf 96chxa4x hfrimpbwkg7dx9g7nmtmzf6vrlnvw9 fxi5hbw","x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response string output field response output example {"response" "string"} mobile devices get device retrieves properties, status, and security settings of a specified mobile device within google workspace input argument name type required description customerid string optional unique identifier projection string optional parameter for mobile devices get device resourceid string optional unique identifier input example {"customerid" "c02xtqyl8","resourceid" "afiqxq cj6tblmkhvoyxy5vg8gyf eugglxcrhok8djrgfnargpa2zzscyb0mgaomq iqolberx7rdef8xznp71 omnq4zi wyr73xxpbcindkfsg6l5ysdu5 hjlauxutbfqy4bqwwxgodrgdux c v2pxb0y4nwasmpzss vesqwd8ahkxwkr i3y8zllaatie7hf 96chxa4x hfrimpbwkg7dx9g7nmtmzf6vrlnvw9 fxi5hbw"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response kind string output field response kind response etag string output field response etag response resourceid string unique identifier response deviceid string unique identifier response name array name of the resource response email array output field response email response model string output field response model response os string output field response os response type string type of the resource response status string status value response hardwareid string unique identifier response firstsync string output field response firstsync response lastsync string output field response lastsync response useragent string output field response useragent response serialnumber string output field response serialnumber response imei string output field response imei response meid string unique identifier response wifimacaddress string output field response wifimacaddress response networkoperator string output field response networkoperator response defaultlanguage string output field response defaultlanguage response managedaccountisonownerprofile boolean output field response managedaccountisonownerprofile response devicecompromisedstatus string status value output example {"response" {"kind" "string","etag" "string","resourceid" "string","deviceid" "string","name" \["string"],"email" \["string"],"model" "string","os" "string","type" "string","status" "active","hardwareid" "string","firstsync" "string","lastsync" "string","useragent" "string","serialnumber" "string"}} mobile devices list retrieves a paginated list of mobile devices registered to google workspace users using the specified 'customerid' input argument name type required description customerid string required unique identifier maxresults number optional result of the operation orderby string optional parameter for mobile devices list pagetoken string optional parameter for mobile devices list projection string optional parameter for mobile devices list query string optional parameter for mobile devices list sortorder string optional parameter for mobile devices list x xgafv string optional parameter for mobile devices list input example {"customerid" "c02xtqyl8","maxresults" 100,"sortorder" "ascending","x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response kind string output field response kind response etag string output field response etag response mobiledevices array output field response mobiledevices response mobiledevices kind string output field response mobiledevices kind response mobiledevices etag string output field response mobiledevices etag response mobiledevices resourceid string unique identifier response mobiledevices deviceid string unique identifier response mobiledevices name array name of the resource response mobiledevices email array output field response mobiledevices email response mobiledevices model string output field response mobiledevices model response mobiledevices os string output field response mobiledevices os response mobiledevices type string type of the resource response mobiledevices status string status value response mobiledevices hardwareid string unique identifier response mobiledevices firstsync string output field response mobiledevices firstsync response mobiledevices lastsync string output field response mobiledevices lastsync response mobiledevices useragent string output field response mobiledevices useragent response mobiledevices serialnumber string output field response mobiledevices serialnumber response mobiledevices imei string output field response mobiledevices imei response mobiledevices meid string unique identifier response mobiledevices wifimacaddress string output field response mobiledevices wifimacaddress response mobiledevices networkoperator string output field response mobiledevices networkoperator output example {"response" {"kind" "string","etag" "string","mobiledevices" \[{}]}} move chrome devices to an organization unit relocate multiple chrome os devices to a new organizational unit within google workspace using 'customerid' and 'orgunitpath' endpoint method post input argument name type required description customerid string required the unique id for the customer's google workspace account orgunitpath string required the full path of the organizational unit or its unique id body object optional request body data body deviceids array optional the unique ids of chrome os devices input example {"customerid" "c01bv75zr","orgunitpath" "/corp/sales","body" {"deviceids" \["deviceid 1","deviceid 2","deviceid 3"]}} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response output example {"status code" 200,"response headers" {},"reason" "ok","response" {}} retrieve a chrome device retrieve details for a specific chrome os device in google workspace using customer and device ids endpoint method get input argument name type required description customerid string required the unique id for the customer''s google workspace account deviceid string required the unique id of chrome os device projection string optional restrict information returned to a set of selected fields input example {"customerid" "c01bv75zr","deviceid" "efssfv432","projection" "basic"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response kind string output field response kind response deviceid string unique identifier response serialnumber string output field response serialnumber response status string status value response lastsync string output field response lastsync response supportenddate string date value response annotateduser string output field response annotateduser response annotatedlocation string output field response annotatedlocation response annotatedassetid string unique identifier response notes string output field response notes response ordernumber string output field response ordernumber response willautorenew boolean output field response willautorenew response osversion string output field response osversion response platformversion string output field response platformversion response firmwareversion string output field response firmwareversion response bootmode string output field response bootmode response lastenrollmenttime string time value response orgunitpath string output field response orgunitpath output example {"status code" 200,"response headers" {},"reason" "ok","response" {"kind" "directory#chromeosdevice","deviceid" "device id value","serialnumber" "device serial number","status" "active","lastsync" "2012 04 05t17 30 04 325z","supportenddate" "2014 04 05t17 30 04 325z","annotateduser" "help desk","annotatedlocation" "mountain view help desk chromebook","annotatedassetid" "12345667890","notes" "loaned from support","ordernumber" "123456","willautorenew"\ true,"osversion" "browser version 18 0","plat retrieve all chrome devices for an account retrieve a paginated list of all chrome os devices for a specified google workspace account using the customerid endpoint method get input argument name type required description customerid string required the unique id for the customer's g suite account orderby string optional the order in which the results are sorted acceptable values are annotatedlocation , annotateduser , lastsync , notes , serialnumber , and status projection string optional restrict information returned to a set of selected fields maxresults number optional the maximum number of results to return acceptable values are 1 to 200 pagetoken string optional token to specify next page in the list query string optional search string in the format given at http //support google com/chromeos/a/bin/answer py?answer=1698333 sortorder string optional the order in which the results are sorted acceptable values are ascending and descending orgunitpath string optional the full path of the organizational unit or its unique id includechildorgunits boolean optional return devices from all child orgunits, as well as the specified org unit if this is set to true, 'orgunitpath' must be provided input example {"projection" "basic","maxresults" 10,"sortorder" "ascending"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response kind string output field response kind response chromeosdevices array output field response chromeosdevices response chromeosdevices kind string output field response chromeosdevices kind response chromeosdevices etag string output field response chromeosdevices etag response chromeosdevices deviceid string unique identifier response chromeosdevices serialnumber string output field response chromeosdevices serialnumber response chromeosdevices status string status value response chromeosdevices lastsync string output field response chromeosdevices lastsync response chromeosdevices supportenddate string date value response chromeosdevices annotateduser string output field response chromeosdevices annotateduser response chromeosdevices annotatedlocation string output field response chromeosdevices annotatedlocation response chromeosdevices annotatedassetid string unique identifier response chromeosdevices notes string output field response chromeosdevices notes response chromeosdevices ordernumber string output field response chromeosdevices ordernumber response chromeosdevices willautorenew boolean output field response chromeosdevices willautorenew response chromeosdevices osversion string output field response chromeosdevices osversion response chromeosdevices platformversion string output field response chromeosdevices platformversion response chromeosdevices firmwareversion string output field response chromeosdevices firmwareversion response chromeosdevices bootmode string output field response chromeosdevices bootmode response chromeosdevices lastenrollmenttime string time value response chromeosdevices orgunitpath string output field response chromeosdevices orgunitpath response chromeosdevices recentusers array output field response chromeosdevices recentusers output example {"status code" 200,"response headers" {},"reason" "ok","response" {"kind" "directory#chromeosdevices","chromeosdevices" \[{}],"nextpagetoken" "abcdefghijkl123","etag" "\\"cmwxoj9nwmeywusny9qypkahjb8plfe5jmuk 1lm7aw/omwmqbslup5m2pco8y7wmwehgp4\\""}} update a chrome device updates a chrome os device's details in google workspace using specified customer and device ids endpoint method put input argument name type required description customerid string required the unique id for the customer's google workspace account deviceid string required the unique id of chrome os device projection string optional restrict information returned to a set of selected fields body object optional request body data body deviceid string optional the unique id of chrome os device body annotateduser string optional user of the device body annotatedlocation string optional address or location of the device as noted by the administrator body annotatedassetid string optional asset id specified during enrollment or through later annotation body notes string optional notes about this device body orgunitpath string optional the full path of the organizational unit or its id input example {"customerid" "c01bv75zr","deviceid" "efssfv432","projection" "basic","body" {"deviceid" "device id value","annotateduser" "help desk","annotatedlocation" "mountain view help desk chromebook","annotatedassetid" "1234567890","notes" "loaned from support","orgunitpath" "/corp/sales"}} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response kind string output field response kind response deviceid string unique identifier response serialnumber string output field response serialnumber response status string status value response lastsync string output field response lastsync response supportenddate string date value response annotateduser string output field response annotateduser response annotatedlocation string output field response annotatedlocation response annotatedassetid string unique identifier response notes string output field response notes response ordernumber string output field response ordernumber response willautorenew boolean output field response willautorenew response osversion string output field response osversion response platformversion string output field response platformversion response firmwareversion string output field response firmwareversion response bootmode string output field response bootmode response lastenrollmenttime string time value response orgunitpath string output field response orgunitpath output example {"status code" 200,"response headers" {},"reason" "ok","response" {"kind" "directory#chromeosdevice","deviceid" "device id value","serialnumber" "device serial number","status" "active","lastsync" "2012 04 05t17 30 04 325z","supportenddate" "2014 04 05t17 30 04 325z","annotateduser" "help desk","annotatedlocation" "mountain view help desk chromebook","annotatedassetid" "12345667890","notes" "loaned from support","ordernumber" "123456","willautorenew"\ true,"osversion" "browser version 18 0","plat vault close matter closes a specified matter in google workspace vault, ensuring secure case management with the required matterid input argument name type required description matterid string required unique identifier x xgafv string optional parameter for vault close matter input example {"matterid" "7c57c405 43f0 496e 8ac6 d106f5d01f46","x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response matter object output field response matter response matter matterid string unique identifier response matter name string name of the resource response matter description string output field response matter description response matter state string output field response matter state output example {"response" {"matter" {"matterid" "string","name" "example name","description" "string","state" "string"}}} vault create matter creates an open matter in google workspace vault with specified details, owned by the initiator endpoint method get input argument name type required description body object required request body data body name string required request body data body description string optional request body data body matterid string optional request body data body matterpermissions array optional request body data body matterpermissions accountid string optional request body data body matterpermissions role string optional request body data body state string optional request body data x xgafv string optional parameter for vault create matter input example {"body" {"name" "matter name","description" "matter description","matterid" "7c57c405 43f0 496e 8ac6 d106f5d01f46","matterpermissions" \[{"accountid" "me","role" "owner"}],"state" "open"},"x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response matterid string unique identifier response name string name of the resource response description string output field response description response state string output field response state output example {"response" {"matterid" "string","name" "example name","description" "string","state" "string"}} vault create export initiates the creation of an export for a specified matter in google workspace vault using the provided matterid and configuration input argument name type required description matterid string required unique identifier body object required request body data body cloudstoragesink object optional request body data body cloudstoragesink files array optional request body data body cloudstoragesink files bucketname string optional request body data body cloudstoragesink files md5hash string optional request body data body cloudstoragesink files objectname string optional request body data body cloudstoragesink files size string optional request body data body createtime string optional request body data body exportoptions object optional request body data body exportoptions driveoptions object optional request body data body exportoptions driveoptions includeaccessinfo boolean optional request body data body exportoptions groupsoptions object optional request body data body exportoptions groupsoptions exportformat string optional request body data body exportoptions hangoutschatoptions object optional request body data body exportoptions hangoutschatoptions exportformat string optional request body data body exportoptions mailoptions object optional request body data body exportoptions mailoptions exportformat string optional request body data body exportoptions mailoptions showconfidentialmodecontent boolean optional request body data body exportoptions mailoptions usenewexport boolean optional request body data body exportoptions region string optional request body data body exportoptions voiceoptions object optional request body data body exportoptions voiceoptions exportformat string optional request body data body id string optional request body data body matterid string optional request body data input example {"matterid" "string","body" {"cloudstoragesink" {"files" \[{"bucketname" "example name","md5hash" "string","objectname" "example name","size" "string"}]},"createtime" "string","exportoptions" {"driveoptions" {"includeaccessinfo"\ true},"groupsoptions" {"exportformat" "string"},"hangoutschatoptions" {"exportformat" "string"},"mailoptions" {"exportformat" "string","showconfidentialmodecontent"\ true,"usenewexport"\ true},"region" "string","voiceoptions" {"exportformat" "string"}},"id" "12345678 1234 1234 1234 123456789abc","matterid" "string","name" "example name","query" {"accountinfo" {"emails" \["string"]},"corpus" "string","datascope" "string","driveoptions" {"clientsideencryptedoption" "string","includeshareddrives"\ true,"includeteamdrives"\ true,"versiondate" "string"},"endtime" "string","hangoutschatinfo" {"roomid" \["string"]},"hangoutschatoptions" {"includerooms"\ true},"mailoptions" {"excludedrafts"\ true},"method" "string","orgunitinfo" {"orgunitid" "string"},"searchmethod" "string","shareddriveinfo" {"shareddriveids" \["string"]},"sitesurlinfo" {"urls" \["string"]},"starttime" "string","teamdriveinfo" {"teamdriveids" \["string"]},"terms" "string","timezone" "string","voiceoptions" {"covereddata" \["string"]}},"requester" {"displayname" "example name","email" "user\@example com"},"stats" {"exportedartifactcount" "string","sizeinbytes" "string","totalartifactcount" "string"},"status" "active"},"x xgafv" "string"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response output example {} vault get export retrieve specific export details from google workspace vault by providing matterid and exportid input argument name type required description matterid string required unique identifier exportid string required unique identifier x xgafv string optional parameter for vault get export input example {"matterid" "9b8cb25a 81c4 42a9 b1c1 e6476d6d786d","exportid" "exportly 25178a5b 97fb 456f a03a ff783fb8e4ee","x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response id string unique identifier response matterid string unique identifier response name string name of the resource response requester object output field response requester response requester email string output field response requester email response requester displayname string name of the resource response query object output field response query response query corpus string output field response query corpus response query datascope string response data response query searchmethod string http method to use response query accountinfo object output field response query accountinfo response query accountinfo emails array output field response query accountinfo emails response query mailoptions object output field response query mailoptions response query method string http method to use response exportoptions object output field response exportoptions response exportoptions mailoptions object output field response exportoptions mailoptions response exportoptions mailoptions exportformat string output field response exportoptions mailoptions exportformat response createtime string time value response status string status value response stats object output field response stats response stats exportedartifactcount string count value response stats totalartifactcount string count value output example {"response" {"id" "12345678 1234 1234 1234 123456789abc","matterid" "string","name" "example name","requester" {"email" "user\@example com","displayname" "example name"},"query" {"corpus" "string","datascope" "string","searchmethod" "string","accountinfo" {},"mailoptions" {},"method" "string"},"exportoptions" {"mailoptions" {}},"createtime" "string","status" "active","stats" {"exportedartifactcount" "string","totalartifactcount" "string","sizeinbytes" "string"},"cloudstoragesink" {"files" \[]}}} vault list exports retrieves a list of export details for a given matter from google workspace vault, requiring the 'matterid' input argument name type required description matterid string required unique identifier pagesize number optional parameter for vault list exports pagetoken string optional parameter for vault list exports x xgafv string optional parameter for vault list exports input example {"matterid" "9b8cb25a 81c4 42a9 b1c1 e6476d6d786d","pagesize" 100,"x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response exports array output field response exports response exports id string unique identifier response exports matterid string unique identifier response exports name string name of the resource response exports requester object output field response exports requester response exports requester email string output field response exports requester email response exports requester displayname string name of the resource response exports query object output field response exports query response exports query corpus string output field response exports query corpus response exports query datascope string response data response exports query searchmethod string http method to use response exports query accountinfo object output field response exports query accountinfo response exports query accountinfo emails array output field response exports query accountinfo emails response exports query mailoptions object output field response exports query mailoptions response exports query method string http method to use response exports exportoptions object output field response exports exportoptions response exports exportoptions mailoptions object output field response exports exportoptions mailoptions response exports exportoptions mailoptions exportformat string output field response exports exportoptions mailoptions exportformat response exports createtime string time value response exports status string status value response exports stats object output field response exports stats response exports stats exportedartifactcount string count value output example {"response" {"exports" \[{}]}} vault get matter retrieves detailed information for a specified matter from google workspace vault using the provided matterid input argument name type required description matterid string required unique identifier view string optional parameter for vault get matter x xgafv string optional parameter for vault get matter input example {"matterid" "80149f71 8e51 4359 a1a4 fec0b64763b7","x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response matterid string unique identifier response name string name of the resource response state string output field response state output example {"response" {"matterid" "string","name" "example name","state" "string"}} vault create hold creates a new hold within a matter in google workspace vault using the provided 'matterid' input argument name type required description matterid string required unique identifier body object optional request body data body accounts array optional request body data body accounts accountid string optional request body data body accounts email string optional request body data body accounts firstname string optional request body data body accounts holdtime string optional request body data body accounts lastname string optional request body data body corpus string optional request body data body holdid string optional request body data body name string optional request body data body orgunit object optional request body data body orgunit holdtime string optional request body data body orgunit orgunitid string optional request body data body query object optional request body data body query drivequery object optional request body data body query drivequery includeshareddrivefiles boolean optional request body data body query drivequery includeteamdrivefiles boolean optional request body data body query groupsquery object optional request body data body query groupsquery endtime string optional request body data body query groupsquery starttime string optional request body data body query groupsquery terms string optional request body data body query hangoutschatquery object optional request body data body query hangoutschatquery includerooms boolean optional request body data body query mailquery object optional request body data input example {"matterid" "string","body" {"accounts" \[{"accountid" "string","email" "user\@example com","firstname" "example name","holdtime" "string","lastname" "example name"}],"corpus" "string","holdid" "string","name" "example name","orgunit" {"holdtime" "string","orgunitid" "string"},"query" {"drivequery" {"includeshareddrivefiles"\ true,"includeteamdrivefiles"\ true},"groupsquery" {"endtime" "string","starttime" "string","terms" "string"},"hangoutschatquery" {"includerooms"\ true},"mailquery" {"endtime" "string","starttime" "string","terms" "string"},"voicequery" {"covereddata" \["string"]}},"updatetime" "string"},"x xgafv" "string"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response output example {} vault list matters retrieve accessible matters with ids and names from google workspace vault for the user input argument name type required description pagesize number optional parameter for vault list matters pagetoken string optional parameter for vault list matters state string optional parameter for vault list matters view string optional parameter for vault list matters x xgafv string optional parameter for vault list matters input example {"pagesize" 10,"pagetoken" "odaxndlmnzetogu1ms00mzu5lwexytqtzmvjmgi2ndc2m2i3","x xgafv" "1"} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response matters array output field response matters response matters matterid string unique identifier response matters name string name of the resource response matters state string output field response matters state response matters description string output field response matters description output example {"response" {"matters" \[{}]}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt