Leapyear Authentication

generated: '2026-07-19'
method: searched
source: https://leapyear-python-docs.readthedocs-hosted.com/en/4.1.1/api/leapyear.html
docs: https://leapyear-python-docs.readthedocs-hosted.com/en/4.1.1/api/leapyear.html
notes: >-
  LeapYear published no OpenAPI, so this profile is taken from the first-party Python
  client reference rather than derived from a spec. LeapYear Core is self-hosted: the
  client authenticates against a customer-operated server, not a public multi-tenant
  endpoint.
summary:
  types:
  - password
  - public-key
  api_key_in: []
  oauth2_flows: []
  token_model: server-issued session token
deployment:
  model: self-hosted
  default_url: http://localhost:4401
  url_env_var: LY_API_URL
  transport: https
  note: >-
    The Client url argument defaults to the LY_API_URL environment variable, falling
    back to http://localhost:4401. Documented examples use port 4401 over TLS.
schemes:
- name: username-password
  type: password
  description: >-
    Client(url=..., username=..., password=...) logs the user in through the default
    ly_login authenticate callback, which returns a LeapYear token held for the life
    of the connection.
  parameters:
  - username
  - password
  source: https://leapyear-python-docs.readthedocs-hosted.com/en/4.1.1/api/leapyear.html
- name: public-key
  type: public-key
  description: >-
    Client(..., public_key_auth=True) authenticates with public key credentials instead
    of a password. Credential problems surface as PublicKeyCredentialsError.
  parameters:
  - public_key_auth
  source: https://leapyear-python-docs.readthedocs-hosted.com/en/4.1.1/api/leapyear.html
- name: custom-authenticate-callback
  type: pluggable
  description: >-
    The authenticate parameter accepts a callback that performs the login and returns
    a LeapYear token, allowing a deployment to substitute its own identity flow.
  parameters:
  - authenticate
  source: https://leapyear-python-docs.readthedocs-hosted.com/en/4.1.1/api/leapyear.html
session:
  connection_lifecycle: >-
    Connections are opened explicitly and closed with Client.close(), or managed with
    the Client context manager.
  token_expiry_error: TokenExpiredError
authorization:
  model: role and grant based
  subjects:
  - User
  - Group
  resources:
  - Database
  - Table
  - View
  controls:
  - get_access / set_access with DatabaseAccessType
  - leapyear.admin.grants permission grants
  - Privacy Profile and privacy limit per database
  source: https://leapyear-python-docs.readthedocs-hosted.com/en/4.1.1/api/admin.html