GET User/Default
Some tooltip text!
• 7 minutes to read
• 7 minutes to read
GET /api/v1/User/Default
Create default User providing the associate type and person id.
System and Anonymous users can be created without an exsisting person and permits person id to be 0.
Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps.
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| userType | Enum: Unknown, InternalAssociate, ResourceAssociate, ExternalAssociate, AnonymousAssociate, SystemAssociate | Type of associate for the user |
| personId | int32 | Primary key of the person to become a user. |
GET /api/v1/User/Default?userType=AnonymousAssociate
GET /api/v1/User/Default?personId=680
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 |
| 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. |
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
GET /api/v1/User/Default
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"AssociateId": 508,
"Name": "Mohr-Brekke",
"Rank": 637,
"Tooltip": "excepturi",
"LicenseOwners": [
{
"Name": "Leffler-Balistreri",
"Description": "Universal local initiative",
"RestrictedModuleLicenses": [
{},
{}
],
"UnrestrictedModuleLicenses": [
{},
{}
],
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 693
}
}
},
{
"Name": "Leffler-Balistreri",
"Description": "Universal local initiative",
"RestrictedModuleLicenses": [
{},
{}
],
"UnrestrictedModuleLicenses": [
{},
{}
],
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 693
}
}
}
],
"Role": null,
"UserGroup": null,
"OtherGroups": [
{
"Value": "autem",
"Tooltip": "rerum",
"Id": 892,
"Rank": 242,
"Deleted": false,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 679
}
}
}
],
"Person": null,
"Deleted": false,
"Lastlogin": "2012-09-05T14:13:49.5867704+02:00",
"Lastlogout": "2011-01-25T14:13:49.5867704+01:00",
"EjUserId": 692,
"RequestSignature": "exercitationem",
"Type": "AnonymousAssociate",
"IsPersonRetired": true,
"IsOnTravel": false,
"Credentials": [
{
"Type": null,
"Value": "in",
"DisplayValue": "quo",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 35
}
}
},
{
"Type": null,
"Value": "in",
"DisplayValue": "quo",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 35
}
}
}
],
"UserName": "Emmerich Group",
"TicketCategories": [
{
"Id": 466,
"Name": "Hodkiewicz LLC",
"ToolTip": "Consequatur sunt.",
"Deleted": false,
"Rank": 992,
"Type": "numquam",
"ChildItems": [
{},
{}
],
"IconHint": "officia",
"ColorBlock": 993,
"ExtraInfo": "expedita",
"StyleHint": "rem",
"FullName": "Jaquan Parker",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 169
}
}
}
],
"NickName": "Rohan-Collier",
"WaitingForApproval": true,
"ExtraFields": {
"ExtraFields1": "maiores",
"ExtraFields2": "est"
},
"CustomFields": {
"CustomFields1": "excepturi",
"CustomFields2": "doloremque"
},
"PostSaveCommands": [
{
"Name": "Lubowitz-Schroeder",
"DisplayName": "Marvin, Reichert and Walsh",
"Description": "Optimized optimizing leverage",
"ToolTip": "Qui dicta et accusamus qui laudantium nihil.",
"Actions": "Implicit",
"ActionData": "quo",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 488
}
}
}
],
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 534
}
}
}