Package dev.getelements.elements.sdk.service.auth

Interface AuthSchemeService

All Known Implementing Classes:

SuperUserAuthSchemeService

public interface AuthSchemeService

Manages instances of AuthScheme. Created by robb on 11/12/21.

Method Summary

Modifier and Type	Method	Description
CreateAuthSchemeResponse	createAuthScheme(CreateAuthSchemeRequest authSchemeRequest)	Creates an AuthScheme
void	deleteAuthScheme(String authSchemeId)	Deletes the AuthScheme with the supplied auth scheme ID.
AuthScheme	getAuthScheme(String authSchemeId)	Fetches a specific AuthScheme instance based on ID.
Pagination<AuthScheme>	getAuthSchemes(int offset, int count, List<String> tags)	Lists all AuthScheme instances
UpdateAuthSchemeResponse	updateAuthScheme(String authSchemeId, UpdateAuthSchemeRequest authSchemeRequest)	Updates the supplied AuthScheme

Method Details

getAuthSchemes

Pagination<AuthScheme> getAuthSchemes(int offset,
 int count,
 List<String> tags)

Lists all AuthScheme instances

Parameters:

offset -

count -

tags -

Returns:

a Pagination of AuthScheme instances

getAuthScheme

AuthScheme getAuthScheme(String authSchemeId)

Fetches a specific AuthScheme instance based on ID. If not found, an exception is raised.

Parameters:

authSchemeId - the auth scheme ID

Returns:

the AuthScheme, never null

updateAuthScheme

UpdateAuthSchemeResponse updateAuthScheme(String authSchemeId,
 UpdateAuthSchemeRequest authSchemeRequest)

Updates the supplied AuthScheme

Parameters:

authSchemeId -

authSchemeRequest - the UpdateAuthSchemeRequest with the information to update the authScheme

Returns:

a UpdateAuthSchemeResponse as it was created

createAuthScheme

CreateAuthSchemeResponse createAuthScheme(CreateAuthSchemeRequest authSchemeRequest)

Creates an AuthScheme

Parameters:

authSchemeRequest - the CreateAuthSchemeRequest with the information to create the authScheme

Returns:

a CreateAuthSchemeResponse as it was created

deleteAuthScheme

void deleteAuthScheme(String authSchemeId)

Deletes the AuthScheme with the supplied auth scheme ID.

Parameters:

authSchemeId - the auth scheme ID.