PocketIDUserGroup
pocketid.internal / v1alpha1
apiVersion: pocketid.internal/v1alpha1
kind: PocketIDUserGroup
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
spec defines the desired state of PocketIDUserGroup
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.
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.
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.
key
string required
Key is the claim key.
value
string required
Value is the claim value.
friendlyName
string
FriendlyName is the display name of the user group. Defaults to the name.
minLength:
2maxLength:
50instanceSelector object
InstanceSelector selects the PocketIDInstance to reconcile against.
If omitted, the controller expects exactly one instance in the cluster.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
name
string
Name of the user group in Pocket-ID. Defaults to metadata.name.
minLength:
2maxLength:
255users object
Users defines the members the operator manages in this group. Members added outside the operator are left in place.
userIDs
[]string
UserIDs are Pocket-ID user IDs to add to this group, for users not managed by a PocketIDUser.
userRefs []object
UserRefs are PocketIDUser custom resources to add to this group. Each must be Ready.
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.
usernames
[]string
Usernames are existing Pocket-ID users to add to this group, for users not managed by a PocketIDUser. Each must exist in Pocket-ID.
status object
status defines the observed state of PocketIDUserGroup
allowedOIDCClientIDs
[]string
AllowedOIDCClientIDs are the IDs of the OIDC clients this group is allowed to access in Pocket-ID.
conditions []object
Conditions represent the current state of the PocketIDUserGroup resource.
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316
createdAt
string
CreatedAt is the creation timestamp from Pocket-ID.
customClaims []object
CustomClaims are the group's custom claims in Pocket-ID.
key
string required
Key is the claim key.
value
string required
Value is the claim value.
friendlyName
string
FriendlyName is the display name from Pocket-ID.
groupID
string
GroupID is the ID assigned by Pocket-ID.
ldapID
string
LdapID is the LDAP identifier if the group is synced from LDAP.
managedUserIDs
[]string
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.
name
string
Name is the group name from Pocket-ID.
totalUserCount
integer
TotalUserCount is the number of members in the group, including those not managed by the operator.
No matches. Try .spec.allowedOIDCClients for an exact path