andwati/zitadel
1
0
Fork 0
mirror of https://github.com/andwati/zitadel.git synced 2026-11-03 21:02:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: rename authorization to role assignment (#11588)

Browse Source 
# Which Problems Are Solved

As part of the naming consistency initiative, the terms Authorization,
User grants, internal authorization and other similar terms that are
used in the context of assigning project roles to users are replaced by
Role Assignments in the UI, API docs, and documentation.

# How the Problems Are Solved

By replacing the following terms with Role Assignments in API docs,
Console UI, and guides.

- Authorization
- internal authorization
- external authorization
- User Grant
- Roles and Authorizations

By adding a note in the API docs to make it clear that Authorization
within the context of Authorization Service API refers to role
assignments, not to OAuth authorization as it is still used in the APIs.

By updating some screenshots in documentation / guides to show "Role
Assignments" instead of "Authorizations" in the UI.

# Additional Changes

N/A

# Additional Context

- Closes https://github.com/zitadel/zitadel/issues/11289

---------

Co-authored-by: Copilot <[email protected]>
This commit is contained in:
Gayathri Vijayan
2026-02-17 13:14:57 +01:00
committed by GitHub
co-authored by Copilot
parent fa5e76661a
commit 93a4ed8857
76 changed files with 1066 additions and 1015 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/content/apis/actions/code-examples.mdx
+20 -20
View File
@@ -2,9 +2,9 @@
title: Code examples
---
Actions are a powerful tool to extend ZITADEL and you might wonder what use cases actions can be used for.
Actions are a powerful tool to extend ZITADEL, and you might wonder what use cases actions can be used for.
This page provides a non-exhaustive list of possibilities which is provided by [examples](https://github.com/zitadel/actions/tree/main/examples). If a use case is missing feel free to contribute an issue or pull request to the repository, thanks in advance 🤗.
This page provides a non-exhaustive list of possibilities which is provided by [examples](https://github.com/zitadel/actions/tree/main/examples). If a use case is missing, feel free to contribute an issue or pull request to the repository, thanks in advance 🤗.
## Customize OIDC response
@@ -16,7 +16,7 @@ Append claims returned on OIDC requests.
- [Pre Userinfo creation](./complement-token#pre-userinfo-creation-id-token-userinfo-introspection-endpoint)
- [Pre access token creation](./complement-token#pre-access-token-creation)
### Set hardcoded claim
### Set a hardcoded claim
Extend the claims by a hardcoded value.
@@ -31,7 +31,7 @@ https://github.com/zitadel/actions/blob/main/examples/add_claim.js
### Set dynamic claim from user metadata
Extend the claims by dynamically read metadata from a user and sets the picture-claim if idpPicture-metadata value is present.
Extend the claims by dynamically reading metadata from a user and sets the picture-claim if idpPicture-metadata value is present.
<details open="">
<summary>{props.summary ? props.summary : 'Code example'}</summary>
@@ -44,7 +44,7 @@ https://github.com/zitadel/actions/blob/main/examples/add_picture_claim_from_idp
### Set dynamic claim from organization metadata
Extend the claims by dynamically read metadata from an organization and sets the present metadata.
Extend the claims by dynamically reading metadata from an organization and sets the present metadata.
<details open="">
<summary>Code example</summary>
@@ -105,7 +105,7 @@ https://github.com/zitadel/actions/blob/main/examples/set_custom_attribute.js
### Set dynamic attribute from organization metadata
Extend the attributes by dynamically read metadata from an organization and sets the present metadata.
Extend the attributes by dynamically reading metadata from an organization and sets the present metadata.
<details open="">
<summary>Code example</summary>
@@ -118,7 +118,7 @@ https://github.com/zitadel/actions/blob/main/examples/org_metadata_attribute.js
## Manipulate user
You can automate manual tasks like setting default grants during user creation.
You can automate manual tasks such as assigning default roles during user creation.
### Set email always verified
@@ -140,9 +140,9 @@ https://github.com/zitadel/actions/blob/main/examples/verify_email.js
</details>
### Add grants to users
### Assign roles to users
Allows you to add default user grants to a user after it was created or federated.
Allows you to assign default roles to a user after the user was created or federated.
#### Triggers
@@ -184,7 +184,7 @@ https://github.com/zitadel/actions/blob/main/examples/add_metadata.js
## Use provided fields of identity providers
If you want to ensure that the data of a user are always up-to-date, you can automatically update user fields during authentication and save time of your customers and your team.
If you want to ensure that the data of a user are always up to date, you can automatically update user fields during authentication and save time of your customers and your team.
### Trigger
@@ -193,7 +193,7 @@ If you want to ensure that the data of a user are always up-to-date, you can aut
### Fields provided by Okta as OIDC IdP
If you use [Okta as an identity provider](/guides/integrate/identity-providers/okta-oidc) you can improve the onboarding experience of new users by prefilling some basic information during authentication.
If you use [Okta as an identity provider](/guides/integrate/identity-providers/okta-oidc), you can improve the onboarding experience of new users by prefilling some basic information during authentication.
<details open="">
<summary>Code example</summary>
@@ -206,7 +206,7 @@ https://github.com/zitadel/actions/blob/main/examples/okta_identity_provider.js
### Fields provided by Gitlab
If you use [Gitlab as an identity provider](/guides/integrate/identity-providers/gitlab) you can improve the onboarding experience of new users by prefilling some basic information during authentication.
If you use [Gitlab as an identity provider](/guides/integrate/identity-providers/gitlab), you can improve the onboarding experience of new users by prefilling some basic information during authentication.
<details open="">
<summary>Code example</summary>
@@ -217,9 +217,9 @@ https://github.com/zitadel/actions/blob/main/examples/gitlab_identity_provider.j
</details>
### Fields provided by Github
### Fields provided by GitHub
If you use [Github as an identity provider](/guides/integrate/identity-providers/github) you can improve the onboarding experience of new users by prefilling some basic information during authentication.
If you use [GitHub as an identity provider](/guides/integrate/identity-providers/github), you can improve the onboarding experience of new users by prefilling some basic information during authentication.
<details open="">
<summary>Code example</summary>
@@ -232,7 +232,7 @@ https://github.com/zitadel/actions/blob/main/examples/github_identity_provider.j
### Claims provided by a generic OIDC identity provider
If you use a [generic OIDC identity provider](/guides/integrate/identity-providers/migrate#migrate-generic-oidc-provider) you can improve the onboarding experience of new users by prefilling some basic information during authentication.
If you use a [generic OIDC identity provider](/guides/integrate/identity-providers/migrate#migrate-generic-oidc-provider), you can improve the onboarding experience of new users by prefilling some basic information during authentication.
<details open="">
<summary>Code example</summary>
@@ -245,7 +245,7 @@ https://github.com/zitadel/actions/blob/main/examples/set_idp_picture_metadata.j
### Attributes provided by Okta as SAML IDP
If you use [Okta as an identity provider](/guides/integrate/identity-providers/okta_saml#add-attribute-statements) you can improve the onboarding experience of new users by prefilling some basic information during authentication.
If you use [Okta as an identity provider](/guides/integrate/identity-providers/okta_saml#add-attribute-statements), you can improve the onboarding experience of new users by prefilling some basic information during authentication.
<details open="">
<summary>Code example</summary>
@@ -258,7 +258,7 @@ https://github.com/zitadel/actions/blob/main/examples/okta_saml_prefil_register_
### Attributes provided by Microsoft Entra as SAML IDP
If you use [Microsoft Entra as SAML identity provider](/guides/integrate/identity-providers/azure-ad-saml) you can improve the onboarding experience of new users by prefilling some basic information during authentication.
If you use [Microsoft Entra as SAML identity provider](/guides/integrate/identity-providers/azure-ad-saml), you can improve the onboarding experience of new users by prefilling some basic information during authentication.
<details open="">
<summary>Code example</summary>
@@ -271,7 +271,7 @@ https://github.com/zitadel/actions/blob/main/examples/entra_id_saml_prefil_regis
### Attributes provided by a generic SAML identity provider
If you use a [SAML identity provider like mocksaml](/guides/integrate/identity-providers/mocksaml) you can improve the onboarding experience of new users by prefilling some basic information during authentication.
If you use a [SAML identity provider like mocksaml](/guides/integrate/identity-providers/mocksaml), you can improve the onboarding experience of new users by prefilling some basic information during authentication.
<details open="">
<summary>Code example</summary>
@@ -282,9 +282,9 @@ https://github.com/zitadel/actions/blob/main/examples/post_auth_saml.js
</details>
## Context aware execution
## Context-aware execution
Based on the context the execution path of an action can change. ZITADEL allows complex execution paths of course. 😎
Based on the context, the execution path of an action can change. ZITADEL allows complex execution paths, of course. 😎
### Based on auth request information