Package net.worcade.client.api

Interface CompanyApi

All Superinterfaces:

OptionalFieldsApi, OwnerApi, RemoteIdsApi

public interface CompanyApi
extends OwnerApi, RemoteIdsApi

Method Summary

Modifier and Type	Method	Description
Result<?>	addApplication(String companyId, String applicationId)
Result<?>	addDomains(String companyId, String... domains)
Result<?>	addUser(String companyId, String userId)
Result<? extends Reference>	create(CompanyModification subject)	Create a new Company.
CompanyCreate	createBuilder()
Result<?>	deleteMember(String userId)
Result<? extends Company>	get(String id)
Result<? extends CompanyProfile>	getProfile(String id)
Result<? extends SamlSettings>	getSamlSettings(String companyId)
Result<?>	inviteUser(String companyId, String userId)
Result<?>	removeDomains(String companyId, String... domains)
Result<?>	setSamlSettings(String companyId, String entityId, String metadataUrl, String attributeName, boolean allowCreate)
Result<?>	setSamlSettings(String companyId, String entityId, String ssoServiceUrl, String certificate, String attributeName, boolean allowCreate)
Result<?>	updateMemberProfile(UserModification subject)
Result<?>	updateProfile(CompanyModification subject)

Methods inherited from interface net.worcade.client.api.mixin.OptionalFieldsApi

addOptionalFields, getOptionalFields, removeOptionalFields

Methods inherited from interface net.worcade.client.api.mixin.OwnerApi

addOwners, removeOwners

Methods inherited from interface net.worcade.client.api.mixin.RemoteIdsApi

addRemoteIds, removeRemoteIds, searchByRemoteId

Method Detail

createBuilder

CompanyCreate createBuilder()

get

Result<? extends Company> get(String id)

getProfile

Result<? extends CompanyProfile> getProfile(String id)

create

Result<? extends Reference> create(CompanyModification subject)

Create a new Company. Use the createBuilder() method for a new, empty template.

updateProfile

Result<?> updateProfile(CompanyModification subject)

inviteUser

Result<?> inviteUser(String companyId,
                     String userId)

addUser

Result<?> addUser(String companyId,
                  String userId)

addApplication

Result<?> addApplication(String companyId,
                         String applicationId)

updateMemberProfile

Result<?> updateMemberProfile(UserModification subject)

deleteMember

Result<?> deleteMember(String userId)

addDomains

Result<?> addDomains(String companyId,
                     String... domains)

removeDomains

Result<?> removeDomains(String companyId,
                        String... domains)

getSamlSettings

Result<? extends SamlSettings> getSamlSettings(String companyId)

setSamlSettings

Result<?> setSamlSettings(String companyId,
                          String entityId,
                          String ssoServiceUrl,
                          String certificate,
                          @Nullable
                          String attributeName,
                          boolean allowCreate)

setSamlSettings

Result<?> setSamlSettings(String companyId,
                          String entityId,
                          String metadataUrl,
                          @Nullable
                          String attributeName,
                          boolean allowCreate)