clerk

May 30, 2024

Changes in this version

type ActorTokenResponse

+ URL *string

type CreateSAMLConnectionParams

+ AttributeMapping *SAMLConnectionAttributeMapping

+ IdpMetadata *string

+ IdpMetadataURL *string

+ Provider string

type InstanceRestrictionsResponse

+ IgnoreDotsForGmailAddresses bool

type OrganizationSettingsResponse

+ MaxAllowedPermissions int

+ MaxAllowedRoles int

type PreviewTemplateRequest

+ ReplyToEmailName *string

+ 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 SAMLConnection

+ AllowIdpInitiated bool

+ AllowSubdomains bool

+ AttributeMapping SAMLConnectionAttributeMapping

+ IdpMetadata *string

+ IdpMetadataURL *string

+ SPMetadataURL string

+ type SAMLConnectionAttributeMapping struct

+ EmailAddress string

+ FirstName string

+ LastName string

+ UserID string

type SessionClaims

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

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

+ type SessionToken struct

+ JWT string

+ Object string

type SessionsService

+ func (s *SessionsService) CreateTokenFromTemplate(sessionID, templateSlug string) (*SessionToken, error)

type Template

+ ReplyToEmailName *string

type UpdateRestrictionsParams

+ IgnoreDotsForGmailAddresses *bool

type UpdateSAMLConnectionParams

+ AllowIdpInitiated *bool

+ AllowSubdomains *bool

+ AttributeMapping *SAMLConnectionAttributeMapping

+ IdpMetadata *string

+ IdpMetadataURL *string

type UpsertTemplateRequest

+ ReplyToEmailName *string

type User

+ SAMLAccounts []*SAMLAccount

type UserOAuthAccessToken

+ ExternalAccountID string

Jan 9, 2024

Changes in this version

+ const ProxyChecksURL

type Client

+ ProxyChecks func() *ProxyChecksService

+ type CreateProxyCheckParams struct

+ DomainID string

+ ProxyURL string

type ListAllUsersParams

+ LastActiveAtSince *int64

type OrganizationSettingsResponse

+ CreatorRole string

+ DomainsDefaultRole string

+ type ProxyCheck struct

+ CreatedAt int64

+ DomainID string

+ ID string

+ LastRunAt *int64

+ Object string

+ ProxyURL string

+ Successful bool

+ UpdatedAt int64

+ type ProxyChecksService service

+ func (s *ProxyChecksService) Create(params CreateProxyCheckParams) (*ProxyCheck, error)

type SessionClaims

+ ActiveOrganizationPermissions []string

+ Actor json.RawMessage

type UpdateOrganizationSettingsParams

+ CreatorRoleID *string

+ DomainsDefaultRoleID *string

type User

+ LastActiveAt *int64

+ LockoutExpiresInSeconds *int64

+ VerificationAttemptsRemaining *int64

Oct 13, 2023

Changes in this version

type ListAllUsersParams

+ ExternalIDs []string

type TemplatesService

+ func (s *TemplatesService) ToggleDelivery(templateType, slug string, ...) (*TemplateExtended, error)

+ type ToggleDeliveryTemplateRequest struct

+ DeliveredByClerk bool

type User

+ Locked bool

type UsersService

+ func (s *UsersService) Lock(userID string) (*User, error)

+ func (s *UsersService) Unlock(userID string) (*User, error)

type VerifyTokenOption

+ func WithProxyURL(proxyURL string) VerifyTokenOption

+ func WithSatelliteDomain(isSatellite bool) VerifyTokenOption

Sep 26, 2023

Changes in this version

type InstanceRestrictionsResponse

+ BlockDisposableEmailDomains bool

type OrganizationSettingsResponse

+ DomainsEnabled bool

+ DomainsEnrollmentModes []string

type Session

+ CreatedAt int64

+ LastActiveOrganizationID string

+ UpdatedAt int64

type UpdateOrganizationSettingsParams

+ DomainsEnabled *bool

+ DomainsEnrollmentModes []string

type UpdateRestrictionsParams

+ BlockDisposableEmailDomains *bool

Aug 7, 2023

Changes in this version

type InstanceRestrictionsResponse

+ BlockEmailSubaddresses bool

Aug 7, 2023

Changes in this version

type UpdateRestrictionsParams

+ BlockEmailSubaddresses *bool

Jul 27, 2023

Changes in this version

type Organization

+ HasImage bool

type User

+ HasImage bool

+ ImageURL *string

type ΟrganizationMembershipPublicUserData

+ HasImage bool

Jul 24, 2023

Changes in this version

+ const DomainsURL

