Manage Organization Invitations by bkiran6398 · Pull Request #1424 · auth0/auth0-cli

bkiran6398 · 2026-01-26T11:14:58Z

This PR introduces comprehensive support for managing organization invitations through the Auth0 CLI. Users can now create, list, show, and delete organization invitations directly from the command line.

🔧 Changes

Key additions:

Added auth0 orgs invitations command group with four subcommands: list, create, show, and delete
Added command alias invs for shorter command invocation
Extended OrganizationAPI interface with four new methods: Invitations(), CreateInvitation(), Invitation(), and DeleteInvitation()
Added new display views for rendering invitation data in multiple output formats (table, JSON, CSV)
Added required OAuth scopes for organization invitation management: read:organization_invitations, create:organization_invitations, and delete:organization_invitations

Command capabilities:

List: Display all invitations for an organization with pagination support
Create: Send new organization invitations with customizable parameters (inviter name, invitee email, client ID, connection ID, TTL, roles, and metadata)
Show: View detailed information about a specific invitation
Delete: Remove one or multiple invitations with interactive picker support

📚 References

#490

🔬 Testing

Automated Tests:

Added comprehensive integration tests covering all invitation commands (list, create, show, delete)
Added unit tests for invitation picker functionality
Tests validate both successful operations and error handling for invalid inputs (missing arguments, invalid IDs)

Integration Test Enhancements:

Created helper scripts for test automation:
- get-org-invitation-id.sh: Extracts invitation IDs from command output for use in subsequent tests
- delete-app-id.sh: Cleanup script to remove test artifacts after app deletion tests
Updated get-app-id.sh script for better compatibility with invitation-related tests
Tests include edge cases such as missing required arguments and operations with non-existent resources

Manual Testing:
All commands have been manually tested with:

Interactive and non-interactive modes
Various output formats (table, JSON, JSON-compact, CSV)
Valid and invalid parameters
Multiple invitations operations

📝 Checklist

All new/changed/fixed functionality is covered by tests (or N/A)
I have added documentation for all new/changed functionality (or N/A)

- Implemented the Invitations method in the OrganizationAPI interface to list invitations for an organization. - Generated corresponding mock methods in organization_mock.go for testing. - This change enhances the API's functionality by allowing retrieval of organization invitations, aligning with the management API documentation.

- Introduced `invitationsOrganizationCmd` to handle invitations management. - Added `listInvitationsOrganizationCmd` for listing organization invitations with options for pagination and output formats. - Implemented `getOrgInvitationsWithSpinner` and `getOrgInvitations` methods for fetching invitations from the API. - Created `invitationsView` struct for displaying invitation details in a structured format.

…tions - Introduced a new section for managing invitations within organizations. - Added a new file `auth0_orgs_invitations.md` detailing the invitation management commands. - Created `auth0_orgs_invitations_list.md` to document the command for listing invitations. - Updated existing documentation files to include links to the new invitations section. This change enhances the usability of the Auth0 CLI by providing clear guidance on managing organization invitations.

codecov-commenter · 2026-01-27T07:45:54Z

Codecov Report

❌ Patch coverage is 31.49606% with 87 lines in your changes missing coverage. Please review.
✅ Project coverage is 58.79%. Comparing base (72153d5) to head (e70e74d).
⚠️ Report is 52 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/cli/organizations.go	42.55%	53 Missing and 1 partial ⚠️
internal/display/invitations.go	0.00%	33 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1424      +/-   ##
==========================================
- Coverage   64.51%   58.79%   -5.72%     
==========================================
  Files         108      118      +10     
  Lines       17959    20535    +2576     
==========================================
+ Hits        11586    12074     +488     
- Misses       5615     7673    +2058     
- Partials      758      788      +30

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Implemented CreateInvitation method in OrganizationAPI interface to facilitate creating invitations for organizations. - Added corresponding mock methods in organization_mock.go for testing purposes. - This change enhances the API's functionality, allowing users to manage organization invitations more effectively.

- Added `create` command to manage organization invitations, allowing users to create new invitations. - Introduced flags for inviter name, invitee email, client ID, connection ID, TTL seconds, and metadata. - Updated `auth0_orgs_invitations.md` to include the new command. - Created detailed documentation in `auth0_orgs_invitations_create.md` for usage and examples. - Enhanced `auth0_orgs_invitations_list.md` to reference the new create command. - Updated `invitations.go` to reflect changes in field names for consistency.

…ality - Implemented the DeleteInvitation method in the OrganizationAPI interface to allow deletion of invitations. - Added DeleteInvitation mock methods in organization_mock.go for testing purposes. - Created a new delete command in organizations.go to handle invitation deletions, including interactive and non-interactive modes. - Introduced invitationPickerOptions method to facilitate selection of invitations for deletion. - Added unit tests for invitationPickerOptions to ensure correct behavior under various scenarios.

… options - Fixed PickMany to validate if the command can prompt for required arguments. - This prevents making redundant GET api calls to list picker options. - Removed the unused selectArgument function to streamline the code.

- Implemented the `show` command for displaying organization invitations. - Added `Invitation` method to the `OrganizationAPI` interface in `organization.go`. - Created mock methods in `organization_mock.go` for testing the new functionality. - Updated `invitations.go` to include a new renderer method for showing invitations.

- Introduced aliases for the invitations commands to enhance usability: - Updated examples in the command documentation to reflect the new aliases. - This change aims to streamline command usage and improve user experience.

ramya18101 · 2026-02-06T04:10:52Z

@claude

