clerk

package module

Go to main page

Versions in this module

v2

v2.2.0

Nov 12, 2024

Changes in this version

+ type Invitations struct

+ Invitations []*Invitation

v2.1.1

Oct 31, 2024

Changes in this version

type Organization

+ MissingMemberWithElevatedPermissions *bool

v2.1.0

Oct 29, 2024

Changes in this version

type OrganizationInvitation

+ RoleName string

type OrganizationMembership

+ RoleName string

+ type SignInToken struct

+ CreatedAt int64

+ ID string

+ Object string

+ Status string

+ Token string

+ URL *string

+ UpdatedAt int64

+ UserID string

type User

+ LegalAcceptedAt *int64

v2.0.9

Oct 2, 2024

Changes in this version

type Invitation

+ ExpiresAt *int64

+ type OrganizationDomain struct

+ AffiliationEmailAddress *string

+ CreatedAt int64

+ EnrollmentMode string

+ ID string

+ Name string

+ Object string

+ OrganizationID string

+ TotalPendingInvitations int64

+ TotalPendingSuggestions int64

+ UpdatedAt int64

+ Verification *OrganizationDomainVerification

+ type OrganizationDomainList struct

+ OrganizationDomains []*OrganizationDomain

+ TotalCount int64

+ type OrganizationDomainVerification struct

+ Attempts int64

+ ExpireAt *int64

+ Status string

+ Strategy string

type OrganizationInvitation

+ PublicOrganizationData *PublicOrganizationData

+ type OrganizationInvitationList struct

+ OrganizationInvitations []*OrganizationInvitation

+ TotalCount int64

+ type PublicOrganizationData struct

+ HasImage bool

+ ID string

+ ImageURL *string

+ Name string

+ Slug string

type SAMLConnection

+ DisableAdditionalIdentifications bool

+ OrganizationID *string

type Session

+ LatestActivity *SessionActivity

+ type SessionActivity struct

+ BrowserName *string

+ BrowserVersion *string

+ City *string

+ Country *string

+ DeviceType *string

+ ID string

+ IPAddress *string

+ IsMobile bool

+ Object string

+ type TOTP struct

+ BackupCodes []string

+ CreatedAt int64

+ ID string

+ Object string

+ Secret *string

+ URI *string

+ UpdatedAt int64

+ Verified bool

v2.0.8

Sep 3, 2024

v2.0.7

Sep 2, 2024

v2.0.6

Aug 29, 2024

Changes in this version

+ type Invitation struct

+ CreatedAt int64

+ EmailAddress string

+ ID string

+ Object string

+ PublicMetadata json.RawMessage

+ Revoked bool

+ Status string

+ URL string

+ UpdatedAt int64

+ type InvitationList struct

+ Invitations []*Invitation

+ TotalCount int64

v2.0.5

Jul 24, 2024

Changes in this version

type Template

+ CanToggle bool

+ Enabled bool

type User

+ CreateOrganizationsLimit *int

v2.0.4

May 13, 2024

Changes in this version

type InstanceRestrictions

+ IgnoreDotsForGmailAddresses bool

+ type TestingToken struct

+ ExpiresAt int64

+ Object string

+ Token string

v2.0.3

Apr 18, 2024

Changes in this version

+ func JSONRawMessage(v json.RawMessage) *json.RawMessage

+ type ClientConfig struct

+ type Clock interface

+ Now func() time.Time

+ func NewClock() Clock

type OAuthAccessToken

+ ExternalAccountID string

+ type SAMLConnection struct

+ AcsURL string

+ Active bool

+ AllowIdpInitiated bool

+ AllowSubdomains bool

+ AttributeMapping SAMLConnectionAttributeMapping

+ CreatedAt int64

+ Domain string

+ ID string

+ IdpCertificate *string

+ IdpEntityID *string

+ IdpMetadata *string

+ IdpMetadataURL *string

+ IdpSsoURL *string

+ Name string

+ Object string

+ Provider string

+ SPEntityID string

+ SPMetadataURL string

+ SyncUserAttributes bool

+ UpdatedAt int64

+ UserCount int64

+ type SAMLConnectionAttributeMapping struct

+ EmailAddress string

+ FirstName string

+ LastName string

+ UserID string

+ type SAMLConnectionList struct

+ SAMLConnections []*SAMLConnection

+ TotalCount int64

type Template

+ ReplyToEmailName *string

