You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/models/Partner.md
+21Lines changed: 21 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,7 @@
9
9
"allow_credential_changes": true,
10
10
"allow_providing_gpg_keys": true,
11
11
"allow_user_creation": true,
12
+
"cc_emails_to_responsible_party": true,
12
13
"id": 1,
13
14
"workspace_id": 1,
14
15
"name": "Acme Corp",
@@ -18,6 +19,8 @@
18
19
2,
19
20
3
20
21
],
22
+
"responsible_group_id": 1,
23
+
"responsible_user_id": 1,
21
24
"root_folder": "/AcmeCorp",
22
25
"tags": "example",
23
26
"user_ids": [
@@ -33,11 +36,14 @@
33
36
*`allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
34
37
*`allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
35
38
*`allow_user_creation` (boolean): Allow Partner Admins to create users.
39
+
*`cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
36
40
*`id` (int64): The unique ID of the Partner.
37
41
*`workspace_id` (int64): ID of the Workspace associated with this Partner.
38
42
*`name` (string): The name of the Partner.
39
43
*`notes` (string): Notes about this Partner.
40
44
*`partner_admin_ids` (array(int64)): Array of User IDs that are Partner Admins for this Partner.
45
+
*`responsible_group_id` (int64): ID of the Group responsible for this Partner.
46
+
*`responsible_user_id` (int64): ID of the User responsible for this Partner.
41
47
*`root_folder` (string): The root folder path for this Partner.
42
48
*`tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
43
49
*`user_ids` (array(int64)): Array of User IDs that belong to this Partner.
@@ -82,7 +88,10 @@ await Partner.create({
82
88
'allow_credential_changes': false,
83
89
'allow_providing_gpg_keys': false,
84
90
'allow_user_creation': false,
91
+
'cc_emails_to_responsible_party': false,
85
92
'notes': "This is a note about the partner.",
93
+
'responsible_group_id': 1,
94
+
'responsible_user_id': 1,
86
95
'tags': "example",
87
96
'name': "Acme Corp",
88
97
'root_folder': "/AcmeCorp",
@@ -98,7 +107,10 @@ await Partner.create({
98
107
*`allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
99
108
*`allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
100
109
*`allow_user_creation` (boolean): Allow Partner Admins to create users.
110
+
*`cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
101
111
*`notes` (string): Notes about this Partner.
112
+
*`responsible_group_id` (int64): ID of the Group responsible for this Partner.
113
+
*`responsible_user_id` (int64): ID of the User responsible for this Partner.
102
114
*`tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
103
115
*`name` (string): Required - The name of the Partner.
104
116
*`root_folder` (string): Required - The root folder path for this Partner.
@@ -117,7 +129,10 @@ await partner.update({
117
129
'allow_credential_changes': false,
118
130
'allow_providing_gpg_keys': false,
119
131
'allow_user_creation': false,
132
+
'cc_emails_to_responsible_party': false,
120
133
'notes': "This is a note about the partner.",
134
+
'responsible_group_id': 1,
135
+
'responsible_user_id': 1,
121
136
'tags': "example",
122
137
'name': "Acme Corp",
123
138
'root_folder': "/AcmeCorp",
@@ -132,7 +147,10 @@ await partner.update({
132
147
*`allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
133
148
*`allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
134
149
*`allow_user_creation` (boolean): Allow Partner Admins to create users.
150
+
*`cc_emails_to_responsible_party` (boolean): When `true`, emails sent to Partner users are copied to the responsible User or Group.
135
151
*`notes` (string): Notes about this Partner.
152
+
*`responsible_group_id` (int64): ID of the Group responsible for this Partner.
153
+
*`responsible_user_id` (int64): ID of the User responsible for this Partner.
136
154
*`tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
137
155
*`name` (string): The name of the Partner.
138
156
*`root_folder` (string): The root folder path for this Partner.
Copy file name to clipboardExpand all lines: docs/models/UserLifecycleRule.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,7 @@
17
17
"include_site_admins": true,
18
18
"apply_to_all_workspaces": true,
19
19
"name": "password specific rules",
20
+
"notify_users": true,
20
21
"partner_tag": "guest",
21
22
"site_id": 1,
22
23
"workspace_id": 12,
@@ -34,6 +35,7 @@
34
35
*`include_site_admins` (boolean): If true, the rule will apply to site admins.
35
36
*`apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
36
37
*`name` (string): User Lifecycle Rule name
38
+
*`notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
37
39
*`partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
38
40
*`site_id` (int64): Site ID
39
41
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
*`include_site_admins` (boolean): If true, the rule will apply to site admins.
101
104
*`include_folder_admins` (boolean): If true, the rule will apply to folder admins.
102
105
*`name` (string): User Lifecycle Rule name
106
+
*`notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
103
107
*`partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
104
108
*`user_state` (string): State of the users to apply the rule to (inactive or disabled)
105
109
*`user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
*`include_site_admins` (boolean): If true, the rule will apply to site admins.
139
144
*`include_folder_admins` (boolean): If true, the rule will apply to folder admins.
140
145
*`name` (string): User Lifecycle Rule name
146
+
*`notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
141
147
*`partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
142
148
*`user_state` (string): State of the users to apply the rule to (inactive or disabled)
143
149
*`user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
// cc_emails_to_responsible_party - boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
132
154
// notes - string - Notes about this Partner.
155
+
// responsible_group_id - int64 - ID of the Group responsible for this Partner.
156
+
// responsible_user_id - int64 - ID of the User responsible for this Partner.
133
157
// tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
134
158
// name - string - The name of the Partner.
135
159
// root_folder - string - The root folder path for this Partner.
thrownewerrors.InvalidParameterError("Bad parameter: tags must be of type String, received ".concat((0,_utils.getType)(params.tags)));
203
+
thrownewerrors.InvalidParameterError("Bad parameter: responsible_group_id must be of type Int, received ".concat((0,_utils.getType)(params.responsible_group_id)));
thrownewerrors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0,_utils.getType)(params.name)));
209
+
thrownewerrors.InvalidParameterError("Bad parameter: responsible_user_id must be of type Int, received ".concat((0,_utils.getType)(params.responsible_user_id)));
// cc_emails_to_responsible_party - boolean - When `true`, emails sent to Partner users are copied to the responsible User or Group.
416
453
// notes - string - Notes about this Partner.
454
+
// responsible_group_id - int64 - ID of the Group responsible for this Partner.
455
+
// responsible_user_id - int64 - ID of the User responsible for this Partner.
417
456
// tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
418
457
// name (required) - string - The name of the Partner.
419
458
// root_folder (required) - string - The root folder path for this Partner.
@@ -452,36 +491,48 @@ _Partner = Partner;
452
491
}
453
492
thrownewerrors.InvalidParameterError("Bad parameter: notes must be of type String, received ".concat((0,_utils.getType)(params.notes)));
thrownewerrors.InvalidParameterError("Bad parameter: tags must be of type String, received ".concat((0,_utils.getType)(params.tags)));
498
+
thrownewerrors.InvalidParameterError("Bad parameter: responsible_group_id must be of type Int, received ".concat((0,_utils.getType)(params.responsible_group_id)));
thrownewerrors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0,_utils.getType)(params.name)));
504
+
thrownewerrors.InvalidParameterError("Bad parameter: responsible_user_id must be of type Int, received ".concat((0,_utils.getType)(params.responsible_user_id)));
0 commit comments