Skip to main content
Save User From Name

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

userName
string
required

User name of the user to get.

Body

User object to save.

SuperOffice User, with login credentials and an associated person. Carrier object for User. Services for the User Carrier is available from the User Agent.

AssociateId
integer<int32>

Primary key

Name
string

Initials, UserId - also used as login name for on-site installations. Identifies user in archives.

Rank
integer<int32>

Rank order

Tooltip
string

Tooltip or other description

LicenseOwners
object[]

The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user

Role
object

Users role for role-based security Carrier object for Role. Services for the Role Carrier is available from the User Agent.

UserGroup
object

The main user group that this user belongs to Carrier object for UserGroup. Services for the UserGroup Carrier is available from the User Agent.

OtherGroups
object[]

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
object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Deleted
boolean

If true, the user is retired and should have no rights, not appear in lists, etc.

Lastlogin
string<date-time>

Last login date

Lastlogout
string<date-time>

Last logout date

EjUserId
integer<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
enum<string>

User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate

Available options:
Unknown,
InternalAssociate,
ResourceAssociate,
ExternalAssociate,
AnonymousAssociate,
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
object[]

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
object[]

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
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 UserDefinedFields properties are deprecated in favor of this combined collection.

PostSaveCommands
object[]

Post custom commands the client should execute after save has completed.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

OK

SuperOffice User, with login credentials and an associated person. Carrier object for User. Services for the User Carrier is available from the User Agent.

AssociateId
integer<int32>

Primary key

Name
string

Initials, UserId - also used as login name for on-site installations. Identifies user in archives.

Rank
integer<int32>

Rank order

Tooltip
string

Tooltip or other description

LicenseOwners
object[]

The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user

Role
object

Users role for role-based security Carrier object for Role. Services for the Role Carrier is available from the User Agent.

UserGroup
object

The main user group that this user belongs to Carrier object for UserGroup. Services for the UserGroup Carrier is available from the User Agent.

OtherGroups
object[]

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
object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Deleted
boolean

If true, the user is retired and should have no rights, not appear in lists, etc.

Lastlogin
string<date-time>

Last login date

Lastlogout
string<date-time>

Last logout date

EjUserId
integer<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
enum<string>

User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate

Available options:
Unknown,
InternalAssociate,
ResourceAssociate,
ExternalAssociate,
AnonymousAssociate,
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
object[]

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
object[]

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
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 UserDefinedFields properties are deprecated in favor of this combined collection.

PostSaveCommands
object[]

Post custom commands the client should execute after save has completed.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.