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.

47

"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".

48

},

49

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

50

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

51

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

52

# - "none" - Provides no access.

53

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

54

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

55

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

56

# - "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.

57

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

58

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

59

60

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

61

62

Args:

63

body: object, The request body. (required)

64

The object takes the form of:

65

66

{

67

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

68

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

69

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

70

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

71

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

72

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

73

"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".

74

},

75

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

76

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

77

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

78

# - "none" - Provides no access.

79

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

80

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

81

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

82

# - "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.

83

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

84

}

85

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame^]

86

pp: string, A parameter

87

trace: string, A parameter

88

strict: string, A parameter

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

89

calendarId: string, Calendar identifier. (required)

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame^]

90

userip: string, A parameter

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

91

92

Returns:

93

An object of the form

94

95

{

96

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

97

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

98

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

99

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

100

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

101

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

102

"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".

103

},

104

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

105

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

106

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

107

# - "none" - Provides no access.

108

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

109

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

110

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

111

# - "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.

112

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

113

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

114

115

<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.

116

117

Args:

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame^]

118

pp: string, A parameter

119

trace: string, A parameter

120

strict: string, A parameter

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

121

calendarId: string, Calendar identifier. (required)

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame^]

122

userip: string, A parameter

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

123

124

Returns:

125

An object of the form

126

127

{

128

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

129

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

130

{

131

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

132

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

133

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

134

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

135

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

136

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

137

"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".

138

},

139

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

140

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

141

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

142

# - "none" - Provides no access.

143

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

144

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

145

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

146

# - "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.

147

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

148

},

149

],

150

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

151

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

152

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

153

154

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

155

156

Args:

157

body: object, The request body. (required)

158

The object takes the form of:

159

160

{

161

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

162

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

163

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

164

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

165

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

166

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

167

"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".

168

},

169

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

170

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

171

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

172

# - "none" - Provides no access.

173

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

174

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

175

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

176

# - "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.

177

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

178

}

179

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame^]

180

pp: string, A parameter

181

trace: string, A parameter

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

182

ruleId: string, ACL rule identifier. (required)

183

calendarId: string, Calendar identifier. (required)

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame^]

184

userip: string, A parameter

185

strict: string, A parameter

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

186

187

Returns:

188

An object of the form

189

190

{

191

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

192

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

193

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

194

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

195

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

196

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

197

"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".

198

},

199

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

200

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

201

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

202

# - "none" - Provides no access.

203

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

204

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

205

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

206

# - "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.

207

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

208

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

209

210

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

211

212

Args:

213

body: object, The request body. (required)

214

The object takes the form of:

215

216

{

217

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

218

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

219

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

220

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

221

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

222

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

223

"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".

224

},

225

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

226

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

227

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

228

# - "none" - Provides no access.

229

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

230

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

231

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

232

# - "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.

233

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

234

}

235

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame^]

236

pp: string, A parameter

237

trace: string, A parameter

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

238

ruleId: string, ACL rule identifier. (required)

239

calendarId: string, Calendar identifier. (required)

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame^]

240

userip: string, A parameter

241

strict: string, A parameter

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

242

243

Returns:

244

An object of the form

245

246

{

247

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

248

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

249

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

250

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

251

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

252

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

253

"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".

254

},

255

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

256

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

257

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

258

# - "none" - Provides no access.

259

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

260

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

261

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

262

# - "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.

263

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

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

<hr>

Data descriptors defined here:

268

269

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