type Client

+ Domains func() *DomainsService

+ type CreateDomainParams struct

+ IsSatellite bool

+ Name string

+ ProxyURL *string

+ type Domain struct

+ AccountsPortalURL *string

+ CNameTargets []DomainCNameTarget

+ DevelopmentOrigin string

+ FapiURL string

+ ID string

+ IsSatellite bool

+ Name string

+ Object string

+ ProxyURL *string

+ type DomainCNameTarget struct

+ Host string

+ Value string

+ type DomainListResponse struct

+ Data []Domain

+ TotalCount int

+ type DomainsService service

+ func (s *DomainsService) Create(params CreateDomainParams) (*Domain, error)

+ func (s *DomainsService) Delete(domainID string) (*DeleteResponse, error)

+ func (s *DomainsService) ListAll() (*DomainListResponse, error)

+ func (s *DomainsService) Update(domainID string, params UpdateDomainParams) (*Domain, error)

+ type UpdateDomainParams struct

+ Name *string

+ ProxyURL *string

Jun 27, 2023

Changes in this version

type OrganizationsService

+ func (s *OrganizationsService) DeleteLogo(organizationID string) (*Organization, error)

Jun 22, 2023

Changes in this version

type OrganizationsService

+ func (s *OrganizationsService) UpdateLogo(organizationID string, params UpdateOrganizationLogoParams) (*Organization, error)

+ type UpdateOrganizationLogoParams struct

+ File multipart.File

+ Filename *string

+ UploaderUserID string

Jun 13, 2023

Changes in this version

type UpdateOrganizationParams

+ Slug *string

Jun 5, 2023

Changes in this version

type Organization

+ AdminDeleteEnabled bool

type OrganizationSettingsResponse

+ AdminDeleteEnabled bool

type SAMLConnection

+ SyncUserAttributes bool

type UpdateOrganizationParams

+ AdminDeleteEnabled *bool

type UpdateOrganizationSettingsParams

+ AdminDeleteEnabled *bool

type UpdateSAMLConnectionParams

+ SyncUserAttributes *bool

May 22, 2023

Changes in this version

type ListAllOrganizationsParams

+ OrderBy *string

May 19, 2023

Changes in this version

+ type ListAllSessionsParams struct

+ ClientID *string

+ Limit *int

+ Offset *int

+ Status *SessionStatus

+ UserID *string

type ListSAMLConnectionsParams

+ OrderBy *string

+ Query *string

type SAMLConnection

+ Provider string

+ UserCount int64

+ type SessionStatus string

+ const SessionStatusAbandoned

+ const SessionStatusActive

+ const SessionStatusEnded

+ const SessionStatusExpired

+ const SessionStatusRemoved

+ const SessionStatusReplaced

+ const SessionStatusRevoked

type SessionsService

+ func (s *SessionsService) ListAllWithFiltering(params ListAllSessionsParams) ([]Session, error)

May 9, 2023

Changes in this version

+ type ListSAMLConnectionsParams struct

+ Limit *int

+ Offset *int

+ type ListSAMLConnectionsResponse struct

+ Data []SAMLConnection

+ TotalCount int64

type ΟrganizationMembershipPublicUserData

+ ImageURL *string

May 9, 2023

Changes in this version

+ const SAMLConnectionsUrl

type Client

+ SAMLConnections func() *SAMLConnectionsService

+ type CreateSAMLConnectionParams struct

+ Domain string

+ IdpCertificate string

+ IdpEntityID string

+ IdpSsoURL string

+ Name string

type Organization

+ ImageURL *string

+ type SAMLConnection struct

+ AcsURL string

+ Active bool

+ CreatedAt int64

+ Domain string

+ ID string

+ IdpCertificate string

+ IdpEntityID string

+ IdpSsoURL string

+ Name string

+ Object string

+ SPEntityID string

+ UpdatedAt int64

+ type SAMLConnectionsService service

+ func (s SAMLConnectionsService) Create(params *CreateSAMLConnectionParams) (*SAMLConnection, error)

+ func (s SAMLConnectionsService) Delete(id string) (*DeleteResponse, error)

+ func (s SAMLConnectionsService) ListAll() ([]SAMLConnection, error)

+ func (s SAMLConnectionsService) Read(id string) (*SAMLConnection, error)

+ func (s SAMLConnectionsService) Update(id string, params *UpdateSAMLConnectionParams) (*SAMLConnection, error)

+ type UpdateSAMLConnectionParams struct

+ Active *bool

+ Domain *string

+ IdpCertificate *string

+ IdpEntityID *string

+ IdpSsoURL *string

