mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 20:57:31 +00:00
chore(v2): move to new org (#3499)
* chore: move to new org * logging * fix: org rename caos -> zitadel Co-authored-by: adlerhurst <silvan.reusser@gmail.com>
This commit is contained in:
Florian Forster
@@ -57,7 +57,7 @@ With this token you can make subsequent requests, just like a human user.
|
||||
|
||||
In this exercise we will authenticate a service user and receive an access_token to use against a API.
|
||||
|
||||
> **Information:** Are you stuck? Don't hesitate to reach out to us on [Github Discussions](https://github.com/caos/zitadel/discussions) or [contact us](https://zitadel.ch/contact/) privately.
|
||||
> **Information:** Are you stuck? Don't hesitate to reach out to us on [Github Discussions](https://github.com/zitadel/zitadel/discussions) or [contact us](https://zitadel.ch/contact/) privately.
|
||||
|
||||
### 1. Generate a private-public key pair in ZITADEL
|
||||
|
||||
@@ -111,7 +111,7 @@ Payload
|
||||
|
||||
Please refer to [JWT_with_Private_Key](../../apis/openidoauth/authn-methods#jwt-with-private-key) in the documentation for further information.
|
||||
|
||||
If you use Go, you might want to use the [provided tool](https://github.com/caos/zitadel-tools) to generate a JWT from the downloaded json. There are many [libraries](https://jwt.io/#libraries-io) to generate and sign JWT.
|
||||
If you use Go, you might want to use the [provided tool](https://github.com/zitadel/zitadel-tools) to generate a JWT from the downloaded json. There are many [libraries](https://jwt.io/#libraries-io) to generate and sign JWT.
|
||||
|
||||
### 3. With this JWT, request an OAuth token from ZITADEL
|
||||
|
||||
|
||||
@@ -36,10 +36,10 @@ If you need support for a specific language we highly recommend you to write tra
|
||||
|
||||
ZITADEL loads translations from three files:
|
||||
|
||||
- [Console translations](https://github.com/caos/zitadel/tree/main/console/src/assets/i18n)
|
||||
- [Login interface texts](https://github.com/caos/zitadel/tree/main/internal/ui/login/static/i18n)
|
||||
- [Email Notifcation texts](https://github.com/caos/zitadel/tree/main/internal/notification/static/i18n)
|
||||
- [Common translations](https://github.com/caos/zitadel/tree/main/internal/static/i18n) for success or error toasts
|
||||
- [Console translations](https://github.com/zitadel/zitadel/tree/main/console/src/assets/i18n)
|
||||
- [Login interface texts](https://github.com/zitadel/zitadel/tree/main/internal/ui/login/static/i18n)
|
||||
- [Email Notifcation texts](https://github.com/zitadel/zitadel/tree/main/internal/notification/static/i18n)
|
||||
- [Common translations](https://github.com/zitadel/zitadel/tree/main/internal/static/i18n) for success or error toasts
|
||||
|
||||
Make sure you set the locale as the name. Later on, language header will determine which file gets displayed.
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ First, download the template configuration files [database.yml](./templates/crd/
|
||||
|
||||
```bash
|
||||
# Download the zitadelctl binary
|
||||
curl -s https://api.github.com/repos/caos/zitadel/releases/latest | grep "browser_download_url.*zitadelctl-$(uname | awk '{print tolower($0)}')-amd64" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/zitadelctl && sudo chmod +x /usr/local/bin/zitadelctl && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadelctl
|
||||
curl -s https://api.github.com/repos/zitadel/zitadel/releases/latest | grep "browser_download_url.*zitadelctl-$(uname | awk '{print tolower($0)}')-amd64" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/zitadelctl && sudo chmod +x /usr/local/bin/zitadelctl && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadelctl
|
||||
sudo chmod +x /usr/local/bin/zitadelctl
|
||||
sudo chown $(id -u):$(id -g) /usr/local/bin/zitadelctl
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ Now open a terminal and execute the following commands.
|
||||
|
||||
```bash
|
||||
# Download the zitadelctl binary
|
||||
curl -s https://api.github.com/repos/caos/zitadel/releases/latest | grep "browser_download_url.*zitadelctl-$(uname | awk '{print tolower($0)}')-amd64" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/zitadelctl && sudo chmod +x /usr/local/bin/zitadelctl && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadelctl
|
||||
curl -s https://api.github.com/repos/zitadel/zitadel/releases/latest | grep "browser_download_url.*zitadelctl-$(uname | awk '{print tolower($0)}')-amd64" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/zitadelctl && sudo chmod +x /usr/local/bin/zitadelctl && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadelctl
|
||||
sudo chmod +x /usr/local/bin/zitadelctl
|
||||
sudo chown $(id -u):$(id -g) /usr/local/bin/zitadelctl
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ In our sample scenario, we assume to have the following users:
|
||||
- **Bill:** is employed at Octagon as Administrator of the Portal Application. Bill also uses a Microsoft Account in combination with a Security Key to secure his account.
|
||||
|
||||
After having determined the constellation of the organizations and its users, all the necessary data (Portal project with roles and app, users, login requirements, identity providers, branding) should be set up in [Console](https://console.zitadel.ch/org).
|
||||
A B2B sample application for NextJS can be found in our [Example Repo](https://github.com/caos/zitadel-examples).
|
||||
A B2B sample application for NextJS can be found in our [Example Repo](https://github.com/zitadel/zitadel-examples).
|
||||
|
||||
To allow another organization to use a project, a project grant has to be created. Upon creation, roles for a grant can be limited to a subset of the total project roles.
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ The [Annex of the data processing agreement](data-processing-agreement#annex-reg
|
||||
|
||||
We offer Support Services directly related to the use of our Services. The Description of Support Services is available as [Annex](support-services) to this document.
|
||||
|
||||
Customers without a Subscription or a Subscription plan that does not include Support Services should post inquiries and issues regarding ZITADEL from customers to our [GitHub Discussions](https://github.com/caos/zitadel/discussions), whenever feasible.
|
||||
Customers without a Subscription or a Subscription plan that does not include Support Services should post inquiries and issues regarding ZITADEL from customers to our [GitHub Discussions](https://github.com/zitadel/zitadel/discussions), whenever feasible.
|
||||
|
||||
If you need support integrating or setting up ZITADEL, please contact our consulting team.
|
||||
|
||||
|
||||
@@ -111,12 +111,12 @@ If you encountered an error (e.g. `code = PermissionDenied desc = No matching pe
|
||||
ensure your service user has the required permissions by assigning the `ORG_OWNER` or `ORG_OWNER_VIEWER` role
|
||||
and check the mentioned [guides](#prerequisites) at the beginning.
|
||||
|
||||
If you've run into any other problem, don't hesitate to contact us or raise an issue on [ZITADEL](https://github.com/caos/zitadel/issues) or in the [SDK](https://github.com/caos/zitadel-go/issues).
|
||||
If you've run into any other problem, don't hesitate to contact us or raise an issue on [ZITADEL](https://github.com/zitadel/zitadel/issues) or in the [SDK](https://github.com/zitadel/zitadel-go/issues).
|
||||
|
||||
### Whats next?
|
||||
|
||||
Now you can proceed implementing our APIs by adding more calls.
|
||||
|
||||
Checkout more [examples from the SDK](https://github.com/caos/zitadel-go/blob/main/example) or refer to our [API Docs](../../apis/introduction).
|
||||
Checkout more [examples from the SDK](https://github.com/zitadel/zitadel-go/blob/main/example) or refer to our [API Docs](../../apis/introduction).
|
||||
|
||||
> This guide will be updated soon to show you how to use the SDK for your own API as well.
|
||||
|
||||
@@ -9,7 +9,7 @@ At the end of the guide you should have an application able to read the details
|
||||
|
||||
## Prerequisites
|
||||
|
||||
The client [SDK](https://github.com/caos/zitadel-go) will handle all necessary OAuth 2.0 requests and send the required headers to the ZITADEL API using our [OIDC client library](https://github.com/caos/oidc).
|
||||
The client [SDK](https://github.com/zitadel/zitadel-go) will handle all necessary OAuth 2.0 requests and send the required headers to the ZITADEL API using our [OIDC client library](https://github.com/zitadel/oidc).
|
||||
All that is required, is a service account with an Org Owner (or another role, depending on the needed api requests) role assigned and its key JSON.
|
||||
|
||||
However, we recommend you read the guide on [how to access ZITADEL API](../../guides/api/access-zitadel-apis) and the associated guides for a basic knowledge of :
|
||||
@@ -25,7 +25,7 @@ However, we recommend you read the guide on [how to access ZITADEL API](../../gu
|
||||
You need to add the SDK into Go Modules by:
|
||||
|
||||
```bash
|
||||
go get github.com/caos/zitadel-go
|
||||
go get github.com/zitadel/zitadel-go
|
||||
```
|
||||
|
||||
### Create example client
|
||||
@@ -40,12 +40,12 @@ import (
|
||||
"context"
|
||||
"log"
|
||||
|
||||
"github.com/caos/oidc/pkg/oidc"
|
||||
"github.com/zitadel/oidc/pkg/oidc"
|
||||
|
||||
"github.com/caos/zitadel-go/pkg/client/management"
|
||||
"github.com/caos/zitadel-go/pkg/client/middleware"
|
||||
"github.com/caos/zitadel-go/pkg/client/zitadel"
|
||||
pb "github.com/caos/zitadel-go/pkg/client/zitadel/management"
|
||||
"github.com/zitadel/zitadel-go/pkg/client/management"
|
||||
"github.com/zitadel/zitadel-go/pkg/client/middleware"
|
||||
"github.com/zitadel/zitadel-go/pkg/client/zitadel"
|
||||
pb "github.com/zitadel/zitadel-go/pkg/client/zitadel/management"
|
||||
)
|
||||
|
||||
|
||||
@@ -123,7 +123,7 @@ If you encountered an error (e.g. `code = PermissionDenied desc = No matching pe
|
||||
ensure your service user has the required permissions by assigning the `ORG_OWNER` or `ORG_OWNER_VIEWER` role
|
||||
and check the mentioned [guides](#prerequisites) at the beginning.
|
||||
|
||||
If you've run into any other problem, don't hesitate to contact us or raise an issue on [ZITADEL](https://github.com/caos/zitadel/issues) or in the [SDK](https://github.com/caos/zitadel-go/issues).
|
||||
If you've run into any other problem, don't hesitate to contact us or raise an issue on [ZITADEL](https://github.com/zitadel/zitadel/issues) or in the [SDK](https://github.com/zitadel/zitadel-go/issues).
|
||||
|
||||
### Whats next?
|
||||
|
||||
@@ -137,6 +137,6 @@ Now you can proceed implementing our APIs by adding more calls or trying to over
|
||||
log.Printf("%s was created on: %s", respOverwrite.Org.Name, respOverwrite.Org.Details.CreationDate.AsTime())
|
||||
}
|
||||
```
|
||||
Checkout more [examples from the SDK](https://github.com/caos/zitadel-go/blob/main/example) or refer to our [API Docs](../../apis/introduction).
|
||||
Checkout more [examples from the SDK](https://github.com/zitadel/zitadel-go/blob/main/example) or refer to our [API Docs](../../apis/introduction).
|
||||
|
||||
> This guide will be updated soon to show you how to use the SDK for your own API as well.
|
||||
|
||||
@@ -6,7 +6,7 @@ import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import {Card, CardWrapper} from '../../src/components/card';
|
||||
|
||||
Get started with ZITADEL quickly by reading a quickstart or by cloning an example from our [ZITADEL examples](https://github.com/caos/zitadel-examples) repo.
|
||||
Get started with ZITADEL quickly by reading a quickstart or by cloning an example from our [ZITADEL examples](https://github.com/zitadel/zitadel-examples) repo.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="app" label="Web · Native applications" default>
|
||||
@@ -33,9 +33,9 @@ Get started with ZITADEL quickly by reading a quickstart or by cloning an exampl
|
||||
## Clone a sample project
|
||||
|
||||
<CardWrapper>
|
||||
<Card githubLink="https://github.com/caos/zitadel-examples/tree/main/python3" title="Python" label="Python" />
|
||||
<Card githubLink="https://github.com/caos/zitadel-examples/tree/main/angular" title="Angular" label="Web · Mobile Web" />
|
||||
<Card githubLink="https://github.com/caos/zitadel-examples/tree/main/nextjs" title="NextJS" label="Web · Mobile Web" />
|
||||
<Card githubLink="https://github.com/zitadel/zitadel-examples/tree/main/python3" title="Python" label="Python" />
|
||||
<Card githubLink="https://github.com/zitadel/zitadel-examples/tree/main/angular" title="Angular" label="Web · Mobile Web" />
|
||||
<Card githubLink="https://github.com/zitadel/zitadel-examples/tree/main/nextjs" title="NextJS" label="Web · Mobile Web" />
|
||||
</CardWrapper>
|
||||
|
||||
## Libraries
|
||||
@@ -43,7 +43,7 @@ Get started with ZITADEL quickly by reading a quickstart or by cloning an exampl
|
||||
|
||||
| Language | Description | Link |
|
||||
| ------------ | ---------------------|-------------|
|
||||
| Go | Go client library for ZITADEL. | [https://github.com/caos/zitadel-go](https://github.com/caos/zitadel-go)
|
||||
| Go | Go client library for ZITADEL. | [https://github.com/zitadel/zitadel-go](https://github.com/zitadel/zitadel-go)
|
||||
| .Net | Authentication / Authorization library written in dotnet for the asp.net web application package. | [https://github.com/caos/zitadel-net](https://github.com/caos/zitadel-net)
|
||||
| Dart | Dart library for ZITADEL, contains gRPC and API access elements. | [https://github.com/caos/zitadel-dart](https://github.com/caos/zitadel-dart) |
|
||||
| Elixir | API Client for the ZITADEL API. | [https://github.com/jshmrtn/zitadel_api](https://github.com/jshmrtn/zitadel_api) |
|
||||
|
||||
@@ -5,7 +5,7 @@ title: Libraries
|
||||
|
||||
| Language | Description | Link |
|
||||
| ------------ | ---------------------|-------------|
|
||||
| Go | Go client library for ZITADEL. | [https://github.com/caos/zitadel-go](https://github.com/caos/zitadel-go)
|
||||
| Go | Go client library for ZITADEL. | [https://github.com/zitadel/zitadel-go](https://github.com/zitadel/zitadel-go)
|
||||
| .Net | Authentication / Authorization library written in dotnet for the asp.net web application package. | [https://github.com/caos/zitadel-net](https://github.com/caos/zitadel-net)
|
||||
| Dart | Dart library for ZITADEL, contains gRPC and API access elements. | [https://github.com/caos/zitadel-dart](https://github.com/caos/zitadel-dart) |
|
||||
| Elixir | API Client for the ZITADEL API. | [https://github.com/jshmrtn/zitadel_api](https://github.com/jshmrtn/zitadel_api) |
|
||||
|
||||
@@ -7,7 +7,7 @@ It shows how to add user login to your application and fetch some data from the
|
||||
|
||||
At the end of the guide, your application has login functionality and has access to the current user's profile.
|
||||
|
||||
> This documentation refers to our [example](https://github.com/caos/zitadel-examples/tree/main/angular) in GitHub. Note that we've written ZITADEL Console in Angular, so you can also use that as a reference.
|
||||
> This documentation refers to our [example](https://github.com/zitadel/zitadel-examples/tree/main/angular) in GitHub. Note that we've written ZITADEL Console in Angular, so you can also use that as a reference.
|
||||
|
||||
## Setup Application and Get Keys
|
||||
|
||||
@@ -22,7 +22,7 @@ We recommend you use [Authorization Code](../../apis/openidoauth/grant-types#aut
|
||||
|
||||
With the Redirect URIs field, you tell ZITADEL where it is allowed to redirect users to after authentication. For development, you can set dev mode to `true` to enable insecure HTTP and redirect to a `localhost` URI.
|
||||
|
||||
> If you are following along with the [example](https://github.com/caos/zitadel-examples/tree/main/angular), set dev mode to `true` and the Redirect URIs to <http://localhost:4200/auth/callback>.
|
||||
> If you are following along with the [example](https://github.com/zitadel/zitadel-examples/tree/main/angular), set dev mode to `true` and the Redirect URIs to <http://localhost:4200/auth/callback>.
|
||||
|
||||
If you want to redirect the users back to a route on your application after they have logged out, add an optional redirect in the Post Logout URIs field.
|
||||
|
||||
@@ -158,7 +158,7 @@ const newState = setState ? await this.statehandler.createState().toPromise() :
|
||||
...
|
||||
```
|
||||
|
||||
If you decide to use the _StatehandlerService_, provide it in the `app.module`. Make sure it gets initialized first using Angular’s `APP_INITIALIZER`. You find the service implementation in the [example](https://github.com/caos/zitadel-examples/tree/main/angular).
|
||||
If you decide to use the _StatehandlerService_, provide it in the `app.module`. Make sure it gets initialized first using Angular’s `APP_INITIALIZER`. You find the service implementation in the [example](https://github.com/zitadel/zitadel-examples/tree/main/angular).
|
||||
|
||||
```ts
|
||||
|
||||
@@ -305,12 +305,12 @@ And in your HTML file:
|
||||
|
||||
You have successfully integrated your Angular application with ZITADEL!
|
||||
|
||||
If you get stuck, consider checking out our [example](https://github.com/caos/zitadel-examples/tree/main/angular) application. It includes all the mentioned functionality of this quickstart. You can simply start by cloning the repository and replacing the _AuthConfig_ in the _AppModule_ by your own configuration. If you run into issues, contact us or raise an issue on [GitHub](https://github.com/caos/zitadel).
|
||||
If you get stuck, consider checking out our [example](https://github.com/zitadel/zitadel-examples/tree/main/angular) application. It includes all the mentioned functionality of this quickstart. You can simply start by cloning the repository and replacing the _AuthConfig_ in the _AppModule_ by your own configuration. If you run into issues, contact us or raise an issue on [GitHub](https://github.com/zitadel/zitadel).
|
||||
|
||||
|
||||
|
||||
### What's next?
|
||||
|
||||
Now that you have enabled authentication, it's time to add authorization to your application using ZITADEL APIs. Refer to the [docs](../../apis/introduction) or check out our ZITADEL Console code on [GitHub](https://github.com/caos/zitadel) which is using gRPC to access data.
|
||||
Now that you have enabled authentication, it's time to add authorization to your application using ZITADEL APIs. Refer to the [docs](../../apis/introduction) or check out our ZITADEL Console code on [GitHub](https://github.com/zitadel/zitadel) which is using gRPC to access data.
|
||||
|
||||
For more information about creating an Angular application, refer to [Angular](https://angular.io/start) and for more information about the OAuth/OIDC library used above, consider reading their docs at [angular-oauth2-oidc](https://github.com/manfredsteyer/angular-oauth2-oidc).
|
||||
|
||||
@@ -4,7 +4,7 @@ title: Next.js
|
||||
|
||||
This is our Zitadel [Next.js](https://nextjs.org/) template. It shows how to authenticate as a user and retrieve user information from the OIDC endpoint.
|
||||
|
||||
> The template code is part of our zitadel-example repo. Take a look [here](https://github.com/caos/zitadel-examples/tree/main/nextjs).
|
||||
> The template code is part of our zitadel-example repo. Take a look [here](https://github.com/zitadel/zitadel-examples/tree/main/nextjs).
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
||||
@@ -9,8 +9,8 @@ At the end of the guide you should have an API with a protected endpoint.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
The client [SDK](https://github.com/caos/zitadel-go) will provides an interceptor for both GRPC and HTTP.
|
||||
This will handle the OAuth 2.0 introspection request including authentication using JWT with Private Key using our [OIDC client library](https://github.com/caos/oidc).
|
||||
The client [SDK](https://github.com/zitadel/zitadel-go) will provides an interceptor for both GRPC and HTTP.
|
||||
This will handle the OAuth 2.0 introspection request including authentication using JWT with Private Key using our [OIDC client library](https://github.com/zitadel/oidc).
|
||||
All that is required, is an API and its key JSON. But for complete
|
||||
|
||||
## Go Setup
|
||||
@@ -20,7 +20,7 @@ All that is required, is an API and its key JSON. But for complete
|
||||
You need to add the SDK into Go Modules by:
|
||||
|
||||
```bash
|
||||
go get github.com/caos/zitadel-go
|
||||
go get github.com/zitadel/zitadel-go
|
||||
```
|
||||
|
||||
### Create example API
|
||||
@@ -37,10 +37,10 @@ import (
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
api_mw "github.com/caos/zitadel-go/pkg/api/middleware"
|
||||
http_mw "github.com/caos/zitadel-go/pkg/api/middleware/http"
|
||||
"github.com/caos/zitadel-go/pkg/client"
|
||||
"github.com/caos/zitadel-go/pkg/client/middleware"
|
||||
api_mw "github.com/zitadel/zitadel-go/pkg/api/middleware"
|
||||
http_mw "github.com/zitadel/zitadel-go/pkg/api/middleware/http"
|
||||
"github.com/zitadel/zitadel-go/pkg/client"
|
||||
"github.com/zitadel/zitadel-go/pkg/client/middleware"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
@@ -65,7 +65,7 @@ module.exports = {
|
||||
position: "left",
|
||||
},
|
||||
{
|
||||
href: "https://github.com/caos/zitadel",
|
||||
href: "https://github.com/zitadel/zitadel",
|
||||
label: "GitHub",
|
||||
position: "right",
|
||||
},
|
||||
@@ -78,7 +78,7 @@ module.exports = {
|
||||
items: [
|
||||
{
|
||||
label: "GitHub Discussions",
|
||||
href: "https://github.com/caos/zitadel/discussions",
|
||||
href: "https://github.com/zitadel/zitadel/discussions",
|
||||
},
|
||||
{
|
||||
label: "Twitter",
|
||||
@@ -141,7 +141,7 @@ module.exports = {
|
||||
{
|
||||
docs: {
|
||||
sidebarPath: require.resolve("./sidebars.js"),
|
||||
editUrl: "https://github.com/caos/zitadel/edit/main/docs/",
|
||||
editUrl: "https://github.com/zitadel/zitadel/edit/main/docs/",
|
||||
remarkPlugins: [require("mdx-mermaid")],
|
||||
},
|
||||
theme: {
|
||||
|
||||
Reference in New Issue
Block a user