AlteryxGallery MongoDB Schema

Version:
2020.2
Last modified: September 03, 2020

The AlteryxGallery MongoDB is the database for the Gallery part of your Server instance. This article covers the AlteryxGallery MongoDB schema version 28, which corresponds to the 2020.2 Server version. Servers using either embedded MongoDB or user-managed MongoDB use this schema.

As a Server admin, you might need to access the MongoDB schema for your Server instance for reporting and analysis. You can access the MongoDB schema using any compatible client. mongo Shell is a good tool for command-line access. MongoDB Compass is good tool for GUI access. If you use MongoDB Atlas you can access the database documents via the Atlas web console.

We do not support making direct edits to your MongoDB database. Doing so can cause unexpected results.

The AlteryxGallery MongoDB is made up of the below collections. Collections are groupings of MongoDB documents which are made up of a set of field-value pairs. Select a collection to see the definition of the fields, also known as the schema.

Version 2020.2 MongoDB Schema Changes

In the 2020.2 version release, the AlteryxGallery MongoDB includes these new fields, obsolete fields, and updated fields.

New Fields

  • There is a new IsE2 field in the users appInfos Collection that identifies if the specific workflow revision is using the e2 (AMP) engine.​​​​​​

Changed Fields

  • The API Key and API Secret within the Users Collection are now used to access both the admin and user API. Admin access requires the user to be a Curator.
activeDirectoryPermissions

This Collection is obsolete as of the 2020.1 version release. The data is preserved if you upgrade from a previous version but is unused.

The activeDirectoryPermissions Collection contains permissions for Active Directory users and groups. This Collection was only present in Servers using Windows Authentication. 

  • [Obsolete] _id: (ObjectId) Document primary key.
  • [Obsolete] Category: (Int32) Identifies the object as a user or a group. User=0. Group=1.
  • [Obsolete] Name: (String) User or group name formatted as domain\object
  • [Obsolete] Sid: (String) Active Directory SID (security identifier).
  • [Obsolete] DisplayName: (String) User or group display name.
  • [Obsolete] PermissionType: (String) Role permission granted to the user or group. -1=No Access. 0=Viewer. 2=Artisan. 3=Curator.
apiNonces

The apiNonces Collection contains API key and nonce data for active API sessions.

  • _id: (ObjectId) Document primary key.
  • ApiKey: (String) User's API key.
  • Timestamp: (Int32) Epoch timestamp.
  • Nonce: (String) Unique nonce value.
  • CompoundKey: (String) Compound key consisting of the API key, timestamp, and nonce.
  • CreateDate: (Date) Date-time (UTC) the nonce was created.
appInfos

