Skip to content
This repository was archived by the owner on Jun 27, 2021. It is now read-only.

Commit d4f2db3

Browse files
authored
Update all documents (#160)
* update all documents * add: default value
1 parent ad7de15 commit d4f2db3

File tree

9 files changed

+193
-149
lines changed

9 files changed

+193
-149
lines changed

website/docs/d/group.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,18 @@ The following arguments are supported:
3232

3333
In addition to the above arguments, the following attributes are exported:
3434

35-
* `id`
35+
* `id` - Unique identifier of Group.
3636

37-
* `aliases`
37+
* `aliases` - List of aliases.
3838

39-
* `name`
39+
* `name` - Group name.
4040

41-
* `description`
41+
* `description` - Description of the group.
4242

43-
* `direct_members_count`
43+
* `direct_members_count` - Group direct members count.
4444

45-
* `admin_created`
45+
* `admin_created` - Is the group created by admin.
4646

47-
* `non_editable_aliases`
47+
* `non_editable_aliases` - List of non editable aliases.
4848

4949
* `member` - Lists the set of members in this group.

website/docs/d/group_settings.md

Lines changed: 90 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -36,116 +36,149 @@ The following arguments are supported:
3636

3737
In addition to the above arguments, the following attributes are exported:
3838

39-
* `is_archived`
39+
* `is_archived` - Allows the Group contents to be archived.
4040

41-
* `kind`
41+
* `kind` - The type of the resource.
4242

43-
* `name`
43+
* `name` - Name of the group, which has a maximum size of 75 characters.
4444

45-
* `description`
45+
* `description` - Description of the group.
4646

47-
* `allow_external_members`
47+
* `allow_external_members` - Identifies whether members external
48+
to your organization can join the group.
4849

49-
* `allow_google_communication`
50+
* `allow_google_communication` - Deprecated. Allows Google to contact
51+
administrator of the group.
5052

51-
* `allow_web_posting`
53+
* `allow_web_posting` - Allows posting from web.
5254

53-
* `archive_only`
55+
* `archive_only` - Allows the group to be archived only.
5456

55-
* `custom_footer_text`
57+
* `custom_footer_text` - Set the content of custom footer text.
5658

57-
* `custom_reply_to`
59+
* `custom_reply_to` - An email address used when replying to a message
60+
if the replyTo property is set to REPLY_TO_CUSTOM. This address is defined
61+
by an account administrator.
5862

59-
* `favorite_replies_on_top`
63+
* `favorite_replies_on_top` - Indicates if favorite replies should be
64+
displayed above other replies.
6065

61-
* `include_custom_footer`
66+
* `include_custom_footer` - Whether to include custom footer.
6267

63-
* `include_in_global_address_list`
68+
* `include_in_global_address_list` - Enables the group to be
69+
included in the Global Address List.
6470

65-
* `max_message_bytes`
71+
* `max_message_bytes` - Deprecated. The maximum size of a message is 25Mb.
6672

67-
* `members_can_post_as_the_group`
73+
* `members_can_post_as_the_group` - Enables members to post messages as the group.
6874

69-
* `message_display_font`
75+
* `message_display_font` - Deprecated. The default message display font
76+
always has a value of "DEFAULT_FONT".
7077

71-
* `message_moderation_level`
78+
* `message_moderation_level` - Moderation level of incoming messages.
7279

73-
* `primary_language`
80+
* `primary_language` - The primary language for group. For a group's primary language use the language tags from
81+
the G Suite languages found at G Suite Email Settings API Email Language Tags.
7482

75-
* `reply_to`
83+
* `reply_to` - Specifies who should the default reply go to.
7684

77-
* `send_message_deny_notification`
85+
* `send_message_deny_notification` - Allows a member to be notified if the
86+
member's message to the group is denied by the group owner.
7887

79-
* `show_in_group_directory`
88+
* `show_in_group_directory` - Deprecated. This is merged into the new
89+
whoCanDiscoverGroup setting.
8090

81-
* `spam_moderation_level`
91+
* `spam_moderation_level` - Specifies moderation levels for messages detected as spam.
8292

83-
* `who_can_add`
93+
* `who_can_add` - This is merged into the new whoCanModerateMembers setting.
8494

85-
* `who_can_add_references`
95+
* `who_can_add_references` - Deprecated. This functionality is no longer
96+
supported in the Google Groups UI.
8697

87-
* `who_can_approve_members`
98+
* `who_can_approve_members` - Specifies who can approve members who ask to join groups.
8899

89-
* `who_can_approve_messages`
100+
* `who_can_approve_messages` - Deprecated. This is merged into the new
101+
whoCanModerateContent setting.
90102

91-
* `who_can_assign_topics`
103+
* `who_can_assign_topics` - Deprecated. This is merged into the new
104+
whoCanAssistContent setting.
92105

93-
* `who_can_assist_content`
106+
* `who_can_assist_content` - Specifies who can moderate metadata.
94107

95-
* `who_can_ban_users`
108+
* `who_can_ban_users` - Specifies who can deny membership to users.
96109

97-
* `who_can_contact_owner`
110+
* `who_can_contact_owner` - Permission to contact owner of the group via web UI.
98111

99-
* `who_can_delete_any_post`
112+
* `who_can_delete_any_post` - Deprecated. This is merged into the new
113+
whoCanModerateContent setting.
100114

101-
* `who_can_delete_topics`
115+
* `who_can_delete_topics` - Deprecated. This is merged into the new
116+
whoCanModerateContent setting.
102117

103-
* `who_can_discover_group`
118+
* `who_can_discover_group` - Specifies the set of users for whom this group
119+
is discoverable.
104120

105-
* `who_can_enter_free_form_tags`
121+
* `who_can_enter_free_form_tags` - Deprecated. This is merged into the new
122+
whoCanAssistContent setting.
106123

107-
* `who_can_hide_abuse`
124+
* `who_can_hide_abuse` - Deprecated. This is merged into the new
125+
whoCanModerateContent setting.
108126

109-
* `who_can_invite`
127+
* `who_can_invite` - Deprecated. This is merged into the new
128+
whoCanModerateMembers setting.
110129

111-
* `who_can_join`
130+
* `who_can_join` - Permission to join group.
112131

113-
* `who_can_leave_group`
132+
* `who_can_leave_group` - Permission to leave the group.
114133

115-
* `who_can_lock_topics`
134+
* `who_can_lock_topics` - Deprecated. This is merged into the new
135+
whoCanModerateContent setting.
116136

117-
* `who_can_make_topics_sticky`
137+
* `who_can_make_topics_sticky` - Deprecated. This is merged into the new
138+
whoCanModerateContent setting.
118139

119-
* `who_can_mark_duplicate`
140+
* `who_can_mark_duplicate` - Deprecated. This is merged into the new
141+
whoCanAssistContent setting.
120142

121-
* `who_can_mark_favorite_reply_on_any_topic`
143+
* `who_can_mark_favorite_reply_on_any_topic` - Deprecated. This is merged into
144+
the new whoCanAssistContent setting.
122145

123-
* `who_can_mark_favorite_reply_on_own_topic`
146+
* `who_can_mark_favorite_reply_on_own_topic` - Deprecated. This is merged into
147+
the new whoCanAssistContent setting.
124148

125-
* `who_can_mark_no_response_needed`
149+
* `who_can_mark_no_response_needed` - Deprecated. This is merged into the new
150+
whoCanAssistContent setting.
126151

127-
* `who_can_moderate_content`
152+
* `who_can_moderate_content` - Specifies who can moderate content.
128153

129-
* `who_can_moderate_members`
154+
* `who_can_moderate_members` - Specifies who can manage members.
130155

131-
* `who_can_modify_members`
156+
* `who_can_modify_members` - Deprecated. This is merged into the new
157+
whoCanModerateMembers setting.
132158

133-
* `who_can_modify_tags_and_categories`
159+
* `who_can_modify_tags_and_categories` - Deprecated. This is merged into the
160+
new whoCanAssistContent setting.
134161

135-
* `who_can_move_topics_in`
162+
* `who_can_move_topics_in` - Deprecated. This is merged into the new
163+
whoCanModerateContent setting.
136164

137-
* `who_can_move_topics_out`
165+
* `who_can_move_topics_out` - Deprecated. This is merged into the new
166+
whoCanModerateContent setting.
138167

139-
* `who_can_post_announcements`
168+
* `who_can_post_announcements` - Deprecated. This is merged into the new
169+
whoCanModerateContent setting.
140170

141-
* `who_can_post_message`
171+
* `who_can_post_message` - Permissions to post messages.
142172

143-
* `who_can_take_topics`
173+
* `who_can_take_topics` - Deprecated. This is merged into the new
174+
whoCanAssistContent setting.
144175

145-
* `who_can_unassign_topic`
176+
* `who_can_unassign_topic` - Deprecated. This is merged into the new
177+
whoCanAssistContent setting.
146178

147-
* `who_can_unmark_favorite_reply_on_any_topic`
179+
* `who_can_unmark_favorite_reply_on_any_topic` - Deprecated. This is merged into
180+
the new whoCanAssistContent setting.
148181

149-
* `who_can_view_group`
182+
* `who_can_view_group` - Permissions to view group messages.
150183

151-
* `who_can_view_membership`
184+
* `who_can_view_membership` - Permissions to view membership.

website/docs/d/user.md

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -28,63 +28,68 @@ The following arguments are supported:
2828

2929
In addition to the above arguments, the following attributes are exported:
3030

31-
* `org_unit_path`
31+
* `org_unit_path` - OrgUnit of User.
3232

33-
* `aliases`
33+
* `aliases` - List of aliases.
3434

35-
* `agreed_to_terms`
35+
* `agreed_to_terms` - Indicates if user has agreed to terms.
3636

37-
* `change_password_next_login`
37+
* `change_password_next_login` - Boolean indicating if the user should
38+
change password in next login
3839

39-
* `creation_time`
40+
* `creation_time` - User's G Suite account creation time.
4041

41-
* `customer_id`
42+
* `customer_id` - CustomerId of User.
4243

43-
* `deletion_time`
44+
* `deletion_time` - User's G Suite account deletion time.
4445

45-
* `etag`
46+
* `etag` - ETag of the resource.
4647

47-
* `include_in_global_list`
48+
* `include_in_global_list` - Boolean indicating if user is included in
49+
Global Address List.
4850

49-
* `is_ip_whitelisted`
51+
* `is_ip_whitelisted` - Boolean indicating if ip is whitelisted.
5052

51-
* `is_admin`
53+
* `is_admin` - Boolean indicating if the user is admin.
5254

53-
* `is_delegated_admin`
55+
* `is_delegated_admin` - Boolean indicating if the user is delegated admin.
5456

55-
* `2s_enforced`
57+
* `2s_enforced` - Is 2-step verification enforced.
5658

57-
* `2s_enrolled`
59+
* `2s_enrolled` - Is enrolled in 2-step verification.
5860

59-
* `is_mailbox_setup`
61+
* `is_mailbox_setup` - Is mailbox setup.
6062

61-
* `last_login_time`
63+
* `last_login_time` - User's last login time.
6264

63-
* `name` - contains a set of `family_name`, `full_name`, `given_name`.
65+
* `name` - User's name.
66+
contains a set of `family_name`, `full_name`, `given_name`.
6467

65-
* `password`
68+
* `password` - User's password.
6669

67-
* `hash_function` - md5, sha-1 and crypt.
70+
* `hash_function` - Hash function name for password. Supported are MD5,
71+
SHA-1 and crypt
6872

6973
* `posix_accounts` - contains a list of sets containing `account_id`, `gecos`,
7074
`gid`, `home_directory`, `shell`, `system_id`, `primary`, `uid`, `username`.
7175

72-
* `ssh_public_keys` - contains a list of sets containing `expiration_time_usec`,
73-
`key`, `fingerprint`.
76+
* `ssh_public_keys` - SSH public keys of the user.
77+
contains a list of sets containing `expiration_time_usec`, `key`, `fingerprint`.
7478

75-
* `is_suspended`
79+
* `is_suspended` - Indicates if user is suspended.
7680

77-
* `suspension_reason`
81+
* `suspension_reason` - Suspension reason if user is suspended.
7882

79-
* `recovery_email`
83+
* `recovery_email` - Recovery email of the user.
8084

81-
* `recovery_phone`
85+
* `recovery_phone` - Recovery phone of the user.
8286

83-
* `custom_schema` - contains a schema of `name` and `value`.
87+
* `custom_schema` - Custom fields of the user.
8488

85-
* `external_ids` - contains a list of sets containing `custom_type`, `type` and
86-
`value`.
89+
* `external_ids` - A list of external IDs for the user, such as an employee or network ID.
90+
contains a list of sets containing `custom_type`, `type` and `value`.
8791

88-
* `organizations` - contains a list of sets containing `cost_center`,
92+
* `organizations` - A list of organizations the user belongs to.
93+
contains a list of sets containing `cost_center`,
8994
`custom_type`, `department`, `description`, `domain`, `full_time_equivalent`,
9095
`location`, `name`, `primary`, `symbol`, `title` and `type`.

website/docs/r/domain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ The following arguments are supported:
3131

3232
In addition to the above arguments, the following attributes are exported:
3333

34-
* `creation_time`
34+
* `creation_time` - Creation time of the domain.
3535

36-
* `etag`
36+
* `etag` - ETag of the resource.
3737

3838
## Import
3939

website/docs/r/group.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ The following arguments are supported:
2929

3030
* `aliases` - (Optional) Provide a list of aliases for this Group.
3131

32-
* `name` - (Optional)
32+
* `name` - (Optional) Group name.
3333

34-
* `description` - (Optional)
34+
* `description` - (Optional) Description of the group.
3535

3636
## Attribute Reference
3737

3838
In addition to the above arguments, the following attributes are exported:
3939

40-
* `direct_members_count`
40+
* `direct_members_count` - Group direct members count.
4141

42-
* `admin_created`
42+
* `admin_created` - Is the group created by admin.
4343

44-
* `non_editable_aliases`
44+
* `non_editable_aliases` - List of non editable aliases.
4545

4646
## Import
4747

website/docs/r/group_member.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ The following arguments are supported:
4141

4242
In addition to the above arguments, the following attributes are exported:
4343

44-
* `etag`
44+
* `etag` - ETag of the resource.
4545

46-
* `kind`
46+
* `kind` - Kind of resource this is.
4747

48-
* `status`
48+
* `status` - Status of member.
4949

50-
* `type`
50+
* `type`- Type of member.
5151

5252
## Import
5353

0 commit comments

Comments
 (0)