Skip to main content

Organization User Group

OrganizationUserGroup

Defines a logical grouping of users for simplified access control.

Allows for the programmatic management of permissions mapping back to internal users and external identities. It acts as the anchor for bulk access assignment across the organization's projects and repositories.

PropertyTypeDescription
apiVersionstringAPI schema version. Pins the manifest to a specific schema contract for backward-compatibility. Must be the constant lowops.manifests.v1.
kindstringResource kind discriminator. Identifies this document as an OrganizationUserGroup so the engine routes it to the correct defaulter, validator, computer, and executor. Must be the constant OrganizationUserGroup.
metadatamapClassification labels and graph linkage. Free-form key/value pairs used to classify the manifest. Certain reserved keys (e.g. name, organization) are read by the engine to resolve this manifest's identity and its parent Organization in the dependency graph.
specSpecDesired user-group configuration. The authoritative, user-authored specification for this OrganizationUserGroup. See Spec.

Spec

Desired user-group configuration.

The authoritative, user-authored specification for this group: descriptive context, an optional parent group for nesting, and the collection of internal and external members that make up the group.

PropertyTypeDescription
descriptionstringHuman-readable description of the group. Optional free text describing the group's purpose. Propagated onto the description of the corresponding GitHub team, and used as context by AI assistants when reasoning about the organization's access structure.
parentstringParent group for nesting. Name of another OrganizationUserGroup manifest to set as this group's parent, creating a nested group hierarchy. When set, the executor attaches this group under the resolved parent team.
membersMembersMembers of this group. The internal and external members that make up the group. See Members.

Members

Members of the group.

The internal OrganizationUser members and external email members that belong to this group.

PropertyTypeDescription
userslist of stringInternal user members. Names of OrganizationUser manifests to add as members of this group.
externallist of stringExternal email members. Email addresses of members who are not defined by an OrganizationUser manifest. Added directly as external members of the group.