Skip to main content
API resource reference for GroupMembership, part of the IAM service. To create or change one, see Changing resources; to inspect, see Reading resources.
This resource is part of the v1alpha1 API and is subject to change. Fields and behavior may change in future releases.

Identity

Groupiam.miloapis.com
Versionv1alpha1
KindGroupMembership
ScopeProject

Overview

A GroupMembership connects a single user to a single group. Use it to add a user as a member of a group so that any roles bound to that group apply to the user. Each membership represents one user-in-group relationship, so you create one GroupMembership per user you want to add to a group.

Spec fields

FieldTypeRequiredDescription
spec.groupRefObjectYesReference to the group the user is being added to.
spec.groupRef.namestringYesName of the group being referenced.
spec.groupRef.namespacestringYesNamespace of the referenced group.
spec.userRefObjectYesReference to the user that becomes a member of the group.
spec.userRef.namestringYesName of the user being referenced.

Status fields (read-only)

FieldTypeDescription
status.conditions[]ObjectLatest available observations of the membership’s current state.

Usage

apiVersion: iam.miloapis.com/v1alpha1
kind: GroupMembership
metadata:
  name: alice-in-platform-admins
spec:
  groupRef:
    name: platform-admins
    namespace: my-project
  userRef:
    name: alice
datumctl apply -f groupmembership.yaml --project my-project
datumctl get groupmemberships.iam.miloapis.com --project my-project
datumctl describe groupmemberships.iam.miloapis.com alice-in-platform-admins --project my-project
Run datumctl explain groupmemberships.iam.miloapis.com --recursive to see the full, live field tree for this resource.
Last modified on July 2, 2026