Tableau Migration SDK 5.1.1
  • Articles
  • Code Samples
  • Python API Reference
  • C# API Reference
Show / Hide Table of Contents
  • SDK Terminology
  • Configuration
  • Plan Validation
  • Logging
  • Hooks
    • Custom Hooks
    • Example Hook Use Cases
    • Python Hook Update from v3 to v4+
  • User Authentication
  • Custom View File
  • Dependency Injection
  • Troubleshooting

User and Group authentication

Tableau Server and Tableau Cloud support different authentication types. The Migration SDK supports authentication types listed in AuthenticationTypes out of the box.

Defaults

The default authentication type for users is ServerDefault. It is set by the automatically registered UserAuthenticationTypeTransformer.

Server to Cloud

It is possible to set the authentication type on users and groups. The ServerToCloudMigrationPlanBuilder contains methods to support mapping Server users and groups to Cloud authentication types.

SAML and Tableau ID specific

  1. WithSamlAuthenticationType(string domain, string? idpConfigurationName = null) : Adds mappings for user and group domains based on the SAML authentication type with a domain supplied. When a site has multiple SAML authentication types enabled, the IdP configuration name should be supplied.
  2. WithTableauIdAuthenticationType(bool mfa = true, string? idpConfigurationName = null): Adds mappings for user and group domains based on the Tableau ID authentication type with or without multi-factor authentication.

Tableau Cloud Usernames

The WithTableauCloudUsernames() method and its overloads allow you to supply an email domain or your own implementation of ITableauCloudUsernameMapping for Tableau Cloud user names.

General methods

The WithAuthenticationType() method and its overloads allow you to supply your chosen authentication type with your implementation of IAuthenticationTypeDomainMapping. When a site has multiple authentication types enabled the IdP configuration name should be used as the authentication type. Otherwise a AuthenticationTypes value should be used.

Custom Mapping

You can also build your own mapping to supply to the appropriate WithAuthenticationType() overload. See Sample EmailDomainMapping for example code.

  • Edit this page
In this article