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

Interface OAuth2AuthSchemeService

All Known Implementing Classes:

SuperUserOAuth2AuthSchemeService

public interface OAuth2AuthSchemeService

Method Summary

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

Method Details

getAuthSchemes

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

Lists all OAuth2AuthScheme instances

Parameters:

offset -

count -

tags -

Returns:

a Pagination of OAuth2AuthScheme instances

getAuthScheme

OAuth2AuthScheme getAuthScheme(String authSchemeId)

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

Parameters:

authSchemeId - the auth scheme ID

Returns:

the OAuth2AuthScheme, never null

updateAuthScheme

CreateOrUpdateOAuth2AuthSchemeResponse updateAuthScheme(String authSchemeId,
 CreateOrUpdateOAuth2AuthSchemeRequest authSchemeRequest)

Updates the supplied OAuth2AuthScheme

Parameters:

authSchemeId -

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

Returns:

a CreateOrUpdateOAuth2AuthSchemeResponse as it was updated.

createAuthScheme

CreateOrUpdateOAuth2AuthSchemeResponse createAuthScheme(CreateOrUpdateOAuth2AuthSchemeRequest authSchemeRequest)

Creates an OAuth2AuthScheme. Returns error if scheme already exists.

Parameters:

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

Returns:

a CreateOrUpdateOAuth2AuthSchemeResponse as it was created

deleteAuthScheme

void deleteAuthScheme(String authSchemeId)

Deletes the OAuth2AuthScheme with the supplied auth scheme ID.

Parameters:

authSchemeId - the auth scheme ID.