- Implemented new test cases for listing, creating, showing, and deleting organization invitations. - Added tests to verify behavior with valid and invalid inputs, including edge cases for missing arguments and invalid IDs. - Created a new script `get-org-invitation-id.sh` to facilitate the retrieval of invitation IDs for testing. - Updated existing `get-app-id.sh` script to ensure compatibility with the organization-invitation functionality.

- Added new required scopes for managing organization invitations: - `read:organization_invitations` - `create:organization_invitations` - `delete:organization_invitations` This change is necessary to ensure that the application has the appropriate permissions to handle organization invitations effectively.

…tion_invitations - Replaced the previous organization invitation scopes with generic extra scopes for better test coverage.

…tests

- Introduced a new script `delete-app-id.sh` to remove the app identifier file created during integration tests. - This script ensures that the identifier file is deleted only if the app is successfully removed, preventing stale data in subsequent test runs. - Updated the test case for app deletion to call this cleanup script after the app is deleted.

…n invitationsView

ramya18101 · 2026-02-08T10:57:27Z

internal/cli/arguments.go

+	if !canPrompt(cmd) {
+		return fmt.Errorf("Missing a required argument: %s", a.GetName())
+	}
+


Don't update the existing Pick logic in arguments.go

The existing Pick function was making API calls to fetch options and then checking whether those could be prompted. This change doesn’t affect the existing logic, but it avoids a redundant API call.

ramya18101 · 2026-02-08T11:01:03Z

internal/cli/organizations.go

+		ShortForm:  "c",
+		Help:       "Auth0 client ID. Used to resolve the application's login initiation endpoint.",
+		IsRequired: true,
+	}
+
+	connectionID = Flag{
+		Name:     "Connection ID",
+		LongForm: "connection-id",


To avoid confusion, remove shortform for clientID too..
as we didn't include shortform for connectionID

ramya18101 · 2026-02-08T11:06:11Z

internal/cli/organizations.go

 }

+func (cli *cli) invitationPickerOptions(ctx context.Context, orgID string) (pickerOptions, error) {
+	invitations, err := cli.getOrgInvitations(ctx, orgID, 1000)


why are we fetching only 1000 invitations..?

ramya18101 · 2026-02-08T11:08:08Z

internal/cli/organizations.go

+	applicationMetadata = Flag{
+		Name:      "App Metadata",
+		LongForm:  "app-metadata",
+		ShortForm: "a",
+		Help:      "Application metadata for the invited user in key=value format.",
+	}
+
+	userMetadata = Flag{
+		Name:      "User Metadata",
+		LongForm:  "user-metadata",
+		ShortForm: "u",
+		Help:      "User metadata for the invited user in key=value format.",
+	}


Clearly mention in the Help of Metadata logic : formatted as JSON.

ramya18101 · 2026-02-08T11:10:16Z

internal/cli/organizations.go

+		Use:     "invitations",
+		Aliases: []string{"invs"},
+		Short:   "Manage invitations of an organization",
+		Long:    "Manage invitations of an organization.",


Update Long more descriptive by taking the reference from : https://auth0.com/docs/manage-users/organizations/configure-organizations/invite-members

ramya18101 · 2026-02-08T11:26:51Z

internal/cli/organizations.go

+		Args:  cobra.MaximumNArgs(2),
+		Short: "Show an organization invitation",
+		Long:  "Display information about an organization invitation.",
+		Example: `  auth0 orgs invs show


Don't follow args format, Instead create separate flags for -orgId and -invId ..

ramya18101 · 2026-02-09T01:43:45Z

internal/cli/organizations.go

+		Short: "Create a new invitation to an organization",
+		Long:  "Create a new invitation to an organization.",
+		Example: `  auth0 orgs invs create
+  auth0 orgs invs create <org-id>


Parse org-id as a flag and use picker logic on top of it

ramya18101 · 2026-02-09T01:44:17Z

internal/cli/organizations.go

+				inputs.OrgID = args[0]
+				args = args[1:]


Use orgId as a flag

ramya18101 · 2026-02-09T01:45:03Z

internal/cli/organizations.go

+				return err
+			}
+
+			sortInvitations(invitations)


Why are we manually sorting, we have a field supporting --sort

ramya18101 · 2026-02-09T01:48:06Z

internal/cli/organizations.go

+		},
+	}
+
+	organizationNumber.Help = "Number of organization invitations to retrieve. Minimum 1, maximum 1000."


Why are we limiting the range to 1 and 1000.
and why are we defining help Here..?

bkiran6398 added 3 commits January 26, 2026 16:19

bkiran6398 added 6 commits February 3, 2026 19:12

feat(invitations): add aliase invs for invitations commands

fc538b2

- Introduced aliases for the invitations commands to enhance usability: - Updated examples in the command documentation to reflect the new aliases. - This change aims to streamline command usage and improve user experience.

bkiran6398 and others added 7 commits February 6, 2026 15:40

feat(tests): Use generic extra scopes for testing instead of organiza…

1489749

…tion_invitations - Replaced the previous organization invitation scopes with generic extra scopes for better test coverage.

chore(invitations): increase retry count for organization invitation …

1e11881

…tests

chore(invitations): remove TODO comment regarding additional fields i…

662a8d8

…n invitationsView

Merge branch 'main' into manage_org_invitations

f47ab10

bkiran6398 marked this pull request as ready for review February 6, 2026 14:37

bkiran6398 requested a review from a team as a code owner February 6, 2026 14:37

ramya18101 requested changes Feb 9, 2026

View reviewed changes

Conversation

bkiran6398 commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔧 Changes

📚 References

🔬 Testing

📝 Checklist

Uh oh!

codecov-commenter commented Jan 27, 2026

Codecov Report

Uh oh!

ramya18101 commented Feb 6, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bkiran6398 commented Jan 26, 2026 •

edited

Loading