diff --git a/README.md b/README.md index f6d0059..8892e44 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,106 @@ provider :slack, 'API_KEY', 'API_SECRET', scope: 'team:read,users:read,identify, Use the first provider to sign users in and the second to add the application to their team. +## Auth Hash Example + +For the scope `team:read,users:read,identify` the resulting auth hash would look like this: + +```ruby +{ + provider: "slack", + uid: "U3BPA937E", + info: { + description: "Welcome to Slack", + email: "email@example.com", + first_name: "Matt", + image: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-192.png", + image_24: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-24.png", + image_48: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-48.png", + is_admin: true, + is_owner: true, + last_name: "Holmes", + name: "Matt Holmes", + nickname: "matty", + team: "Mattison co.", + team_id: "A3V3VC35Y", + time_zone: "Europe/Amsterdam", + user: "matty", + user_id: "U3BPA937E" + }, + credentials { + expires: false, + token: "xoxp-127131411201-127810174082-127813170226-f205827fb956488602bef2068471d7a5", + }, + extra { + bot_info: {}, + raw_info: { + ok: true, + team: "Mattison co.", + team_id: "A3V3VC35Y", + url: "https://mattison.slack.com/", + user: "matty", + user_id: "U3BPA937E" + }, + team_info: { + ok: true, + team: { + domain: "mattison", + email_domain: "", + icon: { + image_102: "https://a.slack-edge.com/66f9/img/avatars-teams/ava_0018-102.png", + image_132 "https://a.slack-edge.com/66f9/img/avatars-teams/ava_0018-132ng", + image_230"https://a.slack-edge.com/66f9/img/avatars-teams/ava_0018-230ng", + image_34 "https://a.slack-edge.com/66f9/img/avatars-teams/ava_0018-34png", + image_44 "https://a.slack-edge.com/66f9/img/avatars-teams/ava_0018-44png", + image_68 "https://a.slack-edge.com/66f9/img/avatars-teams/ava_0018-68png", + image_88 "https://a.slack-edge.com/66f9/img/avatars-teams/ava_0018-88png", + image_default: true + }, + id: "A3V3VC35Y", + name: "Mattison co." + } + }, + user_info: { + ok: true, + user: { + color: "9f69e7", + deleted: false, + has_2fa: false, + id: "U3BPA937E", + is_admin: true, + is_bot: false, + is_owner: true, + is_primary_owner: true, + is_restricted: false, + is_ultra_restricted: false, + name: "matty", + profile: { + avatar_hash: "g69720796ae3", + first_name: "Matt", + image_192: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-192.png", + image_24: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-24.png", + image_32: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-32.png", + image_48: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-48.png", + image_512: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-512.png", + image_72: "https://secure.gravatar.com/avatar/69720796ae3e1c2d63cd66b2d53571a5.jpg?s=192&d=https%3A%2F%2Fa.slack-edge.com%2F7fa9%2Fimg%2Favatars%2Fava_0013-72.png", + last_name: "Holmes", + real_name: "Matt Holmes", + real_name_normalized: "Matt Holmes" + }, + real_name: "Matt Holmes", + status: nil, + team_id: "A3V3VC35Y", + tz: "Europe/Amsterdam", + tz_label: "Central European Time", + tz_offset: 3600 + } + }, + web_hook_info: {} + } +} +``` + + ## Authentication Options ### Team