+ Name *string

Apr 12, 2023

Changes in this version

type UpdateUser

+ SignOutOfOtherSessions *bool

+ SkipPasswordChecks *bool

Apr 11, 2023

Changes in this version

type InstanceService

+ func (s *InstanceService) UpdateHomeURL(params UpdateHomeURLParams) error

+ type UpdateHomeURLParams struct

+ HomeURL string

Apr 7, 2023

Changes in this version

type UpdateInstanceParams

+ DisableSignUps *bool

Apr 5, 2023

Changes in this version

type UpdateInstanceParams

+ DevelopmentOrigin *string

Mar 16, 2023

Changes in this version

type ListAllOrganizationsParams

+ UserIDs []string

Mar 9, 2023

Changes in this version

+ type ListMembershipsParams struct

+ Limit *int

+ Offset *int

+ UserID string

+ type PaginationParams struct

+ Limit *int

+ Offset *int

type UsersService

+ func (s *UsersService) ListMemberships(params ListMembershipsParams) (*ListOrganizationMembershipsResponse, error)

Mar 9, 2023

Changes in this version

type Organization

+ CreatedBy string

Feb 17, 2023

Changes in this version

type ListAllOrganizationsParams

+ Query string

type UpdateInstanceParams

+ URLBasedSessionSyncing *bool

Jan 31, 2023

Changes in this version

type ListOrganizationMembershipsParams

+ Roles []string

Jan 27, 2023

Changes in this version

type OrganizationsService

+ func (s *OrganizationsService) DeleteMembership(organizationID, userID string) (*OrganizationMembership, error)

Jan 26, 2023

Changes in this version

+ type CreateOrganizationMembershipParams struct

+ Role string

+ UserID string

+ type ListOrganizationMembershipsParams struct

+ EmailAddresses []string

+ Limit *int

+ Offset *int

+ OrderBy *string

+ OrganizationID string

+ PhoneNumbers []string

+ Query *string

+ UserIDs []string

+ Usernames []string

+ Web3Wallets []string

+ type ListOrganizationMembershipsResponse struct

+ Data []OrganizationMembership

+ TotalCount int64

+ type OrganizationMembership struct

+ CreatedAt int64

+ ID string

+ Object string

+ Organization *Organization

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

+ PublicUserData *ΟrganizationMembershipPublicUserData

+ Role string

+ UpdatedAt int64

type OrganizationsService

+ func (s *OrganizationsService) CreateMembership(organizationID string, params CreateOrganizationMembershipParams) (*OrganizationMembership, error)

+ func (s *OrganizationsService) ListMemberships(params ListOrganizationMembershipsParams) (*ListOrganizationMembershipsResponse, error)

+ func (s *OrganizationsService) UpdateMembership(organizationID string, params UpdateOrganizationMembershipParams) (*OrganizationMembership, error)

+ type UpdateOrganizationMembershipParams struct

+ Role string

+ UserID string

+ type ΟrganizationMembershipPublicUserData struct

+ FirstName *string

+ Identifier string

+ LastName *string

+ ProfileImageURL string

+ UserID string

Jan 20, 2023

Changes in this version

type CreateUserParams

+ CreatedAt *string

+ ExternalID *string

+ SkipPasswordChecks *bool

+ SkipPasswordRequirement *bool

type UpdateUser

+ CreatedAt *string

+ ExternalID *string

+ PrimaryWeb3WalletID *string

+ ProfileImageID *string

+ Username *string

type User

+ ExternalID *string

+ PrimaryWeb3WalletID *string

+ Web3Wallets []Web3Wallet

+ type UserOAuthAccessToken struct

+ Label *string

+ Object string

+ Provider string

+ PublicMetadata json.RawMessage

+ Scopes []string

+ Token string

+ TokenSecret *string

type UsersService

+ func (s *UsersService) ListOAuthAccessTokens(userID, provider string) ([]*UserOAuthAccessToken, error)

+ type Web3Wallet struct

+ ID string

+ Object string

+ Verification *Verification

+ Web3Wallet string

Jan 13, 2023

Changes in this version

type UpdateOrganizationParams

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

Dec 21, 2022

Changes in this version

type OrganizationsService

+ func (s *OrganizationsService) UpdateMetadata(organizationID string, params UpdateOrganizationMetadataParams) (*Organization, error)

+ type UpdateOrganizationMetadataParams struct

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

Dec 13, 2022

Changes in this version

type OrganizationsService

+ func (s *OrganizationsService) Read(organizationIDOrSlug string) (*Organization, error)

Nov 18, 2022

Changes in this version

