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

Interface OidcAuthSchemeService

All Known Implementing Classes:

SuperUserOidcAuthSchemeService

public interface OidcAuthSchemeService

Method Summary

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

Method Details

getAuthSchemes

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

Lists all OidcAuthScheme instances

Parameters:

offset -

count -

tags -

Returns:

a Pagination of OidcAuthScheme instances

getAuthScheme

OidcAuthScheme getAuthScheme(String authSchemeId)

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

Parameters:

authSchemeId - the auth scheme ID

Returns:

the OidcAuthScheme, never null

updateAuthScheme

CreateOrUpdateOidcAuthSchemeResponse updateAuthScheme(String authSchemeId,
 CreateOrUpdateOidcAuthSchemeRequest authSchemeRequest)

Updates the supplied OidcAuthScheme

Parameters:

authSchemeId -

authSchemeRequest - the CreateOrUpdateOidcAuthSchemeRequest with the information to update the auth scheme. Returns error if the auth scheme does not exist.

Returns:

a CreateOrUpdateOidcAuthSchemeResponse as it was updated.

createAuthScheme

CreateOrUpdateOidcAuthSchemeResponse createAuthScheme(CreateOrUpdateOidcAuthSchemeRequest authSchemeRequest)

Creates an OidcAuthScheme. Returns error if scheme already exists.

Parameters:

authSchemeRequest - the CreateOrUpdateOidcAuthSchemeRequest with the information to create the auth scheme.

Returns:

a CreateOrUpdateOidcAuthSchemeResponse as it was created

deleteAuthScheme

void deleteAuthScheme(String authSchemeId)

Deletes the OidcAuthScheme with the supplied auth scheme ID.

Parameters:

authSchemeId - the auth scheme ID.