PATCH api/v1/organisations/{key}?loginNameFormatStudentRetroactive={loginNameFormatStudentRetroactive}&loginNameFormatPersonnelRetroactive={loginNameFormatPersonnelRetroactive}
This endpoint is used to modify an existing organisation. Currently the following properties can be updated: LoginDomain, LoginNameFormatStudent, LoginnameFormatPersonnel, BoardOrganisationKey, Name, DefaultFunctionKey
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
The unique key that identifies the organisation |
globally unique identifier |
Required |
| loginNameFormatStudentRetroactive | boolean |
Default value is False |
|
| loginNameFormatPersonnelRetroactive | boolean |
Default value is False |
Body Parameters
organisation to be updated
Organisation| Name | Description | Type | Additional information |
|---|---|---|---|
| Tenant | Tenant |
None. |
|
| Name | string |
None. |
|
| City | string |
None. |
|
| Brin | string |
None. |
|
| CrmId | integer |
None. |
|
| LoginDomain | string |
None. |
|
| ActiveDirectoryID | integer |
None. |
|
| AdImportMode | boolean |
None. |
|
| LoginNameFormatStudent | string |
None. |
|
| LoginNameFormatPersonnel | string |
None. |
|
| BoardOrganisationKey | globally unique identifier |
None. |
|
| LicenseKeys | Collection of globally unique identifier |
None. |
|
| DefaultFunctionKey | globally unique identifier |
None. |
|
| PlatformFlags | PlatformFlags |
None. |
|
| Key | globally unique identifier |
None. |
Response Information
Resource Description
None.