mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-26 05:04:05 -08:00
772 lines
16 KiB
TypeScript
772 lines
16 KiB
TypeScript
import {
|
|
INodeProperties,
|
|
} from 'n8n-workflow';
|
|
|
|
export const userOperations = [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
name: 'Create',
|
|
value: 'create',
|
|
description: 'Create a user',
|
|
},
|
|
{
|
|
name: 'Delete',
|
|
value: 'delete',
|
|
description: 'Delete a user',
|
|
},
|
|
{
|
|
name: 'Get',
|
|
value: 'get',
|
|
description: 'Get a user',
|
|
},
|
|
{
|
|
name: 'Get All',
|
|
value: 'getAll',
|
|
description: 'Get all users',
|
|
},
|
|
{
|
|
name: 'Search',
|
|
value: 'search',
|
|
description: 'Search users',
|
|
},
|
|
{
|
|
name: 'Update',
|
|
value: 'update',
|
|
description: 'Update a user',
|
|
},
|
|
],
|
|
default: 'create',
|
|
description: 'The operation to perform.',
|
|
},
|
|
] as INodeProperties[];
|
|
|
|
export const userFields = [
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* user:create */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
required: true,
|
|
description: `The user's name`,
|
|
},
|
|
{
|
|
displayName: 'Additional Fields',
|
|
name: 'additionalFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Alias',
|
|
name: 'alis',
|
|
type: 'string',
|
|
default: '',
|
|
description: `An alias displayed to end users`,
|
|
},
|
|
{
|
|
displayName: 'Custom Role ID',
|
|
name: 'custom_role_id',
|
|
type: 'number',
|
|
default: 0,
|
|
description: `A custom role if the user is an agent on the Enterprise plan`,
|
|
},
|
|
{
|
|
displayName: 'Details',
|
|
name: 'details',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Any details you want to store about the user, such as an address',
|
|
},
|
|
{
|
|
displayName: 'Email',
|
|
name: 'email',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's primary email address`,
|
|
},
|
|
{
|
|
displayName: 'External ID',
|
|
name: 'externalId',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'A unique identifier from another system',
|
|
},
|
|
{
|
|
displayName: 'Locale ID',
|
|
name: 'locale',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getLocales',
|
|
},
|
|
default: '',
|
|
description: `The user's locale.`,
|
|
},
|
|
{
|
|
displayName: 'Moderator',
|
|
name: 'moderator',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: 'Designates whether the user has forum moderation capabilities',
|
|
},
|
|
{
|
|
displayName: 'Notes',
|
|
name: 'notes',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Any notes you want to store about the user',
|
|
},
|
|
{
|
|
displayName: 'Only Private Comments',
|
|
name: 'only_private_comments',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `true if the user can only create private comments`,
|
|
},
|
|
{
|
|
displayName: 'Organization ID',
|
|
name: 'organizationId',
|
|
type: 'number',
|
|
default: 0,
|
|
description: `The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization`,
|
|
},
|
|
{
|
|
displayName: 'Phone',
|
|
name: 'phone',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's primary phone number.`,
|
|
},
|
|
{
|
|
displayName: 'Report CSV',
|
|
name: 'report_csv',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface.`,
|
|
},
|
|
{
|
|
displayName: 'Restricted Agent',
|
|
name: 'restricted_agent',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `If the agent has any restrictions; false for admins and unrestricted agents, true for other agents`,
|
|
},
|
|
{
|
|
displayName: 'Role',
|
|
name: 'role',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'End User',
|
|
value: 'end-user',
|
|
},
|
|
{
|
|
name: 'Agent',
|
|
value: 'agent',
|
|
},
|
|
{
|
|
name: 'Admin',
|
|
value: 'admin',
|
|
},
|
|
],
|
|
default: '',
|
|
description: `The user's role`,
|
|
},
|
|
{
|
|
displayName: 'Signature',
|
|
name: 'signature',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's signature. Only agents and admins can have signatures`,
|
|
},
|
|
{
|
|
displayName: 'Suspended',
|
|
name: 'suspended',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal`,
|
|
},
|
|
{
|
|
displayName: 'Tags',
|
|
name: 'tags',
|
|
type: 'multiOptions',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTags',
|
|
},
|
|
default: [],
|
|
description: 'The array of tags applied to this user',
|
|
},
|
|
{
|
|
displayName: 'Ticket Restriction',
|
|
name: 'ticket_restriction',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Organization',
|
|
value: 'organization',
|
|
},
|
|
{
|
|
name: 'Groups',
|
|
value: 'groups',
|
|
},
|
|
{
|
|
name: 'Assigned',
|
|
value: 'assigned',
|
|
},
|
|
{
|
|
name: 'Requested',
|
|
value: 'requested',
|
|
},
|
|
],
|
|
default: '',
|
|
description: `Specifies which tickets the user has access to`,
|
|
},
|
|
{
|
|
displayName: 'Timezone',
|
|
name: 'time_zone',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's time zone.`,
|
|
},
|
|
{
|
|
displayName: 'User Fields',
|
|
name: 'userFieldsUi',
|
|
placeholder: 'Add User Field',
|
|
description: `Values of custom fields in the user's profile.`,
|
|
type: 'fixedCollection',
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
},
|
|
default: {},
|
|
options: [
|
|
{
|
|
name: 'userFieldValues',
|
|
displayName: 'Field',
|
|
values: [
|
|
{
|
|
displayName: 'Field',
|
|
name: 'field',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getUserFields',
|
|
},
|
|
default: '',
|
|
description: 'Name of the field to sort on.',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Value of the field.',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Verified',
|
|
name: 'verified',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `The user's primary identity is verified or not`,
|
|
},
|
|
],
|
|
},
|
|
/* -------------------------------------------------------------------------- */
|
|
/* user:update */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'User ID',
|
|
name: 'id',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
description: 'User ID',
|
|
},
|
|
{
|
|
displayName: 'Update Fields',
|
|
name: 'updateFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Alias',
|
|
name: 'alis',
|
|
type: 'string',
|
|
default: '',
|
|
description: `An alias displayed to end users`,
|
|
},
|
|
{
|
|
displayName: 'Custom Role ID',
|
|
name: 'custom_role_id',
|
|
type: 'number',
|
|
default: 0,
|
|
description: `A custom role if the user is an agent on the Enterprise plan`,
|
|
},
|
|
{
|
|
displayName: 'Details',
|
|
name: 'details',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Any details you want to store about the user, such as an address',
|
|
},
|
|
{
|
|
displayName: 'Email',
|
|
name: 'email',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's primary email address`,
|
|
},
|
|
{
|
|
displayName: 'External ID',
|
|
name: 'externalId',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'A unique identifier from another system',
|
|
},
|
|
{
|
|
displayName: 'Locale ID',
|
|
name: 'locale',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getLocales',
|
|
},
|
|
default: '',
|
|
description: `The user's locale.`,
|
|
},
|
|
{
|
|
displayName: 'Moderator',
|
|
name: 'moderator',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: 'Designates whether the user has forum moderation capabilities',
|
|
},
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's name`,
|
|
},
|
|
{
|
|
displayName: 'Notes',
|
|
name: 'notes',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Any notes you want to store about the user',
|
|
},
|
|
{
|
|
displayName: 'Only Private Comments',
|
|
name: 'only_private_comments',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `true if the user can only create private comments`,
|
|
},
|
|
{
|
|
displayName: 'Organization ID',
|
|
name: 'organizationId',
|
|
type: 'number',
|
|
default: 0,
|
|
description: `The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization`,
|
|
},
|
|
{
|
|
displayName: 'Phone',
|
|
name: 'phone',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's primary phone number.`,
|
|
},
|
|
{
|
|
displayName: 'Report CSV',
|
|
name: 'report_csv',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface.`,
|
|
},
|
|
{
|
|
displayName: 'Restricted Agent',
|
|
name: 'restricted_agent',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `If the agent has any restrictions; false for admins and unrestricted agents, true for other agents`,
|
|
},
|
|
{
|
|
displayName: 'Role',
|
|
name: 'role',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'End User',
|
|
value: 'end-user',
|
|
},
|
|
{
|
|
name: 'Agent',
|
|
value: 'agent',
|
|
},
|
|
{
|
|
name: 'Admin',
|
|
value: 'admin',
|
|
},
|
|
],
|
|
default: '',
|
|
description: `The user's role`,
|
|
},
|
|
{
|
|
displayName: 'Signature',
|
|
name: 'signature',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's signature. Only agents and admins can have signatures`,
|
|
},
|
|
{
|
|
displayName: 'Suspended',
|
|
name: 'suspended',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal`,
|
|
},
|
|
{
|
|
displayName: 'Tags',
|
|
name: 'tags',
|
|
type: 'multiOptions',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getTags',
|
|
},
|
|
default: [],
|
|
description: 'The array of tags applied to this user',
|
|
},
|
|
{
|
|
displayName: 'Ticket Restriction',
|
|
name: 'ticket_restriction',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Organization',
|
|
value: 'organization',
|
|
},
|
|
{
|
|
name: 'Groups',
|
|
value: 'groups',
|
|
},
|
|
{
|
|
name: 'Assigned',
|
|
value: 'assigned',
|
|
},
|
|
{
|
|
name: 'Requested',
|
|
value: 'requested',
|
|
},
|
|
],
|
|
default: '',
|
|
description: `Specifies which tickets the user has access to`,
|
|
},
|
|
{
|
|
displayName: 'Timezone',
|
|
name: 'time_zone',
|
|
type: 'string',
|
|
default: '',
|
|
description: `The user's time zone.`,
|
|
},
|
|
{
|
|
displayName: 'User Fields',
|
|
name: 'userFieldsUi',
|
|
placeholder: 'Add User Field',
|
|
description: `Values of custom fields in the user's profile.`,
|
|
type: 'fixedCollection',
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
},
|
|
default: {},
|
|
options: [
|
|
{
|
|
name: 'userFieldValues',
|
|
displayName: 'Field',
|
|
values: [
|
|
{
|
|
displayName: 'Field',
|
|
name: 'field',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getUserFields',
|
|
},
|
|
default: '',
|
|
description: 'Name of the field to sort on.',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Value of the field.',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Verified',
|
|
name: 'verified',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `The user's primary identity is verified or not`,
|
|
},
|
|
],
|
|
},
|
|
/* -------------------------------------------------------------------------- */
|
|
/* user:get */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'User ID',
|
|
name: 'id',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'get',
|
|
],
|
|
},
|
|
},
|
|
description: 'User ID',
|
|
},
|
|
/* -------------------------------------------------------------------------- */
|
|
/* user:getAll */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Return All',
|
|
name: 'returnAll',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'If all results should be returned or only up to a given limit.',
|
|
},
|
|
{
|
|
displayName: 'Limit',
|
|
name: 'limit',
|
|
type: 'number',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
returnAll: [
|
|
false,
|
|
],
|
|
},
|
|
},
|
|
typeOptions: {
|
|
minValue: 1,
|
|
maxValue: 100,
|
|
},
|
|
default: 100,
|
|
description: 'How many results to return.',
|
|
},
|
|
{
|
|
displayName: 'Filters',
|
|
name: 'filters',
|
|
type: 'collection',
|
|
placeholder: 'Add Filter',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Roles',
|
|
name: 'role',
|
|
type: 'multiOptions',
|
|
options: [
|
|
{
|
|
name: 'End User',
|
|
value: 'end-user',
|
|
},
|
|
{
|
|
name: 'Agent',
|
|
value: 'agent',
|
|
},
|
|
{
|
|
name: 'Admin',
|
|
value: 'admin',
|
|
},
|
|
],
|
|
default: [],
|
|
},
|
|
],
|
|
},
|
|
/* -------------------------------------------------------------------------- */
|
|
/* user:search */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Return All',
|
|
name: 'returnAll',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'search',
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'If all results should be returned or only up to a given limit.',
|
|
},
|
|
{
|
|
displayName: 'Limit',
|
|
name: 'limit',
|
|
type: 'number',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'search',
|
|
],
|
|
returnAll: [
|
|
false,
|
|
],
|
|
},
|
|
},
|
|
typeOptions: {
|
|
minValue: 1,
|
|
maxValue: 100,
|
|
},
|
|
default: 100,
|
|
description: 'How many results to return.',
|
|
},
|
|
{
|
|
displayName: 'Filters',
|
|
name: 'filters',
|
|
type: 'collection',
|
|
placeholder: 'Add Filter',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'search',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Query',
|
|
name: 'query',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'External ID',
|
|
name: 'external_id',
|
|
type: 'string',
|
|
default: '',
|
|
},
|
|
],
|
|
},
|
|
/* -------------------------------------------------------------------------- */
|
|
/* user:delete */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'User ID',
|
|
name: 'id',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'user',
|
|
],
|
|
operation: [
|
|
'delete',
|
|
],
|
|
},
|
|
},
|
|
description: 'User ID',
|
|
},
|
|
] as INodeProperties[];
|