+ const EmailAddressesURL

+ const InvitationsURL

+ const PhoneNumbersURL

type Client

+ EmailAddresses func() *EmailAddressesService

+ PhoneNumbers func() *PhoneNumbersService

+ type CreateEmailAddressParams struct

+ EmailAddress string

+ Primary *bool

+ UserID string

+ Verified *bool

+ type CreateOrganizationInvitationParams struct

+ EmailAddress string

+ InviterUserID string

+ OrganizationID string

+ PublicMetadata json.RawMessage

+ RedirectURL string

+ Role string

+ type CreatePhoneNumberParams struct

+ PhoneNumber string

+ Primary *bool

+ UserID string

+ Verified *bool

type CreateUserParams

+ PasswordDigest *string

+ PasswordHasher *string

type EmailAddress

+ Reserved bool

+ type EmailAddressesService service

+ func (s *EmailAddressesService) Create(params CreateEmailAddressParams) (*EmailAddress, error)

+ func (s *EmailAddressesService) Delete(emailAddressID string) (*DeleteResponse, error)

+ func (s *EmailAddressesService) Read(emailAddressID string) (*EmailAddress, error)

+ func (s *EmailAddressesService) Update(emailAddressID string, params UpdateEmailAddressParams) (*EmailAddress, error)

+ type OrganizationInvitation struct

+ CreatedAt int64

+ EmailAddress string

+ ID string

+ Object string

+ OrganizationID string

+ PublicMetadata json.RawMessage

+ Role string

+ Status string

+ UpdatedAt int64

type OrganizationsService

+ func (s *OrganizationsService) CreateInvitation(params CreateOrganizationInvitationParams) (*OrganizationInvitation, error)

type PhoneNumber

+ BackupCodes []string

+ DefaultSecondFactor bool

+ Reserved bool

+ type PhoneNumbersService service

+ func (s *PhoneNumbersService) Create(params CreatePhoneNumberParams) (*PhoneNumber, error)

+ func (s *PhoneNumbersService) Delete(phoneNumberID string) (*DeleteResponse, error)

+ func (s *PhoneNumbersService) Read(phoneNumberID string) (*PhoneNumber, error)

+ func (s *PhoneNumbersService) Update(phoneNumberID string, params UpdatePhoneNumberParams) (*PhoneNumber, error)

+ type UpdateEmailAddressParams struct

+ Primary *bool

+ Verified *bool

type UpdateInstanceParams

+ CookielessDev *bool

+ type UpdatePhoneNumberParams struct

+ Primary *bool

+ Verified *bool

+ type Verification struct

+ Attempts *int

+ Error []byte

+ ExpireAt *int64

+ ExternalVerificationRedirectURL *string

+ Nonce *string

+ Status string

+ Strategy string

+ VerifiedAtClient string

Oct 13, 2022

Changes in this version

type CreateUserParams

+ BackupCodes []string

type SessionClaims

+ ActiveOrganizationID string

+ ActiveOrganizationRole string

+ ActiveOrganizationSlug string

type UpdateUser

+ BackupCodes []string

+ TOTPSecret *string

Oct 12, 2022

Changes in this version

+ type CreateOrganizationParams struct

+ CreatedBy string

+ MaxAllowedMemberships *int

+ Name string

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

+ Slug *string

type Organization

+ MaxAllowedMemberships int

type OrganizationSettingsResponse

+ MaxAllowedMemberships int

type OrganizationsService

+ func (s *OrganizationsService) Create(params CreateOrganizationParams) (*Organization, error)

+ func (s *OrganizationsService) Delete(organizationID string) (*DeleteResponse, error)

+ func (s *OrganizationsService) Update(organizationID string, params UpdateOrganizationParams) (*Organization, error)

+ type UpdateOrganizationParams struct

+ MaxAllowedMemberships *int

+ Name *string

type UpdateOrganizationSettingsParams

+ MaxAllowedMemberships *int

Oct 7, 2022

Changes in this version

type InstanceService

+ func (s *InstanceService) UpdateOrganizationSettings(params UpdateOrganizationSettingsParams) (*OrganizationSettingsResponse, error)

+ type OrganizationSettingsResponse struct

+ Enabled bool

+ Object string

+ type UpdateOrganizationSettingsParams struct

+ Enabled *bool

type User

+ BackupCodeEnabled bool

+ TOTPEnabled bool

Sep 19, 2022

Changes in this version

+ const ActorTokensUrl

+ type ActorTokenResponse struct

+ Actor json.RawMessage

+ CreatedAt int64

+ ID string

+ Object string

+ Status string

+ Token string

