-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5700 from owncloud/invitations
Invitations service
- Loading branch information
Showing
46 changed files
with
1,900 additions
and
0 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: IDP | ||
| weight: 20 | ||
| geekdocRepo: https://github.com/owncloud/ocis | ||
| geekdocEditPath: edit/master/docs/services/invitations | ||
| geekdocFilePath: _index.md | ||
| geekdocCollapseSection: true | ||
| --- | ||
|
|
||
| ## Abstract | ||
|
|
||
| This service provides an invitations service to invite guests into the organization. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| {{< toc-tree >}} |
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,15 @@ | ||
| --- | ||
| title: Service Configuration | ||
| date: 2023-03-02T15:27:00+01:00 | ||
| weight: 20 | ||
| geekdocRepo: https://github.com/owncloud/ocis | ||
| geekdocEditPath: edit/master/docs/services/invitations | ||
| geekdocFilePath: configuration.md | ||
| geekdocCollapseSection: true | ||
| --- | ||
|
|
||
| ## Example YAML Config | ||
|
|
||
| {{< include file="services/_includes/invitations-config-example.yaml" language="yaml" >}} | ||
|
|
||
| {{< include file="services/_includes/invitations_configvars.md" >}} |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package command | ||
|
|
||
| import ( | ||
| "github.com/owncloud/ocis/v2/ocis-pkg/config" | ||
| "github.com/owncloud/ocis/v2/ocis-pkg/config/configlog" | ||
| "github.com/owncloud/ocis/v2/ocis-pkg/config/parser" | ||
| "github.com/owncloud/ocis/v2/ocis/pkg/command/helper" | ||
| "github.com/owncloud/ocis/v2/ocis/pkg/register" | ||
| "github.com/owncloud/ocis/v2/services/invitations/pkg/command" | ||
| "github.com/urfave/cli/v2" | ||
| ) | ||
|
|
||
| // InvitationsCommand is the entrypoint for the invitations command. | ||
| func InvitationsCommand(cfg *config.Config) *cli.Command { | ||
| return &cli.Command{ | ||
| Name: cfg.Invitations.Service.Name, | ||
| Usage: helper.SubcommandDescription(cfg.Invitations.Service.Name), | ||
| Category: "services", | ||
| Before: func(c *cli.Context) error { | ||
| configlog.Error(parser.ParseConfig(cfg, true)) | ||
| cfg.Invitations.Commons = cfg.Commons | ||
| return nil | ||
| }, | ||
| Subcommands: command.GetCommands(cfg.Invitations), | ||
| } | ||
| } | ||
|
|
||
| func init() { | ||
| register.AddCommand(InvitationsCommand) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| SHELL := bash | ||
| NAME := invitations | ||
|
|
||
| include ../../.make/recursion.mk | ||
|
|
||
| ############ tooling ############ | ||
| ifneq (, $(shell command -v go 2> /dev/null)) # suppress `command not found warnings` for non go targets in CI | ||
| include ../../.bingo/Variables.mk | ||
| endif | ||
|
|
||
| ############ go tooling ############ | ||
| include ../../.make/go.mk | ||
|
|
||
| ############ release ############ | ||
| include ../../.make/release.mk | ||
|
|
||
| ############ docs generate ############ | ||
| include ../../.make/docs.mk | ||
|
|
||
| .PHONY: docs-generate | ||
| docs-generate: config-docs-generate | ||
|
|
||
| ############ generate ############ | ||
| include ../../.make/generate.mk | ||
|
|
||
| .PHONY: ci-go-generate | ||
| ci-go-generate: $(MOCKERY) # CI runs ci-node-generate automatically before this target | ||
| $(MOCKERY) --dir pkg/backends/keycloak --output pkg/mocks --case underscore --name GoCloak | ||
|
|
||
|
|
||
| .PHONY: ci-node-generate | ||
| ci-node-generate: | ||
|
|
||
| ############ licenses ############ | ||
| .PHONY: ci-node-check-licenses | ||
| ci-node-check-licenses: | ||
|
|
||
| .PHONY: ci-node-save-licenses | ||
| ci-node-save-licenses: |
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,15 @@ | ||
| # Invitations Service | ||
|
|
||
| The invitations service provides an [Invitation Manager](https://learn.microsoft.com/en-us/graph/api/invitation-post?view=graph-rest-1.0&tabs=http) that can be used to invite external users aka Guests to an organization. | ||
|
|
||
| Users invited via this Invitation Manager (libre graph API) will have `userType="Guest"`, whereas users belonging to the organization have `userType="Member"`. | ||
|
|
||
| The corresponding CS3 API [user types](https://cs3org.github.io/cs3apis/#cs3.identity.user.v1beta1.UserType) used to reperesent this are: `USER_TYPE_GUEST` and `USER_TYPE_PRIMARY`. | ||
|
|
||
| ## Provisioning backends | ||
|
|
||
| When oCIS is used for user management the users are created using the `/graph/v1.0/users` endpoint. For larger deployments the keycloak admin API can be used to provision users. We might even make the endpoint, credentials and body configurable using templates. | ||
|
|
||
| ## Bridging provisioning delay | ||
|
|
||
| When a guest account has to be provisioned in an external user management there might be a delay between creating the user and it being available in the local ocis system. In the first iteration the invitations service will only keep track of invites in memory. This list could be persisted in future iterations. |
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,14 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/owncloud/ocis/v2/services/invitations/pkg/command" | ||
| "github.com/owncloud/ocis/v2/services/invitations/pkg/config/defaults" | ||
| ) | ||
|
|
||
| func main() { | ||
| if err := command.Execute(defaults.DefaultConfig()); err != nil { | ||
| os.Exit(1) | ||
| } | ||
| } |
Oops, something went wrong.