-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support to manage Event Streams (#1134)
* Add support to manage Event Streams * docs updates * updated integ test * fixed integration test * integ * integ * final fix * Fixed linting * name update * Added interactive input for update command * Updated go files
- Loading branch information
1 parent
779a1f6
commit 553b348
Showing
20 changed files
with
1,192 additions
and
9 deletions.
There are no files selected for viewing
This file contains 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,17 @@ | ||
| --- | ||
| layout: default | ||
| has_toc: false | ||
| has_children: true | ||
| --- | ||
| # auth0 events | ||
|
|
||
| Events are a way for Auth0 customers to synchronize, correlate or orchestrate changes that occur within Auth0 or 3rd-party identity providers to your app or 3rd party services. | ||
|
|
||
| ## Commands | ||
|
|
||
| - [auth0 events create](auth0_events_create.md) - Create a new event stream | ||
| - [auth0 events delete](auth0_events_delete.md) - Delete an event stream | ||
| - [auth0 events list](auth0_events_list.md) - List your event streams | ||
| - [auth0 events show](auth0_events_show.md) - Show an event stream | ||
| - [auth0 events update](auth0_events_update.md) - Update an event | ||
|
|
This file contains 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,60 @@ | ||
| --- | ||
| layout: default | ||
| parent: auth0 events | ||
| has_toc: false | ||
| --- | ||
| # auth0 events create | ||
|
|
||
| Create a new event stream. | ||
|
|
||
| To create interactively, use `auth0 events create` with no flags. | ||
|
|
||
| To create non-interactively, supply the event stream name, type, subscriptions and configuration through the flags. | ||
|
|
||
| ## Usage | ||
| ``` | ||
| auth0 events create [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ``` | ||
| auth0 events create | ||
| auth0 events create --name my-event-stream --type eventbridge --subscriptions "user.created,user.updated" --configuration '{"aws_account_id":"325235643634","aws_region":"us-east-2"}' | ||
| auth0 events create --name my-event-stream --type webhook --subscriptions "user.created,user.deleted" --configuration '{"webhook_endpoint":"https://mywebhook.net","webhook_authorization":{"method":"bearer","token":"123456789"}}' | ||
| auth0 events create -n my-event-stream -t webhook -s "user.created,user.deleted" -c '{"webhook_endpoint":"https://mywebhook.net","webhook_authorization":{"method":"bearer","token":"123456789"}}' | ||
| ``` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| ``` | ||
| -c, --configuration string Configuration of the Event Stream. Formatted as JSON. | ||
| Webhook Example: {"webhook_endpoint":"https://my-webhook.net","webhook_authorization":{"method":"bearer","token":"123456789"}} | ||
| Eventbridge Example: {"aws_account_id":"7832467231933","aws_region":"us-east-2"} | ||
| --json Output in json format. | ||
| -n, --name string Name of the Event Stream. | ||
| -s, --subscriptions strings Subscriptions of the Event Stream. Formatted as comma separated string. Eg. user.created,user.updated | ||
| -t, --type string Type of the Event Stream. Eg: webhook, eventbridge etc | ||
| ``` | ||
|
|
||
|
|
||
| ## Inherited Flags | ||
|
|
||
| ``` | ||
| --debug Enable debug mode. | ||
| --no-color Disable colors. | ||
| --no-input Disable interactivity. | ||
| --tenant string Specific tenant to use. | ||
| ``` | ||
|
|
||
|
|
||
| ## Related Commands | ||
|
|
||
| - [auth0 events create](auth0_events_create.md) - Create a new event stream | ||
| - [auth0 events delete](auth0_events_delete.md) - Delete an event stream | ||
| - [auth0 events list](auth0_events_list.md) - List your event streams | ||
| - [auth0 events show](auth0_events_show.md) - Show an event stream | ||
| - [auth0 events update](auth0_events_update.md) - Update an event | ||
|
|
||
|
|
This file contains 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,56 @@ | ||
| --- | ||
| layout: default | ||
| parent: auth0 events | ||
| has_toc: false | ||
| --- | ||
| # auth0 events delete | ||
|
|
||
| Delete an event stream. | ||
|
|
||
| To delete interactively, use `auth0 events delete` with no arguments. | ||
|
|
||
| To delete non-interactively, supply the event id and the `--force` flag to skip confirmation. | ||
|
|
||
| ## Usage | ||
| ``` | ||
| auth0 events delete [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ``` | ||
| auth0 events delete | ||
| auth0 events rm | ||
| auth0 events delete <event-id> | ||
| auth0 events delete <event-id> --force | ||
| auth0 events delete <event-id> <event-id2> <event-idn> | ||
| auth0 events delete <event-id> <event-id2> <event-idn> --force | ||
| ``` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| ``` | ||
| --force Skip confirmation. | ||
| ``` | ||
|
|
||
|
|
||
| ## Inherited Flags | ||
|
|
||
| ``` | ||
| --debug Enable debug mode. | ||
| --no-color Disable colors. | ||
| --no-input Disable interactivity. | ||
| --tenant string Specific tenant to use. | ||
| ``` | ||
|
|
||
|
|
||
| ## Related Commands | ||
|
|
||
| - [auth0 events create](auth0_events_create.md) - Create a new event stream | ||
| - [auth0 events delete](auth0_events_delete.md) - Delete an event stream | ||
| - [auth0 events list](auth0_events_list.md) - List your event streams | ||
| - [auth0 events show](auth0_events_show.md) - Show an event stream | ||
| - [auth0 events update](auth0_events_update.md) - Update an event | ||
|
|
||
|
|
This file contains 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,51 @@ | ||
| --- | ||
| layout: default | ||
| parent: auth0 events | ||
| has_toc: false | ||
| --- | ||
| # auth0 events list | ||
|
|
||
| List your existing event streams. To create one, run: `auth0 events create`. | ||
|
|
||
| ## Usage | ||
| ``` | ||
| auth0 events list [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ``` | ||
| auth0 events list | ||
| auth0 events ls | ||
| auth0 events ls --json | ||
| auth0 events ls --csv | ||
| ``` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| ``` | ||
| --csv Output in csv format. | ||
| --json Output in json format. | ||
| ``` | ||
|
|
||
|
|
||
| ## Inherited Flags | ||
|
|
||
| ``` | ||
| --debug Enable debug mode. | ||
| --no-color Disable colors. | ||
| --no-input Disable interactivity. | ||
| --tenant string Specific tenant to use. | ||
| ``` | ||
|
|
||
|
|
||
| ## Related Commands | ||
|
|
||
| - [auth0 events create](auth0_events_create.md) - Create a new event stream | ||
| - [auth0 events delete](auth0_events_delete.md) - Delete an event stream | ||
| - [auth0 events list](auth0_events_list.md) - List your event streams | ||
| - [auth0 events show](auth0_events_show.md) - Show an event stream | ||
| - [auth0 events update](auth0_events_update.md) - Update an event | ||
|
|
||
|
|
This file contains 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,49 @@ | ||
| --- | ||
| layout: default | ||
| parent: auth0 events | ||
| has_toc: false | ||
| --- | ||
| # auth0 events show | ||
|
|
||
| Display the name, type, status, subscriptions and other information about an event stream | ||
|
|
||
| ## Usage | ||
| ``` | ||
| auth0 events show [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ``` | ||
| auth0 events show | ||
| auth0 events show <event-id> | ||
| auth0 events show <event-id> --json | ||
| ``` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| ``` | ||
| --json Output in json format. | ||
| ``` | ||
|
|
||
|
|
||
| ## Inherited Flags | ||
|
|
||
| ``` | ||
| --debug Enable debug mode. | ||
| --no-color Disable colors. | ||
| --no-input Disable interactivity. | ||
| --tenant string Specific tenant to use. | ||
| ``` | ||
|
|
||
|
|
||
| ## Related Commands | ||
|
|
||
| - [auth0 events create](auth0_events_create.md) - Create a new event stream | ||
| - [auth0 events delete](auth0_events_delete.md) - Delete an event stream | ||
| - [auth0 events list](auth0_events_list.md) - List your event streams | ||
| - [auth0 events show](auth0_events_show.md) - Show an event stream | ||
| - [auth0 events update](auth0_events_update.md) - Update an event | ||
|
|
||
|
|
This file contains 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,63 @@ | ||
| --- | ||
| layout: default | ||
| parent: auth0 events | ||
| has_toc: false | ||
| --- | ||
| # auth0 events update | ||
|
|
||
| Update an event. | ||
|
|
||
| To update interactively, use `auth0 events update` with no arguments. | ||
|
|
||
| To update non-interactively, supply the event id, name, status, subscriptions and configuration through the flags. An event stream type CANNOT be updated hence the configuration should match the schema based on the type of event stream | ||
|
|
||
| ## Usage | ||
| ``` | ||
| auth0 events update [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ``` | ||
| auth0 events update <event-id> | ||
| auth0 events update <event-id> --name my-event-stream | ||
| auth0 events update <event-id> --name my-event-stream --status enabled | ||
| auth0 events update <event-id> --name my-event-stream --status enabled --subscriptions "user.created,user.updated" | ||
| auth0 events update <event-id> --name my-event-stream --status disabled --subscriptions "user.deleted" --configuration '{"aws_account_id":"325235643634","aws_region":"us-east-2"}' | ||
| auth0 events update <event-id> --name my-event-stream --status enabled --subscriptions "user.created" --configuration '{"webhook_endpoint":"https://my-new-webhook.net","webhook_authorization":{"method":"bearer","token":"0909090909"}} | ||
| auth0 events update <event-id> -n my-event-stream --status enabled -s "user.created" -c '{"webhook_endpoint":"https://my-new-webhook.net","webhook_authorization":{"method":"bearer","token":"987654321"}} | ||
| ``` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| ``` | ||
| -c, --configuration string Configuration of the Event Stream. Formatted as JSON. | ||
| Webhook Example: {"webhook_endpoint":"https://my-webhook.net","webhook_authorization":{"method":"bearer","token":"123456789"}} | ||
| Eventbridge Example: {"aws_account_id":"7832467231933","aws_region":"us-east-2"} | ||
| --json Output in json format. | ||
| -n, --name string Name of the Event Stream. | ||
| --status string Status of the Event Stream. (enabled/disabled) | ||
| -s, --subscriptions strings Subscriptions of the Event Stream. Formatted as comma separated string. Eg. user.created,user.updated | ||
| ``` | ||
|
|
||
|
|
||
| ## Inherited Flags | ||
|
|
||
| ``` | ||
| --debug Enable debug mode. | ||
| --no-color Disable colors. | ||
| --no-input Disable interactivity. | ||
| --tenant string Specific tenant to use. | ||
| ``` | ||
|
|
||
|
|
||
| ## Related Commands | ||
|
|
||
| - [auth0 events create](auth0_events_create.md) - Create a new event stream | ||
| - [auth0 events delete](auth0_events_delete.md) - Delete an event stream | ||
| - [auth0 events list](auth0_events_list.md) - List your event streams | ||
| - [auth0 events show](auth0_events_show.md) - Show an event stream | ||
| - [auth0 events update](auth0_events_update.md) - Update an event | ||
|
|
||
|
|
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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.