Description
Creates an external role for a user.
This is intended for users belonging to other organisations or companies.
HTTP Method | URI Scheme |
---|---|
POST | /server/external-role |
Parameters
Type | Name | Description | Qualification | Schema |
---|---|---|---|---|
Body | request | Request body parameters, see schema for details. | Required |
Responses
HTTP Code | Message | Description | Schema |
---|---|---|---|
200 | The created external role. | ||
400 | The application with the specified key could not be found | ||
400 | The role name must be unique within the company! | ||
400 | User agreement not found! | ||
400 | Input not valid: ID can't be specified when creating an external role. | ||
400 | Input not valid: Name and enabled must always be specified for an external role. | ||
400 | User agreement not found! | ||
500 | An unexpected error occurred: JSON parse error[...] | These error messages are returned if one or more parameters are of the wrong type. See ExternalRole for details. |
Security
Type | Name |
---|---|
apiKey | Key |