PocketIDUserGroup¶

PocketIDUserGroup is the Schema for the pocketidusergroups API.

`PocketIDUserGroup.spec`¶

PocketIDUserGroupSpec defines the desired state of PocketIDUserGroup.

Field	Type	Description
`instanceSelector`	LabelSelector	InstanceSelector selects the PocketIDInstance to reconcile against. If omitted, the controller expects exactly one instance in the cluster.
`name`	string	Name of the user group in Pocket-ID. Defaults to metadata.name. MaxLength: 255 MinLength: 2
`friendlyName`	string	FriendlyName is the display name of the user group. Defaults to the name. MaxLength: 50 MinLength: 2
`customClaims`	[]object	CustomClaims are additional claims to attach to every user in this group. A user's own claim with the same key takes precedence.
`users`	object	Users defines the members the operator manages in this group. Members added outside the operator are left in place.
`allowedOIDCClients`	[]object	AllowedOIDCClients lists PocketIDOIDCClient CRs that this group grants access to. Each must be Ready. The final set of allowed clients is the union of this field and any PocketIDOIDCClients that reference this group in their allowedUserGroups.

CustomClaim defines a custom claim key/value pair for a user or user group.

Field	Type	Required	Default	Description
`key`	string	yes		Key is the claim key.
`value`	string	yes		Value is the claim value.

UserGroupUsers defines the members the operator manages in a user group.

Field	Type	Description
`userRefs`	[]object	UserRefs are PocketIDUser custom resources to add to this group. Each must be Ready.
`usernames`	string array	Usernames are existing Pocket-ID users to add to this group, for users not managed by a PocketIDUser. Each must exist in Pocket-ID.
`userIDs`	string array	UserIDs are Pocket-ID user IDs to add to this group, for users not managed by a PocketIDUser.

NamespacedUserReference references a PocketIDUser by name and namespace.

Field	Type	Required	Default	Description
`name`	string			Name is the name of the PocketIDUser CR.
`namespace`	string			Namespace is the namespace of the PocketIDUser CR. Defaults to the referencing resource's namespace.

NamespacedOIDCClientReference references a PocketIDOIDCClient by name and namespace.

Field	Type	Required	Default	Description
`name`	string			Name is the name of the PocketIDOIDCClient CR.
`namespace`	string			Namespace is the namespace of the PocketIDOIDCClient CR. Defaults to the referencing resource's namespace.

PocketIDUserGroupStatus defines the observed state of PocketIDUserGroup.

Field	Type	Description
`groupID`	string	GroupID is the ID assigned by Pocket-ID.
`name`	string	Name is the group name from Pocket-ID.
`friendlyName`	string	FriendlyName is the display name from Pocket-ID.
`createdAt`	string	CreatedAt is the creation timestamp from Pocket-ID.
`ldapID`	string	LdapID is the LDAP identifier if the group is synced from LDAP.
`totalUserCount`	integer	TotalUserCount is the number of members in the group, including those not managed by the operator.
`managedUserIDs`	string array	ManagedUserIDs are the Pocket-ID user IDs the operator manages in this group. Members not in this list were added outside the operator and are never removed.
`customClaims`	[]object	CustomClaims are the group's custom claims in Pocket-ID.
`allowedOIDCClientIDs`	string array	AllowedOIDCClientIDs are the IDs of the OIDC clients this group is allowed to access in Pocket-ID.
`conditions`	Condition array	Conditions represent the current state of the PocketIDUserGroup resource.

CustomClaim defines a custom claim key/value pair for a user or user group.

Field	Type	Required	Default	Description
`key`	string	yes		Key is the claim key.
`value`	string	yes		Value is the claim value.