Add User to Site

Add a user to Tableau Cloud and assign the user to the current site.

If the user exists in Tableau Cloud, this card updates the existing user record.

Input

Field Definition Type Required

User

Name

Username of the user.

This corresponds to the email address that the user employs to sign in to Tableau Cloud.

 Text TRUE

Site Role

Select the site role to assign to the user.

  • Site Administrator Creator

  • Creator

  • Site Administrator Explorer

  • Explorer Can Publish

  • Explorer

  • Viewer

  • Unlicensed

If there are no available licenses for the selected role, the card assigns the Unlicensed role.

 Dropdown TRUE

Auth Setting

Select the authentication type for the user.

  • SAML: The user signs in using the identity provider configured for the site.

  • OpenID: The user signs in using Google, Salesforce, or their OpenID provider credentials.

  • TableauID With MFA: The user signs in with a combination of TableauID credentials and a registered verification method.

  • Server Default: The user signs in using the default authentication method set for the server.

If Tableau Cloud hasn't updated the site to require Tableau with MFA, you can use the Server Default type on a temporary basis. After the site is updated to require Tableau with MFA, this authentication method fails and the card returns a 400 Bad Request error.

 Dropdown TRUE

Output

Field Definition Type

User

ID

Unique identifier of the user. Text

Name

Username of the user. Text

Site Role

The site role that is assigned to the user.

If the site doesn't have available licenses for the selected role, then this value is different from the Site Role input.

 Text

Auth Setting

The authentication type for the user.

 Text

External Auth User ID

The ID stored in the single sign-on (SSO) system for Tableau Cloud.

If the user isn't configured to use external authentication, this value is the empty string.

 Text