type TemplatePreview

+ ReplyToEmailAddress *string

v2.0.2-beta.10

Apr 17, 2024

v2.0.2-beta.9

Apr 17, 2024

v2.0.2-beta.8

Apr 16, 2024

v2.0.2-beta.7

Apr 2, 2024

v2.0.2-beta.6

Mar 29, 2024

v2.0.2-beta.5

Mar 28, 2024

v2.0.2-beta.4

Mar 22, 2024

v2.0.2-beta.3

Mar 2, 2024

v2.0.2-beta.2

Mar 1, 2024

v2.0.2-beta.1

Feb 28, 2024

v2.0.2-beta.0

Feb 27, 2024

v2.0.1-beta.1

Feb 23, 2024

v2.0.1-beta.0

Feb 22, 2024

v2.0.0

Feb 22, 2024

Changes in this version

+ const APIURL

+ func Bool(v bool) *bool

+ func ContextWithSessionClaims(ctx context.Context, value any) context.Context

+ func Int64(v int64) *int64

+ func JoinPath(base string, elem ...string) (string, error)

+ func SetBackend(b Backend)

+ func SetKey(key string)

+ func String(v string) *string

+ type APIErrorResponse struct

+ Errors []Error

+ HTTPStatusCode int

+ TraceID string

+ func (resp *APIErrorResponse) Error() string

+ type APIParams struct

+ func (params *APIParams) ToMultipart() ([]byte, string, error)

+ func (params *APIParams) ToQuery() url.Values

+ type APIRequest struct

+ Method string

+ Params Params

+ Path string

+ func NewAPIRequest(method, path string) *APIRequest

+ func NewMultipartAPIRequest(method, path string) *APIRequest

+ func (req *APIRequest) SetParams(params Params)

+ type APIResource struct

+ Response *APIResponse

+ func (r *APIResource) Read(response *APIResponse)

+ type APIResponse struct

+ Header http.Header

+ RawJSON json.RawMessage

+ Status string

+ StatusCode int

+ TraceID string

+ func NewAPIResponse(resp *http.Response, body json.RawMessage) *APIResponse

+ func (resp *APIResponse) Success() bool

+ type ActorToken struct

+ Actor json.RawMessage

+ CreatedAt int64

+ ID string

+ Object string

+ Status string

+ Token string

+ URL *string

+ UpdatedAt int64

+ UserID string

+ type AllowlistIdentifier struct

+ CreatedAt int64

+ ID string

+ Identifier string

+ IdentifierType string

+ InvitationID *string

+ Object string

+ UpdatedAt int64

+ type AllowlistIdentifierList struct

+ AllowlistIdentifiers []*AllowlistIdentifier

+ TotalCount int64

+ type Backend interface

+ Call func(context.Context, *APIRequest, ResponseReader) error

+ func GetBackend() Backend

+ func NewBackend(config *BackendConfig) Backend

+ type BackendConfig struct

+ CustomRequestHeaders *CustomRequestHeaders

+ HTTPClient *http.Client

+ Key *string

+ URL *string

+ type BlocklistIdentifier struct

+ CreatedAt int64

+ ID string

+ Identifier string

+ IdentifierType string

+ Object string

+ UpdatedAt int64

+ type BlocklistIdentifierList struct

+ BlocklistIdentifiers []*BlocklistIdentifier

+ TotalCount int64

+ type CNAMETarget struct

+ Host string

+ Value string

+ type Claims struct

+ ActiveOrganizationID string

+ ActiveOrganizationPermissions []string

+ ActiveOrganizationRole string

+ ActiveOrganizationSlug string

+ Actor json.RawMessage

+ AuthorizedParty string

+ SessionID string

+ type Client struct

+ CreatedAt int64

+ ID string

+ LastActiveSessionID *string

+ Object string

+ SessionIDs []string

+ Sessions []*Session

+ SignInID *string

+ SignUpID *string

+ UpdatedAt int64

+ type ClientList struct

+ Clients []*Client

+ TotalCount int64

+ type CustomRequestHeaders struct

+ Application string

+ type DeletedResource struct

+ Deleted bool

+ ID string

+ Object string

+ Slug string

+ type Domain struct

+ AccountPortalURL *string

+ CNAMETargets []CNAMETarget

+ DevelopmentOrigin string

+ FrontendAPIURL string

+ ID string

+ IsSatellite bool