The appInfos Collection contains published workflows data.

  • _id: (ObjectId): Document primary key.
  • CreatedBy: (String) Original author ID.
  • IsPublic: (Boolean) Workflow publicly shared flag.
  • DateMadePublic: (Date) Date-time (UTC) when the workflow was last made public.
  • IsDeleted: (Boolean) Workflow deleted flag. Note, changing this back to false does not recover the deleted workflow.
  • TotalRunCount: (Int32) Count of all runs across all workflow versions.
  • SubscriptionId: (String) Workflow's Subscription (Studio) ID.
  • SubscriptionName: (String) Subscription display name.
  • TagIds: (Array) Array of Tag IDs.
  • ServiceId: (String) ID of the document in AlteryxServiceAS_Applications.
  • SourceAppID: (String) ID used for workflow migration (promotion) via the API.
  • Revisions: (Array) Array of info for all workflow revisions.
    • RevisionId: (String) Revision ID.
    • ParentId: (String)
    • RevisionNumber: (Int32)
    • AuthorId: ID of the author that published the revision.
    • DateCreated: (Date) Date-time (UTC) when the revision was published.
    • ExecutionMode: (Int32) Workflow run mode. 0=Safe. 1=Semi-Safe. 2=Unrestricted.
    • RunDisabled: (Boolean) Flag to disable workflow runs.
    • IsChunkedPackage: (Boolean) Flag that indicates whether the workflow package was split into chunks when uploaded.
    • RunCount: (Int32) Count of revision runs.
    • DownloadCount: (Int32) Count of revision downloads.
    • PackageType: (Int32) Integer value identifying type of workflow package. 0=app. 1=workflow. 2=macro.
    • PrimaryApplication: (Object) Workflow metadata.
      • FileName: (String) Workflow file name.
      • MetaInfo: (Object) Workflow metadata as provided by Designer. Includes these strings: Name, Description, Author, Copyright, Url, UrlText, OutputMessage, NoOutputFilesMessage.
      • NextApp: (String) Used for chained apps.
      • Validation: (Object) Validation info specific to the primary workflow.
        • IsValid: (Boolean) Flag set if workflow passes validation.
        • RequiresPrivateData: (Boolean) Flag set if the workflow requires location or business insights data.
        • Messages: (Array) Validation error messages.
        • DatasetMessages: (Array) Validation error message if caused by dataset requirement.
        • ValidationId: (String) Validation Job ID.
        • RequiresApproval: Workflow violates configured run mode and requires approval by a curator.
    • Applications: (Array) Workflow metadata. The data structure is the same as Primary Application but also includes information about chained apps.
    • Validation: (Object) Validation information for the overall package. Validation is performed when the workflow is published. Fields are the same as those in the Primary Application Validation object.
    • HasPrivateDataExemption: (Boolean) Flag for private data exemption. HasPrivateDataExemption can be null if it has never been set. Defaults to false if no value is present.
    • UploadDate: (Date) Date-time (UTC) the workflow was uploaded.
    • WorkflowCredentialType: (Int32) Integer value identifying the workflow credential type. 
    • CredentialId: (String) ID of the workflow credential used.
    • CredentialUsername: (String) Credential username.
    • CredentialPasswordId: (String) ID of the stored credential password.
    • [New] IsE2: (Boolean) Identifies if the specific workflow revision is using the e2 (AMP) engine.
    • Permissions: (Array) Workflow-specific permissions.
      • CanDownload: (Boolean) Flag that enables workflow downloads.
      • AllowVersionHistory: (Boolean) Flag that allows others to view workflow history.
  • PublishedRevision: (Object) Info about the published workflow revision. The data structure is the same as Revisions. 
  • IconID: (String) Workflow icon image ID.
  • Version: (Null)
  • WorkerTag: (String) Workflow worker tag.
  • IsReadyForMigration: (Boolean) Workflow migration (promotion) flag.
  • RunDisabled: Flag to disable workflow runs.
  • PackageType: (Null)
appPackages

The appPackages Collection is no longer used.

auditEvents

The auditEvents Collection contains audit log events. See Audit Logs.

  • _id: (ObjectId) Document primary key.

  • Entity: (String) Type of object created, changed, or removed.

  • EntityId: (String) Object ID.

  • UserId: (String) User ID for the user that triggered the action.

  • Timestamp: (Date) Date-time (UTC) the action occurred.

  • Event: (String) The action.

  • OldValues: (String) Original entity values.

  • NewValues: (String) New entity values.

authenticationNonces

The authenticationNonces Collection stores nonce values used during authentication.

  • _id: (ObjectId) Document primary key.
  • NonceValue: (String) Unique nonce value.
  • TimeStamp: (Date) Date-time (UTC) the nonce was created.
bannerImages

The bannerImages Collection contains banner images uploaded to Gallery. See Media.

  • _id: (ObjectId) Document primary key.
  • MimeType: (String) Uploaded image mime type.
  • FileName: (String) Uploaded image file name.
  • Banner: (String) Base64-encoded binary data for the uploaded file.
  • Active: (Boolean) Flag for whether the banner is active.
  • StartDate: (Date) Date-time (UTC) when the banner was set to active.
  • EndDate: (Date) Date-time (UTC) when the banner was set to inactive.
  • SortOrder: (Int32) Banner rotation order. 
  • Link: (String) URL banner image links to.
  • AltText: (String) URL descriptive hover text.
