DesignerAddRoleV1

The DesignerAddRoleV1 call gives you the ability to assign a particular role to a user for a particular project. This must be an existing user. A business application can provide this user access to KCM Designer according to a particular role for a particular project.

Except for the Viewer role, the roles that are allowed to be assigned through the DesignerAddRole request must be explicitly whitelisted on the server. By default, only the Viewer role is allowed to be assigned. The whitelist is defined by the KCM Core setting Designer.AllowedUserRoles, which can be specified on the General tab of the Environments node in KCM Core Administrator.

Multiple calls for the same user and the same project are cumulative, so adding a role for a particular user and project does not modify existing roles for that user.

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
project	message	The name of the project for the given role is assigned to the given user.
user	message	The name of the user assigned the given role within the given project. This name may contain spaces.
role	message	The role of the user. Only roles that are whitelisted on the KCM server are accepted.

The response only contains the standard fields.

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

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