How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

lakeFS external API

The external API from lakeFS — 4 operation(s) for external.

lakeFS external API is one of 17 APIs that lakeFS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, /api/v1.

5 operations 4 paths 8 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
/api/v1
Authentication
HTTP Basic, HTTP Bearer, API Key, API Key, API Key
License
Resource Areas
1

Authentication & Security 5

lakeFS external API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_auth). It accepts HTTP bearer tokens (JWT) (jwt_token). An API key is passed in the cookie as internal_auth_session (cookie_auth). An API key is passed in the cookie as oidc_auth_session (oidc_auth). An API key is passed in the cookie as saml_auth_session (saml_auth). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

external 5
POST
/auth/external/principal/login
perform a login using an external authenticator
externalPrincipalLogin body → 200400401403404429default
POST
/auth/users/{userId}/external/principals
attach external principal to user
createUserExternalPrincipal 2 params body → 201400401404409429default
DELETE
/auth/users/{userId}/external/principals
delete external principal from user
deleteUserExternalPrincipal 2 params → 204400401404429default
GET
/auth/users/{userId}/external/principals/ls
list user external policies attached to a user
listUserExternalPrincipals 4 params → 200400401404429default
GET
/auth/external/principals
describe external principal by id
getExternalPrincipal 1 param → 200400401404429default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Pagination (4 properties), ExternalPrincipal (3 properties), ExternalLoginInformation (2 properties), ExternalPrincipalList (2 properties). Each schema is shown below with its type and property counts.

Pagination
object
4 properties 4 required
ExternalPrincipalSettings
object
Additional settings to be consumed by the remote authenticator
Error
object
1 property 1 required
ExternalPrincipal
object
3 properties 2 required
ExternalPrincipalCreation
object
1 property
ExternalPrincipalList
object
2 properties 2 required
ExternalLoginInformation
object
2 properties 1 required
AuthenticationToken
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lakefs-external-api-openapi.yml Raw ↑

Other APIs lakeFS publishes across the network.

lakeFS actions API
lakeFS auth API
lakeFS branches API
lakeFS commits API
lakeFS config API
lakeFS experimental API
lakeFS healthCheck API
lakeFS import API
lakeFS internal API
lakeFS metadata API
lakeFS objects API
lakeFS pulls API
Where this information came from

This is an independent, third-party profile of lakeFS external API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.