# Functions
HashUserPassword receives a plain password and hash it, returning a [UserPassword].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
BillingStatusActive represents active status without any issues.
BillingStatusCanceled represents canceled status.
BillingStatusInactive represents inactive status.
BillingStatusIncomplete represents incomplete status.
BillingStatusIncompleteExpired represents incomplete_expired status.
BillingStatusPastDue represents past_due status.
BillingStatusPaused represents paused status.
BillingStatusToCancelAtEndOfPeriod represents to_cancel_at_end_of_period status.
BillingStatusTrialing represents active status without any issues, but the subscription is in trial period.
BillingStatusUnpaid represents unpaid status.
default Announcement Message for the shellhub namespace.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UserAuthMethodLocal indicates that the user can authenticate using an email and password.
UserAuthMethodManual indicates that the user can authenticate using a third-party SAML application.
UserOriginLocal indicates that the user was created through the standard signup process, without using third-party integrations like SSO IdPs.
UserOriginSAML indicates that the user was created using a SAML method.
UserStatusConfirmed indicates that the user has completed the registration process and confirmed their email address.
UserStatusInvited applies to cloud-only instances.
UserStatusNotConfirmed applies to cloud-only instances.
# Structs
No description provided by the author
APIKey is used to authenticate a request.
APIKeyChanges specifies the attributes that can be updated for an API key.
APIKeyConflicts holds API keys attributes that must be unique for each item (per tenant ID) and can be utilized in queries to identify conflicts.
No description provided by the author
Billing contains information about the ShellHub's subscription.
BillingEvaluation contains information about the billing evaluation of acceptance and connection.
No description provided by the author
No description provided by the author
ConnectorData contains the mutable data for each Connector.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Filter is a helper struct to filter results from the database.
FirewallFilter contains the filter rule of a Public Key.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PublicKeyFilter contains the filter rule of a Public Key.
No description provided by the author
NOTE: This struct has been moved to the cloud repo as it is only used in a cloud context; however, it is also utilized by migrations.
No description provided by the author
SessionEvent represents a session event.
SessionEvents stores the events registered in a session.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UserChanges specifies the attributes that can be updated for a user.
UserConflicts holds user attributes that must be unique for each itam and can be utilized in queries to identify conflicts.
No description provided by the author
No description provided by the author
UserMFA represents the attributes related to MFA for a user.
No description provided by the author
No description provided by the author
No description provided by the author
NOTE: This struct has been moved to the cloud repo as it is only used in a cloud context; however, it is also utilized by migrations.
# Type aliases
BillingStatus represents the status of a subscription.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UserAuthIdentifier is an username or email used to authenticate.
No description provided by the author
No description provided by the author
No description provided by the author