mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-18 19:25:13 +00:00
chore: naming inconsistency application (#11431)
This commit is contained in:
@@ -294,5 +294,5 @@ the [Sent information Response](./usage#sent-information-response) payload descr
|
||||
## Conclusion
|
||||
|
||||
You have successfully set up a target and execution to manipulate API responses in your ZITADEL instance.
|
||||
This feature can now be used to add necessary information for clients including the new login UI.
|
||||
This feature can now be used to add necessary information for applications including the new login UI.
|
||||
Find more information about the actions feature in the [API documentation](/concepts/features/actions_v2).
|
||||
|
||||
@@ -4,7 +4,7 @@ sidebar_label: Back-Channel Logout
|
||||
---
|
||||
|
||||
The Back-Channel Logout implements [OpenID Connect Back-Channel Logout 1.0](https://openid.net/specs/openid-connect-backchannel-1_0.html)
|
||||
and can be used to notify clients about session termination at the OpenID Provider. This guide will explain how
|
||||
and can be used to notify applications about session termination at the OpenID Provider. This guide will explain how
|
||||
back-channel logout is implemented inside ZITADEL and gives some usage examples.
|
||||
|
||||
<Callout type="info">
|
||||
@@ -24,8 +24,8 @@ understanding on the following topics before starting with this guide:
|
||||
## Concept
|
||||
|
||||
ZITADEL provides the possibility for OpenID Connect clients to be notified about the session termination, for example
|
||||
if a user signs out from another client using the same SSO session.
|
||||
This allows the client to also invalidate the user's session without the need for an active browser session.
|
||||
if a user signs out from another application using the same SSO session.
|
||||
This allows the application to also invalidate the user's session without the need for an active browser session.
|
||||
|
||||

|
||||
|
||||
@@ -57,7 +57,7 @@ provides the possibility to match the exact SSO session, which was terminated.
|
||||
|
||||
### Client
|
||||
|
||||
To enable the back-channel logout on a client, they simply need to register a `backchannel_logout_uri` as part of their
|
||||
To enable the back-channel logout on an application, they simply need to register a `backchannel_logout_uri` as part of their
|
||||
configuration, e.g. [creating an OIDC application](https://zitadel.com/docs/reference/api/management/management-service-add-oidc-app).
|
||||
|
||||
As soon as the URI is set, every new authorization request will register a back-channel notification to be sent once
|
||||
@@ -66,7 +66,7 @@ the session is terminated by a user sign out.
|
||||
## Back-Channel Request
|
||||
|
||||
When the session is terminated, ZITADEL will send back-channel logout requests asynchronously to every registered
|
||||
client of the corresponding session.
|
||||
application of the corresponding session.
|
||||
The request is an `application/x-www-form-urlencoded` POST request to the registered URI including a `logout_token`
|
||||
parameter in the body.
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ You will have to paste it in the Entra ID Client later.
|
||||
|
||||
You need to have access to an Entra ID Tenant. If you do not yet have one follow [this guide from Microsoft](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant) to create one for free.
|
||||
|
||||
### Register a new client
|
||||
### Register a new application
|
||||
|
||||
1. Browse to the [App registration menus create dialog](https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/CreateApplicationBlade/quickStartType~/null/isMSAApp~/false) to create a new app.
|
||||
2. Give the application a name and choose who should be able to login (Single-Tenant, Multi-Tenant, Personal Accounts, etc.) This setting will also have an impact on how to configure the provider later on in ZITADEL.
|
||||
|
||||
@@ -29,7 +29,7 @@ You will have to paste this URL in your external OIDC provider's application con
|
||||
|
||||
1. Log in to your external OIDC Provider's dashboard or management console.
|
||||
2. Navigate to the applications, clients, or integrations section (name may vary depending on your provider).
|
||||
3. Create a new application or client and select "OIDC" or "OpenID Connect" as the type.
|
||||
3. Create a new application and select "OIDC" or "OpenID Connect" as the type.
|
||||
4. Set a name for the application.
|
||||
5. [Paste the ZITADEL Callback URL you copied before](#open-the-generic-oidc-provider-template) into the "redirect URIs" or "sign-in redirect URIs" field.
|
||||
6. Save or copy the generated **Client ID** and **Client Secret**.
|
||||
|
||||
@@ -26,7 +26,7 @@ You will have to paste it in the Google Cloud Platform later.
|
||||
|
||||
## Google Configuration
|
||||
|
||||
### Register a new client
|
||||
### Register a new application
|
||||
|
||||
1. Go to the Google Cloud Platform and choose your project: [https://console.cloud.google.com/apis/credentials](https://console.cloud.google.com/apis/credentials)
|
||||
2. Click on "+ CREATE CREDENTIALS" and choose "OAuth client ID"
|
||||
|
||||
@@ -130,7 +130,7 @@ Example Response POST-binding:
|
||||
}
|
||||
```
|
||||
|
||||
Which expects your client to do a POST call to the URL `https://myapp.example.com/acs` with the payload containing the following attributes:
|
||||
Which expects your application to do a POST call to the URL `https://myapp.example.com/acs` with the payload containing the following attributes:
|
||||
|
||||
```
|
||||
RelayState: "CncN92gdF6is7bak63thXOsn0MmJn7CLQeGKWaXZo2L8nJN0sPEHbb4I",
|
||||
@@ -154,7 +154,7 @@ Example Response Redirect-binding:
|
||||
}
|
||||
```
|
||||
|
||||
Which expects your client to redirect to the url 'https://myapp.example.com/acs?RelayState=...&SAMLResponse=...' with all information as URL parameters.
|
||||
Which expects your application to redirect to the url 'https://myapp.example.com/acs?RelayState=...&SAMLResponse=...' with all information as URL parameters.
|
||||
|
||||
### SAML Endpoints
|
||||
|
||||
|
||||
@@ -225,7 +225,7 @@ This strategy aims to fulfill the following requirements:
|
||||
2. Applications have enough time to see the next activated web key on the [JWKS](#json-web-key-set) endpoint.
|
||||
3. Web keys are kept long enough to cover the access and ID token validity of 24 hours.
|
||||
4. Web keys are kept long enough to to allow usage of the `id_token_hint` for at least 3 months.
|
||||
Users that haven't logged in / refreshed tokens with the client app for that period,
|
||||
Users that haven't logged in / refreshed tokens with the client application for that period,
|
||||
will need to re-enter their username.
|
||||
|
||||
When the instance was created, resp. the feature was rolled out, the instance got two keys with the first one activated. When this feature becomes generally available, instance creation will setup the first two keys in the same way. So the initial state always looks like this:
|
||||
|
||||
@@ -40,7 +40,7 @@ In order to access role information via the token you must include the right aud
|
||||
|
||||
An important concept in OpenID Connect (OIDC) is the 'audience' (`aud`) claim, which is part of the token payload. The `aud` claim identifies who or what this token is intended for. If the recipient (e.g., a resource server) does not identify itself with a value in the `aud` claim when this claim is present, then the token must be rejected.
|
||||
|
||||
The audience is essential in multi-tier systems, where you may authenticate with one client (in one project) but access resources from another client (in a different project) or when you are accessing ZITADEL’s management APIs. Without the correct audience in your token, you will run into errors, such as the ‘Invalid audience’ error in ZITADEL.
|
||||
The audience is essential in multi-tier systems, where you may authenticate with one application (in one project) but access resources from another application (in a different project) or when you are accessing ZITADEL’s management APIs. Without the correct audience in your token, you will run into errors, such as the ‘Invalid audience’ error in ZITADEL.
|
||||
|
||||
You can determine the audience in two ways:
|
||||
|
||||
|
||||
@@ -51,7 +51,7 @@ ZITADEL supports two primary authentication methods for service users:
|
||||
* ZITADEL validates the signature using the service user's public key.
|
||||
* JWTs can include expiration dates and scopes to control access.
|
||||
|
||||
Follow our guide on using [private key JWT client authentication](./private-key-jwt) to get started authenticating service users and clients.
|
||||
Follow our guide on using [private key JWT client authentication](./private-key-jwt) to get started authenticating service users and applications.
|
||||
|
||||
#### Benefits of private key JWT authentication
|
||||
|
||||
@@ -74,7 +74,7 @@ Follow our guide on using [private key JWT client authentication](./private-key-
|
||||
* Presents a client ID and client secret associated with the service user.
|
||||
* Simpler than the JWT profile in specific scenarios.
|
||||
|
||||
Follow our guide on using [client credentials grant](./client-credentials) to get started authenticating service users and clients.
|
||||
Follow our guide on using [client credentials grant](./client-credentials) to get started authenticating service users and applications.
|
||||
|
||||
This method is still available in ZITADEL but is generally considered less secure than JWT due to:
|
||||
|
||||
@@ -86,7 +86,7 @@ This method is still available in ZITADEL but is generally considered less secur
|
||||
* **Ready-to-use tokens:** Generated for specific service users and can be directly included in the authorization header of API requests.
|
||||
* **Currently available only for machine users** (service users) and not regular human users.
|
||||
|
||||
Follow our guide on using [personal access tokens](./personal-access-token) to get started authenticating service users and clients.
|
||||
Follow our guide on using [personal access tokens](./personal-access-token) to get started authenticating service users and applications.
|
||||
|
||||
PAT offer some benefits, such as:
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ Prerequisites:
|
||||
- Existing ZITADEL instance, organization, and project. Follow our [get started](/guides/start/quickstart) guide to get started. If not present follow [this guide](/guides/start/quickstart)
|
||||
- Existing Cloudflare account and [team domain](https://developers.cloudflare.com/cloudflare-one/glossary/#team-domain)
|
||||
|
||||
## Create the client in ZITADEL
|
||||
## Create the application in ZITADEL
|
||||
|
||||
<CreateApp components={props.components} appType="web" authType="code" appName="Cloudflare" redirectURI="https://<your-team-name>.cloudflareaccess.com/cdn-cgi/access/callback"/>
|
||||
|
||||
@@ -23,7 +23,7 @@ Make sure to enable "User Info inside ID Token" on your application settings.
|
||||

|
||||
|
||||
<Callout>
|
||||
Cloudflare will return an error "User email was not returned. API permissions are likely incorrect". Enable to send the user information inside the token on your client settings.
|
||||
Cloudflare will return an error "User email was not returned. API permissions are likely incorrect". Enable to send the user information inside the token on your application settings.
|
||||
</Callout>
|
||||
|
||||
## Configure Cloudflare Zero Trust Authentication
|
||||
|
||||
+12
-12
@@ -1,17 +1,17 @@
|
||||
Upon successful introspection, regardless of the token type or introspection method, a response with the boolean `active` is returned, indicating if the provided token is active and if the requesting client is part of the token audience. If `active` is true, further information will be provided:
|
||||
|
||||
| **Property** | **Description** |
|
||||
| --- | --- |
|
||||
| `aud` | The audience of the token |
|
||||
| `client_id` | The client_id of the application the token was issued to |
|
||||
| `exp` | Time the token expires (as unix time) |
|
||||
| `iat` | Time the token was issued at (as unix time) |
|
||||
| `iss` | Issuer of the token |
|
||||
| `jti` | Unique id of the token |
|
||||
| `nbf` | Time the token must not be used before (as unix time) |
|
||||
| `scope` | Space delimited list of scopes granted to the token |
|
||||
| `token_type` | Type of the inspected token. Value is always Bearer |
|
||||
| `username` | ZITADEL's login name of the user. Consists of username@primarydomain |
|
||||
| **Property** | **Description** |
|
||||
|--------------|----------------------------------------------------------------------|
|
||||
| `aud` | The audience of the token |
|
||||
| `client_id` | The client_id of the application the token was issued to |
|
||||
| `exp` | Time the token expires (as unix time) |
|
||||
| `iat` | Time the token was issued at (as unix time) |
|
||||
| `iss` | Issuer of the token |
|
||||
| `jti` | Unique id of the token |
|
||||
| `nbf` | Time the token must not be used before (as unix time) |
|
||||
| `scope` | Space delimited list of scopes granted to the token |
|
||||
| `token_type` | Type of the inspected token. Value is always Bearer |
|
||||
| `username` | ZITADEL's login name of the user. Consists of username@primarydomain |
|
||||
|
||||
Depending on the granted scopes, additional information about the authorized user is provided.
|
||||
|
||||
|
||||
+3
-3
@@ -40,9 +40,9 @@ Install the package via nuget
|
||||
dotnet add package Zitadel.Api
|
||||
```
|
||||
|
||||
### Create example client
|
||||
### Create example application
|
||||
|
||||
Change the program.cs file to the content below. This will create a client for the management api and call its `GetMyUsers` function.
|
||||
Change the program.cs file to the content below. This will create a application for the management api and call its `GetMyUsers` function.
|
||||
The SDK will make sure you will have access to the API by retrieving a Bearer Token using JWT Profile with the provided scopes (`openid` and `urn:zitadel:iam:org:project:id:zitadel:aud`).
|
||||
|
||||
Make sure to fill the const `apiUrl`, and `personalAccessToken` with your own instance data. The used vars below are from a test instance, to show you how it should look.
|
||||
@@ -86,7 +86,7 @@ result = await client.GetMyUserAsync(new());
|
||||
Console.WriteLine($"User: {result.User}");
|
||||
```
|
||||
|
||||
### Test client
|
||||
### Test application
|
||||
|
||||
After you have configured everything correctly, you can simply start the example by:
|
||||
|
||||
|
||||
@@ -35,9 +35,9 @@ You need to add the SDK into Go Modules by:
|
||||
go get -u github.com/zitadel/zitadel-go/v3
|
||||
```
|
||||
|
||||
### Create example client
|
||||
### Create example application
|
||||
|
||||
Create a new go file with the content below. This will create a client and call its `GetMyOrg` function on the ManagementService.
|
||||
Create a new go file with the content below. This will create a application and call its `GetMyOrg` function on the ManagementService.
|
||||
The SDK will make sure you will have access to the API by retrieving a Bearer Token using JWT Profile with the provided scopes (`openid` and `urn:zitadel:iam:org:project:id:zitadel:aud`).
|
||||
|
||||
```go reference
|
||||
@@ -82,5 +82,5 @@ Now you can proceed implementing our APIs by adding more calls or using a differ
|
||||
api.SessionService().CreateSession(ctx, &session.CreateSessionRequest{})
|
||||
```
|
||||
Checkout more [examples from the SDK](https://github.com/zitadel/zitadel-go/blob/next/example),
|
||||
like how you can integrate the [client in your own API](https://github.com/zitadel/zitadel-go/blob/next/example/api/client/main.go)
|
||||
like how you can integrate the [application in your own API](https://github.com/zitadel/zitadel-go/blob/next/example/api/client/main.go)
|
||||
or refer to our [API Docs](/apis/introduction).
|
||||
|
||||
Reference in New Issue
Block a user