Google Workspace Directory

Use the @bijection/connectors/google-directory entrypoint to declare Google Workspace Directory resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Users	`enumeration`	enumeration
Groups	`enumeration`	enumeration
Group members	`enumeration`	enumeration

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Users

enumeration: enumeration

The following example matches configuration standard.

import { googleDirectory } from "@bijection/connectors/google-directory";
export const people = googleDirectory.users.enumeration();

Inferred record types

{
  "id": string;
  "primaryEmail": string;
  "givenName": string | undefined;
  "familyName": string | undefined;
  "fullName": string | undefined;
  "suspended": boolean | undefined;
  "archived": boolean | undefined;
  "isAdmin": boolean | undefined;
  "isDelegatedAdmin": boolean | undefined;
  "orgUnitPath": string | undefined;
  "creationTime": string | undefined;
  "lastLoginTime": string | undefined;
  "isEnrolledIn2Sv": boolean | undefined;
}

Configuration: standard

Case: google-directory/users/enumeration/standard. Connection and resource configuration are declared by this exact case. Credential kind: google-directory. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements.

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "google-directory",
    "output": {
      "kind": "single",
      "collection": "users"
    },
    "credential_kind": "google-directory",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://admin.googleapis.com/admin/directory/v1"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {}
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: users

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Reconciliation
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "user": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": true,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "users": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange user",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange users",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "reconciliation",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "users": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": true,
      "reconciliation": true,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "user": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": true,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "users": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange user",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange users",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "reconciliation",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“users”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“users”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“users”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/google-directory/fixtures/identity.json	passed (2026-10-24T21:36:12.059Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Groups

enumeration: enumeration

The following example matches configuration standard.

import { googleDirectory } from "@bijection/connectors/google-directory";
export const groups = googleDirectory.groups.enumeration();

Inferred record types

{
  "id": string;
  "email": string;
  "name": string | undefined;
  "description": string | undefined;
  "directMembersCount": string | undefined;
  "adminCreated": boolean | undefined;
}

Configuration: standard

Case: google-directory/groups/enumeration/standard. Connection and resource configuration are declared by this exact case. Credential kind: google-directory. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements.

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "google-directory",
    "output": {
      "kind": "single",
      "collection": "groups"
    },
    "credential_kind": "google-directory",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://admin.googleapis.com/admin/directory/v1"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {}
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: groups

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Reconciliation
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "group": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": true,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "groups": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange group",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange groups",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "reconciliation",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "groups": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": true,
      "reconciliation": true,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "group": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": true,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "groups": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange group",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange groups",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "reconciliation",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“groups”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“groups”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“groups”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/google-directory/fixtures/identity.json	passed (2026-10-24T21:36:12.060Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Group members

enumeration: enumeration

The following example matches configuration standard.

import { googleDirectory } from "@bijection/connectors/google-directory";
export const finance = googleDirectory.members.enumeration();

Inferred record types

{
  "id": string;
  "email": string | undefined;
  "role": string;
  "type": string;
  "status": string | undefined;
}

Configuration: standard

Case: google-directory/members/enumeration/standard. Connection and resource configuration are declared by this exact case. Credential kind: google-directory. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`groupKey`	string	Yes	Resource binding

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "google-directory",
    "output": {
      "kind": "single",
      "collection": "members"
    },
    "credential_kind": "google-directory",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://admin.googleapis.com/admin/directory/v1"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "groupKey": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: members

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Reconciliation
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "member": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": true,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "members": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange member",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange members",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "reconciliation",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "members": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": true,
      "reconciliation": true,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "member": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": true,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "members": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange member",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange members",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "reconciliation",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“members”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“members”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“members”}	No retained check covers this scoped Google Directory requirement; no Workspace customer has been reached.	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/google-directory/fixtures/identity.json	passed (2026-10-24T21:36:12.060Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. The connection uses a google-directory credential (googleDirectory.credential): an OAuth refresh grant consented by a Workspace administrator with admin.directory.user.readonly, admin.directory.group.readonly, admin.directory.group.member.readonly and admin.directory.customer.readonly. The customer id is the account identity. Service-account domain-wide delegation is not supported by the credential owner. The Directory API has no change token and lists nothing deleted. Users and groups are listed 200 per page through Google’s nextPageToken; members lists the direct members of the one group its binding’s groupKey names. A published record leaves only when a point read of its id answers 404. Google omits an empty array, so an empty listing (for example a group with no members) refuses its page. Nested groups are not expanded. No Workspace customer has been reached by these recipes’ checks.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Google Workspace Directory

Availability

Resources and modes

Users

enumeration: enumeration

Configuration: standard

Groups

enumeration: enumeration

Configuration: standard

Group members

enumeration: enumeration

Configuration: standard

Provider guidance

Provider references

Source and evidence

​Availability

​Resources and modes

​Users

​enumeration: enumeration

​Configuration: standard

​Groups

​enumeration: enumeration

​Configuration: standard

​Group members

​enumeration: enumeration

​Configuration: standard

​Provider guidance

​Provider references

​Source and evidence

Availability

Resources and modes

Users

enumeration: enumeration

Configuration: standard

Groups

enumeration: enumeration

Configuration: standard

Group members

enumeration: enumeration

Configuration: standard

Provider guidance

Provider references

Source and evidence