PUT User/{userName}
Some tooltip text!
• 12 minutes to read
• 12 minutes to read
PUT /api/v1/User/{userName}
Save a user, with lookup based on the user name.
Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps.
| Path Part | Type | Description |
|---|---|---|
| userName | string | User name of the user to get. Required |
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: user
User object to save.
| Property Name | Type | Description |
|---|---|---|
| AssociateId | Integer | Primary key |
| Name | String | Initials, UserId - also used as login name for on-site installations. Identifies user in archives. |
| Rank | Integer | Rank order |
| Tooltip | String | Tooltip or other description |
| LicenseOwners | Array | The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user |
| Role | Role | Users role for role-based security. Determines permissions and access rights for the user. |
| UserGroup | UserGroup | The main user group that this user belongs to. |
| OtherGroups | Array | The other groups this user is a member of, apart from the main user group. |
| Person | Person | The person associated with this user. Detailed information about the user |
| Deleted | Boolean | If true, the user is retired and should have no rights, not appear in lists, etc. |
| Lastlogin | String | Last login date |
| Lastlogout | String | Last logout date |
| EjUserId | Integer | ID of the ej user record corresponding to this associate; 0 for associates that are not ej users |
| RequestSignature | String | ej users request signature |
| Type | String | User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate |
| IsPersonRetired | Boolean | True if the user is retired and should have no rights, not appear in lists, etc. |
| IsOnTravel | Boolean | True if the user is on travel. |
| Credentials | Array | List of credentials registered for this user. i.e. valid authentication methods. |
| UserName | String | User name, a.k.a. Login name. This might be an e-mail address. |
| TicketCategories | Array | Request Ticket Categories assigned to the user. |
| NickName | String | The unique nick name for this user. Used in Service as an alias, similar to Name/Initials. |
| WaitingForApproval | Boolean | The user is waiting for an administrator to approve/grant her/him access. |
| ExtraFields | Object | Deprecated: Use {SuperOffice.CRM.Services.User.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc. |
| CustomFields | Object | Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.User.ExtraFields} and |
| PostSaveCommands | Array | Post custom commands the client should execute after save has completed. |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: User
| Property Name | Type | Description |
|---|---|---|
| AssociateId | int32 | Primary key |
| Name | string | Initials, UserId - also used as login name for on-site installations. Identifies user in archives. |
| Rank | int32 | Rank order |
| Tooltip | string | Tooltip or other description |
| LicenseOwners | array | The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user |
| Role | Role | Users role for role-based security. Determines permissions and access rights for the user. |
| UserGroup | UserGroup | The main user group that this user belongs to. Use MDO List name "usergroup" to get list items. |
| OtherGroups | array | The other groups this user is a member of, apart from the main user group. Use MDO List name "usergroup" to get list items. |
| Person | Person | The person associated with this user. Detailed information about the user Use MDO List name "person_new" to get list items. |
| Deleted | bool | If true, the user is retired and should have no rights, not appear in lists, etc. |
| Lastlogin | date-time | Last login date |
| Lastlogout | date-time | Last logout date |
| EjUserId | int32 | ID of the ej user record corresponding to this associate; 0 for associates that are not ej users |
| RequestSignature | string | ej users request signature |
| Type | string | User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate |
| IsPersonRetired | bool | True if the user is retired and should have no rights, not appear in lists, etc. |
| IsOnTravel | bool | True if the user is on travel. |
| Credentials | array | List of credentials registered for this user. i.e. valid authentication methods. |
| UserName | string | User name, a.k.a. Login name. This might be an e-mail address. |
| TicketCategories | array | Request Ticket Categories assigned to the user. Use MDO List name "ejCategory" to get list items. |
| NickName | string | The unique nick name for this user. Used in Service as an alias, similar to Name/Initials. |
| WaitingForApproval | bool | The user is waiting for an administrator to approve/grant her/him access. |
| ExtraFields | object | Deprecated: Use {SuperOffice.CRM.Services.User.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc. |
| CustomFields | object | Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.User.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection. |
| PostSaveCommands | array | Post custom commands the client should execute after save has completed. |
| TableRight | TableRight | The carrier's table right |
| FieldProperties | object | Field property dictionary mapping field names to field access rights. |
Sample request
PUT /api/v1/User/{userName}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8
{
"AssociateId": 396,
"Name": "Konopelski-Dickens",
"Rank": 500,
"Tooltip": "dolor",
"LicenseOwners": [
{
"Name": "Christiansen-Schamberger",
"Description": "Devolved optimal flexibility",
"RestrictedModuleLicenses": [
{},
{}
],
"UnrestrictedModuleLicenses": [
{},
{}
]
},
{
"Name": "Christiansen-Schamberger",
"Description": "Devolved optimal flexibility",
"RestrictedModuleLicenses": [
{},
{}
],
"UnrestrictedModuleLicenses": [
{},
{}
]
}
],
"Role": null,
"UserGroup": null,
"OtherGroups": [
{
"Value": "soluta",
"Tooltip": "nulla",
"Id": 25,
"Rank": 575,
"Deleted": false
},
{
"Value": "soluta",
"Tooltip": "nulla",
"Id": 25,
"Rank": 575,
"Deleted": false
}
],
"Person": null,
"Deleted": false,
"Lastlogin": "2011-05-14T14:13:49.5711489+02:00",
"Lastlogout": "2016-10-29T14:13:49.5711489+02:00",
"EjUserId": 485,
"RequestSignature": "quaerat",
"Type": "AnonymousAssociate",
"IsPersonRetired": false,
"IsOnTravel": true,
"Credentials": [
{
"Type": null,
"Value": "officiis",
"DisplayValue": "optio"
},
{
"Type": null,
"Value": "officiis",
"DisplayValue": "optio"
}
],
"UserName": "Bashirian-Dietrich",
"TicketCategories": [
{
"Id": 681,
"Name": "Towne-Johnston",
"ToolTip": "Consectetur ipsum atque saepe id.",
"Deleted": false,
"Rank": 444,
"Type": "molestiae",
"ChildItems": [
{},
{}
],
"IconHint": "et",
"ColorBlock": 985,
"ExtraInfo": "aut",
"StyleHint": "deleniti",
"FullName": "Dalton Gibson"
}
],
"NickName": "Weimann LLC",
"WaitingForApproval": false,
"ExtraFields": {
"ExtraFields1": "optio",
"ExtraFields2": "quidem"
},
"CustomFields": {
"CustomFields1": "nam",
"CustomFields2": "similique"
},
"PostSaveCommands": [
{
"Name": "Zboncak-Crona",
"DisplayName": "Grady-Mayert",
"Description": "Programmable 24/7 core",
"ToolTip": "Quod quam necessitatibus ut voluptatem minima.",
"Actions": "Implicit",
"ActionData": "sint"
},
{
"Name": "Zboncak-Crona",
"DisplayName": "Grady-Mayert",
"Description": "Programmable 24/7 core",
"ToolTip": "Quod quam necessitatibus ut voluptatem minima.",
"Actions": "Implicit",
"ActionData": "sint"
}
]
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"AssociateId": 723,
"Name": "Armstrong-Hane",
"Rank": 193,
"Tooltip": "modi",
"LicenseOwners": [
{
"Name": "Franecki-Waters",
"Description": "User-centric global productivity",
"RestrictedModuleLicenses": [
{},
{}
],
"UnrestrictedModuleLicenses": [
{},
{}
],
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 385
}
}
},
{
"Name": "Franecki-Waters",
"Description": "User-centric global productivity",
"RestrictedModuleLicenses": [
{},
{}
],
"UnrestrictedModuleLicenses": [
{},
{}
],
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 385
}
}
}
],
"Role": null,
"UserGroup": null,
"OtherGroups": [
{
"Value": "dolores",
"Tooltip": "et",
"Id": 824,
"Rank": 82,
"Deleted": false,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 514
}
}
}
],
"Person": null,
"Deleted": false,
"Lastlogin": "2004-02-07T14:13:49.5711489+01:00",
"Lastlogout": "2000-10-17T14:13:49.5711489+02:00",
"EjUserId": 532,
"RequestSignature": "voluptate",
"Type": "AnonymousAssociate",
"IsPersonRetired": false,
"IsOnTravel": true,
"Credentials": [
{
"Type": null,
"Value": "occaecati",
"DisplayValue": "ea",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 96
}
}
},
{
"Type": null,
"Value": "occaecati",
"DisplayValue": "ea",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 96
}
}
}
],
"UserName": "Halvorson LLC",
"TicketCategories": [
{
"Id": 786,
"Name": "Thiel-Gislason",
"ToolTip": "Quis aperiam.",
"Deleted": true,
"Rank": 692,
"Type": "est",
"ChildItems": [
{},
{}
],
"IconHint": "officia",
"ColorBlock": 747,
"ExtraInfo": "necessitatibus",
"StyleHint": "dolore",
"FullName": "Mrs. Isom Kuhn DVM",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 902
}
}
}
],
"NickName": "Metz, Turner and Rice",
"WaitingForApproval": true,
"ExtraFields": {
"ExtraFields1": "blanditiis",
"ExtraFields2": "quia"
},
"CustomFields": {
"CustomFields1": "aspernatur",
"CustomFields2": "nisi"
},
"PostSaveCommands": [
{
"Name": "King Inc and Sons",
"DisplayName": "Lakin Inc and Sons",
"Description": "Innovative contextually-based hierarchy",
"ToolTip": "Possimus repudiandae ipsum illo pariatur voluptas doloribus.",
"Actions": "Implicit",
"ActionData": "perspiciatis",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 177
}
}
}
],
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 89
}
}
}