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 auth API

The auth API from lakeFS — 23 operation(s) for auth.

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

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

This API exposes 37 operations across 23 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

37 operations 23 paths 25 schemas 8 DELETE17 GET8 POST4 PUT

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 auth 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 37

Across 23 paths, the API surfaces 37 operations — 8 DELETE, 17 GET, 8 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

auth 37
GET
/user
get current user
getCurrentUser → 200
POST
/auth/login
perform a login
login body → 200400401429default
POST
/auth/external/principal/login
perform a login using an external authenticator
externalPrincipalLogin body → 200400401403404429default
GET
/auth/users
list users
listUsers 3 params → 200400401429default
POST
/auth/users
create user
createUser body → 201400401409429default
GET
/auth/users/{userId}
get user
getUser 1 param → 200400401404429default
DELETE
/auth/users/{userId}
delete user
deleteUser 1 param → 204400401404429default
GET
/auth/groups
list groups
listGroups 3 params → 200400401429default
POST
/auth/groups
create group
createGroup body → 201400401404429default
GET
/auth/groups/{groupId}
get group
getGroup 1 param → 200400401404429default
DELETE
/auth/groups/{groupId}
delete group
deleteGroup 1 param → 204400401404429default
GET
/auth/policies
list policies
listPolicies 3 params → 200400401429default
POST
/auth/policies
create policy
createPolicy body → 201400401409429default
GET
/auth/policies/{policyId}
get policy
getPolicy 1 param → 200400401404429default
PUT
/auth/policies/{policyId}
update policy
updatePolicy 1 param body → 200400401404429default
DELETE
/auth/policies/{policyId}
delete policy
deletePolicy 1 param → 204400401404429default
GET
/auth/groups/{groupId}/members
list group members
listGroupMembers 4 params → 200400401429default
PUT
/auth/groups/{groupId}/members/{userId}
add group membership
addGroupMembership 2 params → 201400401404429default
DELETE
/auth/groups/{groupId}/members/{userId}
delete group membership
deleteGroupMembership 2 params → 204400401404429default
GET
/auth/users/{userId}/credentials
list user credentials
listUserCredentials 4 params → 200400401404429default
POST
/auth/users/{userId}/credentials
create credentials
createCredentials 1 param → 201400401404429default
DELETE
/auth/users/{userId}/credentials/{accessKeyId}
delete credentials
deleteCredentials 2 params → 204400401404429default
GET
/auth/users/{userId}/credentials/{accessKeyId}
get credentials
getCredentials 2 params → 200400401404429default
GET
/auth/users/{userId}/groups
list user groups
listUserGroups 4 params → 200400401404429default
GET
/auth/users/{userId}/policies
list user policies
listUserPolicies 5 params → 200400401404429default
PUT
/auth/users/{userId}/policies/{policyId}
attach policy to user
attachPolicyToUser 2 params → 201400401404429default
DELETE
/auth/users/{userId}/policies/{policyId}
detach policy from user
detachPolicyFromUser 2 params → 204400401404429default
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
GET
/auth/groups/{groupId}/policies
list group policies
listGroupPolicies 4 params → 200400401404429default
PUT
/auth/groups/{groupId}/policies/{policyId}
attach policy to group
attachPolicyToGroup 2 params → 201400401404429default
DELETE
/auth/groups/{groupId}/policies/{policyId}
detach policy from group
detachPolicyFromGroup 2 params → 204400401404429default
POST
/auth/groups/{groupId}/acl
set ACL of group
setGroupACL 1 param body → 201400401404429default
GET
/auth/groups/{groupId}/acl
get ACL of group
getGroupACL 1 param → 200400401404429default
GET
/oidc/callback
oauthCallback → 302401default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are User (4 properties), Pagination (4 properties), Group (4 properties), Statement (4 properties). Each schema is shown below with its type and property counts.

Group
object
4 properties 2 required
PolicyList
object
2 properties 2 required
LoginInformation
object
2 properties 2 required
GroupCreation
object
2 properties 1 required
CredentialsList
object
2 properties 2 required
Credentials
object
2 properties 2 required
ExternalPrincipal
object
3 properties 2 required
ExternalPrincipalCreation
object
1 property
ExternalLoginInformation
object
2 properties 1 required
UserCreation
object
2 properties 1 required
ExternalPrincipalSettings
object
Additional settings to be consumed by the remote authenticator
PolicyCondition
object
Condition operator (e.g., IpAddress)
Statement
object
4 properties 3 required
Error
object
1 property 1 required
ErrorNoACL
object
2 properties 1 required
Pagination
object
4 properties 4 required
GroupList
object
2 properties 2 required
CurrentUser
object
1 property 1 required
Policy
object
3 properties 2 required
ACL
object
1 property 1 required
ExternalPrincipalList
object
2 properties 2 required
User
object
4 properties 2 required
CredentialsWithSecret
object
3 properties 3 required
UserList
object
2 properties 2 required
AuthenticationToken
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lakefs-auth-api-openapi.yml Raw ↑

Other APIs lakeFS publishes across the network.

lakeFS actions API
lakeFS branches API
lakeFS commits API
lakeFS config API
lakeFS experimental API
lakeFS external 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 auth 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.