DesignerAddUserV2

The DesignerAddUserV2 call gives you the ability to create new KCM Designer users. A business application can provide such a new user access to the KCM Designer with the DesignerStartSessionV3 call. The new user can create a password from this KCM Designer session. Once a password is created, the user can also log in through other mechanisms, such as KCM Designer for Windows.

If the KCM Designer user with the given name already exists, this call has no effect. If the user exists but is marked for deletion, a new user is created.

When the LDAP mode is enabled in KCM Designer, you cannot use this call. For more information on LDAP, see the Kofax Communications Manager Installation Guide.

The request requires the following fields next to the standard fields.

Field	Type	Description
user	message	The name of the user that is added. This name may contain spaces.
role	message	Optional. The role of the user. If passed, it assigns this role to all existing projects. If the user with the given name already exists, the call has no effect, and the role is not assigned to the user. Use DesignerAddRoleV1 to ensure that the user account gets the specified role. See DesignerAddRoleV1. Only roles that are whitelisted on the KCM server are accepted. For more information on whitelisting, see Designer administration requests

The response only contains the standard fields.

In case of an error, the response contains a SOAP Fault structure.

If the user account already exists, the API call has no effect, but no error is generated. Also, the role specified in the call is not assigned to the user. To verify that the user account gets the role, use the DesignerAddRoleV1 call.

The DesignerAddUserV2 call belongs to the CCMAdministration contract type and can only be used when application authentication is enabled on the Contract Manager.