> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Default User From User Type > Create default User providing the user type. Only System and Anonymous users can be created without an exsisting person. Use CreateDefaultUserFromUserTypeAndPersonId to create internal (i.e. Employee) or external users. NsApiSlow threshold: 2000 ms. ## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps. ## OpenAPI ````yaml /openapi/agent/openapi-v3-UserAgent.json post /api/v1/Agents/User/CreateDefaultUserFromUserType openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - UserAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/User/CreateDefaultUserFromUserType: post: tags: - User_Agent summary: Create Default User From User Type description: "Create default User providing the user type.\n\nOnly System and Anonymous users can be created without an exsisting person. Use CreateDefaultUserFromUserTypeAndPersonId to create internal (i.e. Employee) or external users.\r\nNsApiSlow threshold: 2000 ms.\r\n## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps." operationId: v1UserAgent_CreateDefaultUserFromUserType parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.CreateDefaultUserFromUserTypeRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.CreateDefaultUserFromUserTypeRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.CreateDefaultUserFromUserTypeRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.CreateDefaultUserFromUserTypeRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.CreateDefaultUserFromUserTypeRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.CreateDefaultUserFromUserTypeRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.UserCarriers.CreateDefaultUserFromUserTypeRequest description: UserType required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.User' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.User' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.User' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.User' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.User' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.User' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.UserCarriers.CreateDefaultUserFromUserTypeRequest: description: >- CreateDefaultUserFromUserType: Create default User providing the user type. Only System and Anonymous users can be created without an exsisting person. Use CreateDefaultUserFromUserTypeAndPersonId to create internal (i.e. Employee) or external users. type: object properties: UserType: enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string SuperOffice.CRM.Services.User: description: "SuperOffice User, with login credentials and an associated person.\r\n\r\nCarrier object for User.\r\nServices for the User Carrier is available from the User Agent." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: >- Initials, UserId - also used as login name for on-site installations. Identifies user in archives. type: string Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string LicenseOwners: description: >- The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.LicenseOwner' Role: $ref: '#/components/schemas/SuperOffice.CRM.Services.Role' UserGroup: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserGroup' OtherGroups: description: "The other groups this user is a member of, apart from the main user group. \r\nUse MDO List name \"usergroup\" to get list items." type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserGroup' Person: $ref: '#/components/schemas/SuperOffice.CRM.Services.Person' Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean Lastlogin: format: date-time description: Last login date type: string Lastlogout: format: date-time description: Last logout date type: string EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer RequestSignature: description: ej users request signature type: string Type: description: >- User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string IsPersonRetired: description: >- True if the user is retired and should have no rights, not appear in lists, etc. type: boolean IsOnTravel: description: True if the user is on travel. type: boolean Credentials: description: >- List of credentials registered for this user. i.e. valid authentication methods. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.Credential' UserName: description: User name, a.k.a. Login name. This might be an e-mail address. type: string TicketCategories: description: "Request Ticket Categories assigned to the user. \r\nUse MDO List name \"ejCategory\" to get list items." type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' NickName: description: >- The unique nick name for this user. Used in Service as an alias, similar to Name/Initials. type: string WaitingForApproval: description: >- The user is waiting for an administrator to approve/grant her/him access. type: boolean ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.User.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.User.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string PostSaveCommands: description: >- Post custom commands the client should execute after save has completed. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomCommand' TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.LicenseOwner: description: "Carrier object for LicenseOwner.\r\nServices for the LicenseOwner Carrier is available from the License Agent." type: object properties: Name: description: The name of the license owner type: string Description: description: '' type: string RestrictedModuleLicenses: description: '' type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ModuleLicenseLink' UnrestrictedModuleLicenses: description: The unrestricted module licenses that this license owner type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ModuleLicenseLink' TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Role: description: "Users role for role-based security\r\n\r\nCarrier object for Role.\r\nServices for the Role Carrier is available from the User Agent." type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.UserGroup: description: "The main user group that this user belongs to\r\n\r\nCarrier object for UserGroup.\r\nServices for the UserGroup Carrier is available from the User Agent." type: object properties: Value: description: UserGroup name type: string Tooltip: description: Tooltip or other description type: string Id: format: int32 description: Primary key type: integer Rank: format: int32 description: Rank order type: integer Deleted: description: >- Deleted equal to true means that this is a user group that no longer can be selected by the user. It is not permitted to delete a UserGroup. type: boolean TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Person: description: "Carrier object for Person.\r\nServices for the Person Carrier is available from the Person Agent." type: object properties: Position: description: >- The position. This is a predefined SuperOffice value, different from Title type: string PersonId: format: int32 description: Primary key type: integer Mrmrs: description: e.g. Mrs sex_title type: string Firstname: description: First name type: string Lastname: description: Last name type: string MiddleName: description: Middle name or 'van' etc. type: string Title: description: Title type: string Description: description: Info text/description on person. type: string Email: description: First email on contact person. type: string FullName: description: >- Get the persons full name (internal name used in clients for employees). type: string DirectPhone: description: Returns the direct phone that belong to the contact person. type: string FormalName: description: >- Get formal name for a person, as used in labels. (Full name + person title + academic title) type: string CountryId: format: int32 description: Country type: integer ContactId: format: int32 description: Owning contact ID type: integer ContactName: description: The persons company name type: string Retired: format: int32 description: >- 1 = the user is retired and should have no rights, not appear in lists, etc. type: integer Rank: format: int32 description: Display sort sequence for default sort order type: integer ActiveInterests: format: int32 description: >- Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true type: integer ContactDepartment: description: The persons contact department type: string ContactCountryId: format: int32 description: The persons contact country id type: integer ContactOrgNr: description: The persons contact organization number type: string FaxPhone: description: Returns the fax phone that belong to the contact person. type: string MobilePhone: description: Returns the mobile phone that belong to the contact person. type: string ContactPhone: description: Returns the direct phone that belong to the persons contact. type: string AssociateName: description: Name of the person's owner type: string AssociateId: format: int32 description: Id of the item's owner (Associate id) type: integer UsePersonAddress: description: If 1, use person's address for mailing instead of company address type: boolean ContactFax: description: Actual phone number as eneterd by the user type: string Kanafname: description: Kana first name, used in Japanese versions only type: string Kanalname: description: Kana last name, used in Japanese versions only type: string Post1: description: Postal address, used in Japanese versions only type: string Post2: description: Postal address, used in Japanese versions only type: string Post3: description: Postal address, used in Japanese versions only type: string EmailName: description: E-mail description type: string ContactFullName: description: Company full name + department type: string ActiveErpLinks: format: int32 description: How many active ERP links are there for this person? type: integer TicketPriorityId: format: int32 description: Ticket priority ID type: integer SupportLanguageId: format: int32 description: Support priority ID type: integer SupportAssociateId: format: int32 description: Our support contact for this person type: integer CategoryName: description: The category list item name type: string PersonNumber: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Credential: description: "Credentials supported for authentication\r\n\r\nCarrier object for Credential.\r\nServices for the Credential Carrier is available from the User Agent." type: object properties: Type: $ref: '#/components/schemas/SuperOffice.CRM.Services.CredentialType' Value: description: >- This is the actuall value of the credentials. This will typically be the password or teh users SID in active directory type: string DisplayValue: description: >- The value displayed to the user. this will typically be the users login name in active directory. type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.MDOListItem: description: "Carrier object for MDOListItem.\r\nServices for the MDOListItem Carrier is available from the MDO Agent." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ChildItems: description: The child items of the MDOListItem type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' IconHint: description: The Icon hint of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string FullName: description: The name of the ListItem in its context type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.CustomCommand: description: "Generic carrier object for entity commands.\r\n\r\nCarrier object for CustomCommand." type: object properties: Name: description: Unique name of the command type: string DisplayName: description: The name to show in GUI type: string Description: description: Description of the command. type: string ToolTip: description: Tooltip to be used in the GUI type: string Actions: description: The actions to call when invoked enum: - Implicit - YesNo - OkCancel - Ok type: string ActionData: description: The data to be used when the command is invoked type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Services.ModuleLicenseLink: description: "License assignments carrier\r\n\r\nCarrier object for ModuleLicenseLink.\r\nServices for the ModuleLicenseLink Carrier is available from the License Agent." type: object properties: Unrestricted: description: Is this module license restricted or unrestricted type: boolean Total: format: int32 description: >- The total number of module licenses. In other words the number of free license added to the number of licenses in use equals the total number of licenses type: integer Tooltip: description: >- The tooltip to be shown in some gui with details on the module license type: string CanAssign: description: Can a specific user assign this module license type: boolean Free: format: int32 description: The number of licenses that are free to be assigned type: integer InUse: format: int32 description: >- The total number of licenses (of a given license module) that are occupied type: integer IsHidden: description: Is hidden from UI type: boolean Assigned: description: Is the module license assigned to a given user? type: boolean ModuleLicenseId: format: int32 description: The identifier of the module license type: integer Name: description: The name of the module license type: string Description: description: The description of the module license type: string PrerequisiteModuleName: description: Name of module that must be active for this license to be used. type: string SortOrder: format: int32 description: Sort order of licenses. type: integer ExtraFlags: format: int32 description: License flags. 1 = user plan type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.CredentialType: description: "Description of credential type\r\n\r\nCarrier object for CredentialType.\r\nServices for the CredentialType Carrier is available from the User Agent." type: object properties: DisplayType: description: >- The name of the credentials to be displayed in the user interface. This will typically be Password for user-name/password scenarios and Active Directoru User for AD integration. type: string Type: description: >- Type of credentials, corresponding to name of plugin and type in the credentials table type: string Description: description: >- Description of the authentication type. This value is used in a list of authentication providers that can be choosen by an end user and should be a fairly describtive text. This will typically be SuperOffice is responsible for username and password for a password scenario. type: string ValueControl: description: Type of control used to display the value. enum: - Static - Edit - Password - Link - Hidden type: string CanCreatePerson: description: '' type: boolean IsUserNameSupported: description: '' type: boolean TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [Create Default User From User Type And Credential](/en/api/reference/restful/agent/user_agent/create-default-user-from-user-type-and-credential.md) - [Create Default User From User Type And Person Id](/en/api/reference/restful/rest/user/create-default-user-from-user-type-and-person-id.md) - [SuperOffice.WebApi.Data.User CreateDefaultUserFromUserTypeRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_CreateDefaultUserFromUserTypeRequest.md) - [SuperOffice.WebApi.Data.User CreateDefaultUserFromUserTypeAndCredentialRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_CreateDefaultUserFromUserTypeAndCredentialRequest.md) - [NSUserAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserAgent.md)