Package io.lakefs.clients.sdk

Class ExternalApi

java.lang.Object

io.lakefs.clients.sdk.ExternalApi

public class ExternalApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ExternalApi.APIcreateUserExternalPrincipalRequest
class	ExternalApi.APIdeleteUserExternalPrincipalRequest
class	ExternalApi.APIexternalPrincipalLoginRequest
class	ExternalApi.APIgetExternalPrincipalRequest
class	ExternalApi.APIlistUserExternalPrincipalsRequest

Constructor Summary

Constructors

Constructor	Description
ExternalApi()
ExternalApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ExternalApi.APIcreateUserExternalPrincipalRequest	createUserExternalPrincipal(String userId, String principalId)	attach external principal to user
ExternalApi.APIdeleteUserExternalPrincipalRequest	deleteUserExternalPrincipal(String userId, String principalId)	delete external principal from user
ExternalApi.APIexternalPrincipalLoginRequest	externalPrincipalLogin()	perform a login using an external authenticator
ApiClient	getApiClient()
String	getCustomBaseUrl()
ExternalApi.APIgetExternalPrincipalRequest	getExternalPrincipal(String principalId)	describe external principal by id
int	getHostIndex()
ExternalApi.APIlistUserExternalPrincipalsRequest	listUserExternalPrincipals(String userId)	list user external policies attached to a user
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalApi

public ExternalApi()

ExternalApi

public ExternalApi(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)

createUserExternalPrincipal

public ExternalApi.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	-

deleteUserExternalPrincipal

public ExternalApi.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	-

externalPrincipalLogin

public ExternalApi.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	-

getExternalPrincipal

public ExternalApi.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	-

listUserExternalPrincipals

public ExternalApi.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	-