Alteryx · Schema

UpdateUserContract

Contract for updating an existing user

AnalyticsAutomationData EngineeringData PreparationData ScienceETLMachine LearningPredictive Analytics

Properties

Name	Type	Description
id	string	User ID (optional, for verification)
firstName	string
lastName	string
email	string
role	string
defaultWorkerTag	string
canScheduleJobs	boolean
canPrioritizeJobs	boolean
canAssignJobs	boolean
canCreateCollections	boolean
isApiEnabled	boolean
defaultCredentialId	string
isAccountLocked	boolean	Whether the account is locked
isActive	boolean
isValidated	boolean	Whether the user's email has been validated
timeZone	string
language	string	User's preferred language
canCreateAndUpdateDcm	boolean
canShareForExecutionDcm	boolean
canShareForCollaborationDcm	boolean
canManageGenericVaultsDcm	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UpdateUserContract",
  "type": "object",
  "description": "Contract for updating an existing user",
  "properties": {
    "id": {
      "type": "string",
      "description": "User ID (optional, for verification)"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "role": {
      "type": "string"
    },
    "defaultWorkerTag": {
      "type": "string"
    },
    "canScheduleJobs": {
      "type": "boolean"
    },
    "canPrioritizeJobs": {
      "type": "boolean"
    },
    "canAssignJobs": {
      "type": "boolean"
    },
    "canCreateCollections": {
      "type": "boolean"
    },
    "isApiEnabled": {
      "type": "boolean"
    },
    "defaultCredentialId": {
      "type": "string"
    },
    "isAccountLocked": {
      "type": "boolean",
      "description": "Whether the account is locked"
    },
    "isActive": {
      "type": "boolean"
    },
    "isValidated": {
      "type": "boolean",
      "description": "Whether the user's email has been validated"
    },
    "timeZone": {
      "type": "string"
    },
    "language": {
      "type": "string",
      "description": "User's preferred language"
    },
    "canCreateAndUpdateDcm": {
      "type": "boolean"
    },
    "canShareForExecutionDcm": {
      "type": "boolean"
    },
    "canShareForCollaborationDcm": {
      "type": "boolean"
    },
    "canManageGenericVaultsDcm": {
      "type": "boolean"
    }
  }
}