devportal.solo.iouser.proto

Package : devportal.solo.io

Top

user.proto

Table of Contents

UserSpec

A User defines an entity which can authenticate to the Portal App. Users are members of Groups, which determines which ApiDocs they can see.

Field Type Description
username devportal.solo.io. The User’s username must be unique within the system..
email devportal.solo.io. The User’s email address..
basicAuth devportal.solo.io.UserSpec.BasicAuth Authenticate the user with BasicAuth..
accessLevel devportal.solo.io.AccessLevel The User’s access level. The user will have all the permissions granted in the access level, PLUS the permissions granted by the AccessLevels contained in the Groups to which this User belongs..

UserSpec.BasicAuth

Used for authenticating with basic auth

Field Type Description
passwordSecretName string Name of a BasicAuth secret in the cluster to use to authenticate the user. A BasicAuth secret contains the user password. This field is required..
passwordSecretNamespace string Namespace containing the named BasicAuth secret. If empty, defaults to the same namespace as the user..
passwordSecretKey string Name of the secret’s data key which contains the password. Defaults to “password” if not set..

UserStatus

The current status of the User. It contains information about the Portals and API docs the user has access to.

Field Type Description
observedGeneration devportal.solo.io. The observed generation of the User. When this matches the User’s metadata.generation, it indicates the status is up-to-date..
state devportal.solo.io.common.devportal.solo.io.State The current state of the user.
reason devportal.solo.io. A human-readable string explaining the error, if any..
hasLoggedIn devportal.solo.io. Special status flag that indicates whether the user has logged in for the first time. Set by the Portal Web App..