Description

Creates an external role for a user.

This is intended for users belonging to other organisations or companies.

HTTP method	URI scheme

HTTP method	URI scheme
POST	/server/external-role

Parameters

Type	Name	Description	Qualification	Schema

Type	Name	Description	Qualification	Schema
Body	request	Request body parameters, see schema for details.	Required	ExternalRole

HTTP code	Common messages	Description	Schema

HTTP code	Common messages	Description	Schema
200		The created external role.	ExternalRole
400	The application with the specified key could not be found		String
	The role name must be unique within the company!		String
	Input not valid: Your platform does not support specifying an agreement template ID when creating an external role.		String
	User agreement not found!		String
	Input not valid: ID can't be specified when creating an external role.		String
	Input not valid: Name and enabled must always be specified for an external role.		String
500	An unexpected error occurred: JSON parse error <%1>	This error message can be returned if one or more parameters are of the wrong type. See ExternalRole for details.	String

Type	Name

Type	Name
apiKey	Key