Deleting users and groups¶
Deleting users and groups uses a similar pattern to the retrieval operations. For this you can use static methods provided by the AtlanUser
and AtlanGroup
classes.
All delete operations are permanent
All delete operations on users and groups are permanent, hard-deletes. There is no way to archive (soft-delete) users and groups.
Delete a group¶
For example, to delete a group:
Delete a group | |
---|---|
1 |
|
- To delete a group, you must specify its GUID and can simply call the
AtlanGroup.delete()
method.
Delete a group | |
---|---|
1 2 3 4 |
|
- To delete a group, you must specify its GUID and can simply call the
group.purge()
method.
Delete a group | |
---|---|
1 |
|
- To delete a group, you must specify its GUID and can simply call the
AtlanGroup.delete()
method.
POST /api/service/groups/e79cb8eb-2bb6-4821-914c-f8dfd21fedc7/delete | |
---|---|
1 |
|
-
All details are in the URL itself.
Group ID in the URL
Note that you must provide the unique ID (GUID) of the group to delete it.
Delete a user¶
Not currently allowed
Deleting users can have unintended knock-on impacts, such as causing workflows to fail or leaving behind dangling references. We therefore do not allow this to be done directly. If you need to delete users, please raise a support ticket.