Module: Clerk

Defined in:
lib/clerk.rb,
lib/clerk/sdk.rb,
lib/clerk/utils.rb,
lib/clerk/errors.rb,
lib/clerk/railtie.rb,
lib/clerk/version.rb,
lib/clerk/constants.rb,
lib/clerk/resources/jwks.rb,
lib/clerk/authenticatable.rb,
lib/clerk/rack_middleware.rb,
lib/clerk/resources/users.rb,
lib/clerk/resources/emails.rb,
lib/clerk/resources/clients.rb,
lib/clerk/rack_middleware_v2.rb,
lib/clerk/resources/sessions.rb,
lib/clerk/resources/allowlist.rb,
lib/clerk/authenticate_context.rb,
lib/clerk/authenticate_request.rb,
lib/clerk/resources/organizations.rb,
lib/clerk/resources/phone_numbers.rb,
lib/clerk/resources/email_addresses.rb,
lib/clerk/resources/plural_resource.rb,
lib/clerk/resources/singular_resource.rb,
lib/clerk/resources/allowlist_identifiers.rb

Defined Under Namespace

Modules: AuthErrorReason, Authenticatable, Errors, Resources, TokenVerificationErrorReason, Utils Classes: AuthenticateContext, AuthenticateRequest, Config, Proxy, ProxyV2, RackMiddleware, RackMiddlewareV2, Railtie, SDK

Constant Summary collapse

VERSION = 
"4.0.0.beta2"
"__session".freeze
"__client_uat".freeze
"__clerk_db_jwt".freeze
"__clerk_handshake".freeze
HANDSHAKE_HELP_QUERY_PARAM = 
"__clerk_help".freeze
"handshake".freeze
AUTH_STATUS_HEADER =

auth debug response headers

"X-Clerk-Auth-Status".freeze
AUTH_REASON_HEADER = 
"X-Clerk-Auth-Reason".freeze
AUTH_MESSAGE_HEADER = 
"X-Clerk-Auth-Message".freeze
CONTENT_TYPE_HEADER = 
"Content-Type".freeze
SEC_FETCH_DEST_HEADER = 
"HTTP_SEC_FETCH_DEST".freeze
LOCATION_HEADER =

headers used in response - should be lowered case and without http prefix

"Location".freeze
"Set-Cookie".freeze
AUTHORIZATION_HEADER =

clerk url related headers

"HTTP_AUTHORIZATION".freeze
ACCEPT_HEADER = 
"HTTP_ACCEPT".freeze
USER_AGENT_HEADER = 
"HTTP_USER_AGENT".freeze
ORIGIN_HEADER = 
"HTTP_ORIGIN".freeze

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



13
14
15
 
# File 'lib/clerk.rb', line 13

def configuration
  @configuration ||= Config.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



9
10
11
 
# File 'lib/clerk.rb', line 9

def configure
  yield(configuration)
end