POST - system/apikey/withsetting

system/apikey/withsetting

environmentNameOrURL

unknown

string

The identifier for the environment in which to log in

This can be:

• the name of the environment
  
• one of the values entered in the URLs setting of the environment
  
• the full URL to the backoffice (eg: http://www.domain.com/CHILI/ENVIRONMENT_NAME/interface.aspx )

userName

body

string

The user to log in with.
This user needs to exist in the specified environment.

password

body

string

The user's password.
This can be provided as a MD5 encoded string (which of course is the preferred method)

settingsXML

body

xmlString

XML representation of name/value pairs of the settings to apply. Eg:
<settings>
<item name='userAssetDirectory' value='users\USER_NAME' />
<item name='allowWorkspaceAdministration' value='false' />
</settings>

Key names are case sensitive. An exception will be thrown for invalid key names.
Possible key names are:

• allowWorkspaceAdministration
  
• allowContentAdministration
  
• noAutomaticPreviewForNewItems
  
• noApiKeyInURL
  
• userLanguage
  
• userLanguageIgnoreWorkSpaceLanguage
  
• xinetUser
  
• xinetPW
  
• userAssetDirectory
  
• userGroupAssetDirectory
  
• documentAssetDirectory