Package io.lakefs.clients.sdk

Class AuthApi

java.lang.Object

io.lakefs.clients.sdk.AuthApi

public class AuthApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AuthApi.APIaddGroupMembershipRequest
class	AuthApi.APIattachPolicyToGroupRequest
class	AuthApi.APIattachPolicyToUserRequest
class	AuthApi.APIcreateCredentialsRequest
class	AuthApi.APIcreateGroupRequest
class	AuthApi.APIcreatePolicyRequest
class	AuthApi.APIcreateUserExternalPrincipalRequest
class	AuthApi.APIcreateUserRequest
class	AuthApi.APIdeleteCredentialsRequest
class	AuthApi.APIdeleteGroupMembershipRequest
class	AuthApi.APIdeleteGroupRequest
class	AuthApi.APIdeletePolicyRequest
class	AuthApi.APIdeleteUserExternalPrincipalRequest
class	AuthApi.APIdeleteUserRequest
class	AuthApi.APIdetachPolicyFromGroupRequest
class	AuthApi.APIdetachPolicyFromUserRequest
class	AuthApi.APIexternalPrincipalLoginRequest
class	AuthApi.APIgetCredentialsRequest
class	AuthApi.APIgetCurrentUserRequest
class	AuthApi.APIgetExternalPrincipalRequest
class	AuthApi.APIgetGroupACLRequest
class	AuthApi.APIgetGroupRequest
class	AuthApi.APIgetPolicyRequest
class	AuthApi.APIgetUserRequest
class	AuthApi.APIlistGroupMembersRequest
class	AuthApi.APIlistGroupPoliciesRequest
class	AuthApi.APIlistGroupsRequest
class	AuthApi.APIlistPoliciesRequest
class	AuthApi.APIlistUserCredentialsRequest
class	AuthApi.APIlistUserExternalPrincipalsRequest
class	AuthApi.APIlistUserGroupsRequest
class	AuthApi.APIlistUserPoliciesRequest
class	AuthApi.APIlistUsersRequest
class	AuthApi.APIloginRequest
class	AuthApi.APIsetGroupACLRequest
class	AuthApi.APIupdatePolicyRequest

Constructor Summary

Constructors

Constructor	Description
AuthApi()
AuthApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AuthApi.APIaddGroupMembershipRequest	addGroupMembership(String groupId, String userId)	add group membership
AuthApi.APIattachPolicyToGroupRequest	attachPolicyToGroup(String groupId, String policyId)	attach policy to group
AuthApi.APIattachPolicyToUserRequest	attachPolicyToUser(String userId, String policyId)	attach policy to user
AuthApi.APIcreateCredentialsRequest	createCredentials(String userId)	create credentials
AuthApi.APIcreateGroupRequest	createGroup()	create group
AuthApi.APIcreatePolicyRequest	createPolicy(Policy policy)	create policy
AuthApi.APIcreateUserRequest	createUser()	create user
AuthApi.APIcreateUserExternalPrincipalRequest	createUserExternalPrincipal(String userId, String principalId)	attach external principal to user
AuthApi.APIdeleteCredentialsRequest	deleteCredentials(String userId, String accessKeyId)	delete credentials
AuthApi.APIdeleteGroupRequest	deleteGroup(String groupId)	delete group
AuthApi.APIdeleteGroupMembershipRequest	deleteGroupMembership(String groupId, String userId)	delete group membership
AuthApi.APIdeletePolicyRequest	deletePolicy(String policyId)	delete policy
AuthApi.APIdeleteUserRequest	deleteUser(String userId)	delete user
AuthApi.APIdeleteUserExternalPrincipalRequest	deleteUserExternalPrincipal(String userId, String principalId)	delete external principal from user
AuthApi.APIdetachPolicyFromGroupRequest	detachPolicyFromGroup(String groupId, String policyId)	detach policy from group
AuthApi.APIdetachPolicyFromUserRequest	detachPolicyFromUser(String userId, String policyId)	detach policy from user
AuthApi.APIexternalPrincipalLoginRequest	externalPrincipalLogin()	perform a login using an external authenticator
ApiClient	getApiClient()
AuthApi.APIgetCredentialsRequest	getCredentials(String userId, String accessKeyId)	get credentials
AuthApi.APIgetCurrentUserRequest	getCurrentUser()	get current user
String	getCustomBaseUrl()
AuthApi.APIgetExternalPrincipalRequest	getExternalPrincipal(String principalId)	describe external principal by id
AuthApi.APIgetGroupRequest	getGroup(String groupId)	get group
AuthApi.APIgetGroupACLRequest	getGroupACL(String groupId)	get ACL of group
int	getHostIndex()
AuthApi.APIgetPolicyRequest	getPolicy(String policyId)	get policy
AuthApi.APIgetUserRequest	getUser(String userId)	get user
AuthApi.APIlistGroupMembersRequest	listGroupMembers(String groupId)	list group members
AuthApi.APIlistGroupPoliciesRequest	listGroupPolicies(String groupId)	list group policies
AuthApi.APIlistGroupsRequest	listGroups()	list groups
AuthApi.APIlistPoliciesRequest	listPolicies()	list policies
AuthApi.APIlistUserCredentialsRequest	listUserCredentials(String userId)	list user credentials
AuthApi.APIlistUserExternalPrincipalsRequest	listUserExternalPrincipals(String userId)	list user external policies attached to a user
AuthApi.APIlistUserGroupsRequest	listUserGroups(String userId)	list user groups
AuthApi.APIlistUserPoliciesRequest	listUserPolicies(String userId)	list user policies
AuthApi.APIlistUsersRequest	listUsers()	list users
AuthApi.APIloginRequest	login()	perform a login
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
AuthApi.APIsetGroupACLRequest	setGroupACL(String groupId, ACL ACL)	set ACL of group
void	setHostIndex(int hostIndex)
AuthApi.APIupdatePolicyRequest	updatePolicy(String policyId, Policy policy)	update policy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthApi

