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/ https //console cloud google com/ navigate to this link to create a new project https //console cloud google com/projectcreate 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 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 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 https //console cloud google com/apis/library/alertcenter googleapis com g suite vault api https //console cloud google com/apis/library/vault googleapis com https //console cloud google com/apis/library/vault googleapis com admin sdk api https //console cloud google com/apis/library/admin googleapis com https //console cloud google com/apis/library/admin googleapis com google chat api https //console cloud google com/apis/library/chat googleapis com https //console cloud google com/apis/library/chat googleapis com google sheets api https //console cloud google com/apis/library/sheets googleapis com 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 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 google cloud console 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 https //localhost copy the full url for the https //localhost 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 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 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/ 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 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 here 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 scopes https //developers google com/gmail/api/auth/scopes the gmail api must be enabled https //console developers google com/apis/library/gmail googleapis com 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/ 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 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 here https //developers google com/admin sdk/alertcenter/guides/prerequisites for alert details and to see the different alert types click here 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 https //developers google com/admin sdk/alertcenter/guides/query filters vault https //ediscovery google com/ 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 create a message api documentation https //developers google com/workspace/chat/api/reference/rest/v1/spaces messages/createlist spaces api documentation https //developers google com/workspace/chat/api/reference/rest/v1/spaces/listchrome devices api https //developers google com/admin sdk/directory/reference/rest/v1/chromeosdevices/getpython sdk documentation 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 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 add row or add data api documentation 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 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 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 insertdimension object optional inserts new rows or columns in a sheet range object optional the dimensions to insert both the start and end indexes must be bounded sheetid number optional the sheet this span is on dimension string optional the dimension of the span startindex number optional the start (inclusive) of the span, or not set if unbounded endindex number optional the end (exclusive) of the span, or not set if unbounded 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 pastedata object optional pastes data (html or delimited) into a sheet coordinate object optional the coordinate at which the data should start being inserted sheetid number optional the sheet this coordinate is on rowindex number optional the row index of the coordinate columnindex number optional the column index of the coordinate data string optional the data to insert type string optional how the data should be pasted delimiter string optional the delimiter in the data html boolean optional true if the data is html insertrange object optional inserts new cells in a sheet, shifting the existing cells range object optional the range to insert new cells into sheetid number optional the sheet this range is on startrowindex number optional the start row (inclusive) of the range, or not set if unbounded endrowindex number optional the end row (exclusive) of the range, or not set if unbounded startcolumnindex number optional the start column (inclusive) of the range, or not set if unbounded output parameter type description status code number http status code of the response reason string response reason phrase response object output field response spreadsheetid string unique identifier replies array output field replies updatedspreadsheet object output field updatedspreadsheet 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 alertid array required unique identifier customerid string optional unique identifier x xgafv string optional parameter for alertcenter batch delete alerts output parameter type description status code number http status code of the response reason string response reason phrase response object output field response example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok" } ] 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 alertid array required unique identifier customerid string optional unique identifier x xgafv string optional parameter for alertcenter batch undelete alerts output parameter type description status code number http status code of the response reason string response reason phrase response object output field response example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok" } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok" } ] 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 output parameter type description alertid string unique identifier createtime string time value customerid string unique identifier data object response data a key string output field a key deleted boolean output field deleted endtime string time value etag string output field etag metadata object response data assignee string output field assignee customerid string unique identifier etag string output field etag severity string output field severity status string status value updatetime string time value securityinvestigationtoollink string output field securityinvestigationtoollink source string output field source starttime string time value type string type of the resource updatetime string time value 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response alerts array output field alerts customerid string unique identifier alertid string unique identifier createtime string time value starttime string time value endtime string time value type string type of the resource source string output field source data object response data @type string type of the resource email string output field email logindetails object output field logindetails ipaddress string output field ipaddress securityinvestigationtoollink string output field securityinvestigationtoollink metadata object response data customerid string unique identifier alertid string unique identifier status string status value updatetime string time value severity string output field severity etag string output field etag updatetime string time value example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 customerid string optional unique identifier x xgafv string optional parameter for alertcenter undelete alert output parameter type description status code number http status code of the response reason string response reason phrase response object output field response customerid string unique identifier alertid string unique identifier createtime string time value starttime string time value endtime string time value type string type of the resource source string output field source data object response data @type string type of the resource email string output field email logindetails object output field logindetails ipaddress string output field ipaddress metadata object response data customerid string unique identifier alertid string unique identifier status string status value updatetime string time value severity string output field severity etag string output field etag updatetime string time value etag string output field etag example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "response" { "customerid" "string", "alertid" "string", "createtime" "string", "starttime" "string", "endtime" "string", "type" "string", "source" "string", "data" {}, "metadata" {}, "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 summary string optional parameter for calendar create event location string optional parameter for calendar create event description string optional parameter for calendar create event start object optional parameter for calendar create event datetime string optional time value timezone string optional parameter for calendar create event end object optional parameter for calendar create event datetime string optional time value timezone string optional parameter for calendar create event reminders object optional parameter for calendar create event usedefault boolean optional parameter for calendar create event overrides array optional unique identifier method string optional http method to use minutes number optional parameter for calendar create event 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 output parameter type description response object output field response kind string output field kind etag string output field etag id string unique identifier status string status value htmllink string output field htmllink created string output field created updated string output field updated summary string output field summary description string output field description location string output field location creator object output field creator email string output field email self boolean output field self organizer object output field organizer email string output field email self boolean output field self start object output field start datetime string time value timezone string output field timezone end object output field end datetime string time value timezone string output field timezone icaluid string unique identifier sequence number output field sequence 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" {}, "organizer" {}, "start" {}, "end" {}, "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 output parameter type description response object output field response success string whether the operation was successful 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 output parameter type description response object output field response kind string output field kind etag string output field etag id string unique identifier status string status value htmllink string output field htmllink created string output field created updated string output field updated summary string output field summary description string output field description location string output field location creator object output field creator email string output field email self boolean output field self organizer object output field organizer email string output field email self boolean output field self start object output field start datetime string time value timezone string output field timezone end object output field end datetime string time value timezone string output field timezone icaluid string unique identifier sequence number output field sequence 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" {}, "organizer" {}, "start" {}, "end" {}, "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 output parameter type description response object output field response kind string output field kind etag string output field etag summary string output field summary updated string output field updated timezone string output field timezone accessrole string output field accessrole defaultreminders array output field defaultreminders method string http method to use minutes number output field minutes items array output field items kind string output field kind etag string output field etag id string unique identifier status string status value htmllink string output field htmllink created string output field created updated string output field updated summary string output field summary description string output field description location string output field location creator object output field creator email string output field email self boolean output field self organizer object output field organizer 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 text string optional plain text body of the message the first link to an image, video, or web page generates a preview chip cardsv2 array optional parameter for chat create a message 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 card object optional parameter for chat create a message 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 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 subtitle string optional the subtitle of the card header if specified, appears on its own line below the title imageurl string optional the https url of the image in the card header imagetype string optional the shape used to crop the image imagealttext string optional the alternative text of this image that's used for accessibility sections array optional a section contains a collection of widgets that are rendered vertically in the order that they're specified header string optional text that appears at the top of a section supports simple html formatted text collapsible boolean optional indicates whether this section is collapsible uncollapsiblewidgetscount number optional the number of uncollapsible widgets which remain visible even when a section is collapsed widgets array optional all the widgets in the section must contain at least one widget sectiondividerstyle string optional the divider style between sections cardactions array optional the card's actions actions are added to the card's toolbar menu actionlabel string optional the label that displays as the action menu item onclick object optional the onclick action for this action item name string optional name of the card used as a card identifier in card navigation output parameter type description status code number http status code of the response reason string response reason phrase response object output field response 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response spaces array output field spaces name string name of the resource type string type of the resource spacetype string type of the resource singleuserbotdm boolean output field singleuserbotdm threaded boolean output field threaded displayname string name of the resource externaluserallowed boolean output field externaluserallowed spacethreadingstate string output field spacethreadingstate spacedetails object output field spacedetails description string output field description guidelines string unique identifier spacehistorystate string output field spacehistorystate importmode boolean output field importmode createtime string time value admininstalled boolean output field admininstalled accesssettings object output field accesssettings accessstate string output field accessstate audience string output field audience spaceuri string output field spaceuri nextpagetoken string output field nextpagetoken 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 deviceids array required list of the ids of the chromeos devices to change maximum 50 changechromeosdevicestatusaction string required the action to take on the chromeos device in order to change its status deprovisionreason string optional the reason for deprovisioning the device output parameter type description status code number http status code of the response reason string response reason phrase response object output field response changechromeosdevicestatusresults array status value deviceid string unique identifier response object output field response code number output field code message string response message details array output field details @type string type of the resource 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response success boolean whether the operation was successful example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 output parameter type description status code number http status code of the response reason string response reason phrase response array output field response kind string output field kind userpermission object output field userpermission id string unique identifier type string type of the resource role string output field role kind string output field kind selflink string output field selflink etag string output field etag pendingowner boolean output field pendingowner fileextension string output field fileextension md5checksum string output field md5checksum selflink string output field selflink ownernames array name of the resource lastmodifyingusername string name of the resource editable boolean output field editable writerscanshare boolean output field writerscanshare downloadurl string url endpoint for the request mimetype string type of the resource parents array output field parents selflink string output field selflink id string unique identifier isroot boolean output field isroot example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 file string optional parameter for drive file upload file name string optional name of the resource 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 id string optional unique identifier output parameter type description status code number http status code of the response reason string response reason phrase response object output field response title string output field title mime type string type of the resource mimetype string type of the resource kind string output field kind id string unique identifier etag string output field etag selflink string output field selflink webcontentlink string response content alternatelink string output field alternatelink embedlink string output field embedlink iconlink string output field iconlink thumbnaillink string output field thumbnaillink labels object output field labels starred boolean output field starred hidden boolean unique identifier trashed boolean output field trashed restricted boolean output field restricted viewed boolean output field viewed copyrequireswriterpermission boolean output field copyrequireswriterpermission createddate string date value modifieddate string date value modifiedbymedate string date value example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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" {}, "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 output parameter type description status code number http status code of the response reason string response reason phrase file array output field file example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok" } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response id string unique identifier threadid string unique identifier labelids array unique identifier snippet string output field snippet payload object output field payload partid string unique identifier mimetype string type of the resource filename string name of the resource headers array http headers for the request name string name of the resource value string value for the parameter body object request body data size number output field size parts array output field parts partid string unique identifier mimetype string type of the resource filename string name of the resource headers array http headers for the request name string name of the resource value string value for the parameter body object request body data attachmentid string unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "response" { "id" "12345678 1234 1234 1234 123456789abc", "threadid" "string", "labelids" \[], "snippet" "string", "payload" {}, "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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response messages array response message id string unique identifier threadid string unique identifier nextpagetoken string output field nextpagetoken resultsizeestimate number result of the operation example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 file string optional parameter for gmail send email file name string optional name of the resource description string optional parameter for gmail send email output parameter type description id string unique identifier threatid string unique identifier labelids array unique identifier 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response labels array output field labels id string unique identifier name string name of the resource messagelistvisibility string response message labellistvisibility string output field labellistvisibility type string type of the resource example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response 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 example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "response" { "id" "12345678 1234 1234 1234 123456789abc", "threadid" "string", "labelids" \[], "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 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 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response historyid string unique identifier id string unique identifier messages array response message historyid string unique identifier id string unique identifier internaldate string date value labelids array unique identifier payload object output field payload body object request body data attachmentid string unique identifier data string response data size number output field size filename string name of the resource headers array http headers for the request name string name of the resource value string value for the parameter mimetype string type of the resource partid string unique identifier parts array output field parts file name string name of the resource file string output field file raw string output field raw example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 action string required parameter for mobile devices action x xgafv string optional parameter for mobile devices action output parameter type description status code number http status code of the response reason string response reason phrase response string output field response example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 output parameter type description status code number http status code of the response reason string response reason phrase response string output field response example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response kind string output field kind etag string output field etag resourceid string unique identifier deviceid string unique identifier name array name of the resource email array output field email model string output field model os string output field os type string type of the resource status string status value hardwareid string unique identifier firstsync string output field firstsync lastsync string output field lastsync useragent string output field useragent serialnumber string output field serialnumber imei string output field imei meid string unique identifier wifimacaddress string output field wifimacaddress networkoperator string output field networkoperator defaultlanguage string output field defaultlanguage managedaccountisonownerprofile boolean output field managedaccountisonownerprofile devicecompromisedstatus string status value example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "response" { "kind" "string", "etag" "string", "resourceid" "string", "deviceid" "string", "name" \[], "email" \[], "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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response kind string output field kind etag string output field etag mobiledevices array output field mobiledevices kind string output field kind etag string output field etag resourceid string unique identifier deviceid string unique identifier name array name of the resource email array output field email model string output field model os string output field os type string type of the resource status string status value hardwareid string unique identifier firstsync string output field firstsync lastsync string output field lastsync useragent string output field useragent serialnumber string output field serialnumber imei string output field imei meid string unique identifier wifimacaddress string output field wifimacaddress networkoperator string output field networkoperator example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 deviceids array optional the unique ids of chrome os devices output parameter type description status code number http status code of the response reason string response reason phrase response object output field response 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response kind string output field kind deviceid string unique identifier serialnumber string output field serialnumber status string status value lastsync string output field lastsync supportenddate string date value annotateduser string output field annotateduser annotatedlocation string output field annotatedlocation annotatedassetid string unique identifier notes string output field notes ordernumber string output field ordernumber willautorenew boolean output field willautorenew osversion string output field osversion platformversion string output field platformversion firmwareversion string output field firmwareversion bootmode string output field bootmode lastenrollmenttime string time value orgunitpath string output field orgunitpath 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", "platformversion" "platform version 1415 2 0", "firmwareversion" "firmware version 1 2 3 4" } } ] 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 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response kind string output field kind chromeosdevices array output field chromeosdevices kind string output field kind etag string output field etag deviceid string unique identifier serialnumber string output field serialnumber status string status value lastsync string output field lastsync supportenddate string date value annotateduser string output field annotateduser annotatedlocation string output field annotatedlocation annotatedassetid string unique identifier notes string output field notes ordernumber string output field ordernumber willautorenew boolean output field willautorenew osversion string output field osversion platformversion string output field platformversion firmwareversion string output field firmwareversion bootmode string output field bootmode lastenrollmenttime string time value orgunitpath string output field orgunitpath recentusers array output field recentusers 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 deviceid string optional the unique id of chrome os device annotateduser string optional user of the device annotatedlocation string optional address or location of the device as noted by the administrator annotatedassetid string optional asset id specified during enrollment or through later annotation notes string optional notes about this device orgunitpath string optional the full path of the organizational unit or its id output parameter type description status code number http status code of the response reason string response reason phrase response object output field response kind string output field kind deviceid string unique identifier serialnumber string output field serialnumber status string status value lastsync string output field lastsync supportenddate string date value annotateduser string output field annotateduser annotatedlocation string output field annotatedlocation annotatedassetid string unique identifier notes string output field notes ordernumber string output field ordernumber willautorenew boolean output field willautorenew osversion string output field osversion platformversion string output field platformversion firmwareversion string output field firmwareversion bootmode string output field bootmode lastenrollmenttime string time value orgunitpath string output field orgunitpath 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", "platformversion" "platform version 1415 2 0", "firmwareversion" "firmware version 1 2 3 4" } } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response matter object output field matter matterid string unique identifier name string name of the resource description string output field description state string output field state example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "response" { "matter" {} } } ] 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 name string required name of the resource description string optional parameter for vault create matter matterid string optional unique identifier matterpermissions array optional parameter for vault create matter accountid string optional unique identifier role string optional parameter for vault create matter state string optional parameter for vault create matter x xgafv string optional parameter for vault create matter output parameter type description status code number http status code of the response reason string response reason phrase response object output field response matterid string unique identifier name string name of the resource description string output field description state string output field state example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 cloudstoragesink object optional parameter for vault create export files array optional parameter for vault create export bucketname string optional name of the resource md5hash string optional parameter for vault create export objectname string optional name of the resource size string optional parameter for vault create export createtime string optional time value exportoptions object optional parameter for vault create export driveoptions object optional parameter for vault create export includeaccessinfo boolean optional parameter for vault create export groupsoptions object optional parameter for vault create export exportformat string optional parameter for vault create export hangoutschatoptions object optional parameter for vault create export exportformat string optional parameter for vault create export mailoptions object optional parameter for vault create export exportformat string optional parameter for vault create export showconfidentialmodecontent boolean optional unique identifier usenewexport boolean optional parameter for vault create export region string optional parameter for vault create export voiceoptions object optional parameter for vault create export exportformat string optional parameter for vault create export id string optional unique identifier matterid string optional unique identifier output parameter type description status code number http status code of the response reason string response reason phrase response object output field response example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok" } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response id string unique identifier matterid string unique identifier name string name of the resource requester object output field requester email string output field email displayname string name of the resource query object output field query corpus string output field corpus datascope string response data searchmethod string http method to use accountinfo object output field accountinfo emails array output field emails mailoptions object output field mailoptions method string http method to use exportoptions object output field exportoptions mailoptions object output field mailoptions exportformat string output field exportformat createtime string time value status string status value stats object output field stats exportedartifactcount string count value totalartifactcount string count value example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "response" { "id" "12345678 1234 1234 1234 123456789abc", "matterid" "string", "name" "example name", "requester" {}, "query" {}, "exportoptions" {}, "createtime" "string", "status" "active", "stats" {}, "cloudstoragesink" {} } } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response exports array output field exports id string unique identifier matterid string unique identifier name string name of the resource requester object output field requester email string output field email displayname string name of the resource query object output field query corpus string output field corpus datascope string response data searchmethod string http method to use accountinfo object output field accountinfo emails array output field emails mailoptions object output field mailoptions method string http method to use exportoptions object output field exportoptions mailoptions object output field mailoptions exportformat string output field exportformat createtime string time value status string status value stats object output field stats exportedartifactcount string count value example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response matterid string unique identifier name string name of the resource state string output field state example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 accounts array optional parameter for vault create hold accountid string optional unique identifier email string optional parameter for vault create hold firstname string optional name of the resource holdtime string optional time value lastname string optional name of the resource corpus string optional parameter for vault create hold holdid string optional unique identifier name string optional name of the resource orgunit object optional parameter for vault create hold holdtime string optional time value orgunitid string optional unique identifier query object optional parameter for vault create hold drivequery object optional parameter for vault create hold includeshareddrivefiles boolean optional parameter for vault create hold includeteamdrivefiles boolean optional parameter for vault create hold groupsquery object optional parameter for vault create hold endtime string optional time value starttime string optional time value terms string optional parameter for vault create hold hangoutschatquery object optional parameter for vault create hold includerooms boolean optional parameter for vault create hold mailquery object optional parameter for vault create hold output parameter type description status code number http status code of the response reason string response reason phrase response object output field response example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok" } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response matters array output field matters matterid string unique identifier name string name of the resource state string output field state description string output field description example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "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 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