-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Adding a handful of Get Current User actions #18774
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
31b152d
Get Current User actions
dannyroosevelt b77208e
Merge branch 'master' into danny/authed-user-actions
dannyroosevelt 26d4070
Update get-current-user.mjs
dannyroosevelt fa9706c
Merge branch 'danny/authed-user-actions' of github.com:PipedreamHQ/pi…
dannyroosevelt ed7e235
Merge branch 'danny/authed-user-actions' of github.com:PipedreamHQ/pi…
dannyroosevelt 9beca8e
Update get-current-user.mjs
dannyroosevelt b4224b6
Cleaning up the descriptions
dannyroosevelt ed3f47d
Cleaning up the code
dannyroosevelt eade12d
Merge branch 'master' into danny/authed-user-actions
dannyroosevelt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
components/github/actions/get-current-user/get-current-user.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| import github from "../../github.app.mjs"; | ||
|
|
||
| const DEFAULT_ORGS_LIMIT = 20; | ||
| const DEFAULT_TEAMS_LIMIT = 20; | ||
|
|
||
| export default { | ||
| key: "github-get-current-user", | ||
| name: "Get Current User", | ||
| description: "Gather a full snapshot of the authenticated GitHub actor, combining `/user`, `/user/orgs`, and `/user/teams`. Returns profile metadata (login, name, email, company, plan, creation timestamps) and trimmed lists of organizations and teams for quick role awareness. Helpful when you need to validate which user is calling the API, adapt behavior based on their org/team memberships, or provide LLMs with grounding before repository operations. [See the documentation](https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-the-authenticated-user).", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: true, | ||
| }, | ||
| props: { | ||
| github, | ||
| }, | ||
| async run({ $ }) { | ||
| const [ | ||
| user, | ||
| organizations, | ||
| teams, | ||
| ] = await Promise.all([ | ||
| this.github.getAuthenticatedUser(), | ||
| this.github.getOrganizations() | ||
| .then((orgs) => orgs.slice(0, DEFAULT_ORGS_LIMIT)), | ||
| this.github.getTeams() | ||
| .then((teamsResponse) => teamsResponse.slice(0, DEFAULT_TEAMS_LIMIT)), | ||
| ]); | ||
|
|
||
| $.export("$summary", `Retrieved GitHub user ${user.login}`); | ||
|
|
||
| return { | ||
| user, | ||
| organizations, | ||
| teams, | ||
| }; | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
components/google_calendar/actions/get-current-user/get-current-user.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| import googleCalendar from "../../google_calendar.app.mjs"; | ||
| import constants from "../../common/constants.mjs"; | ||
|
|
||
| const DEFAULT_CALENDAR_SAMPLE_LIMIT = 25; | ||
|
|
||
| export default { | ||
| key: "google_calendar-get-current-user", | ||
| name: "Get Current User", | ||
| description: "Retrieve information about the authenticated Google Calendar account, including the primary calendar (summary, timezone, ACL flags), a list of accessible calendars, user-level settings (timezone, locale, week start), and the color palette that controls events and calendars. Ideal for confirming which calendar account is in use, customizing downstream scheduling, or equipping LLMs with the user’s context (timezones, available calendars) prior to creating or updating events. [See the documentation](https://developers.google.com/calendar/api/v3/reference/calendars/get).", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: true, | ||
| }, | ||
| props: { | ||
| googleCalendar, | ||
| }, | ||
| async run({ $ }) { | ||
| const [ | ||
| primaryCalendar, | ||
| calendarList, | ||
| settings, | ||
| colors, | ||
| ] = await Promise.all([ | ||
| this.googleCalendar.getCalendar({ | ||
| calendarId: "primary", | ||
| }), | ||
| this.googleCalendar.listCalendars({ | ||
| maxResults: DEFAULT_CALENDAR_SAMPLE_LIMIT, | ||
| }), | ||
| this.googleCalendar.requestHandler({ | ||
| api: constants.API.SETTINGS.NAME, | ||
| method: constants.API.SETTINGS.METHOD.LIST, | ||
| }), | ||
| this.googleCalendar.requestHandler({ | ||
| api: constants.API.COLORS.NAME, | ||
| method: constants.API.COLORS.METHOD.GET, | ||
| }), | ||
| ]); | ||
|
|
||
| const timezoneSetting = settings?.items?.find?.((setting) => setting.id === "timezone")?.value; | ||
| const localeSetting = settings?.items?.find?.((setting) => setting.id === "locale")?.value; | ||
|
|
||
| const summaryName = primaryCalendar?.summary || primaryCalendar?.id; | ||
| $.export("$summary", `Retrieved Google Calendar user ${summaryName}`); | ||
|
|
||
| return { | ||
| primaryCalendar, | ||
| calendars: calendarList?.items ?? [], | ||
| settings: settings?.items ?? [], | ||
| timezone: timezoneSetting || primaryCalendar?.timeZone, | ||
| locale: localeSetting, | ||
| colors, | ||
| }; | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
components/google_drive/actions/get-current-user/get-current-user.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import googleDrive from "../../google_drive.app.mjs"; | ||
|
|
||
| const ABOUT_FIELDS = "user,storageQuota"; | ||
|
|
||
| export default { | ||
| key: "google_drive-get-current-user", | ||
| name: "Get Current User", | ||
| description: "Retrieve Google Drive account metadata for the authenticated user via `about.get`, including display name, email, permission ID, and storage quota. Useful when flows or agents need to confirm the active Google identity or understand available storage. [See the documentation](https://developers.google.com/drive/api/v3/reference/about/get).", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: true, | ||
| }, | ||
| props: { | ||
| googleDrive, | ||
| }, | ||
| async run({ $ }) { | ||
| const about = await this.googleDrive.getAbout(ABOUT_FIELDS); | ||
|
|
||
| const summaryName = | ||
| about?.user?.displayName | ||
| || about?.user?.emailAddress | ||
| || about?.user?.permissionId; | ||
| $.export("$summary", `Retrieved Google Drive user ${summaryName}`); | ||
|
|
||
| return { | ||
| about, | ||
| }; | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
components/google_sheets/actions/get-current-user/get-current-user.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import googleSheets from "../../google_sheets.app.mjs"; | ||
|
|
||
| const ABOUT_FIELDS = "user,storageQuota"; | ||
|
|
||
| export default { | ||
| key: "google_sheets-get-current-user", | ||
| name: "Get Current User", | ||
| description: "Retrieve Google Sheets account metadata for the authenticated user by calling Drive's `about.get`, returning the user profile (display name, email, permission ID) and storage quota information. Helpful when you need to verify which Google account is active, tailor sheet operations to available storage, or give an LLM clear context about the user identity before composing read/write actions. [See the Drive API documentation](https://developers.google.com/drive/api/v3/reference/about/get).", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: true, | ||
| }, | ||
| props: { | ||
| googleSheets, | ||
| }, | ||
| async run({ $ }) { | ||
| const about = await this.googleSheets.getAbout(ABOUT_FIELDS); | ||
|
|
||
| const summaryName = | ||
| about?.user?.displayName | ||
| || about?.user?.emailAddress | ||
| || about?.user?.permissionId; | ||
| $.export("$summary", `Retrieved Google Sheets user ${summaryName}`); | ||
|
|
||
| return { | ||
| about, | ||
| }; | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
components/linear/actions/get-current-user/get-current-user.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| import linearApp from "../../linear.app.mjs"; | ||
|
|
||
| const DEFAULT_CONNECTION_LIMIT = 50; | ||
|
|
||
| export default { | ||
| key: "linear-get-current-user", | ||
| name: "Get Current User", | ||
| description: "Retrieve rich context about the authenticated Linear user, including core profile fields, recent timestamps, direct team memberships, and high-level organization settings. Returns the user object, a paginated team list (with names, keys, cycle configs, etc.), associated team memberships, and organization metadata such as auth defaults and SCIM/SAML flags. Use this when your workflow or agent needs to understand who is currently authenticated, which teams they belong to, or what workspace policies might influence subsequent Linear actions. See Linear's GraphQL viewer docs [here](https://developers.linear.app/docs/graphql/working-with-the-graphql-api).", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: true, | ||
| }, | ||
| props: { | ||
| linearApp, | ||
| }, | ||
| async run({ $ }) { | ||
| const client = this.linearApp.client(); | ||
| const viewer = await client.viewer; | ||
|
|
||
| const [ | ||
| organization, | ||
| teamsConnection, | ||
| teamMembershipsConnection, | ||
| ] = await Promise.all([ | ||
| viewer.organization, | ||
| viewer.teams({ | ||
| first: DEFAULT_CONNECTION_LIMIT, | ||
| }), | ||
| viewer.teamMemberships({ | ||
| first: DEFAULT_CONNECTION_LIMIT, | ||
| }), | ||
| ]); | ||
|
|
||
| const summaryIdentifier = viewer.name || viewer.displayName || viewer.email || viewer.id; | ||
| $.export("$summary", `Retrieved Linear user ${summaryIdentifier}`); | ||
|
|
||
| return { | ||
| user: viewer, | ||
| organization, | ||
| teams: teamsConnection, | ||
| teamMemberships: teamMembershipsConnection, | ||
| }; | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
components/notion/actions/get-current-user/get-current-user.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| import notion from "../../notion.app.mjs"; | ||
|
|
||
| export default { | ||
| key: "notion-get-current-user", | ||
| name: "Get Current User", | ||
| description: "Retrieve the Notion identity tied to the current OAuth token, returning the full `users.retrieve` payload for `me` (person or bot). Includes the user ID, name, avatar URL, type (`person` vs `bot`), and workspace ownership metadata—useful for confirming which workspace is connected, adapting downstream queries, or giving an LLM the context it needs about who is operating inside Notion. [See the documentation](https://developers.notion.com/reference/get-user).", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: true, | ||
| }, | ||
| props: { | ||
| notion, | ||
| }, | ||
| async run({ $ }) { | ||
| const response = await this.notion.getUser("me"); | ||
|
|
||
| const displayName = response?.name || response?.bot?.workspace_name || response?.id; | ||
| const ownerUser = response?.bot?.owner?.user; | ||
| const ownerName = ownerUser?.name || ownerUser?.id; | ||
| const ownerEmail = ownerUser?.person?.email; | ||
| const summaryParts = [ | ||
| response?.bot?.workspace_name && `workspace **${response.bot.workspace_name}**`, | ||
| (() => { | ||
| if (!ownerName && !ownerEmail) return null; | ||
| if (ownerName && ownerEmail) return `owner ${ownerName} (<${ownerEmail}>)`; | ||
| if (ownerName) return `owner ${ownerName}`; | ||
| return `owner <${ownerEmail}>`; | ||
| })(), | ||
| ].filter(Boolean); | ||
|
|
||
| const summaryContext = summaryParts.length | ||
| ? ` — ${summaryParts.join(", ")}` | ||
| : ""; | ||
|
|
||
| $.export("$summary", `Retrieved Notion ${response?.type || "user"} **${displayName}**${summaryContext}`); | ||
|
|
||
| return response; | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
components/slack/actions/get-current-user/get-current-user.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| import slack from "../../slack.app.mjs"; | ||
|
|
||
| export default { | ||
| key: "slack-get-current-user", | ||
| name: "Get Current User", | ||
| description: "Retrieve comprehensive context about the authenticated Slack member, combining `auth.test`, `users.info`, `users.profile.get`, and `team.info` payloads. Returns the user’s profile (name variants, email, locale, timezone, status, admin flags), raw auth test data, and workspace metadata (domain, enterprise info, icons). Ideal when you need to confirm which user token is active, tailor messages to their locale/timezone, or ground an LLM in the member’s role and workspace before executing other Slack actions. [See Slack API docs](https://api.slack.com/methods/auth.test).", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| annotations: { | ||
| destructiveHint: false, | ||
| openWorldHint: true, | ||
| readOnlyHint: true, | ||
| }, | ||
| props: { | ||
| slack, | ||
| }, | ||
| async run({ $ }) { | ||
| const authContext = await this.slack.authTest(); | ||
|
|
||
| const userId = authContext.user_id || authContext.user; | ||
| if (!userId) { | ||
| throw new Error(`Unable to determine user ID from auth context. Received: ${JSON.stringify(authContext)}`); | ||
| } | ||
|
|
||
| let userInfo; | ||
| try { | ||
| userInfo = await this.slack.usersInfo({ | ||
| user: userId, | ||
| include_locale: true, | ||
| }); | ||
| } catch (error) { | ||
| // Gracefully degrade if scope not available | ||
| } | ||
|
|
||
| let userProfile; | ||
| try { | ||
| userProfile = await this.slack.getUserProfile({ | ||
| user: userId, | ||
| }); | ||
| } catch (error) { | ||
| // Gracefully degrade if scope not available | ||
| } | ||
|
|
||
| let teamInfo; | ||
| try { | ||
| teamInfo = await this.slack.getTeamInfo(); | ||
| } catch (error) { | ||
| // Gracefully degrade if scope not available | ||
| } | ||
|
|
||
| const user = userInfo?.user; | ||
| const profile = userProfile?.profile ?? user?.profile; | ||
| const summaryName = | ||
| profile?.real_name_normalized | ||
| || profile?.display_name_normalized | ||
| || authContext.user | ||
| || userId; | ||
|
|
||
| $.export("$summary", `Retrieved Slack user ${summaryName}`); | ||
|
|
||
| return { | ||
| authContext, | ||
| user, | ||
| profile, | ||
| team: teamInfo?.team, | ||
| }; | ||
| }, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.