Module slack_bolt.authorization.authorize_result
Classes
-
Authorize function call result
Args
enterprise_id- Organization ID (Enterprise Grid) starting with
E team_id- Workspace ID starting with
T team- Workspace name
url- Workspace slack.com URL
bot_user_id- Bot user's User ID starting with either
UorW bot_id- Bot ID starting with
B bot_token- Bot user access token starting with
xoxb- bot_scopes- The scopes associated with the bot token
user_id- The request user ID
user- The request user's name
user_token- User access token starting with
xoxp- user_scopes- The scopes associated wth the user token
Expand source code
class AuthorizeResult(dict): """Authorize function call result""" enterprise_id: Optional[str] team_id: Optional[str] team: Optional[str] # since v1.18 url: Optional[str] # since v1.18 bot_id: Optional[str] bot_user_id: Optional[str] bot_token: Optional[str] bot_scopes: Optional[Sequence[str]] # since v1.17 user_id: Optional[str] user: Optional[str] # since v1.18 user_token: Optional[str] user_scopes: Optional[Sequence[str]] # since v1.17 def __init__( self, *, enterprise_id: Optional[str], team_id: Optional[str], team: Optional[str] = None, url: Optional[str] = None, # bot bot_user_id: Optional[str] = None, bot_id: Optional[str] = None, bot_token: Optional[str] = None, bot_scopes: Optional[Union[Sequence[str], str]] = None, # user user_id: Optional[str] = None, user: Optional[str] = None, user_token: Optional[str] = None, user_scopes: Optional[Union[Sequence[str], str]] = None, ): """ Args: enterprise_id: Organization ID (Enterprise Grid) starting with `E` team_id: Workspace ID starting with `T` team: Workspace name url: Workspace slack.com URL bot_user_id: Bot user's User ID starting with either `U` or `W` bot_id: Bot ID starting with `B` bot_token: Bot user access token starting with `xoxb-` bot_scopes: The scopes associated with the bot token user_id: The request user ID user: The request user's name user_token: User access token starting with `xoxp-` user_scopes: The scopes associated wth the user token """ self["enterprise_id"] = self.enterprise_id = enterprise_id self["team_id"] = self.team_id = team_id self["team"] = self.team = team self["url"] = self.url = url # bot self["bot_user_id"] = self.bot_user_id = bot_user_id self["bot_id"] = self.bot_id = bot_id self["bot_token"] = self.bot_token = bot_token if bot_scopes is not None and isinstance(bot_scopes, str): bot_scopes = [scope.strip() for scope in bot_scopes.split(",")] self["bot_scopes"] = self.bot_scopes = bot_scopes # user self["user_id"] = self.user_id = user_id self["user"] = self.user = user self["user_token"] = self.user_token = user_token if user_scopes is not None and isinstance(user_scopes, str): user_scopes = [scope.strip() for scope in user_scopes.split(",")] self["user_scopes"] = self.user_scopes = user_scopes @classmethod def from_auth_test_response( cls, *, bot_token: Optional[str] = None, user_token: Optional[str] = None, bot_scopes: Optional[Union[Sequence[str], str]] = None, user_scopes: Optional[Union[Sequence[str], str]] = None, auth_test_response: Union[SlackResponse, "AsyncSlackResponse"], # type: ignore[name-defined] user_auth_test_response: Optional[Union[SlackResponse, "AsyncSlackResponse"]] = None, # type: ignore[name-defined] ) -> "AuthorizeResult": bot_user_id: Optional[str] = ( auth_test_response.get("user_id") if auth_test_response.get("bot_id") is not None else None ) user_id: Optional[str] = auth_test_response.get("user_id") if auth_test_response.get("bot_id") is None else None user_name: Optional[str] = auth_test_response.get("user") if user_id is None and user_auth_test_response is not None: user_id = user_auth_test_response.get("user_id") user_name = user_auth_test_response.get("user") return AuthorizeResult( enterprise_id=auth_test_response.get("enterprise_id"), team_id=auth_test_response.get("team_id"), team=auth_test_response.get("team"), url=auth_test_response.get("url"), bot_id=auth_test_response.get("bot_id"), bot_user_id=bot_user_id, bot_scopes=bot_scopes, user_id=user_id, user=user_name, bot_token=bot_token, user_token=user_token, user_scopes=user_scopes, )Ancestors
- builtins.dict
Class variables
Static methods