+ Name string

+ Object string

+ ProxyURL *string

+ type DomainList struct

+ Domains []*Domain

+ TotalCount int64

+ type EmailAddress struct

+ EmailAddress string

+ ID string

+ LinkedTo []*LinkedIdentification

+ Object string

+ Reserved bool

+ Verification *Verification

+ type Error struct

+ Code string

+ LongMessage string

+ Message string

+ Meta json.RawMessage

+ type ExternalAccount struct

+ ApprovedScopes string

+ AvatarURL string

+ EmailAddress string

+ FirstName string

+ ID string

+ IdentificationID string

+ ImageURL *string

+ Label *string

+ LastName string

+ Object string

+ Provider string

+ ProviderUserID string

+ PublicMetadata json.RawMessage

+ Username *string

+ Verification *Verification

+ type InstanceRestrictions struct

+ Allowlist bool

+ BlockDisposableEmailDomains bool

+ BlockEmailSubaddresses bool

+ Blocklist bool

+ Object string

+ type JSONWebKey struct

+ Algorithm string

+ Key any

+ KeyID string

+ Use string

+ func JSONWebKeyFromPEM(key string) (*JSONWebKey, error)

+ func (k *JSONWebKey) UnmarshalJSON(data []byte) error

+ type JSONWebKeySet struct

+ Keys []*JSONWebKey

+ type JWTTemplate struct

+ AllowedClockSkew int64

+ Claims json.RawMessage

+ CreatedAt int64

+ CustomSigningKey bool

+ ID string

+ Lifetime int64

+ Name string

+ Object string

+ SigningAlgorithm string

+ UpdatedAt int64

+ type JWTTemplateList struct

+ JWTTemplates []*JWTTemplate

+ TotalCount int64

+ type LinkedIdentification struct

+ ID string

+ Type string

+ type ListParams struct

+ Limit *int64

+ Offset *int64

+ func (params ListParams) ToQuery() url.Values

+ type OAuthAccessToken struct

+ Label *string

+ Object string

+ Provider string

+ PublicMetadata json.RawMessage

+ Scopes []string

+ Token string

+ TokenSecret *string

+ type OAuthAccessTokenList struct

+ OAuthAccessTokens []*OAuthAccessToken

+ TotalCount int64

+ type Organization struct

+ AdminDeleteEnabled bool

+ CreatedAt int64

+ CreatedBy string

+ HasImage bool

+ ID string

+ ImageURL *string

+ MaxAllowedMemberships int64

+ MembersCount *int64

+ Name string

+ Object string

+ PendingInvitationsCount *int64

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

+ Slug string

+ UpdatedAt int64

+ type OrganizationInvitation struct

+ CreatedAt int64

+ EmailAddress string

+ ID string

+ Object string

+ OrganizationID string

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

+ Role string

+ Status string

+ UpdatedAt int64

+ type OrganizationList struct

+ Organizations []*Organization

+ TotalCount int64

+ type OrganizationMembership struct

+ CreatedAt int64

+ ID string

+ Object string

+ Organization *Organization

+ Permissions []string

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

+ PublicUserData *OrganizationMembershipPublicUserData

+ Role string

+ UpdatedAt int64

+ type OrganizationMembershipList struct

+ OrganizationMemberships []*OrganizationMembership

+ TotalCount int64

+ type OrganizationMembershipPublicUserData struct

+ FirstName *string

+ HasImage bool

+ Identifier string

+ ImageURL *string

+ LastName *string

+ UserID string

+ type OrganizationSettings struct

+ AdminDeleteEnabled bool

+ CreatorRole string

+ DomainsDefaultRole string

+ DomainsEnabled bool

+ DomainsEnrollmentModes []string

+ Enabled bool

+ MaxAllowedMemberships int64

+ MaxAllowedPermissions int64

+ MaxAllowedRoles int64

+ Object string

+ type Params interface

+ ToMultipart func() ([]byte, string, error)

+ ToQuery func() url.Values

+ type PhoneNumber struct

+ BackupCodes []string

+ DefaultSecondFactor bool

+ ID string

+ LinkedTo []*LinkedIdentification

+ Object string

+ PhoneNumber string

+ Reserved bool

+ ReservedForSecondFactor bool

+ Verification *Verification

+ type ProxyCheck struct

+ CreatedAt int64

+ DomainID string

+ ID string

