rancher v2.15.1

User

User represents a user in Rancher

12 fields
User fields and descriptions
Field / TypeDescription
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

description
string

Description provides a brief summary about the user.

displayName
string

DisplayName is the user friendly name shown in the UI.

enabled
boolean

Enabled indicates whether the user account is active.

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

me
boolean

Deprecated. Only used by /v3 Rancher API.

metadata
object

No description provided.

mustChangePassword
boolean

MustChangePassword is a flag that, if true, forces the user to change their password upon their next login.

password
string

Deprecated. Password are stored in secrets in the cattle-local-user-passwords namespace.

string[]

PrincipalIDs lists the authentication provider identities (e.g. GitHub, Keycloak or Active Directory) that are associated with this user account.

object

Status contains the most recent observed state of the user.

username
string

Username is the unique login identifier for the user.