forked from CrowdStrike/falconpy
/
user_management.py
230 lines (210 loc) · 10.9 KB
/
user_management.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
"""
_______ __ _______ __ __ __
| _ .----.-----.--.--.--.--| | _ | |_.----|__| |--.-----.
|. 1___| _| _ | | | | _ | 1___| _| _| | <| -__|
|. |___|__| |_____|________|_____|____ |____|__| |__|__|__|_____|
|: 1 | |: 1 |
|::.. . | CROWDSTRIKE FALCON |::.. . | FalconPy
`-------' `-------'
OAuth2 API - Customer SDK
iocs - CrowdStrike Falcon User Management API interface class
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org>
"""
from ._util import parse_id_list, service_request
from ._service_class import ServiceClass
class User_Management(ServiceClass):
""" The only requirement to instantiate an instance of this class
is a valid token provided by the Falcon API SDK OAuth2 class.
"""
def GetRoles(self: object, ids) -> dict:
""" Get info about a role. """
# [GET] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/GetRoles
ID_LIST = str(parse_id_list(ids)).replace(",", "&ids=")
FULL_URL = self.base_url+'/user-roles/entities/user-roles/v1?ids={}'.format(ID_LIST)
HEADERS = self.headers
returned = service_request(caller=self,
method="GET",
endpoint=FULL_URL,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def GrantUserRoleIds(self: object, parameters: dict, body: dict) -> dict:
""" Assign one or more roles to a user. """
# [POST] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/GrantUserRoleIds
FULL_URL = self.base_url+'/user-roles/entities/user-roles/v1'
HEADERS = self.headers
BODY = body
PARAMS = parameters
returned = service_request(caller=self,
method="POST",
endpoint=FULL_URL,
params=PARAMS,
body=BODY,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def RevokeUserRoleIds(self: object, ids, parameters: dict) -> dict:
""" Revoke one or more roles from a user. """
# [DELETE] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/RevokeUserRoleIds
ID_LIST = str(parse_id_list(ids)).replace(",", "&ids=")
FULL_URL = self.base_url+'/user-roles/entities/user-roles/v1?ids={}'.format(ID_LIST)
HEADERS = self.headers
PARAMS = parameters
returned = service_request(caller=self,
method="DELETE",
endpoint=FULL_URL,
params=PARAMS,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def GetAvailableRoleIds(self: object) -> dict:
""" Show role IDs for all roles available in your customer account.
For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
"""
# [GET] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/GetAvailableRoleIds
FULL_URL = self.base_url+'/user-roles/queries/user-role-ids-by-cid/v1'
HEADERS = self.headers
returned = service_request(caller=self,
method="GET",
endpoint=FULL_URL,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def GetUserRoleIds(self: object, parameters: dict) -> dict:
""" Show role IDs of roles assigned to a user. For more information on each role,
provide the role ID to `/customer/entities/roles/v1`.
"""
# [GET] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/GetUserRoleIds
FULL_URL = self.base_url+'/user-roles/queries/user-role-ids-by-user-uuid/v1'
HEADERS = self.headers
PARAMS = parameters
returned = service_request(caller=self,
method="GET",
endpoint=FULL_URL,
params=PARAMS,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def RetrieveUser(self: object, ids) -> dict:
""" Get info about a user. """
# [GET] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/RetrieveUser
ID_LIST = str(parse_id_list(ids)).replace(",", "&ids=")
FULL_URL = self.base_url+'/users/entities/users/v1?ids={}'.format(ID_LIST)
HEADERS = self.headers
returned = service_request(caller=self,
method="GET",
endpoint=FULL_URL,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def CreateUser(self: object, body: dict) -> dict:
""" Create a new user. After creating a user,
assign one or more roles with POST /user-roles/entities/user-roles/v1.
"""
# [POST] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/CreateUser
FULL_URL = self.base_url+'/users/entities/users/v1'
HEADERS = self.headers
BODY = body
returned = service_request(caller=self,
method="POST",
endpoint=FULL_URL,
body=BODY,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def DeleteUser(self: object, parameters: dict) -> dict:
""" Delete a user permanently. """
# [DELETE] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/DeleteUser
FULL_URL = self.base_url+'/users/entities/users/v1'
HEADERS = self.headers
PARAMS = parameters
returned = service_request(caller=self,
method="DELETE",
endpoint=FULL_URL,
params=PARAMS,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def UpdateUser(self: object, parameters: dict, body: dict) -> dict:
""" Modify an existing user. """
# [PATCH] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/UpdateUser
FULL_URL = self.base_url+'/users/entities/users/v1'
HEADERS = self.headers
BODY = body
PARAMS = parameters
returned = service_request(caller=self,
method="PATCH",
endpoint=FULL_URL,
params=PARAMS,
body=BODY,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def RetrieveEmailsByCID(self: object) -> dict:
""" List the usernames (usually an email address) for all users in your customer account. """
# [GET] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/RetrieveEmailsByCID
FULL_URL = self.base_url+'/users/queries/emails-by-cid/v1'
HEADERS = self.headers
returned = service_request(caller=self,
method="GET",
endpoint=FULL_URL,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def RetrieveUserUUIDsByCID(self: object) -> dict:
""" List user IDs for all users in your customer account.
For more information on each user, provide the user ID to `/users/entities/user/v1`.
"""
# [GET] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/RetrieveUserUUIDsByCID
FULL_URL = self.base_url+'/users/queries/user-uuids-by-cid/v1'
HEADERS = self.headers
returned = service_request(caller=self,
method="GET",
endpoint=FULL_URL,
headers=HEADERS,
verify=self.ssl_verify
)
return returned
def RetrieveUserUUID(self: object, parameters: dict) -> dict:
""" Get a user's ID by providing a username (usually an email address). """
# [GET] https://assets.falcon.crowdstrike.com/support/api/swagger.html#/user-management/RetrieveUserUUID
FULL_URL = self.base_url+'/users/queries/user-uuids-by-email/v1'
HEADERS = self.headers
PARAMS = parameters
returned = service_request(caller=self,
method="GET",
endpoint=FULL_URL,
params=PARAMS,
headers=HEADERS,
verify=self.ssl_verify
)
return returned