Skip to main content

Organization User Group

OrganizationUserGroup​

A logical group of users for simpler access control.

The group maps to internal users and external identities. It anchors bulk access assignment across projects and repositories.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be OrganizationUserGroup.
metadatamapThe engine reads the reserved keys name and organization to resolve the identity and the parent Organization.
specSpecDesired user-group configuration. See Spec.

Spec​

Desired user-group configuration.

A description, an optional parent group, and the members.

PropertyTypeDescription
descriptionstringOptional description of the group. The engine copies it to the description of the related GitHub team.
parentstringName of another OrganizationUserGroup manifest that is the parent of this group. This creates a nested hierarchy. The engine attaches the group under the resolved parent team.
membersMembersInternal and external members of the group. See Members.

Members​

Members of the group.

Internal OrganizationUser members and external email members.

PropertyTypeDescription
userslist of stringNames of the OrganizationUser manifests that are members of the group.
externallist of stringEmail addresses of members that no OrganizationUser manifest defines. The engine adds them as external members.