Google_Admin

Handle Initialize Authorization

post

Handle integration initialization request.

Body

application/json

or

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/connectors/google_admin/integrations

HTTPcURLJavaScriptPython

POST /connectors/google_admin/integrations HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "auth_type": "oauth2",
  "callback_url": "text"
}

No content

Handle Get Integration

get

Handle get integration request.

Path parameters

user_identifierstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/connectors/google_admin/integrations/{user_identifier}

HTTPcURLJavaScriptPython

GET /connectors/google_admin/integrations/{user_identifier} HTTP/1.1
Host: 
Accept: */*

No content

Handle Select Integration

post

Handle integration selection request.

Path parameters

user_identifierstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/connectors/google_admin/integrations/{user_identifier}

HTTPcURLJavaScriptPython

POST /connectors/google_admin/integrations/{user_identifier} HTTP/1.1
Host: 
Accept: */*

No content

Handle Remove Integration

delete

Handle integration removal request.

Path parameters

user_identifierstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/connectors/google_admin/integrations/{user_identifier}

HTTPcURLJavaScriptPython

DELETE /connectors/google_admin/integrations/{user_identifier} HTTP/1.1
Host: 
Accept: */*

No content

Handle User Has Integration

get

Handle user integration existence check.

Responses

200

Successful Response

application/json

Responseany

get

/connectors/google_admin/integration-exists

HTTPcURLJavaScriptPython

GET /connectors/google_admin/integration-exists HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

Auth Schema

get

Handle authentication schema request.

Responses

200

Successful Response

application/json

Responseany

get

/connectors/google_admin/auth-schema

HTTPcURLJavaScriptPython

GET /connectors/google_admin/auth-schema HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

Success Authorize Callback

get

Handle successful authorization callback.

Responses

200

Successful Response

application/json

Responseany

get

/connectors/google_admin/success-authorize-callback

HTTPcURLJavaScriptPython

GET /connectors/google_admin/success-authorize-callback HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

List Groups

post

List groups in a Google Admin SDK.

Args: request: The request object. http_headers: The HTTP headers.

Returns: The list of groups.

Body

application/json

List groups request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]

string[]Optional

or

nullOptional

response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

• field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
• root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.

Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]

or

nullOptional

emailstringRequired

Email of the user to list groups for

cursorany ofOptional

Cursor for pagination

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/connectors/google_admin/list_groups

HTTPcURLJavaScriptPython

POST /connectors/google_admin/list_groups HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "response_fields": [
    "id",
    "name",
    "status"
  ],
  "response_filters": [
    {
      "field_name": "status",
      "type": "string_list",
      "values": [
        "open",
        "in_progress"
      ]
    }
  ],
  "email": "text",
  "cursor": "text"
}

{
  "data": [
    {
      "id": "text",
      "email": "text",
      "name": "text",
      "description": "text",
      "admin_created": true,
      "direct_members_count": "text",
      "kind": "text",
      "etag": "text",
      "aliases": [
        "text"
      ],
      "non_editable_aliases": [
        "text"
      ]
    }
  ],
  "meta": {
    "has_next": true,
    "forwards_cursor": "text"
  }
}