+ UpdatedAt int64

+ UserID string

+ type ActorTokenService service

+ func (s *ActorTokenService) Create(params CreateActorTokenParams) (*ActorTokenResponse, error)

+ func (s *ActorTokenService) Revoke(actorTokenID string) (*ActorTokenResponse, error)

type Client

+ ActorTokens func() *ActorTokenService

+ type CreateActorTokenParams struct

+ Actor json.RawMessage

+ ExpiresInSeconds *int

+ SessionMaxDurationInSeconds *int

+ UserID string

Sep 14, 2022

Changes in this version

type User

+ Banned bool

+ type UserDisableMFAResponse struct

+ UserID string

type UsersService

+ func (s *UsersService) Ban(userID string) (*User, error)

+ func (s *UsersService) DisableMFA(userID string) (*UserDisableMFAResponse, error)

+ func (s *UsersService) Unban(userID string) (*User, error)

Sep 5, 2022

Changes in this version

+ const ImpersonationTokensUrl

type Client

+ ImpersonationTokens func() *ImpersonationTokenService

+ type CreateImpersonationTokenParams struct

+ ActorID string

+ ExpiresInSeconds *int

+ SubjectID string

+ type ImpersonationTokenRespose struct

+ ActorID string

+ CreatedAt int64

+ ID string

+ Object string

+ Status string

+ SubjectID string

+ Token string

+ UpdatedAt int64

+ type ImpersonationTokenService service

+ func (s *ImpersonationTokenService) Create(params CreateImpersonationTokenParams) (*ImpersonationTokenRespose, error)

+ func (s *ImpersonationTokenService) Revoke(impersonationTokenID string) (*ImpersonationTokenRespose, error)

Aug 29, 2022

Changes in this version

type AllowlistIdentifierResponse

+ IdentifierType string

type BlocklistIdentifierResponse

+ IdentifierType string

type CreateUserParams

+ TOTPSecret *string

Aug 27, 2022

Changes in this version

+ type CreateUserParams struct

+ EmailAddresses []string

+ FirstName *string

+ LastName *string

+ Password *string

+ PhoneNumbers []string

+ PrivateMetadata *json.RawMessage

+ PublicMetadata *json.RawMessage

+ UnsafeMetadata *json.RawMessage

+ Username *string

+ Web3Wallets []string

type UsersService

+ func (s *UsersService) Create(params CreateUserParams) (*User, error)

Aug 22, 2022

Changes in this version

+ const AllowlistsUrl

+ type AllowlistIdentifierResponse struct

+ CreatedAt int64

+ ID string

+ Identifier string

+ InvitationID string

+ Object string

+ UpdatedAt int64

+ type AllowlistIdentifiersResponse struct

+ Data []*AllowlistIdentifierResponse

+ TotalCount int64

+ type AllowlistsService service

+ func (s *AllowlistsService) CreateIdentifier(params CreateAllowlistIdentifierParams) (*AllowlistIdentifierResponse, error)

+ func (s *AllowlistsService) DeleteIdentifier(identifierID string) (*DeleteResponse, error)

+ func (s *AllowlistsService) ListAllIdentifiers() (*AllowlistIdentifiersResponse, error)

type Client

+ Allowlists func() *AllowlistsService

+ type CreateAllowlistIdentifierParams struct

+ Identifier string

+ Notify bool

+ type InstanceRestrictionsResponse struct

+ Allowlist bool

+ Blocklist bool

+ Object string

type InstanceService

+ func (s *InstanceService) UpdateRestrictions(params UpdateRestrictionsParams) (*InstanceRestrictionsResponse, error)

+ type UpdateRestrictionsParams struct

+ Allowlist *bool

+ Blocklist *bool

Aug 19, 2022

Changes in this version

+ const BlocklistsUrl

+ type BlocklistIdentifierResponse struct

+ CreatedAt int64

+ ID string

+ Identifier string

+ Object string

+ UpdatedAt int64

+ type BlocklistIdentifiersResponse struct

+ Data []*BlocklistIdentifierResponse

+ TotalCount int64

+ type BlocklistsService service

+ func (s *BlocklistsService) CreateIdentifier(params CreateBlocklistIdentifierParams) (*BlocklistIdentifierResponse, error)

+ func (s *BlocklistsService) DeleteIdentifier(identifierID string) (*DeleteResponse, error)

+ func (s *BlocklistsService) ListAllIdentifiers() (*BlocklistIdentifiersResponse, error)

type Client

+ Blocklists func() *BlocklistsService

+ type CreateBlocklistIdentifierParams struct

+ Identifier string

