slack-objects
A focused Python package for working with Slack objects commonly used in administration and automation workflows.
The following Slack object types will be supported:
- Users
- Conversations
- Messages
- Files
- Workspaces
- IDP_groups
Overview
slack-objects provides lightweight, reusable classes that wrap Slack Web API, Admin API, and SCIM operations in a consistent, object-oriented way. It is designed for:
- Slack administration automation
- Identity and access management flows
- Internal tooling and bots
- Auditing and cleanup scripts
The package does not aim to be a full Slack SDK replacement. Instead, it focuses on common higher-level tasks that typically require multiple API calls and boilerplate logic.
Requirements
- Python 3.9+
- Slack app with appropriate scopes
- Tokens provided via environment variables or from Azure KeyVault using PC_Azure package (
python -m pip install PC_Azure)
Typical dependencies:
slack_sdkrequestspython-dotenv(optional)PC_Azure(optional)
Installation
pip install -r requirements.txt
Classes and usage
Users
Purpose: actions related to Slack users.
Constructor:
Users(global_vars, client, logger, user_id="")
Key methods:
is_contingent_worker()→ bool using name/display name label[External].is_guest()→ bool ifis_restrictedoris_ultra_restricted.make_multi_channel_guest(token, scim_version='v1')→requests.Responsevia SCIM (v1/v2).remove_from_channels(token, client, logger, channel_ids)→ remove user from channels (admin API).remove_from_workspaces(client, logger, workspace_ids, keep=[])→ remove user from workspaces.ap_studio_process()→ composite flow: convert to MCG, remove from org-wide channels, remove from other workspaces.get_userId_from_email(email)→ Slack user ID or empty string.is_user_authorized(service_name, auth_level='read')→ bool based on IdP group membership.invite_user(channel_ids, email, team_id, email_password_policy_enabled=False)→ invite a user, returns response string.
Example:
u = Users(global_vars, client, logger, user_id="U123")
if u.is_contingent_worker():
u.make_multi_channel_guest(token=global_vars.user_token)
Conversations
Purpose: actions related to conversations (e.g., channels).
Constructor:
Conversations(global_vars, client, logger, channel_id)
Key methods:
is_private()→ bool.get_messages(channel_id="", include_all_metadata=False, limit=None, inclusive=True, latest=None, oldest=None)→ list of messages usingconversations.historywith pagination.
Example:
ch = Conversations(global_vars, client, logger, channel_id="C123")
msgs = ch.get_messages(limit=100)
Messages
Purpose: manage Slack messages and blocks.
Constructor:
Messages(global_vars, client, logger, channel_id, ts, message=None)
Key methods:
update_message(as_user=True, channel_id="", message_ts="", new_message_blocks=[], new_message_text="", new_message_attachments="")→ update message viachat.update.replace_message_block(blocks=[], block_type="", block_id="", text="", new_block={}, new_block_id="")→ find a block by type or id and replace it, then update message.
Example:
msg = Messages(global_vars, client, logger, "C123", "1717000000.000100")
msg.update_message(new_message_text="Updated content")
Files
Purpose: interact with files in Slack.
Constructor:
Files(global_vars, client, logger, file_id="", get_content=False)
Key methods:
get_text_content()→ fetch content for text files viaurl_private(uses bot token).upload_to_slack(title, channel="", thread_ts="")→ upload the current file content viafiles_upload_v2.delete_file(file_id="")→ delete a file by id.list_files(**args)→ simple wrapper aroundfiles.list.get_file_source_message(channel: Channels, file_id="", user_id="")→ find the message where a file was shared (looks back ~5 messages).
Example:
f = Files(global_vars, client, logger, file_id="F123", get_content=True)
f.upload_to_slack(title="Processed file", channel="C123")
Workspaces
Purpose: workspace info helper.
Constructor:
Workspaces(client, logger, workspace_id)
Obtains attributes via team.info.
IDP_groups
Purpose: manage IdP (Okta) groups via SCIM.
Constructor:
IDP_groups(global_vars)
Key methods:
get_groups()→ list of{ 'group id', 'group name' }(paginated).get_members(group_id)→ list of members withvalue(user id) anddisplay(name).is_member(user_id, group_id)→ bool.
Example:
idp = IDP_groups(global_vars)
if idp.is_member("U123", "GP456"):
print("authorized")
Tokens and rate limits
- Methods that call admin or SCIM APIs require the User OAuth token.
- Standard Web API calls may use the Bot token via
App.client. - Some methods respect internal wait times (e.g.,
Tier_2,Tier_3,Tier_4) to avoid rate limits. Configure these inlibraries_and_globals.py.
Error handling
- Methods catch
SlackApiErrorand log messages via the providedlogger. - Some methods post audit logs to channels configured in
global_vars.
Notes
- SCIM version: production uses
v1, sandbox may usev2. Files.get_text_content()is designed fortext/*mimetypes.
Metadata
Release files for slack-objects 0.0.post31
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| slack_objects-0.0.post31.tar.gz | 43.0 kB | Without provenance | Details for slack_objects-0.0.post31.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| slack_objects-0.0.post31-py3-none-any.whl | Python 3 | none | any | Details for slack_objects-0.0.post31-py3-none-any.whl |
Total release size: 74.2 kB
Release files / slack_objects-0.0.post31.tar.gz
| Download URL | slack_objects-0.0.post31.tar.gz |
|---|---|
| Size | 43.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cbc36ec144809985f01b43f11e9de94dec4caf6bcf9fc2693b4b96bd4f66e3c1
|
|
BLAKE2b-256 checksum How to use checksums |
dfd04962c6540b38d12db5b97c997264aebfc2d3c6ca2663f2b59ae12bf13508
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.2
|
Release files / slack_objects-0.0.post31-py3-none-any.whl
| Download URL | slack_objects-0.0.post31-py3-none-any.whl |
|---|---|
| Size | 31.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
99d8a382ec0197d57c1f316924810c8d3603dd19bc064bd1c1d9d47ef6858a1b
|
|
BLAKE2b-256 checksum How to use checksums |
c1ecded15b524b38dbfb72de4920fa95c42aef1c19ef31712fe8c6cb855955dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.2
|
Security for slack-objects 0.0.post31
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.