You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api-ref.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4103,7 +4103,7 @@ The `UserItem` class contains the members or attributes for the view resources o
4103
4103
4104
4104
Name | Description
4105
4105
:--- | :---
4106
-
`auth_setting` | (Optional) This attribute is only for Tableau Cloud. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Cloud -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**.
4106
+
`auth_setting` | (Optional) This attribute is only for Tableau Cloud. The new authentication type for the user - see **User Auth** below for values.
4107
4107
`domain_name` | The name of the site.
4108
4108
`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Cloud. For other server configurations, this field contains null.
4109
4109
`id` | The id of the user on the site.
@@ -4115,6 +4115,15 @@ Name | Description
4115
4115
`site_role` | The role the user has on the site. This attribute is required if you are creating a `UserItem` instance. See *User Roles* below for details.
4116
4116
`groups` | The groups that the user belongs to. You must run the populate_groups method to add the groups to the `UserItem`.
4117
4117
4118
+
**User Auth**
4119
+
4120
+
You can assign the following values for this attribute:
4121
+
*`OpenID`
4122
+
*`SAML` (the user signs in using **Single sign-on**)
4123
+
*`ServerDefault` (the user signs in using the default authentication method for the server - in Tableau Cloud this is **TableauID**)
4124
+
*`TableauIDWithMFA`
4125
+
These options appear in the **Authentication** tab on the **Settings** page in Tableau Cloud.
4126
+
4118
4127
**User Roles**
4119
4128
4120
4129
The possible user roles for the `site_role` attribute are the following:
0 commit comments