Skip to content

fix(backend): Replace OrganizationMembershipRole with custom types for authorization #2408

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.

Sign up for GitHub

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
panteliselef merged 2 commits into from
Dec 20, 2023
Merged

fix(backend): Replace OrganizationMembershipRole with custom types for authorization #2408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15e0e73
fix(backend): Replace `OrganizationMembershipRole` with custom types …
panteliselef Dec 19, 2023
c0024fb
fix(backend): Add changeset
panteliselef Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/beige-eyes-relate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

`OrganizationMembershipRole` should respect authorization types provided by the developer if those exist.
4 changes: 3 additions & 1 deletion packages/backend/src/api/resources/Enums.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import type { OrganizationCustomRoleKey } from '@clerk/types';

export type OAuthProvider =
| 'facebook'
| 'google'
Expand All @@ -20,7 +22,7 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';
export type OrganizationMembershipRole = OrganizationCustomRoleKey;

@RodneyU215 RodneyU215 Dec 20, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please forgive my ignorance but would we not want to include the default roles 'org:member' | 'org:admin' here as well? We had a customer reach out to support regarding this TS error.
Screenshot 2023-12-19 at 11 14 19 PM

@panteliselef panteliselef Dec 20, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed we will not add the default roles in types for the time being, customers will be unblocked with the fix from this PR


export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';

Expand Down