public class SFAccountsEntity extends SFEntitiesBase
client| Constructor and Description |
|---|
SFAccountsEntity(ISFApiClient client) |
| Modifier and Type | Method and Description |
|---|---|
ISFQuery<SFAccessControlDomains> |
createFolderAccessControlDomains(SFAccessControlDomains accessControlDomains)
Create or replace the Folder Access Control List of domains
{
"AccessControlType" : "AllowedDomains",
"Domains": ["domainA", "domainB", ...]
}
|
ISFQuery<SFAccessControlDomains> |
createLoginAccessControlDomains(SFAccessControlDomains accessControlDomains)
Create or replace the Login Access Control List of domains
{
"AccessControlType" : "AllowedDomains",
"Domains": ["domainA", "domainB", ...]
}
|
ISFQuery |
deleteFolderAccessControlDomains(SFAccessControlDomains accessControlDomains)
Delete domains from the Folder Access Control List of domains
{
"AccessControlType" : "AllowedDomains",
"Domains": ["domainA", "domainB", ...]
}
Deletes the specified domains from the list.
|
ISFQuery |
deleteLoginAccessControlDomains(SFAccessControlDomains accessControlDomains)
Delete domains from the Logins Access Control List of domains
{
"AccessControlType" : "AllowedDomains",
"Domains": ["domainA", "domainB", ...]
}
Deletes the specified domains from the list.
|
ISFQuery<SFFindSubdomainResult> |
findSubdomain(SFFindSubdomainParams findSubdomainParams)
Find Subdomain
{
"UsernameShort":"usernameShort",
"Password":"pass",
"EmployeeOnly":false
}
Find the user account information based on the short username
|
ISFQuery<SFFindSubdomainResult> |
findSubdomain(SFFindSubdomainParams findSubdomainParams,
java.lang.Boolean singlePlane)
Find Subdomain
{
"UsernameShort":"usernameShort",
"Password":"pass",
"EmployeeOnly":false
}
Find the user account information based on the short username
|
ISFQuery<SFAccount> |
get()
Get current Account
Retrieves information about the Account defined in the call subdomain
|
ISFQuery<SFAccount> |
get(java.lang.String id)
Get current Account
Retrieves information about the Account defined in the call subdomain
|
ISFQuery<SFODataFeed<SFContact>> |
getAddressBook()
Get Account AddressBooks
Retrieves an address book from the account.
|
ISFQuery<SFODataFeed<SFContact>> |
getAddressBook(java.lang.String type)
Get Account AddressBooks
Retrieves an address book from the account.
|
ISFQuery<SFODataFeed<SFContact>> |
getAddressBook(java.lang.String type,
java.lang.String searchTerm)
Get Account AddressBooks
Retrieves an address book from the account.
|
ISFQuery<SFAccount> |
getBranding()
Get current Account branding
Retrievs Branding information about the subdomain account.
|
ISFQuery<SFODataFeed<SFAccount>> |
getByUser(SFODataObject parameters,
java.lang.String username)
Get List of Accounts for User
{
"password":"password"
}
Retrieve the list of Accounts associated with a given user
All parameters to this call may be passed in the Post body as root JSON parameters, or in the URI -
with the exception of password that must be provided in the POST body.
|
ISFQuery<SFODataFeed<SFAccount>> |
getByUser(SFODataObject parameters,
java.lang.String username,
java.lang.Boolean employeesonly)
Get List of Accounts for User
{
"password":"password"
}
Retrieve the list of Accounts associated with a given user
All parameters to this call may be passed in the Post body as root JSON parameters, or in the URI -
with the exception of password that must be provided in the POST body.
|
ISFQuery<SFODataFeed<SFAccount>> |
getByUser(SFODataObject parameters,
java.lang.String username,
java.lang.Boolean employeesonly,
java.lang.Boolean requirehomefolders)
Get List of Accounts for User
{
"password":"password"
}
Retrieve the list of Accounts associated with a given user
All parameters to this call may be passed in the Post body as root JSON parameters, or in the URI -
with the exception of password that must be provided in the POST body.
|
ISFQuery<SFODataFeed<SFAccount>> |
getByUser(SFODataObject parameters,
java.lang.String username,
java.lang.Boolean employeesonly,
java.lang.Boolean requirehomefolders,
java.lang.Boolean singleplane)
Get List of Accounts for User
{
"password":"password"
}
Retrieve the list of Accounts associated with a given user
All parameters to this call may be passed in the Post body as root JSON parameters, or in the URI -
with the exception of password that must be provided in the POST body.
|
ISFQuery<SFODataFeed<SFContact>> |
getClients()
Get List of current Account Clients
Retrieves the list of Clients in the Account.
|
ISFQuery<SFODataFeed<SFContact>> |
getEmployees()
Get List of current Account Employees
Retrives the list of Employees in the Account
Employees are named users in the Account.
|
ISFQuery<SFAccessControlDomains> |
getFolderAccessControlDomains()
Get the Folder Access Control List of domains
Retrieve the list of domains that are allowed or disallowed to have access to folders.
|
ISFQuery<SFAccessControlDomains> |
getLoginAccessControlDomains()
Get the Login Access Control List of domains
Retrieve the list of domains that are allowed or disallowed to login.
|
ISFQuery<SFMobileSecuritySettings> |
getMobileSecuritySettings()
Get Account Mobile Security Settings
Returns the Mobile device configuration settings for this account
|
ISFQuery<SFOutlookInformation> |
getOutlookInformation()
Get Outlook Information
|
ISFQuery<SFAccountPreferences> |
getPreferences()
Get Account Preferences
|
ISFQuery<SFProductDefaults> |
getProductDefaults()
Get Account Product Defaults
|
ISFQuery<SFSSOAccountProvider> |
getSSO()
Get Account Single Sign-On Configuration
Retrieve the Single Sign-on configuration for the Account
|
ISFQuery<SFSSOAccountProvider> |
getSSO(java.lang.String provider)
Get Account Single Sign-On Configuration
Retrieve the Single Sign-on configuration for the Account
|
ISFQuery<SFSSOAccountProvider> |
getSSO(java.lang.String provider,
java.lang.String idpEntityId)
Get Account Single Sign-On Configuration
Retrieve the Single Sign-on configuration for the Account
|
ISFQuery<SFSSOInfo> |
getSSOInfo(java.lang.String subdomain)
Get SSO Info
|
ISFQuery<SFODataFeed<SFAccount>> |
getTenants()
Get the tenants of a partner account
|
ISFQuery<SFAccount> |
getTenants(java.lang.String id) |
ISFQuery<SFODataFeed<SFZone>> |
getZones(java.lang.String parentid)
Get list of multi-tenant zones assigned to a tenant.
|
ISFQuery<SFRequireSubdomainResult> |
requireSubdomain(java.lang.String username)
Check if subdomain is required
|
ISFQuery<SFRequireSubdomainResult> |
requireSubdomain(java.lang.String username,
java.lang.Boolean singlePlane)
Check if subdomain is required
|
ISFQuery<SFRequireWebPopResult> |
requireWebPop(java.lang.String subdomain)
Check if WebPop is required
|
ISFQuery<SFRequireWebPopResult> |
requireWebPop(java.lang.String subdomain,
java.lang.String username)
Check if WebPop is required
|
ISFQuery<SFRequireWebPopResult> |
requireWebPop(java.lang.String subdomain,
java.lang.String username,
java.lang.Boolean singlePlane)
Check if WebPop is required
|
ISFQuery |
sendToEmail(java.lang.String email)
Email List of Accounts to User
Sends the list of accounts to the specified email address
This operation does not require authentication
|
ISFQuery<SFAccount> |
updateBranding(SFAccount account)
Modify the Branding for this account
Modifies Branding information about the subdomain account.
|
ISFQuery<SFAccessControlDomains> |
updateFolderAccessControlDomains(SFAccessControlDomains accessControlDomains)
Update the Folder Access Control List of domains
{
"AccessControlType" : "AllowedDomains",
"Domains": ["domainA", "domainB", ...]
}
Merges the specified domains with existing domains in the list, and/or updates the AccessControlType.
|
ISFQuery<SFAccessControlDomains> |
updateLoginAccessControlDomains(SFAccessControlDomains accessControlDomains)
Update the Login Access Control List of domains
{
"AccessControlType" : "AllowedDomains",
"Domains": ["domainA", "domainB", ...]
}
Merges the specified domains with existing domains in the list, and/or updates the AccessControlType.
|
ISFQuery<SFSSOAccountProvider> |
updateSSO(SFSSOAccountProvider sso)
Update Account Single Sign-On Configuration
{
"LogoutUrl":"",
"LoginUrl":"https://idp.com/signin",
"IPRestrictions":"+all",
"ForceSSO":true,
"EntityID":"http://account.sf-api.com/saml/info",
"SFEntityID":"http://idp.com/saml/info",
"SPInitatedAuthContext":"exact",
"SPInitatedAuthMethod":"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"
}
Modifies the Single Sign-on Configuration for this account.
|
ISFQuery<SFSSOAccountProvider> |
updateSSO(SFSSOAccountProvider sso,
java.lang.String provider)
Update Account Single Sign-On Configuration
{
"LogoutUrl":"",
"LoginUrl":"https://idp.com/signin",
"IPRestrictions":"+all",
"ForceSSO":true,
"EntityID":"http://account.sf-api.com/saml/info",
"SFEntityID":"http://idp.com/saml/info",
"SPInitatedAuthContext":"exact",
"SPInitatedAuthMethod":"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"
}
Modifies the Single Sign-on Configuration for this account.
|
ISFQuery<SFRedirection> |
webAppAdmin()
Create a one-time use login Uri for the Web App.
|
getEntitypublic SFAccountsEntity(ISFApiClient client)
public ISFQuery<SFAccount> get(java.lang.String id) throws InvalidOrMissingParameterException
id - (default: null)InvalidOrMissingParameterExceptionpublic ISFQuery<SFAccount> get()
public ISFQuery<SFAccount> getBranding()
public ISFQuery<SFAccount> updateBranding(SFAccount account) throws InvalidOrMissingParameterException
InvalidOrMissingParameterExceptionpublic ISFQuery<SFODataFeed<SFContact>> getEmployees()
public ISFQuery<SFODataFeed<SFContact>> getClients()
public ISFQuery<SFODataFeed<SFContact>> getAddressBook(java.lang.String type, java.lang.String searchTerm) throws InvalidOrMissingParameterException
type - (default: "personal")searchTerm - (default: "")InvalidOrMissingParameterExceptionpublic ISFQuery<SFODataFeed<SFContact>> getAddressBook(java.lang.String type) throws InvalidOrMissingParameterException
type - (default: "personal")InvalidOrMissingParameterExceptionpublic ISFQuery<SFODataFeed<SFContact>> getAddressBook()
public ISFQuery<SFMobileSecuritySettings> getMobileSecuritySettings()
public ISFQuery<SFProductDefaults> getProductDefaults()
public ISFQuery<SFAccountPreferences> getPreferences()
public ISFQuery<SFSSOAccountProvider> getSSO(java.lang.String provider, java.lang.String idpEntityId) throws InvalidOrMissingParameterException
provider - (default: "saml")idpEntityId - (default: null)InvalidOrMissingParameterExceptionpublic ISFQuery<SFSSOAccountProvider> getSSO(java.lang.String provider) throws InvalidOrMissingParameterException
provider - (default: "saml")InvalidOrMissingParameterExceptionpublic ISFQuery<SFSSOAccountProvider> getSSO()
public ISFQuery<SFSSOAccountProvider> updateSSO(SFSSOAccountProvider sso, java.lang.String provider) throws InvalidOrMissingParameterException
sso - provider - (default: "saml")InvalidOrMissingParameterExceptionpublic ISFQuery<SFSSOAccountProvider> updateSSO(SFSSOAccountProvider sso) throws InvalidOrMissingParameterException
sso - InvalidOrMissingParameterExceptionpublic ISFQuery<SFODataFeed<SFAccount>> getByUser(SFODataObject parameters, java.lang.String username, java.lang.Boolean employeesonly, java.lang.Boolean requirehomefolders, java.lang.Boolean singleplane) throws InvalidOrMissingParameterException
username - employeesonly - (default: false)requirehomefolders - (default: false)singleplane - (default: false)InvalidOrMissingParameterExceptionpublic ISFQuery<SFODataFeed<SFAccount>> getByUser(SFODataObject parameters, java.lang.String username, java.lang.Boolean employeesonly, java.lang.Boolean requirehomefolders) throws InvalidOrMissingParameterException
username - employeesonly - (default: false)requirehomefolders - (default: false)InvalidOrMissingParameterExceptionpublic ISFQuery<SFODataFeed<SFAccount>> getByUser(SFODataObject parameters, java.lang.String username, java.lang.Boolean employeesonly) throws InvalidOrMissingParameterException
username - employeesonly - (default: false)InvalidOrMissingParameterExceptionpublic ISFQuery<SFODataFeed<SFAccount>> getByUser(SFODataObject parameters, java.lang.String username) throws InvalidOrMissingParameterException
username - InvalidOrMissingParameterExceptionpublic ISFQuery sendToEmail(java.lang.String email) throws InvalidOrMissingParameterException
email - InvalidOrMissingParameterExceptionpublic ISFQuery<SFAccessControlDomains> getLoginAccessControlDomains()
public ISFQuery<SFAccessControlDomains> getFolderAccessControlDomains()
public ISFQuery<SFAccessControlDomains> createLoginAccessControlDomains(SFAccessControlDomains accessControlDomains) throws InvalidOrMissingParameterException
InvalidOrMissingParameterExceptionpublic ISFQuery<SFAccessControlDomains> createFolderAccessControlDomains(SFAccessControlDomains accessControlDomains) throws InvalidOrMissingParameterException
InvalidOrMissingParameterExceptionpublic ISFQuery<SFAccessControlDomains> updateLoginAccessControlDomains(SFAccessControlDomains accessControlDomains) throws InvalidOrMissingParameterException
InvalidOrMissingParameterExceptionpublic ISFQuery<SFAccessControlDomains> updateFolderAccessControlDomains(SFAccessControlDomains accessControlDomains) throws InvalidOrMissingParameterException
InvalidOrMissingParameterExceptionpublic ISFQuery deleteLoginAccessControlDomains(SFAccessControlDomains accessControlDomains) throws InvalidOrMissingParameterException
InvalidOrMissingParameterExceptionpublic ISFQuery deleteFolderAccessControlDomains(SFAccessControlDomains accessControlDomains) throws InvalidOrMissingParameterException
InvalidOrMissingParameterExceptionpublic ISFQuery<SFRequireWebPopResult> requireWebPop(java.lang.String subdomain, java.lang.String username, java.lang.Boolean singlePlane) throws InvalidOrMissingParameterException
subdomain - username - (default: null)singlePlane - (default: false)InvalidOrMissingParameterExceptionpublic ISFQuery<SFRequireWebPopResult> requireWebPop(java.lang.String subdomain, java.lang.String username) throws InvalidOrMissingParameterException
subdomain - username - (default: null)InvalidOrMissingParameterExceptionpublic ISFQuery<SFRequireWebPopResult> requireWebPop(java.lang.String subdomain) throws InvalidOrMissingParameterException
subdomain - InvalidOrMissingParameterExceptionpublic ISFQuery<SFRequireSubdomainResult> requireSubdomain(java.lang.String username, java.lang.Boolean singlePlane) throws InvalidOrMissingParameterException
username - singlePlane - (default: false)InvalidOrMissingParameterExceptionpublic ISFQuery<SFRequireSubdomainResult> requireSubdomain(java.lang.String username) throws InvalidOrMissingParameterException
username - InvalidOrMissingParameterExceptionpublic ISFQuery<SFFindSubdomainResult> findSubdomain(SFFindSubdomainParams findSubdomainParams, java.lang.Boolean singlePlane) throws InvalidOrMissingParameterException
findSubdomainParams - singlePlane - (default: false)InvalidOrMissingParameterExceptionpublic ISFQuery<SFFindSubdomainResult> findSubdomain(SFFindSubdomainParams findSubdomainParams) throws InvalidOrMissingParameterException
findSubdomainParams - InvalidOrMissingParameterExceptionpublic ISFQuery<SFOutlookInformation> getOutlookInformation()
public ISFQuery<SFSSOInfo> getSSOInfo(java.lang.String subdomain) throws InvalidOrMissingParameterException
subdomain - InvalidOrMissingParameterExceptionpublic ISFQuery<SFODataFeed<SFAccount>> getTenants()
public ISFQuery<SFAccount> getTenants(java.lang.String id) throws InvalidOrMissingParameterException
public ISFQuery<SFODataFeed<SFZone>> getZones(java.lang.String parentid) throws InvalidOrMissingParameterException
parentid - InvalidOrMissingParameterExceptionpublic ISFQuery<SFRedirection> webAppAdmin()