public AuthApi()

AuthApi

public AuthApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

addGroupMembership

public AuthApi.APIaddGroupMembershipRequest addGroupMembership(String groupId,
                                                               String userId)

add group membership

Parameters:

groupId - (required)

userId - (required)

Returns:

APIaddGroupMembershipRequest

Http Response Details:

Status Code	Description	Response Headers
201	membership added successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

attachPolicyToGroup

public AuthApi.APIattachPolicyToGroupRequest attachPolicyToGroup(String groupId,
                                                                 String policyId)

attach policy to group

Parameters:

groupId - (required)

policyId - (required)

Returns:

APIattachPolicyToGroupRequest

Http Response Details:

Status Code	Description	Response Headers
201	policy attached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

attachPolicyToUser

public AuthApi.APIattachPolicyToUserRequest attachPolicyToUser(String userId,
                                                               String policyId)

attach policy to user

Parameters:

userId - (required)

policyId - (required)

Returns:

APIattachPolicyToUserRequest

Http Response Details:

Status Code	Description	Response Headers
201	policy attached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

createCredentials

public AuthApi.APIcreateCredentialsRequest createCredentials(String userId)

create credentials

Parameters:

userId - (required)

Returns:

APIcreateCredentialsRequest

Http Response Details:

Status Code	Description	Response Headers
201	credentials	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

createGroup

public AuthApi.APIcreateGroupRequest createGroup()

create group

Returns:

APIcreateGroupRequest

Http Response Details:

Status Code	Description	Response Headers
201	group	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

createPolicy

public AuthApi.APIcreatePolicyRequest createPolicy(Policy policy)

create policy

Parameters:

policy - (required)

Returns:

APIcreatePolicyRequest

Http Response Details:

Status Code	Description	Response Headers
201	policy	-
400	Validation Error	-
401	Unauthorized	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

createUser

public AuthApi.APIcreateUserRequest createUser()

create user

Returns:

APIcreateUserRequest

Http Response Details:

Status Code	Description	Response Headers
201	user	-
400	validation error	-
401	Unauthorized	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

createUserExternalPrincipal

public AuthApi.APIcreateUserExternalPrincipalRequest createUserExternalPrincipal(String userId,
                                                                                 String principalId)