+ LastRunAt *int64

+ Object string

+ ProxyURL string

+ Successful bool

+ UpdatedAt int64

+ type RedirectURL struct

+ CreatedAt int64

+ ID string

+ Object string

+ URL string

+ UpdatedAt int64

+ type RedirectURLList struct

+ RedirectURLs []*RedirectURL

+ TotalCount int64

+ type RegisteredClaims struct

+ Audience []string

+ Expiry *int64

+ ID string

+ IssuedAt *int64

+ Issuer string

+ NotBefore *int64

+ Subject string

+ func (c *RegisteredClaims) UnmarshalJSON(data []byte) error

+ func (c *RegisteredClaims) ValidateWithLeeway(expected time.Time, leeway time.Duration) error

+ type ResponseReader interface

+ Read func(*APIResponse)

+ type SAMLAccount struct

+ Active bool

+ EmailAddress string

+ FirstName *string

+ ID string

+ LastName *string

+ Object string

+ Provider string

+ ProviderUserID *string

+ PublicMetadata json.RawMessage

+ Verification *Verification

+ type Session struct

+ AbandonAt int64

+ Actor json.RawMessage

+ ClientID string

+ CreatedAt int64

+ ExpireAt int64

+ ID string

+ LastActiveAt int64

+ LastActiveOrganizationID string

+ Object string

+ Status string

+ UpdatedAt int64

+ UserID string

+ type SessionClaims struct

+ Custom any

+ func SessionClaimsFromContext(ctx context.Context) (*SessionClaims, bool)

+ func (s *SessionClaims) HasPermission(permission string) bool

+ func (s *SessionClaims) HasRole(role string) bool

+ func (s *SessionClaims) UnmarshalJSON(data []byte) error

+ type SessionList struct

+ Sessions []*Session

+ TotalCount int64

+ type SvixWebhook struct

+ SvixURL string

+ type Template struct

+ AvailableVariables []string

+ Body string

+ CanDelete bool

+ CanRevert bool

+ CreatedAt int64

+ DeliveredByClerk bool

+ FromEmailName *string

+ Markup string

+ Name string

+ Object string

+ Position int

+ RequiredVariables []string

+ ResourceType string

+ Slug string

+ Subject string

+ TemplateType TemplateType

+ UpdatedAt int64

+ type TemplateList struct

+ Templates []*Template

+ TotalCount int64

+ type TemplatePreview struct

+ Body string

+ FromEmailAddress *string

+ Subject string

+ type TemplateType string

+ const TemplateTypeEmail

+ const TemplateTypeSMS

+ type UnverifiedToken struct

+ Extra map[string]any

+ KeyID string

+ type User struct

+ BackupCodeEnabled bool

+ Banned bool

+ CreateOrganizationEnabled bool

+ CreatedAt int64

+ DeleteSelfEnabled bool

+ EmailAddresses []*EmailAddress

+ ExternalAccounts []*ExternalAccount

+ ExternalID *string

+ FirstName *string

+ HasImage bool

+ ID string

+ ImageURL *string

+ LastActiveAt *int64

+ LastName *string

+ LastSignInAt *int64

+ Locked bool

+ LockoutExpiresInSeconds *int64

+ Object string

+ PasswordEnabled bool

+ PasswordLastUpdatedAt *int64

+ PhoneNumbers []*PhoneNumber

+ PrimaryEmailAddressID *string

+ PrimaryPhoneNumberID *string

+ PrimaryWeb3WalletID *string

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

+ SAMLAccounts []*SAMLAccount

+ TOTPEnabled bool

+ TwoFactorEnabled bool

+ UnsafeMetadata json.RawMessage

+ UpdatedAt int64

+ Username *string

+ VerificationAttemptsRemaining *int64

+ Web3Wallets []*Web3Wallet

+ type UserList struct

+ TotalCount int64

+ Users []*User

+ type Verification struct

+ Attempts *int64

+ Error json.RawMessage

+ ExpireAt *int64

+ ExternalVerificationRedirectURL *string

+ Nonce *string

+ Status string

+ Strategy string

+ VerifiedAtClient string

+ type Web3Wallet struct

+ ID string

+ Object string

+ Verification *Verification

+ Web3Wallet string

v2.0.0-beta.1

Feb 22, 2024

v2.0.0-beta

Feb 22, 2024

v2.0.0-32f2af8

Feb 2, 2024

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL