Skip to content

Commit 4259c40

Browse files
author
Jordan Caussat
committed
Update users doc: add link for admin options and rename identities options to extern_*
1 parent 05b8d03 commit 4259c40

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

website/docs/d/users.html.markdown

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ description: |-
1010

1111
Provides details about a list of users in the gitlab provider. The results include id, username, email, name and more about the requested users. Users can also be sorted and filtered using several options.
1212

13+
**NOTE**: Some of the available options require administrator privileges. Please visit [Gitlab API documentation][users_for_admins] for more information.
14+
1315
## Example Usage
1416

1517
```hcl
@@ -34,9 +36,9 @@ The following arguments are supported:
3436

3537
* `sort` - (Optional) Sort users' list in asc or desc order. (Requires administrator privileges)
3638

37-
* `identities_extern_uid` - (Optional) Lookup users by external UID. (Requires administrator privileges)
39+
* `extern_uid` - (Optional) Lookup users by external UID. (Requires administrator privileges)
3840

39-
* `identities_provider` - (Optional) Lookup users by external provider. (Requires administrator privileges)
41+
* `extern_provider` - (Optional) Lookup users by external provider. (Requires administrator privileges)
4042

4143
* `created_before` - (Optional) Search for users created before a specific date. (Requires administrator privileges)
4244

@@ -64,3 +66,4 @@ The following attributes are exported:
6466
* `two_factor_enabled` - Whether user's two factor auth is enabled.
6567

6668

69+
[users_for_admins]: https://docs.gitlab.com/ce/api/users.html#for-admins

0 commit comments

Comments
 (0)