Skip to content

Commit c4c73d9

Browse files
jorwoodsclaude
andcommitted
docs: fix sites.list_auth_configurations method name
Rename list_authentication_configurations to list_auth_configurations to match the actual method name in the endpoint. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 8617d49 commit c4c73d9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/api-ref.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3903,7 +3903,7 @@ Source file: models/site_item.py
39033903

39043904
### SiteAuthConfiguration class
39053905

3906-
The `SiteAuthConfiguration` class contains the attributes for the authentication configuration on Tableau Cloud. This class represents the authentication configuration information returned when using the `sites.list_authentication_configurations` method.
3906+
The `SiteAuthConfiguration` class contains the attributes for the authentication configuration on Tableau Cloud. This class represents the authentication configuration information returned when using the `sites.list_auth_configurations` method.
39073907

39083908
**Attributes**
39093909

@@ -3923,7 +3923,7 @@ Attribute | Description
39233923
# sign in, etc.
39243924

39253925
# Get authentication configurations for the current site
3926-
auth_configs = server.sites.list_authentication_configurations()
3926+
auth_configs = server.sites.list_auth_configurations()
39273927

39283928
# Display configuration details
39293929
for config in auth_configs:
@@ -4230,15 +4230,15 @@ server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d')
42304230
<br>
42314231
<br>
42324232

4233-
#### sites.list_authentication_configurations
4233+
#### sites.list_auth_configurations
42344234

42354235
```py
4236-
sites.list_authentication_configurations()
4236+
sites.list_auth_configurations()
42374237
```
42384238

42394239
Lists the authentication configurations for the current site.
42404240

4241-
REST API: [List Authentication Configurations for the current Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_site.htm#list_authentication_configurations_site)
4241+
REST API: [List Authentication Configurations for the current Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_site.htm#list_auth_configurations_site)
42424242

42434243
**Returns**
42444244

@@ -4251,7 +4251,7 @@ Returns a list of authentication configurations for the current site.
42514251
# server = TSC.Server('https://MY-SERVER')
42524252
# sign in, etc.
42534253

4254-
auth_configs = server.sites.list_authentication_configurations()
4254+
auth_configs = server.sites.list_auth_configurations()
42554255
for config in auth_configs:
42564256
print(f"IDP Configuration ID: {config.idp_configuration_id}")
42574257
print(f"Name: {config.idp_configuration_name}")
@@ -4950,7 +4950,7 @@ Name | Description
49504950
`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance.
49514951
`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.
49524952
`groups` | The groups that the user belongs to. You must run the populate_groups method to add the groups to the `UserItem`.
4953-
`idp_configuration_id` | Tableau Cloud only. The authentication method for the user. To find the idp_configuration_id value, use sites.list_authentication_configurations method. **Important: Use idp_configuration_id or auth_setting, but not both.**
4953+
`idp_configuration_id` | Tableau Cloud only. The authentication method for the user. To find the idp_configuration_id value, use sites.list_auth_configurations method. **Important: Use idp_configuration_id or auth_setting, but not both.**
49544954

49554955

49564956
**User Auth**

0 commit comments

Comments
 (0)