collections

The "collections" Collection contains data about collections.

  • _id: (ObjectId) Document primary key.
  • CollectionId: (String) Collection ID. Used in the Gallery collection URL.
  • Name: (String) Collection name.
  • OwnerId: (String) User ID of collection owner.
  • DateAdded: (Date) Date-time (UTC) collection was created.
  • Apps: (Array) Array of info on all workflows in the collection.
    • ApplicationId: (String) Workflow ID.
    • DateAdded: (Date) Date-time (UTC) workflow was added to the collection.
    • AddedById: (String) User ID for the user that added the workflow to the collection.
  • Insights: (Array) Array of info on all insights in the collection.
    • InsightId: (String) Insight ID.
    • DateAdded: (Date) Date-time (UTC) insight was added to the collection.
    • AddedById: (String) User ID for the user that added the insight to the collection.
  • Users: (Array) Array of users the collection is shared with.
    • UserId: (String) User ID.
    • DateAdded: (Date) Date-time (UTC) user was added.
    • AddedById: (String) User Id of the user who added the user.
    • ActiveDirectoryObject: (Array) Active Directory info for Servers using integrated windows authentication.
      • Category: (Int32) Type of Active Directory object. 0=user. 1=group.
      • Name: (String) Network name for Active Directory user or group.
      • Sid: (String) SID for Active Directory user or group.
      • DisplayName: (String) Active Directory user or group name.
    • ExpirationDate: (Date) User's expiration date-time (UTC). 
    • Permissions: (Object) User's collection permissions.
      • Collection: (Object) Collection-level user permissions.
        • IsAdmin: (Boolean) Flag for collection admin permissions. Users with this permission have all asset and user-management permissions.
      • Assets: (Object) Asset-level collection permissions.
        • CanAdd: (Boolean) Permission for adding assets (for example, workflows and insights) to the collection. 
        • CanRemove: (Boolean) Permission for removing assets (for example, workflows and insights) from the collection.
        • CanUpdate: (Boolean) Permission for updating assets (for example, workflows and insights) in the collection.
      • Users: (Object) User-management collection permissions.
        • CanAdd: (Boolean) Permission to add users to the collection.
        • CanRemove: (Boolean) Permission for removing users from the collection
      • Subscriptions: (Array) Array containing info on the subscriptions (studios) the collection is shared with. The data structure is the same as Users.
commandQueueItems

The commandQueueItems Collection contains index search update commands. This collection is typically empty except in the case that the search indexer is currently updating entries within the AlteryxGallery_Lucene database or a failure to update search indexes has occurred.

  • _id: (ObjectId) Document primary key.
  • Command: (Int32) Type of command.
  • SearchData: (Object) Metadata specific to the search index. This schema may vary depending on the type of search being created or updated. There are additional fields containing the search data.
    • _t: (String) Type of search data.
    • _id: (String) Search data ID.
  • State: (Object) Update request state and messaging.
configurations