type UpdateInstanceParams

+ ClerkJSVersion *string

Aug 2, 2022

Changes in this version

type UpdateUser

+ UnsafeMetadata interface{}

type User

+ UnsafeMetadata interface{}

Jul 29, 2022

Changes in this version

+ const RedirectURLsUrl

type Client

+ RedirectURLs func() *RedirectURLsService

+ type CreateRedirectURLParams struct

+ URL string

+ type RedirectURLResponse struct

+ CreatedAt int64

+ ID string

+ Object string

+ URL string

+ UpdatedAt int64

+ type RedirectURLsService service

+ func (s *RedirectURLsService) Create(params CreateRedirectURLParams) (*RedirectURLResponse, error)

+ func (s *RedirectURLsService) Delete(redirectURLID string) (*DeleteResponse, error)

+ func (s *RedirectURLsService) ListAll() ([]*RedirectURLResponse, error)

Jul 28, 2022

Changes in this version

type UpdateInstanceParams

+ EnhancedEmailDeliverability *bool

Jul 28, 2022

Changes in this version

type UpdateInstanceParams

+ SupportEmail *string

Jul 27, 2022

Changes in this version

type Client

+ Instances func() *InstanceService

+ type InstanceService service

+ func (s *InstanceService) Update(params UpdateInstanceParams) error

+ type UpdateInstanceParams struct

+ HIBP *bool

+ TestMode *bool

Jul 22, 2022

Changes in this version

+ type UpdateUserMetadata struct

+ PrivateMetadata interface{}

+ PublicMetadata interface{}

+ UnsafeMetadata interface{}

type UsersService

+ func (s *UsersService) UpdateMetadata(userId string, updateMetadataRequest *UpdateUserMetadata) (*User, error)

Jul 20, 2022

Changes in this version

type VerifyTokenOption

+ func WithCustomClaims(customClaims interface{}) VerifyTokenOption

Jul 19, 2022

Changes in this version

type ListAllOrganizationsParams

+ IncludeMembersCount bool

type Organization

+ MembersCount int

Jul 5, 2022

Changes in this version

+ const OrganizationsUrl

type Client

+ Organizations func() *OrganizationsService

type EmailResponse

+ Data json.RawMessage

+ DeliveredByClerk bool

+ type ListAllOrganizationsParams struct

+ Limit *int

+ Offset *int

+ type Organization struct

+ CreatedAt int64

+ ID string

+ LogoURL *string

+ Name string

+ Object string

+ PrivateMetadata json.RawMessage

+ PublicMetadata json.RawMessage

+ Slug *string

+ UpdatedAt int64

+ type OrganizationsResponse struct

+ Data []Organization

+ TotalCount int64

+ type OrganizationsService service

+ func (s *OrganizationsService) ListAll(params ListAllOrganizationsParams) (*OrganizationsResponse, error)

type PreviewTemplateRequest

+ FromEmailName *string

type SMSMessageResponse

+ Data json.RawMessage

+ DeliveredByClerk bool

type Template

+ DeliveredByClerk bool

+ FromEmailName *string

type TemplatePreview

+ FromEmailAddress *string

type UpsertTemplateRequest

+ DeliveredByClerk *bool

+ FromEmailName *string

Apr 4, 2022

Changes in this version

type Template

+ ResourceType string

type User

+ LastSignInAt *int64

type VerifyTokenOption

+ func WithJWTVerificationKey(key string) VerifyTokenOption

+ func WithLeeway(leeway time.Duration) VerifyTokenOption

Mar 22, 2022

Changes in this version

+ const UsersCountUrl

type ListAllUsersParams

+ OrderBy *string

+ Query *string

+ UserIDs []string

+ Usernames []string

+ Web3Wallets []string

+ type UserCount struct

+ Object string

+ TotalCount int

type UsersService

+ func (s *UsersService) Count(params ListAllUsersParams) (*UserCount, error)

Feb 1, 2022

Changes in this version

+ const JWTTemplatesUrl

+ const TemplatesUrl

+ type ClerkOption func(*client) error

+ func WithBaseURL(rawURL string) ClerkOption

+ func WithHTTPClient(httpClient *http.Client) ClerkOption

type Client

+ JWTTemplates func() *JWTTemplatesService

+ Templates func() *TemplatesService

+ type CreateUpdateJWTTemplate struct

+ AllowedClockSkew *int

+ Claims map[string]interface{}

+ CustomSigningKey bool

+ Lifetime *int

+ Name string

+ SigningAlgorithm *string

+ SigningKey *string

type DeleteResponse

+ Slug string

+ type JWTTemplate struct

