Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

user role docs update #325

Merged
merged 2 commits into from
Apr 30, 2021
Merged

user role docs update #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e060626
Update user roles docs
pdt-dridge Apr 15, 2021
014f63d
Update documentation formatting
pdt-dridge Apr 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion website/docs/r/team_membership.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ The following arguments are supported:

* `user_id` - (Required) The ID of the user to add to the team.
* `team_id` - (Required) The ID of the team in which the user will belong.
* `role` - (Optional) The role of the user in the team. One of `observer`, `responder`, or `manager`. Defaults to `manager`. These roles match up to user roles in the following ways:
* `role` - (Optional) The role of the user in the team. One of `observer`, `responder`, or `manager`. Defaults to `manager`.
These roles match up to user roles in the following ways:
* User role of `user` is a Team role of `manager`
* User role of `limited_user` is a Team role of `responder`

Expand Down
6 changes: 5 additions & 1 deletion website/docs/r/user.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,11 @@ The following arguments are supported:
* `name` - (Required) The name of the user.
* `email` - (Required) The user's email address.
* `color` - (Optional) The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
* `role` - (Optional) The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`. Can be `admin`, `limited_user`, `observer`, `owner`, `read_only_user`, `read_only_limited_user`, `restricted_access`, or `user`.
* `role` - (Optional) The user role. Can be `admin`, `limited_user`, `observer`, `owner`, `read_only_user`, `read_only_limited_user`, `restricted_access`, or `user`.
Notes:
* Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`.
* With advanced permissions, users can have both a user role (base role) and a team role. The team role can configured in the `pagerduty_team_membership` resource.
* Mapping of `role` values to Web UI user role names available in the [user roles support page](https://support.pagerduty.com/docs/advanced-permissions#roles-in-the-rest-api-and-saml).
* `job_title` - (Optional) The user's title.
* `teams` - (Optional, **DEPRECATED**) A list of teams the user should belong to. Please use `pagerduty_team_membership` instead.
* `time_zone` - (Optional) The time zone of the user. Default is account default timezone.
Expand Down