Alteryx · Schema

CreateUserContract

Contract for creating a new user

AnalyticsAutomationData EngineeringData PreparationData ScienceETLMachine LearningPredictive Analytics

Properties

Name Type Description
firstName string User's first name
lastName string User's last name
email string User's email address
role string User role determining access level
defaultWorkerTag string Default worker tag for the user
canScheduleJobs boolean Whether the user can create schedules
canPrioritizeJobs boolean Whether the user can set job priority
canAssignJobs boolean Whether the user can assign jobs to workers
canCreateCollections boolean Whether the user can create collections
isApiEnabled boolean Whether API access is enabled for the user
defaultCredentialId string Default credential ID for the user
isActive boolean Whether the user account is active
timeZone string User's preferred time zone
canCreateAndUpdateDcm boolean Whether the user can create and update DCM connections
canShareForExecutionDcm boolean Whether the user can share DCM connections for execution
canShareForCollaborationDcm boolean Whether the user can share DCM connections for collaboration
canManageGenericVaultsDcm boolean Whether the user can manage generic DCM vaults
View JSON Schema on GitHub

JSON Schema

alteryx-server-v3-create-user-contract-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateUserContract",
  "type": "object",
  "description": "Contract for creating a new user",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "User's first name"
    },
    "lastName": {
      "type": "string",
      "description": "User's last name"
    },
    "email": {
      "type": "string",
      "description": "User's email address"
    },
    "role": {
      "type": "string",
      "description": "User role determining access level"
    },
    "defaultWorkerTag": {
      "type": "string",
      "description": "Default worker tag for the user"
    },
    "canScheduleJobs": {
      "type": "boolean",
      "description": "Whether the user can create schedules"
    },
    "canPrioritizeJobs": {
      "type": "boolean",
      "description": "Whether the user can set job priority"
    },
    "canAssignJobs": {
      "type": "boolean",
      "description": "Whether the user can assign jobs to workers"
    },
    "canCreateCollections": {
      "type": "boolean",
      "description": "Whether the user can create collections"
    },
    "isApiEnabled": {
      "type": "boolean",
      "description": "Whether API access is enabled for the user"
    },
    "defaultCredentialId": {
      "type": "string",
      "description": "Default credential ID for the user"
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether the user account is active"
    },
    "timeZone": {
      "type": "string",
      "description": "User's preferred time zone"
    },
    "canCreateAndUpdateDcm": {
      "type": "boolean",
      "description": "Whether the user can create and update DCM connections"
    },
    "canShareForExecutionDcm": {
      "type": "boolean",
      "description": "Whether the user can share DCM connections for execution"
    },
    "canShareForCollaborationDcm": {
      "type": "boolean",
      "description": "Whether the user can share DCM connections for collaboration"
    },
    "canManageGenericVaultsDcm": {
      "type": "boolean",
      "description": "Whether the user can manage generic DCM vaults"
    }
  }
}