+ AllowedClockSkew int

+ Claims json.RawMessage

+ CreatedAt int64

+ CustomSigningKey bool

+ ID string

+ Lifetime int

+ Name string

+ Object string

+ SigningAlgorithm string

+ UpdatedAt int64

+ type JWTTemplatesService service

+ func (s JWTTemplatesService) Create(params *CreateUpdateJWTTemplate) (*JWTTemplate, error)

+ func (s JWTTemplatesService) Delete(id string) (*DeleteResponse, error)

+ func (s JWTTemplatesService) ListAll() ([]JWTTemplate, error)

+ func (s JWTTemplatesService) Read(id string) (*JWTTemplate, error)

+ func (s JWTTemplatesService) Update(id string, params *CreateUpdateJWTTemplate) (*JWTTemplate, error)

+ type PreviewTemplateRequest struct

+ Body string

+ Subject string

type SessionClaims

+ AuthorizedParty string

+ type Template struct

+ CanDelete bool

+ CanRevert bool

+ CreatedAt int64

+ Name string

+ Object string

+ Position int

+ Slug string

+ TemplateType string

+ UpdatedAt int64

+ type TemplateExtended struct

+ AvailableVariables []string

+ Body string

+ Markup string

+ RequiredVariables []string

+ Subject string

+ type TemplatePreview struct

+ Body string

+ Subject string

+ type TemplatesService service

+ func (s *TemplatesService) Delete(templateType, slug string) (*DeleteResponse, error)

+ func (s *TemplatesService) ListAll(templateType string) ([]Template, error)

+ func (s *TemplatesService) Preview(templateType, slug string, previewTemplateRequest *PreviewTemplateRequest) (*TemplatePreview, error)

+ func (s *TemplatesService) Read(templateType, slug string) (*TemplateExtended, error)

+ func (s *TemplatesService) Revert(templateType, slug string) (*TemplateExtended, error)

+ func (s *TemplatesService) Upsert(templateType, slug string, upsertTemplateRequest *UpsertTemplateRequest) (*TemplateExtended, error)

+ type UpsertTemplateRequest struct

+ Body string

+ Markup string

+ Name string

+ Subject string

+ type VerifyTokenOption func(*verifyTokenOptions)

+ func WithAuthorizedParty(parties ...string) VerifyTokenOption

Oct 21, 2021

Changes in this version

+ const ActiveSessionClaims

+ func RequireSessionV2(client Client) func(handler http.Handler) http.Handler

+ func WithSessionV2(client Client) func(handler http.Handler) http.Handler

type Client

+ APIKey func() string

+ DecodeToken func(token string) (*TokenClaims, error)

+ Interstitial func() ([]byte, error)

+ JWKS func() *JWKSService

+ VerifyToken func(token string) (*SessionClaims, error)

+ type JWKS jose.JSONWebKeySet

+ type JWKSService service

+ func (s *JWKSService) ListAll() (*JWKS, error)

+ type SessionClaims struct

+ SessionID string

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

+ type SvixResponse struct

+ SvixURL string

+ type TokenClaims struct

+ Extra map[string]interface{}

type WebhooksService

+ func (s *WebhooksService) CreateSvix() (*SvixResponse, error)

+ func (s *WebhooksService) DeleteSvix() error

+ func (s *WebhooksService) RefreshSvixURL() (*SvixResponse, error)

May 14, 2021

Changes in this version

+ type ListAllUsersParams struct

+ EmailAddresses []string

+ Limit *int

+ Offset *int

+ PhoneNumbers []string

May 6, 2021

Changes in this version

+ const WebhooksUrl

type Client

+ Webhooks func() *WebhooksService

+ type DiahookResponse struct

+ DiahookURL string

+ type WebhooksService service

+ func (s *WebhooksService) CreateDiahook() (*DiahookResponse, error)

+ func (s *WebhooksService) DeleteDiahook() error

+ func (s *WebhooksService) RefreshDiahookURL() (*DiahookResponse, error)

Apr 22, 2021

Changes in this version

type ClientResponse

+ SessionIDs []string

+ Sessions []*Session

Feb 18, 2021

Changes in this version

type UpdateUser

+ PrivateMetadata interface{}

+ PublicMetadata interface{}

type User

+ PublicMetadata interface{}

Feb 3, 2021

Changes in this version

+ type Error struct

+ Code string

+ LongMessage string

+ Message string

+ Meta interface{}

+ type ErrorResponse struct

+ Errors []Error

+ Response *http.Response

+ func (e *ErrorResponse) Error() string

Jan 22, 2021

Changes in this version

type Client

