Skip to content

Commit 9162447

Browse files
committed
docs: correct link names and URLs
1 parent fcb1fb0 commit 9162447

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

docs/api-ref.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4933,11 +4933,11 @@ users.bulk_add(users)
49334933

49344934
When adding users in bulk, the server creates an asynchronous job. This method returns the `JobItem` you can use to track progress.
49354935

4936-
REST API: Add User to Site. ([Tableau Help][1])
4936+
REST API: [Import Users to Site from CSV ](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#import_users_to_site_from_csv)
49374937

49384938
**Version**
49394939

4940-
This endpoint is available with REST API version **3.15** and up.
4940+
This endpoint is available with REST API version **3.27** and up.
49414941

49424942
**Parameters**
49434943

@@ -4947,14 +4947,14 @@ This endpoint is available with REST API version **3.15** and up.
49474947

49484948
**UserItem field notes**
49494949

4950-
* `name` **required**. If using Active Directory and the username isn’t unique across domains, include the domain-qualified form (for example `example\\Adam` or `adam@example.com`). ([Tableau Help][1])
4950+
* `name` **required**. If using Active Directory and the username isn’t unique across domains, include the domain-qualified form (for example `example\\Adam` or `adam@example.com`).
49514951
* `fullname` is used as the user’s display name (TSC reads the display name from `fullname`).
4952-
* `email` optional, but if provided it must be a valid email address; it is included in the REST payload as `email`. ([Tableau Help][1])
4953-
* `auth_setting` optional. If not provided and `idp_configuration_id` is `None`, the default is `ServerDefault`. (REST supports `authSetting` and `idpConfigurationId` as user creation attributes.) ([Tableau Help][1])
4952+
* `email` optional, but if provided it must be a valid email address; it is included in the REST payload as `email`.
4953+
* `auth_setting` optional. If not provided and `idp_configuration_id` is `None`, the default is `ServerDefault`. (REST supports `authSetting` and `idpConfigurationId` as user creation attributes.)
49544954
* `site_role` optional. If not provided, defaults to `Unlicensed`.
49554955
* `password` optional and only used when the server is using **local authentication**; do not provide a password for other auth types.
49564956
* Admin level and publishing capability are inferred from `site_role`.
4957-
* If the user belongs to a different IdP configuration, set `UserItem.idp_configuration_id` to that configuration’s ID. (REST supports `idpConfigurationId` when adding a user.) ([Tableau Help][1])
4957+
* If the user belongs to a different IdP configuration, set `UserItem.idp_configuration_id` to that configuration’s ID. (REST supports `idpConfigurationId` when adding a user.)
49584958

49594959
**Returns**
49604960

@@ -4983,7 +4983,6 @@ for user in users:
49834983
job = server.users.bulk_add(users)
49844984
```
49854985

4986-
[1]: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm "Users and Groups Methods - Tableau"
49874986

49884987

49894988
#### users.bulk_remove
@@ -4994,11 +4993,11 @@ users.bulk_remove(users)
49944993

49954994
Remove multiple users from the current site in a single bulk operation. Users are identified by **domain** and **name** (not by user ID). This call is "fire-and-forget" in TSC: it does **not** return a `JobItem`, and it does not provide per-user results.
49964995

4997-
REST API: **Delete Users from Site with CSV** (`POST /sites/{site-id}/users/delete`). ([Tableau Help][1])
4996+
REST API: [Delete Users from Site with CSV](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#delete_users_from_site_with_csv)
49984997

49994998
**Version**
50004999

5001-
This endpoint is available with REST API version **3.15** and up. ([Tableau Help][2])
5000+
This endpoint is available with REST API version **3.27** and up.
50025001

50035002
**Parameters**
50045003

0 commit comments

Comments
 (0)