attach external principal to user

Parameters:

userId - (required)

principalId - (required)

Returns:

APIcreateUserExternalPrincipalRequest

Http Response Details:

Status Code	Description	Response Headers
201	external principal attached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

deleteCredentials

public AuthApi.APIdeleteCredentialsRequest deleteCredentials(String userId,
                                                             String accessKeyId)

delete credentials

Parameters:

userId - (required)

accessKeyId - (required)

Returns:

APIdeleteCredentialsRequest

Http Response Details:

Status Code	Description	Response Headers
204	credentials deleted successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

deleteGroup

public AuthApi.APIdeleteGroupRequest deleteGroup(String groupId)

delete group

Parameters:

groupId - (required)

Returns:

APIdeleteGroupRequest

Http Response Details:

Status Code	Description	Response Headers
204	group deleted successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

deleteGroupMembership

public AuthApi.APIdeleteGroupMembershipRequest deleteGroupMembership(String groupId,
                                                                     String userId)

delete group membership

Parameters:

groupId - (required)

userId - (required)

Returns:

APIdeleteGroupMembershipRequest

Http Response Details:

Status Code	Description	Response Headers
204	membership deleted successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

deletePolicy

public AuthApi.APIdeletePolicyRequest deletePolicy(String policyId)

delete policy

Parameters:

policyId - (required)

Returns:

APIdeletePolicyRequest

Http Response Details:

Status Code	Description	Response Headers
204	policy deleted successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

deleteUser

public AuthApi.APIdeleteUserRequest deleteUser(String userId)

delete user

Parameters:

userId - (required)

Returns:

APIdeleteUserRequest

Http Response Details:

Status Code	Description	Response Headers
204	user deleted successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

deleteUserExternalPrincipal

public AuthApi.APIdeleteUserExternalPrincipalRequest deleteUserExternalPrincipal(String userId,
                                                                                 String principalId)

delete external principal from user

Parameters:

userId - (required)

principalId - (required)

Returns:

APIdeleteUserExternalPrincipalRequest

Http Response Details:

Status Code	Description	Response Headers
204	external principal detached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

detachPolicyFromGroup

public AuthApi.APIdetachPolicyFromGroupRequest detachPolicyFromGroup(String groupId,
                                                                     String policyId)

detach policy from group

Parameters:

groupId - (required)

policyId - (required)

Returns:

APIdetachPolicyFromGroupRequest

Http Response Details:

Status Code	Description	Response Headers
204	policy detached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

detachPolicyFromUser

public AuthApi.APIdetachPolicyFromUserRequest detachPolicyFromUser(String userId,
                                                                   String policyId)

detach policy from user

Parameters:

userId - (required)

policyId - (required)

Returns:

APIdetachPolicyFromUserRequest

Http Response Details:

Status Code	Description	Response Headers
204	policy detached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

externalPrincipalLogin

public AuthApi.APIexternalPrincipalLoginRequest externalPrincipalLogin()

perform a login using an external authenticator

Returns:

APIexternalPrincipalLoginRequest

Http Response Details:

Status Code	Description	Response Headers
200	successful external login	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getCredentials

public AuthApi.APIgetCredentialsRequest getCredentials(String userId,
                                                       String accessKeyId)

get credentials

Parameters:

userId - (required)

accessKeyId - (required)

Returns:

APIgetCredentialsRequest

Http Response Details:

Status Code	Description	Response Headers
200	credentials	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getCurrentUser

public AuthApi.APIgetCurrentUserRequest getCurrentUser()

get current user

Returns:

APIgetCurrentUserRequest

Http Response Details:

Status Code	Description	Response Headers
200	user	-

getExternalPrincipal

public AuthApi.APIgetExternalPrincipalRequest getExternalPrincipal(String principalId)

describe external principal by id

Parameters:

principalId - (required)

Returns:

APIgetExternalPrincipalRequest

Http Response Details:

Status Code	Description	Response Headers
200	external principal	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getGroup

public AuthApi.APIgetGroupRequest getGroup(String groupId)

get group

Parameters:

groupId - (required)

Returns:

APIgetGroupRequest

