diff --git a/integration_tests/env_variable_names.py b/integration_tests/env_variable_names.py index 5a0f4e144..f9c02172a 100644 --- a/integration_tests/env_variable_names.py +++ b/integration_tests/env_variable_names.py @@ -27,6 +27,8 @@ SLACK_SDK_TEST_GRID_IDP_USERGROUP_ID_2 = "SLACK_SDK_TEST_GRID_IDP_USERGROUP_ID_2" SLACK_SDK_TEST_GRID_TEAM_ID = "SLACK_SDK_TEST_GRID_TEAM_ID" SLACK_SDK_TEST_GRID_USER_ID = "SLACK_SDK_TEST_GRID_USER_ID" +# The following user must be a full member, who is not a primary owner +SLACK_SDK_TEST_GRID_USER_ID_ADMIN_AUTH = "SLACK_SDK_TEST_GRID_USER_ID_ADMIN_AUTH" # Webhook SLACK_SDK_TEST_INCOMING_WEBHOOK_URL = "SLACK_SDK_TEST_INCOMING_WEBHOOK_URL" diff --git a/integration_tests/web/test_admin_auth_policy.py b/integration_tests/web/test_admin_auth_policy.py new file mode 100644 index 000000000..34f06af11 --- /dev/null +++ b/integration_tests/web/test_admin_auth_policy.py @@ -0,0 +1,69 @@ +import logging +import os +import unittest + +from integration_tests.env_variable_names import ( + SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN, SLACK_SDK_TEST_GRID_USER_ID_ADMIN_AUTH, +) +from integration_tests.helpers import async_test +from slack_sdk.web import WebClient +from slack_sdk.web.async_client import AsyncWebClient + + +class TestWebClient(unittest.TestCase): + """Runs integration tests with real Slack API""" + + def setUp(self): + self.logger = logging.getLogger(__name__) + self.org_admin_token = os.environ[SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN] + self.sync_client: WebClient = WebClient(token=self.org_admin_token) + self.async_client: AsyncWebClient = AsyncWebClient(token=self.org_admin_token) + self.user_ids = [os.environ[SLACK_SDK_TEST_GRID_USER_ID_ADMIN_AUTH]] + + def tearDown(self): + pass + + def test_sync(self): + client = self.sync_client + + list = client.admin_auth_policy_getEntities(policy_name="email_password", limit=3) + self.assertIsNotNone(list) + + assignment = client.admin_auth_policy_assignEntities( + entity_ids=self.user_ids, + policy_name="email_password", + entity_type="USER", + ) + self.assertIsNotNone(assignment) + self.assertEqual(list["entity_total_count"] + 1, assignment["entity_total_count"]) + + removal = client.admin_auth_policy_removeEntities( + entity_ids=self.user_ids, + policy_name="email_password", + entity_type="USER", + ) + self.assertIsNotNone(removal) + self.assertEqual(list["entity_total_count"], removal["entity_total_count"]) + + @async_test + async def test_async(self): + client = self.async_client + + list = await client.admin_auth_policy_getEntities(policy_name="email_password", limit=3) + self.assertIsNotNone(list) + + assignment = await client.admin_auth_policy_assignEntities( + entity_ids=self.user_ids, + policy_name="email_password", + entity_type="USER", + ) + self.assertIsNotNone(assignment) + self.assertEqual(list["entity_total_count"] + 1, assignment["entity_total_count"]) + + removal = await client.admin_auth_policy_removeEntities( + entity_ids=self.user_ids, + policy_name="email_password", + entity_type="USER", + ) + self.assertIsNotNone(removal) + self.assertEqual(list["entity_total_count"], removal["entity_total_count"]) diff --git a/slack_sdk/web/async_client.py b/slack_sdk/web/async_client.py index 6027e2a7b..450fc15af 100644 --- a/slack_sdk/web/async_client.py +++ b/slack_sdk/web/async_client.py @@ -182,6 +182,65 @@ async def admin_apps_uninstall( "admin.apps.uninstall", http_verb="POST", params=kwargs ) + async def admin_auth_policy_getEntities( + self, + *, + policy_name: str, + cursor: Optional[str] = None, + entity_type: Optional[str] = None, + limit: Optional[int] = None, + **kwargs + ) -> AsyncSlackResponse: + """Fetch all the entities assigned to a particular authentication policy by name.""" + kwargs.update({"policy_name": policy_name}) + if cursor is not None: + kwargs.update({"cursor": cursor}) + if entity_type is not None: + kwargs.update({"entity_type": entity_type}) + if limit is not None: + kwargs.update({"limit": limit}) + return await self.api_call( + "admin.auth.policy.getEntities", http_verb="POST", params=kwargs + ) + + async def admin_auth_policy_assignEntities( + self, + *, + entity_ids: Union[str, Sequence[str]], + policy_name: str, + entity_type: str, + **kwargs + ) -> AsyncSlackResponse: + """Assign entities to a particular authentication policy.""" + if isinstance(entity_ids, (list, Tuple)): + kwargs.update({"entity_ids": ",".join(entity_ids)}) + else: + kwargs.update({"entity_ids": entity_ids}) + kwargs.update({"policy_name": policy_name}) + kwargs.update({"entity_type": entity_type}) + return await self.api_call( + "admin.auth.policy.assignEntities", http_verb="POST", params=kwargs + ) + + async def admin_auth_policy_removeEntities( + self, + *, + entity_ids: Union[str, Sequence[str]], + policy_name: str, + entity_type: str, + **kwargs + ) -> AsyncSlackResponse: + """Remove specified entities from a specified authentication policy.""" + if isinstance(entity_ids, (list, Tuple)): + kwargs.update({"entity_ids": ",".join(entity_ids)}) + else: + kwargs.update({"entity_ids": entity_ids}) + kwargs.update({"policy_name": policy_name}) + kwargs.update({"entity_type": entity_type}) + return await self.api_call( + "admin.auth.policy.removeEntities", http_verb="POST", params=kwargs + ) + async def admin_barriers_create( self, *, diff --git a/slack_sdk/web/client.py b/slack_sdk/web/client.py index f5fdab06a..58d9ff20b 100644 --- a/slack_sdk/web/client.py +++ b/slack_sdk/web/client.py @@ -165,6 +165,65 @@ def admin_apps_uninstall( kwargs.update({"team_ids": team_ids}) return self.api_call("admin.apps.uninstall", http_verb="POST", params=kwargs) + def admin_auth_policy_getEntities( + self, + *, + policy_name: str, + cursor: Optional[str] = None, + entity_type: Optional[str] = None, + limit: Optional[int] = None, + **kwargs + ) -> SlackResponse: + """Fetch all the entities assigned to a particular authentication policy by name.""" + kwargs.update({"policy_name": policy_name}) + if cursor is not None: + kwargs.update({"cursor": cursor}) + if entity_type is not None: + kwargs.update({"entity_type": entity_type}) + if limit is not None: + kwargs.update({"limit": limit}) + return self.api_call( + "admin.auth.policy.getEntities", http_verb="POST", params=kwargs + ) + + def admin_auth_policy_assignEntities( + self, + *, + entity_ids: Union[str, Sequence[str]], + policy_name: str, + entity_type: str, + **kwargs + ) -> SlackResponse: + """Assign entities to a particular authentication policy.""" + if isinstance(entity_ids, (list, Tuple)): + kwargs.update({"entity_ids": ",".join(entity_ids)}) + else: + kwargs.update({"entity_ids": entity_ids}) + kwargs.update({"policy_name": policy_name}) + kwargs.update({"entity_type": entity_type}) + return self.api_call( + "admin.auth.policy.assignEntities", http_verb="POST", params=kwargs + ) + + def admin_auth_policy_removeEntities( + self, + *, + entity_ids: Union[str, Sequence[str]], + policy_name: str, + entity_type: str, + **kwargs + ) -> SlackResponse: + """Remove specified entities from a specified authentication policy.""" + if isinstance(entity_ids, (list, Tuple)): + kwargs.update({"entity_ids": ",".join(entity_ids)}) + else: + kwargs.update({"entity_ids": entity_ids}) + kwargs.update({"policy_name": policy_name}) + kwargs.update({"entity_type": entity_type}) + return self.api_call( + "admin.auth.policy.removeEntities", http_verb="POST", params=kwargs + ) + def admin_barriers_create( self, *, diff --git a/slack_sdk/web/legacy_client.py b/slack_sdk/web/legacy_client.py index f6bd1ad0e..50b38bb1d 100644 --- a/slack_sdk/web/legacy_client.py +++ b/slack_sdk/web/legacy_client.py @@ -178,6 +178,65 @@ def admin_apps_uninstall( kwargs.update({"team_ids": team_ids}) return self.api_call("admin.apps.uninstall", http_verb="POST", params=kwargs) + def admin_auth_policy_getEntities( + self, + *, + policy_name: str, + cursor: Optional[str] = None, + entity_type: Optional[str] = None, + limit: Optional[int] = None, + **kwargs + ) -> Union[Future, SlackResponse]: + """Fetch all the entities assigned to a particular authentication policy by name.""" + kwargs.update({"policy_name": policy_name}) + if cursor is not None: + kwargs.update({"cursor": cursor}) + if entity_type is not None: + kwargs.update({"entity_type": entity_type}) + if limit is not None: + kwargs.update({"limit": limit}) + return self.api_call( + "admin.auth.policy.getEntities", http_verb="POST", params=kwargs + ) + + def admin_auth_policy_assignEntities( + self, + *, + entity_ids: Union[str, Sequence[str]], + policy_name: str, + entity_type: str, + **kwargs + ) -> Union[Future, SlackResponse]: + """Assign entities to a particular authentication policy.""" + if isinstance(entity_ids, (list, Tuple)): + kwargs.update({"entity_ids": ",".join(entity_ids)}) + else: + kwargs.update({"entity_ids": entity_ids}) + kwargs.update({"policy_name": policy_name}) + kwargs.update({"entity_type": entity_type}) + return self.api_call( + "admin.auth.policy.assignEntities", http_verb="POST", params=kwargs + ) + + def admin_auth_policy_removeEntities( + self, + *, + entity_ids: Union[str, Sequence[str]], + policy_name: str, + entity_type: str, + **kwargs + ) -> Union[Future, SlackResponse]: + """Remove specified entities from a specified authentication policy.""" + if isinstance(entity_ids, (list, Tuple)): + kwargs.update({"entity_ids": ",".join(entity_ids)}) + else: + kwargs.update({"entity_ids": entity_ids}) + kwargs.update({"policy_name": policy_name}) + kwargs.update({"entity_type": entity_type}) + return self.api_call( + "admin.auth.policy.removeEntities", http_verb="POST", params=kwargs + ) + def admin_barriers_create( self, *, diff --git a/tests/slack_sdk_async/web/test_web_client_coverage.py b/tests/slack_sdk_async/web/test_web_client_coverage.py index 6d2cc1d9a..6801af339 100644 --- a/tests/slack_sdk_async/web/test_web_client_coverage.py +++ b/tests/slack_sdk_async/web/test_web_client_coverage.py @@ -14,9 +14,9 @@ class TestWebClientCoverage(unittest.TestCase): - # 235 endpoints as of Apr 30, 2021 + # 238 endpoints as of Jun 14, 2021 # Can be fetched by running `var methodNames = [].slice.call(document.getElementsByClassName('bold')).map(e => e.text);console.log(methodNames.toString());console.log(methodNames.length);` on https://api.slack.com/methods - all_api_methods = "admin.analytics.getFile,admin.apps.approve,admin.apps.clearResolution,admin.apps.restrict,admin.apps.uninstall,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.barriers.create,admin.barriers.delete,admin.barriers.list,admin.barriers.update,admin.conversations.archive,admin.conversations.convertToPrivate,admin.conversations.create,admin.conversations.delete,admin.conversations.getConversationPrefs,admin.conversations.getCustomRetention,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.removeCustomRetention,admin.conversations.rename,admin.conversations.search,admin.conversations.setConversationPrefs,admin.conversations.setCustomRetention,admin.conversations.setTeams,admin.conversations.unarchive,admin.conversations.ekm.listOriginalConnectedChannelInfo,admin.conversations.restrictAccess.addGroup,admin.conversations.restrictAccess.listGroups,admin.conversations.restrictAccess.removeGroup,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.usergroups.addChannels,admin.usergroups.addTeams,admin.usergroups.listChannels,admin.usergroups.removeChannels,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.clearSettings,admin.users.session.getSettings,admin.users.session.invalidate,admin.users.session.list,admin.users.session.reset,admin.users.session.setSettings,api.test,apps.connections.open,apps.event.authorizations.list,apps.uninstall,auth.revoke,auth.test,auth.teams.list,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,calls.participants.remove,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.archive,conversations.close,conversations.create,conversations.history,conversations.info,conversations.invite,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.mark,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.kick,channels.leave,channels.list,channels.mark,channels.rename,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.createChild,groups.history,groups.info,groups.invite,groups.kick,groups.leave,groups.list,groups.mark,groups.open,groups.rename,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.close,im.history,im.list,im.mark,im.open,im.replies,mpim.close,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies".split( + all_api_methods = "admin.analytics.getFile,admin.apps.approve,admin.apps.clearResolution,admin.apps.restrict,admin.apps.uninstall,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.auth.policy.assignEntities,admin.auth.policy.getEntities,admin.auth.policy.removeEntities,admin.barriers.create,admin.barriers.delete,admin.barriers.list,admin.barriers.update,admin.conversations.archive,admin.conversations.convertToPrivate,admin.conversations.create,admin.conversations.delete,admin.conversations.getConversationPrefs,admin.conversations.getCustomRetention,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.removeCustomRetention,admin.conversations.rename,admin.conversations.search,admin.conversations.setConversationPrefs,admin.conversations.setCustomRetention,admin.conversations.setTeams,admin.conversations.unarchive,admin.conversations.ekm.listOriginalConnectedChannelInfo,admin.conversations.restrictAccess.addGroup,admin.conversations.restrictAccess.listGroups,admin.conversations.restrictAccess.removeGroup,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.usergroups.addChannels,admin.usergroups.addTeams,admin.usergroups.listChannels,admin.usergroups.removeChannels,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.clearSettings,admin.users.session.getSettings,admin.users.session.invalidate,admin.users.session.list,admin.users.session.reset,admin.users.session.setSettings,api.test,apps.connections.open,apps.uninstall,apps.event.authorizations.list,auth.revoke,auth.test,auth.teams.list,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,calls.participants.remove,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.archive,conversations.close,conversations.create,conversations.history,conversations.info,conversations.invite,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.mark,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.comments.delete,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.kick,channels.leave,channels.list,channels.mark,channels.rename,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.createChild,groups.history,groups.info,groups.invite,groups.kick,groups.leave,groups.list,groups.mark,groups.open,groups.rename,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.close,im.history,im.list,im.mark,im.open,im.replies,mpim.close,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies".split( "," ) @@ -79,6 +79,33 @@ async def run_method(self, method_name, method, async_method): elif method_name == "admin_apps_clearResolution": self.api_methods_to_call.remove(method(app_id="AID123")["method"]) await async_method(app_id="AID123") + elif method_name == "admin_auth_policy_getEntities": + self.api_methods_to_call.remove( + method(policy_name="policyname")["method"] + ) + await async_method(policy_name="policyname") + elif method_name == "admin_auth_policy_assignEntities": + self.api_methods_to_call.remove( + method( + entity_ids=["1", "2"], + entity_type="type", + policy_name="policyname", + )["method"] + ) + await async_method( + entity_ids=["1", "2"], entity_type="type", policy_name="policyname" + ) + elif method_name == "admin_auth_policy_removeEntities": + self.api_methods_to_call.remove( + method( + entity_ids=["1", "2"], + entity_type="type", + policy_name="policyname", + )["method"] + ) + await async_method( + entity_ids=["1", "2"], entity_type="type", policy_name="policyname" + ) elif method_name == "admin_barriers_create": self.api_methods_to_call.remove( method(