Blame - docs/dyn/calendar.v3.acl.html - platform/external/python/google-api-python-client

# - "domain" - Limits the scope to a domain.  Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

39

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

40

},

41

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

42

"etag": "A String", # ETag of the resource.

43

"role": "A String", # The role assigned to the scope. Possible values are:

44

# - "none" - Provides no access.

45

# - "freeBusyReader" - Provides read access to free/busy information.

46

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

47

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

48

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

49

"id": "A String", # Identifier of the ACL rule.

50

}</tt></dd></dl>

51

52

<dl><dt><a name="Resource-insert">insert</a> = method(self, **kwargs)</dt><dd><tt>Creates an access control rule.

53

54

Args:

55

body: object, The request body. (required)

56

The object takes the form of:

57

58

{

59

"scope": { # The scope of the rule.

60

"type": "A String", # The type of the scope. Possible values are:

61

# - "default" - The public scope. This is the default value.

62

# - "user" - Limits the scope to a single user.

63

# - "group" - Limits the scope to a group.

64

# - "domain" - Limits the scope to a domain.  Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

65

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

66

},

67

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

68

"etag": "A String", # ETag of the resource.

69

"role": "A String", # The role assigned to the scope. Possible values are:

70

# - "none" - Provides no access.

71

# - "freeBusyReader" - Provides read access to free/busy information.

72

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

73

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

74

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

75

"id": "A String", # Identifier of the ACL rule.

76

}

77

78

calendarId: string, Calendar identifier. (required)

79

80

Returns:

81

An object of the form

82

83

{

84

"scope": { # The scope of the rule.

85

"type": "A String", # The type of the scope. Possible values are:

86

# - "default" - The public scope. This is the default value.

87

# - "user" - Limits the scope to a single user.

88

# - "group" - Limits the scope to a group.

89

# - "domain" - Limits the scope to a domain.  Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

90

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

91

},

92

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

93

"etag": "A String", # ETag of the resource.

94

"role": "A String", # The role assigned to the scope. Possible values are:

95

# - "none" - Provides no access.

96

# - "freeBusyReader" - Provides read access to free/busy information.

97

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

98

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

99

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

100

"id": "A String", # Identifier of the ACL rule.

101

}</tt></dd></dl>

102

103

<dl><dt><a name="Resource-list">list</a> = method(self, **kwargs)</dt><dd><tt>Returns the rules in the access control list for the calendar.

104

105

Args:

106

calendarId: string, Calendar identifier. (required)

107

108

Returns:

109

An object of the form

110

111

{

112

"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.

113

"items": [ # List of rules on the access control list.

114

{

115

"scope": { # The scope of the rule.

116

"type": "A String", # The type of the scope. Possible values are:

117

# - "default" - The public scope. This is the default value.

118

# - "user" - Limits the scope to a single user.

119

# - "group" - Limits the scope to a group.

120

# - "domain" - Limits the scope to a domain.  Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

121

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

122

},

123

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

124

"etag": "A String", # ETag of the resource.

125

"role": "A String", # The role assigned to the scope. Possible values are:

126

# - "none" - Provides no access.

127

# - "freeBusyReader" - Provides read access to free/busy information.

128

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

129

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

130

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

131

"id": "A String", # Identifier of the ACL rule.

132

},

133

],

134

"kind": "calendar#acl", # Type of the collection ("calendar#acl").

135

"etag": "A String", # ETag of the collection.

136

}</tt></dd></dl>

137

138

<dl><dt><a name="Resource-patch">patch</a> = method(self, **kwargs)</dt><dd><tt>Updates an access control rule. This method supports patch semantics.

139

140

Args:

141

body: object, The request body. (required)

142

The object takes the form of:

143

144

{

145

"scope": { # The scope of the rule.

146

"type": "A String", # The type of the scope. Possible values are:

147

# - "default" - The public scope. This is the default value.

148

# - "user" - Limits the scope to a single user.

149

# - "group" - Limits the scope to a group.

150

# - "domain" - Limits the scope to a domain.  Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

151

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

152

},

153

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

154

"etag": "A String", # ETag of the resource.

155

"role": "A String", # The role assigned to the scope. Possible values are:

156

# - "none" - Provides no access.

157

# - "freeBusyReader" - Provides read access to free/busy information.

158

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

159

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

160

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

161

"id": "A String", # Identifier of the ACL rule.

162

}

163

164

ruleId: string, ACL rule identifier. (required)

165

calendarId: string, Calendar identifier. (required)

166

167

Returns:

168

An object of the form

169

170

{

171

"scope": { # The scope of the rule.

172

"type": "A String", # The type of the scope. Possible values are:

173

# - "default" - The public scope. This is the default value.

174

# - "user" - Limits the scope to a single user.

175

# - "group" - Limits the scope to a group.

176

# - "domain" - Limits the scope to a domain.  Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

177

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

178

},

179

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

180

"etag": "A String", # ETag of the resource.

181

"role": "A String", # The role assigned to the scope. Possible values are:

182

# - "none" - Provides no access.

183

# - "freeBusyReader" - Provides read access to free/busy information.

184

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

185

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

186

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

187

"id": "A String", # Identifier of the ACL rule.

188

}</tt></dd></dl>

189

190

<dl><dt><a name="Resource-update">update</a> = method(self, **kwargs)</dt><dd><tt>Updates an access control rule.

191

192

Args:

193

body: object, The request body. (required)

194

The object takes the form of:

195

196

{

197

"scope": { # The scope of the rule.

198

"type": "A String", # The type of the scope. Possible values are:

199

# - "default" - The public scope. This is the default value.

200

# - "user" - Limits the scope to a single user.

201

# - "group" - Limits the scope to a group.

202

# - "domain" - Limits the scope to a domain.  Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

203

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

204

},

205

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

206

"etag": "A String", # ETag of the resource.

207

"role": "A String", # The role assigned to the scope. Possible values are:

208

# - "none" - Provides no access.

209

# - "freeBusyReader" - Provides read access to free/busy information.

210

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

211

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

212

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

213

"id": "A String", # Identifier of the ACL rule.

214

}

215

216

ruleId: string, ACL rule identifier. (required)

217

calendarId: string, Calendar identifier. (required)

218

219

Returns:

220

An object of the form

221

222

{

223

"scope": { # The scope of the rule.

224

"type": "A String", # The type of the scope. Possible values are:

225

# - "default" - The public scope. This is the default value.

226

# - "user" - Limits the scope to a single user.

227

# - "group" - Limits the scope to a group.

228

# - "domain" - Limits the scope to a domain.  Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

229

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

230

},

231

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

232

"etag": "A String", # ETag of the resource.

233

"role": "A String", # The role assigned to the scope. Possible values are:

234

# - "none" - Provides no access.

235

# - "freeBusyReader" - Provides read access to free/busy information.

236

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

237

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

238

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

239

"id": "A String", # Identifier of the ACL rule.

}</tt></dd></dl>

<hr>

Data descriptors defined here:

244

245

<dd><tt>dictionary for instance variables (if defined)</tt></dd>