Http Response Details:

Status Code	Description	Response Headers
200	group	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getGroupACL

public AuthApi.APIgetGroupACLRequest getGroupACL(String groupId)

get ACL of group

Parameters:

groupId - (required)

Returns:

APIgetGroupACLRequest

Http Response Details:

Status Code	Description	Response Headers
200	ACL of group	-
401	Unauthorized	-
404	Group not found, or group found but has no ACL	-
420	too many requests	-
0	Internal Server Error	-

getPolicy

public AuthApi.APIgetPolicyRequest getPolicy(String policyId)

get policy

Parameters:

policyId - (required)

Returns:

APIgetPolicyRequest

Http Response Details:

Status Code	Description	Response Headers
200	policy	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getUser

public AuthApi.APIgetUserRequest getUser(String userId)

get user

Parameters:

userId - (required)

Returns:

APIgetUserRequest

Http Response Details:

Status Code	Description	Response Headers
200	user	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

listGroupMembers

public AuthApi.APIlistGroupMembersRequest listGroupMembers(String groupId)

list group members

Parameters:

groupId - (required)

Returns:

APIlistGroupMembersRequest

Http Response Details:

Status Code	Description	Response Headers
200	group member list	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

listGroupPolicies

public AuthApi.APIlistGroupPoliciesRequest listGroupPolicies(String groupId)

list group policies

Parameters:

groupId - (required)

Returns:

APIlistGroupPoliciesRequest

Http Response Details:

Status Code	Description	Response Headers
200	policy list	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

listGroups

public AuthApi.APIlistGroupsRequest listGroups()

list groups

Returns:

APIlistGroupsRequest

Http Response Details:

Status Code	Description	Response Headers
200	group list	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

listPolicies

public AuthApi.APIlistPoliciesRequest listPolicies()

list policies

Returns:

APIlistPoliciesRequest

Http Response Details:

Status Code	Description	Response Headers
200	policy list	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

listUserCredentials

public AuthApi.APIlistUserCredentialsRequest listUserCredentials(String userId)

list user credentials

Parameters:

userId - (required)

Returns:

APIlistUserCredentialsRequest

Http Response Details:

Status Code	Description	Response Headers
200	credential list	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

listUserExternalPrincipals

public AuthApi.APIlistUserExternalPrincipalsRequest listUserExternalPrincipals(String userId)

list user external policies attached to a user

Parameters:

userId - (required)

Returns:

APIlistUserExternalPrincipalsRequest

Http Response Details:

Status Code	Description	Response Headers
200	external principals list	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

listUserGroups

public AuthApi.APIlistUserGroupsRequest listUserGroups(String userId)

list user groups

Parameters:

userId - (required)

Returns:

APIlistUserGroupsRequest

Http Response Details:

Status Code	Description	Response Headers
200	group list	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

listUserPolicies

public AuthApi.APIlistUserPoliciesRequest listUserPolicies(String userId)

list user policies

Parameters:

userId - (required)

Returns:

APIlistUserPoliciesRequest

Http Response Details:

Status Code	Description	Response Headers
200	policy list	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

listUsers

public AuthApi.APIlistUsersRequest listUsers()

list users

Returns:

APIlistUsersRequest

Http Response Details:

Status Code	Description	Response Headers
200	user list	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

login

public AuthApi.APIloginRequest login()

perform a login

Returns:

APIloginRequest

Http Response Details:

Status Code	Description	Response Headers
200	successful login	* Set-Cookie -
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

setGroupACL

public AuthApi.APIsetGroupACLRequest setGroupACL(String groupId,
                                                 ACL ACL)

set ACL of group

Parameters:

groupId - (required)

ACL - (required)

Returns:

APIsetGroupACLRequest

Http Response Details:

Status Code	Description	Response Headers
201	ACL successfully changed	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

updatePolicy

public AuthApi.APIupdatePolicyRequest updatePolicy(String policyId,
                                                   Policy policy)

update policy

Parameters:

policyId - (required)

policy - (required)

Returns:

APIupdatePolicyRequest

Http Response Details:

Status Code	Description	Response Headers
200	policy	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-