forked from code42/crashplan_api_examples
-
Notifications
You must be signed in to change notification settings - Fork 0
/
EditUserRoles.py
286 lines (227 loc) · 8.75 KB
/
EditUserRoles.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
#
# File: EditUserRoles.py
# Author: Nick Olmsted, Code 42 Software
# Last Modified: 01-29-2014
#
# Adds or Removes a role from all users. If an orgId is specified than only adds/removes from that Org.
# Log file: EditUserRoles.log
#
# Python 2.7
# REQUIRED MODULE: Requests
# http://docs.python-requests.org/en/latest/user/install/
#
# API Call: POST/DELETE api/UserRole
#
# Arguments: orgId, action, userRole, loggingLevel(optional)
#
# Example usages:
# 1) Delete 'test' role for all users
# python EditUserRoles.py 0 remove test
#
# 2) Add 'test' role to orgId 3 users
# python EditUserRoles.py 3 add test
#
# 3) Delete 'test' role for orgId 4 users in DEBUG mode
# python EditUserRoles.py 3 add test DEBUG
#
# NOTE: Make sure to set cpc_host, cpc_port, cpc_username, cpc_password to your environments values.
# Also make sure the role you are trying to add or remove has been added to your PROe environment.
#
# NOT TESTED ON API VERSIONS BEFORE 3.5.4.
#
import sys
import json
import base64
import logging
import requests
import math
import getpass
# Set to your environments values
#cp_host = "<HOST OR IP ADDRESS>" ex: http://localhost or https://localhost
#cp_port = "<PORT>" ex: 4280 or 4285
#cp_username = "<username>"
#cp_password = "<pw>"
# Test values
cp_host = "http://localhost"
cp_port = "4280"
cp_username = "admin"
cp_password = getpass.getpass('Enter your CrashPlan console password: ') # You will be prompted to enter the password
# REST API Calls
cp_api_userRole = "/api/UserRole"
cp_api_user = "/api/User"
# This number is set to the maximum limit (current ver. 3.5.4) the REST API allows a resultset size to be.
MAX_PAGE_NUM = 250
## ARGUMENTS ##
# ARG1 - ORG ID (Integer) - pass in 0 to make the change to all users
cp_orgId = str(sys.argv[1])
# ARG2 - add/delete userRole
cp_action = str(sys.argv[2])
# ARG3 - userRole
cp_userRole = str(sys.argv[3])
# ARG4 (optional)- logging level for console (default is INFO, add DEBUG for additional output to console)
cp_logLevel = "INFO"
if len(sys.argv)==5:
cp_logLevel = str(sys.argv[4])
#
# Compute base64 representation of the authentication token.
#
def getAuthHeader(u,p):
token = base64.b64encode('%s:%s' % (u,p))
return "Basic %s" % token
#
# Sets logger to file and console
#
def setLoggingLevel():
# set up logging to file
logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
datefmt='%m-%d %H:%M',
filename='EditUserRoles.log',
filemode='w')
# define a Handler which writes INFO messages or higher to the sys.stderr
console = logging.StreamHandler()
if(cp_logLevel=="DEBUG"):
console.setLevel(logging.DEBUG)
else:
console.setLevel(logging.INFO)
# set a format which is simpler for console use
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
# tell the handler to use this format
console.setFormatter(formatter)
# add the handler to the root logger
logging.getLogger('').addHandler(console)
#
# Removes the role for all users
#
def removeAllUsersRole(orgId):
logging.debug("removeAllUsersRole-params: orgId[" + orgId + "]")
count = 0
numRequests = getUsersPageCount(orgId)
# Outer loop for number of user requests
for x in xrange(1, numRequests+1):
users = getUsers(orgId, str(x))
# Inner loop to cycle through each user and remove the role
for user in users['users']:
userId = str(user['userId'])
userName = user['username']
if (removeUserRole(userId, cp_userRole)):
count = count + 1
logging.info("Success: userRole[" + cp_userRole + "] removal for userId[" + userId + "]:userName[" + userName + "]")
else:
logging.info("Fail: userRole[" + cp_userRole + "] removal for userId[" + userId + "]:userName[" + userName + "]")
logging.info("Total Users affected: " + str(count))
#
# Adds a role for all users
#
def addAllUsersRole(orgId):
logging.debug("addAllUsersRole-params: orgId[" + orgId + "]")
count = 0
numRequests = getUsersPageCount(orgId)
# Outer loop for number of user requests
for x in xrange(1, numRequests+1):
users = getUsers(orgId, str(x))
# Inner loop to cycle through each user and add the role
for user in users['users']:
userId = str(user['userId'])
userName = user['username']
if (addUserRole(userId, cp_userRole)):
count = count + 1
logging.info("Success: userRole[" + cp_userRole + "] added for userId[" + userId + "]:userName[" + userName + "]")
else:
logging.info("Fail: userRole[" + cp_userRole + "] added for userId[" + userId + "]:userName[" + userName + "]")
logging.info("Total Users affected: " + str(count))
#
# Remove the role from an individual user.
# Note: attempts to remove the role from a user even if the role doesn't exist.
#
def removeUserRole(userId, roleName):
logging.debug("removeUserRole-params: userId[" + userId + "]:roleName[" + roleName + "]")
headers = {"Authorization":getAuthHeader(cp_username,cp_password)}
url = cp_host + ":" + cp_port + cp_api_userRole
# payload = {'userId': userId, 'roleName': '"'+roleName+'"'}
payload = {}
parameters = {}
parameters['userId'] = userId
parameters['roleName'] = roleName
r = requests.delete(url, params=parameters, data=json.dumps(payload), headers=headers)
logging.debug(r.text)
logging.debug(r.status_code)
# Delete was successful with an HTTP return code of 204
return r.status_code == 204
#
# Adds the role to an individual user.
# Note: attempts to add the role to a user even if it already exists.
#
def addUserRole(userId, roleName):
logging.debug("addUserRole-params: userId[" + userId + "]:roleName[" + roleName + "]")
result = False
if(userId!=1):
headers = {"Authorization":getAuthHeader(cp_username,cp_password)}
url = cp_host + ":" + cp_port + cp_api_userRole
payload = {'userId': userId, 'roleName': roleName}
r = requests.post(url, data=json.dumps(payload), headers=headers)
logging.debug(r.text)
logging.debug(r.status_code)
if(r.status_code == 200):
result = True
else:
logging.debug("user is the default admin user, skip adding the user role.")
result = True
# Post was successful with an HTTP return code of 200
return result
#
# Returns a list of users,
# Params:
# orgId - integer, that is used to limit the users to an org. Can be set to 0 to return all users.
# pgNum - Current page request count.
#
def getUsers(orgId, pgNum):
logging.debug("getUsers-params:orgId[" + orgId + "]:pgNum[" + str(pgNum) + "]")
headers = {"Authorization":getAuthHeader(cp_username,cp_password)}
url = cp_host + ":" + cp_port + cp_api_user
payload = {'orgId': orgId, 'pgNum': str(pgNum), 'pgSize': str(MAX_PAGE_NUM)}
r = requests.get(url, params=payload, headers=headers)
logging.debug(r.text)
content = r.content
binary = json.loads(content)
logging.debug(binary)
users = binary['data']
return users
#
# Gets the number of page requests needed to return all users.
# Note: This is used because of the current REST API resultset limit of 250 results.
#
def getUsersPageCount(orgId):
logging.debug("getUsersPageCount-params: orgId[" + orgId + "]")
headers = {"Authorization":getAuthHeader(cp_username,cp_password)}
url = cp_host + ":" + cp_port + cp_api_user
payload = {'orgId': orgId}
r = requests.get(url, params=payload, headers=headers)
logging.debug(r.text)
content = r.content
binary = json.loads(content)
logging.debug(binary)
users = binary['data']
totalCount = users['totalCount']
logging.debug("getUsersPageCount:totalCount= " + str(totalCount))
# num of requests is rounding down and not up. Add+1 as we know we are completed because the computerId value returns as 0
numOfRequests = int(math.ceil(totalCount/MAX_PAGE_NUM)+1)
logging.debug("getUsersPageCount:numOfRequests= " + str(numOfRequests))
return numOfRequests
#
# Performs the Add or remove user role action.
#
def performUserRoleAction():
logging.info("User Role Action: " + cp_action)
orgId = cp_orgId
if (cp_orgId == "0"):
orgId = "All Orgs"
logging.info("Users pulled from OrgId: " + str(orgId))
if(cp_action == "remove"):
removeAllUsersRole(cp_orgId)
elif(cp_action == "add"):
addAllUsersRole(cp_orgId)
else:
logging.error("Invalid second argument value. Please enter remove or add for second argument")
setLoggingLevel()
performUserRoleAction()