The configurations Collection contains Gallery configuration settings data.

  • _id: (ObjectId) Document primary key.
  • EffectiveDate: (Date) The installation date-time (UTC) for the environment
  • SystemMessage: (String) Banner system message displayed to users in Gallery. See Notifications.
  • [Obsolete] Terms: (Array) Terms of service information (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
    • [Obsolete] _id: (ObjectId) Document primary key.
    • [Obsolete] EffectiveDate: (Date) Date terms were agreed to. 
    • [Obsolete] Text: (String) Terms of service agreement text.
  • Notifications: (Object) Email notification configuration info.
    • Email: (Array) Array of email notifications.
      • Name: (String) Email notification name.
      • Subject: (String) Email notification subject.
      • Body: (String) Email notification body.
      • IsBodyHtml: (Boolean) Flag for HTML email notification body.
      • EmailGroup: (Object) Info on email preference group the email notification is a part of.
        • Group: (String) Email preference group ID. 
        • Description: (String) Email preference group description.
        • Active: (Boolean) Flag for whether the group is active.
      • FriendlyName: (String) Email notification display name.
      • Description: (String) Email notification description.
      • Placeholders: (Array) Array of placeholder strings. Placeholders are used in the email notification templates. Strings include Collection Name, Collection Owner Name, Collection URL, Workflow Name, Workflow URL, and Collection Owner URL.
      • IsDisableable: (Boolean) Flag to allow notification to be disabled.
      • Enabled: (Boolean) Flag to enable notification.
    • NotificationPreferenceGroups: (Array) Email preference groups info.
      • Group: (String) Email preference group ID.
      • Description: (String) Email preference group description.
      • Active: (Boolean) Flag to make group active.
    • DesignerDownloadURL: (String) Designer download link URL.
    • DefaultPermission: (String) Default user role. Possible values are No Access, Viewer, Member, Artisan, or Curator.
    • SignupDisabled: (Boolean) Flag to disable Gallery account signups. Allows users to sign up for an account via the login screen in galleries using built-in authentication. This flag also allows accounts to be created automatically with SAML after the user successfully authenticates with the IDP. 
    • GalleryName: (String) Custom name for the Gallery. Defined in theme settings. See Theme
    • AnonymousUsage: (Boolean) Flat to enable anonymous (unregistered) users to run workflows. 
    • ApiEnabled: (Boolean) Flag to enable Gallery API access.
    • CustomCss: (Object) Custom CSS defined in the Gallery theme. See Theme
      • Sections: (Array) Array containing each theme section.
        • Name: (String) Section name. Possible values are Header, Side Navigation, Primary button, Secondary button.
        • Styles: (Array) Style info.
          • Selector: (String) Comma-separated list of selectors style is applied to.
          • Properties: (Array) Style properties.
            • FriendlyName (String) Friendly name of the CSS style property.
            • Names: (Array) CSS style properties.
            • Value: (String) Property value.
    • UserCredentialState: (Int32)
    • SchedulerEnabled: (Boolean) Gallery-level flag to enable scheduling.
    • SchedulerValidationInterval: (String)
    • KeyPairXmlEncrypted: (String)
    • NumAllowedLoginAttempts: (Int32) Number of login failures allowed before the account is locked.
    • MigrationEnabled: (Boolean) Flag to allow workflows to be migrated (promoted).
    • AccountLockTimeout: (Int32) Account lockout period
    • EnforceLoginAttemptTimeout: (Boolean) Flag to enable account lockout for failed attempts. 
credentials

The credentials Collection contains workflow credentials data. See Credentials.

  • _id: (ObjectId) Document primary key.
  • Username: (String) Workflow credential username.
  • PasswordId: (String) Stored password ID.
  • Subscriptions: (Array) Array of subscription IDs the workflow credential has been shared with.
  • Users: (Array) Array of user IDs the workflow credential has been shared with.
dataConnections

The dataConnections Collection contains info about data connections. See Data Connections.

  • _id: (ObjectId) Document primary key.
  • ConectionString: (String) Hashed database connection string.
  • PasswordSecured: (String) Hashed password for the database connection.
  • ConnectionName: (String) Data connection display name.
  • Subscriptions: (Array) Array of subscription IDs the data connection has been shared with.
  • Users: (Array) Array of user IDs the data connection has been shared with.
districtIcons

The districtIcons Collection contains data for icons associated with districts. See Districts.

  • _id: (ObjectId) Document primary key.
  • FileName: (String) Icon file name.
  • MimeType: (String) Icon mime type.
  • LargeIcon: (String) Base64-encoded binary data for the uploaded file.
  • UploadDate: (Date) Date-time (UTC) icon was uploaded.
  • SmallIcon: (String) Base64-encoded binary data for the icon thumbnail.
districts

The districts Collection contains data about districts. See Districts.

  • _id: (ObjectId) Document primary key.
  • Title: (String) District display name.
  • Description: (String) District description.
  • TagId: (String) Tag ID for the tag associated with the district.
  • NavTitle: (String) District navigation link text.
  • IconId: (String) Icon ID.
  • Active: (Boolean) Flag for whether district is active.
  • SortOrder: (Int32) District sort order.
  • Excerpt: (String) District excerpt text.
groupRoles

This Collection is new as of the 2020.1 version release. The data from the activeDirectoryPermissions was migrated to the WindowsIdentity object in this Collection and the users Collection.

The groupRoles Collection contains data about Active Directory groups. See Set a Group Role

  • _id: (ObjectId) Document primary key.
  • WindowsIdentity: (Object) Info on Active Directory group.
    • Sid: (String) Group SID (security identifier).
    • DisplayName: (String) Group display name.
    • Name: (String) Group name in domain/group format.
    • SamAccountName: (String) Sam account name.
  • Role: (String) Role assigned to the group. Possible values are No Access, Viewer, Member, Artisan, or Curator.
  • DateAdded: (Date) Date-time (UTC) the group was added to the environment. Note, for existing groups this date is set to the date-time of the upgrade to version 2020.1. If you skipped version 2020.1, the date-time of groups that existed prior to upgrade is set to the date-time of the upgrade to 2020.2. 
insightIcons

The insightIcons Collection contains data about insight icons. 

  • _id: (ObjectId) Document primary key.
  • FileName: (String) Icon file name.
  • MimeType: (String) Icon mime type.
  • LargeIcon: (String) Base64-encoded binary data for the uploaded file.
  • UploadDate: (Date) Date-time (UTC) icon was uploaded.
  • SmallIcon: (String) Base64-encoded binary data for the icon thumbnail.
insights

The insight Collection contains data about insights. 

  • _id: (ObjectId) Document primary key.
  • InsightId: (String) Insight ID. Used in the Gallery insight URL. 
  • Name: (String) Insight display name.
  • LastUpdated: (Date) Date-time (UTC) insight was last updated.
  • OwnerId: (String) User ID for the user the owns the insight.
  • IconId: (String) Insight icon ID. 
licenseAdministrators

The licenseAdministrators Collection contains data about license administrators (only applies to the Alteryx Public Gallery at gallery.alteryx.com).

licenseBundles

The licenseBundles Collection contains data about licensing bundles (only applies to the Alteryx Public Gallery at gallery.alteryx.com).

licenseTemplates

The licenseTemplates Collection contains data about licensing templates (only applies to the Alteryx Public Gallery at gallery.alteryx.com).

locks

The locks Collection contains search indexing and schema migration locks. Index locks are set when actions are taken within the Gallery that require an index update for search purposes. Migration locks are set during Server installation or upgrade. 

  • _id: (ObjectId) Document primary key.
  • Type: (Int32) Type of lock. 0=index. 1=schema migration.
  • LastObtained: (Date) Date-time (UTC) the lock was last obtained.
  • MachineName: (String) Hostname of the Gallery node holding the lock.
  • OwnerId: (Null) 
logoImages

The logoImages Collection contains data about logo images uploaded in the Gallery theme. See Theme.

  • _id: (ObjectId) Document primary key.
  • ImageData: (String) Base64-encoded binary data for the uploaded file.
  • IsDefault: (Boolean) 
  • MimeType: (String) Logo mime type.
medias

The medias Collection contains data about uploaded media files. See Media.

  • _id: (ObjectId) Document primary key.
  • FileName: (String) Icon file name.
  • Title: (String) Title of the media. This is usually the same as the file name.
  • Type: (String) The type of media file uploaded. 
  • Data: (String) Base64-encoded binary data for the uploaded file.
  • Thumbnail: (String) Base64-encoded binary data for the thumbnail.
  • Extension: (String) File extension.
navigations

The navigations Collection contains data about links specified on the Links page. See Links

  • _id: (ObjectId) Document primary key.
  • Header: (Array) Array of header links. Footer links were moved to the header.
    • _id: (ObjectId) Link ID.
    • Title: (String) Link text.
    • URL: (String) Link URL.
    • Children: (Array)
    • PageId: (String) ID of the linked page (if the link is to a Gallery page).
  • Footer: No longer used.
  • Main: No longer used.
pages

The pages Collection contains data about pages. See Pages

  • _id: (ObjectId) Document primary key.
  • AuthorUserId: (String) User ID for the user that created the page.
  • Title: (String) Page title.
  • Permalink: (String) Page permalink.
  • Body: (String) Page body content.
  • Excerpt: (String) Page excerpt.
  • Categories: (Null)
  • Status: (Int32) Page status. 0=Draft. 1=Published.
  • CreatedDate: (Date) Date-time (UTC) page was created.
  • UpdatedDate: (Date) Date-time (UTC) page was last updated. 
sessions

The sessions Collection contains user session data. 

  • _id: (ObjectId) Document primary key.
  • SessionId: (String) Session ID.
  • Active: (Boolean) Flag for whether the session is active.
  • UserId: (String) User ID.
  • CreationDate: (Date) Date-time (UTC) session was created.
  • UpdatedDate: (Date) Date-time (UTC) session was last updated.
  • Anonymous: (Boolean) Flag for whether session is for an anonymous user.
  • KeepAlive: (Boolean) Flag for whether the session should be kept alive.
subscriptions

The subscriptions Collection contains data about subscriptions. See Subscriptions

  • _id: (ObjectId) Document primary key.
  • [Obsolete] LicenseKey: (String) Subscription (Studio) key.
  • Name: (String) Studio display name.
  • ApiKey: (String) Subscription API key.
  • ApiSecret: (String) Hashed API secret for the subscription.
  • [Obsolete] PrimaryContactInfo: (Object) Info on the primary contact for the subscription. This entire object is now obsolete. 
  • Active: (Boolean) Flag for whether subscription is active.
  • [Obsolete] Type: (Int32) Type of subscription. 0=free. 2=paid.
  • [Obsolete] SeatsPurchased: (Int32) Number of Artisan seats.
  • [Obsolete] MemberPassesPurchased: (Int32) Number of Member seats.
  • [Obsolete] MemberPassesUsed: (Int32) Number of Member seats assigned to users.
  • [Obsolete] PurchaseDate: (Date) Date-time (UTC) subscription was created.
  • [Obsolete] ExpirationDate: (String) Date-time (UTC) subscription expires.
  • ExpDate: (Date) Date-time (UTC) subscription expires.
  • DateUpdated: (Date) Date-time (UTC) subscription was last updated. 
  • [Obsolete] TrialUsed: (Boolean) 
  • ApiEnabled: (Boolean) Flag to enable Gallery API access for the subscription.
  • CanShareSchedules: (Boolean) Flag to enable scheduling for the subscription.
  • CredentialId: (String) Default workflow credential ID for the subscription.
  • Credentials: (Array) List of workflow credential IDs shared with the subscription.
  • DataConnections: (Array) List of data connection IDs shared with the subscription.
  • DefaultWorkerTag: (String) Tag for the default worker assigned to the subscription.
tags

The tags Collection contains data about tags. See Add a Tag.

  • _id: (ObjectId) Document primary key.
  • Name: (String) Tag display name.
  • Description: (String) Tag description.
  • AdminOnly: (Boolean) Tag is enabled for Curators only.
temporaryTokens

The temporaryTokens Collection contains temporary tokens associated with user sessions.

  • _id: (ObjectId) Document primary key.
  • Token: (String) Token string.
  • UserId: (String) User ID.
  • Expiration: (Date) Date-time (UTC) token expires.
  • SessionId: (String) Session ID.

 

usageReports

The usageReports Collection contains Designer usage data from Designers configured to report usage to this Server. 

  • _id: (ObjectId) Document primary key.
  • Type: (Int32) Integer value representing the type of usage data captured. Possible values are 10=AppExecution, 11=SignupDisplayed, 12=GlobalSearch, 13=LicenseTransfer, 14=Shepherding, GlobalSettings=15, 400=Profiling, 401=DataProfiling, 1000-1999=Exceptions.
  • SerialNumber: (String) Serial number (typically an email address) associated with the active license.
  • DeviceId: (String) ID of device reporting the data. The ID is a combination of the device GUID, machine name, and serial number.
  • SeatGuid: (String) Seat ID.
  • FlexnetVendorSnippets: (Object) License data.
    • ActivationId: (String) Activation ID issued by Flexera when a license is activated.
    • ProductName: (String) Activated product names.
    • Snippet: (String) Hashed value.
  • Guid: (String) Unique Guid.
  • IpAddress: (String) IP address for machine reporting usage data.
  • DateTime: (Date) Date-time (UTC) the data was reported by the client.
  • ServerDateTime: (Date) Date-time (UTC) on the Server when the data was received.
  • Version: (String) Version of Designer.
  • Preview: (Boolean) Flag for whether the build is Beta.
  • Cores: (Int32) Number of cores detected by Designer.
  • IsTrial: (Boolean) Flag for a trial license.
  • Data: (String) Usage data in JSON format. 
  • UserId: (String) User ID.
users

The users Collection contains user data. 

  • _id: (ObjectId) Document primary key.
  • [Obsolete] Curator: (Boolean) Flag to for Curator permission.
  • [Obsolete] Anonymous: (Boolean) Flag to set user to anonymous.
  • [Obsolete] LicenseCurator: (Boolean) Flag to allow user to manage licenses (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
  • [Obsolete] Sponsor: Subscription ID that is granting membership rights.
  • Role: The user's assigned role. 
  • Email: (String) The user's email address.
  • FirstName: (String) The user's first name.
  • LastName: (String) The user's last name.
  • DateAdded: (Date) Date-time (UTC) the user was created.
  • DateUpdated: (Date) Date-time (UTC) the user was last updated.
  • [Obsolete] DateTermsAgreed: (Date) Date-time (UTC) the user agreed to terms of service (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
  • Validated: (Boolean) The user's email address has been validated.
  • Pending: (Boolean) The user's email address is pending validation.
  • Active:  (Boolean) The user's email address is active.
  • ApiEnabled:  (Boolean) Enables access to the Gallery API.
  • ApiKey: (String) User's API key. Used to access both the admin and user API. Admin access requires the user to be a Curator.
  • ApiSecret: (String) User's API secret. Used to access both the admin and user API. Admin access requires the user to be a Curator. 
  • SecurityInfo: (Object) User password info.
    • Password: (String) Hashed, salted, and encrypted password.
    • HMACKey: (String) HMAC key for hashing password.
    • Salt: (String) Salt value used to salt password.
    • PasswordResetNonce: (String) Nonce value used when password reset is initiated.
  • NumFailedLogins: (Int32) Count of failed login attempts.
  • AccountLocked: (Boolean) Flag for locked account.
  • AccountLockedAt: (Date) Date-time (UTC) account was locked.
  • UserProfile: (Object) Extended user info.
    • [Obsolete] Company: (String) User's company.
    • [Obsolete] Title: (String) User's title.
    • [Obsolete] Department: (String) User's department.
    • [Obsolete] JobRole: (String) User's job role.
    • [Obsolete] ContactPhoneNumber: (String) User's phone number.
    • [Obsolete] CompanyAddress: (String) User's company addresss.
    • [Obsolete] Nickname: (String) User's nickname.
    • Picture: (String) User's profile picture.
    • [Obsolete] Website: (String) User's website.
    • [Obsolete] PublicProperties: (Null)
    • IconId: (String) ID of the user's profile picture.
  • SubscriptionId: (String) User's subscription ID.
  • [Obsolete] Referrer: (String) ID of the user that referred the user (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
  • [Obsolete] Referral: (Object) Referrer info (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
  • ExpDate: (Date) Date-time (UTC) the user's account expires (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
  • LastLoginDate: (Date) Date-time (UTC) of the user's last login.
  • Notifications: (Object) Notifications sent to the user.
    • Messages: (Object) Info on notifications sent to the user.
      • _t: (String) Type of notification.
      • _id: (ObjectId) Notification message ID.
      • Message: (String) Message content in HTML.
      • CreatedDate: (Date) Date-time (UTC) the message was sent.
      • Category: (String) Notification category.
      • Enabled: (Boolean) Flag for whether notification is enabled.
    • LastPolled: (Date) Date-time (UTC) the notifications were last checked.
  • NotificationGroupsToFilter: (Array) Array containing info on notifications the user has opted out of via email group selection.
  • WindowsIdentity: (Array) The user's Active Directory identity information for use with Integrated Windows Authentication.
    • Sid: (String) User's Active Directory security ID.
    • DisplayName: (String) User's Active Directory display name.
    • Name: (String) User's Active Directory name in domain\user format.
    • SamAccountName: (String) User's Active Directory Sam (typically their login name).
  • [Obsolete] SignupLocation: (Int32) Integer value representing where the user signed up  (only applies to the Alteryx Public Gallery at gallery.alteryx.com).
  • [Obsolete] Sid: (String) User's Active Directory Security ID.
  • DefaultCredential: (Object) User's selected default credential. Value is null if the user hasn't set a default credential.
    • Username: (String) Username for the user's default credential.
    • PasswordId: (String) Encrypted password if the user-provided credentials that aren't shared. Value is null if the user selects a shared workflow credential as their default credential.
    • CredentialId: (String) Id of the workflow credential if the user-selected default is a shared credential.
  • Credentials: (Array) Workflow credentials shared with the user.
  • DataConnections: (Array) Data connections shared with the user.
  • CanSchedule: (Boolean) User permission flag for scheduling workflows.
  • CanSetPriority: (Boolean) User permission flag for setting workflow priority. 
  • CanSetWorkerTag: (Boolean) User permission flag for setting a worker tag.
  • RecaptchaResponse: (Null) Only applies to the Alteryx Public Gallery at gallery.alteryx.com.
  • Timezone: (String) User's selected time zone.
  • CanCreateCollections: (Boolean) User permission flag for creating collections.
validationKeys
  • _id: (ObjectId) Document primary key.
  • UserId: User ID.
versions

The versions Collection contains MongoDB database schema version data.

  • _id: (ObjectId) Document primary key.
  • Number: (Int32) MongoDB database schema version number.
  • MigrationDate: (Date) Date-time the schema was migrated to this version in UTC. This is typically the date and time of the upgrade to a new Server version.
windowsIdentity

This Collection is obsolete as of the 2020.1 version release. The data is preserved if you upgrade from a previous version but is unused.

The windowsIdentity collection contains Active Directory user information for use with Integrated Windows Authentication.

  • [Obsolete] _id: (ObjectId) Document primary key. 
    • [Obsolete] Name: (String) User's Active Directory name in domain\user format.
    • [Obsolete] Sid: (String) User's Active Directory security ID.
    • [Obsolete] GivenName: (String) User's first name in Active Directory.
    • [Obsolete] SurName: (String) User's last name in Active Directory.
    • [Obsolete] Email: (String) User's email address in Active Directory.
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.