+ func NewClientWithCustomHTTP(token string, urlStr string, httpClient *http.Client) (Client, error)

Jan 19, 2021

Changes in this version

+ const ActiveSession

+ const ClientsUrl

+ const ClientsVerifyUrl

+ const CookieSession

+ const EmailsUrl

+ const OriginHeader

+ const ProdUrl

+ const QueryParamSessionId

+ const SMSUrl

+ const SessionsUrl

+ const UsersUrl

+ func WithSession(client Client) func(handler http.Handler) http.Handler

type Client

+ Clients func() *ClientsService

+ Verification func() *VerificationService

+ type ClientResponse struct

+ Ended bool

+ ID string

+ LastActiveSessionID *string

+ Object string

+ SignInAttemptID *string

+ SignUpAttemptID *string

+ type ClientsService service

+ func (s *ClientsService) ListAll() ([]ClientResponse, error)

+ func (s *ClientsService) Read(clientId string) (*ClientResponse, error)

+ func (s *ClientsService) Verify(token string) (*ClientResponse, error)

type EmailResponse

+ ToEmailAddress *string

type SMSMessageResponse

+ ToPhoneNumber *string

type SessionsService

+ func (s *SessionsService) Verify(sessionId string, token string) (*Session, error)

+ type VerificationService service

+ func (s *VerificationService) Verify(req *http.Request) (*Session, error)

Jan 15, 2021

Changes in this version

+ type Client interface

+ Do func(req *http.Request, v interface{}) (*http.Response, error)

+ Emails func() *EmailService

+ NewRequest func(method string, url string, body ...interface{}) (*http.Request, error)

+ SMS func() *SMSService

+ Sessions func() *SessionsService

+ Users func() *UsersService

+ func NewClient(token string) (Client, error)

+ func NewClientWithBaseUrl(token string, baseUrl string) (Client, error)

+ type DeleteResponse struct

+ Deleted bool

+ ID string

+ Object string

+ type Email struct

+ Body string

+ EmailAddressID *string

+ FromEmailName string

+ Subject string

+ ToEmailAddress *string

+ type EmailAddress struct

+ EmailAddress string

+ ID string

+ LinkedTo []IdentificationLink

+ Object string

+ Verification interface{}

+ type EmailResponse struct

+ ID string

+ Object string

+ Status string

+ type EmailService service

+ func (s *EmailService) Create(email Email) (*EmailResponse, error)

+ type IdentificationLink struct

+ IdentID string

+ IdentType string

+ type PhoneNumber struct

+ ID string

+ LinkedTo []IdentificationLink

+ Object string

+ PhoneNumber string

+ ReservedForSecondFactor bool

+ Verification interface{}

+ type SMSMessage struct

+ Message string

+ PhoneNumberID *string

+ ToPhoneNumber *string

+ type SMSMessageResponse struct

+ FromPhoneNumber string

+ ID string

+ Object string

+ Status string

+ type SMSService service

+ func (s *SMSService) Create(message SMSMessage) (*SMSMessageResponse, error)

+ type Session struct

+ AbandonAt int64

+ ClientID string

+ ExpireAt int64

+ ID string

+ LastActiveAt int64

+ Object string

+ Status string

+ UserID string

+ type SessionsService service

+ func (s *SessionsService) ListAll() ([]Session, error)

+ func (s *SessionsService) Read(sessionId string) (*Session, error)

+ func (s *SessionsService) Revoke(sessionId string) (*Session, error)

+ type UpdateUser struct

+ FirstName *string

+ LastName *string

+ Password *string

+ PrimaryEmailAddressID *string

+ PrimaryPhoneNumberID *string

+ ProfileImage *string

+ type User struct

+ Birthday *string

+ CreatedAt *time.Time

+ EmailAddresses []EmailAddress

+ ExternalAccounts []interface{}

+ FirstName *string

+ Gender *string

+ ID string

+ LastName *string

+ Metadata interface{}

+ Object string

+ PasswordEnabled bool

+ PhoneNumbers []PhoneNumber

+ PrimaryEmailAddressID *string

+ PrimaryPhoneNumberID *string

+ PrivateMetadata interface{}

+ ProfileImageURL string

+ TwoFactorEnabled bool

+ UpdatedAt *time.Time

+ Username *string

+ type UsersService service

+ func (s *UsersService) Delete(userId string) (*DeleteResponse, error)

+ func (s *UsersService) ListAll() ([]User, error)

+ func (s *UsersService) Read(userId string) (*User, error)

+ func (s *UsersService) Update(userId string, updateRequest *UpdateUser) (*User, error)