mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 18:07:31 +00:00
feat: api v2beta to api v2 protos (#8343)
# Which Problems Are Solved The go linter can't limit the checks to the diff in https://github.com/zitadel/zitadel/pull/8283 because it's too large # How the Problems Are Solved The protos from https://github.com/zitadel/zitadel/pull/8283 are merged separately # Additional Context Contributes to #7236 --------- Co-authored-by: Elio Bischof <elio@zitadel.com>
This commit is contained in:
@@ -52,7 +52,7 @@ message RequestExecution {
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
min_length: 1,
|
||||
max_length: 1000,
|
||||
example: "\"/zitadel.session.v2beta.SessionService/ListSessions\"";
|
||||
example: "\"/zitadel.session.v2.SessionService/ListSessions\"";
|
||||
}
|
||||
];
|
||||
// GRPC-service as condition.
|
||||
@@ -61,7 +61,7 @@ message RequestExecution {
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
min_length: 1,
|
||||
max_length: 1000,
|
||||
example: "\"zitadel.session.v2beta.SessionService\"";
|
||||
example: "\"zitadel.session.v2.SessionService\"";
|
||||
}
|
||||
];
|
||||
// All calls to any available services and methods as condition.
|
||||
@@ -78,7 +78,7 @@ message ResponseExecution {
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
min_length: 1,
|
||||
max_length: 1000,
|
||||
example: "\"/zitadel.session.v2beta.SessionService/ListSessions\"";
|
||||
example: "\"/zitadel.session.v2.SessionService/ListSessions\"";
|
||||
}
|
||||
];
|
||||
// GRPC-service as condition.
|
||||
@@ -87,7 +87,7 @@ message ResponseExecution {
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
min_length: 1,
|
||||
max_length: 1000,
|
||||
example: "\"zitadel.session.v2beta.SessionService\"";
|
||||
example: "\"zitadel.session.v2.SessionService\"";
|
||||
}
|
||||
];
|
||||
// All calls to any available services and methods as condition.
|
||||
|
@@ -47,7 +47,7 @@ message IncludeFilter {
|
||||
string include = 1 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
description: "the id of the include"
|
||||
example: "\"request.zitadel.session.v2beta.SessionService\"";
|
||||
example: "\"request.zitadel.session.v2.SessionService\"";
|
||||
}
|
||||
];
|
||||
}
|
||||
|
@@ -85,7 +85,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
|
||||
--data-raw '{
|
||||
"condition": {
|
||||
"request": {
|
||||
"method": "/zitadel.user.v2beta.UserService/AddHumanUser"
|
||||
"method": "/zitadel.user.v2.UserService/AddHumanUser"
|
||||
}
|
||||
},
|
||||
"targets": [
|
||||
@@ -98,10 +98,10 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
|
||||
|
||||
## Example call
|
||||
|
||||
Now on every call on `/zitadel.user.v2beta.UserService/AddHumanUser` the local server prints out the received body of the request:
|
||||
Now on every call on `/zitadel.user.v2.UserService/AddHumanUser` the local server prints out the received body of the request:
|
||||
|
||||
```shell
|
||||
curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/users/human' \
|
||||
curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2/users/human' \
|
||||
-H 'Content-Type: application/json' \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Authorization: Bearer <TOKEN>' \
|
||||
@@ -119,7 +119,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/users/human' \
|
||||
Should print out something like, also described under [Sent information Request](./introduction#sent-information-request):
|
||||
```shell
|
||||
{
|
||||
"fullMethod": "/zitadel.user.v2beta.UserService/AddHumanUser",
|
||||
"fullMethod": "/zitadel.user.v2.UserService/AddHumanUser",
|
||||
"instanceID": "262851882718855632",
|
||||
"orgID": "262851882718921168",
|
||||
"projectID": "262851882719052240",
|
||||
|
@@ -70,16 +70,16 @@ The API documentation to set an Execution can be found [here](/apis/resources/ac
|
||||
### Condition Best Match
|
||||
|
||||
As the conditions can be defined on different levels, ZITADEL tries to find out which Execution is the best match.
|
||||
This means that for example if you have an Execution defined on `all requests`, on the service `zitadel.user.v2beta.UserService` and on `/zitadel.user.v2beta.UserService/AddHumanUser`,
|
||||
ZITADEL would with a call on the `/zitadel.user.v2beta.UserService/AddHumanUser` use the Executions with the following priority:
|
||||
This means that for example if you have an Execution defined on `all requests`, on the service `zitadel.user.v2.UserService` and on `/zitadel.user.v2.UserService/AddHumanUser`,
|
||||
ZITADEL would with a call on the `/zitadel.user.v2.UserService/AddHumanUser` use the Executions with the following priority:
|
||||
|
||||
1. `/zitadel.user.v2beta.UserService/AddHumanUser`
|
||||
2. `zitadel.user.v2beta.UserService`
|
||||
1. `/zitadel.user.v2.UserService/AddHumanUser`
|
||||
2. `zitadel.user.v2.UserService`
|
||||
3. `all`
|
||||
|
||||
If you then have a call on `/zitadel.user.v2beta.UserService/UpdateHumanUser` the following priority would be found:
|
||||
If you then have a call on `/zitadel.user.v2.UserService/UpdateHumanUser` the following priority would be found:
|
||||
|
||||
1. `zitadel.user.v2beta.UserService`
|
||||
1. `zitadel.user.v2.UserService`
|
||||
2. `all`
|
||||
|
||||
And if you use a different service, for example `zitadel.session.v2.SessionService`, then the `all` Execution would still be used.
|
||||
@@ -100,7 +100,7 @@ If you define 2 Executions as follows:
|
||||
{
|
||||
"condition": {
|
||||
"request": {
|
||||
"service": "zitadel.user.v2beta.UserService"
|
||||
"service": "zitadel.user.v2.UserService"
|
||||
}
|
||||
},
|
||||
"targets": [
|
||||
@@ -115,7 +115,7 @@ If you define 2 Executions as follows:
|
||||
{
|
||||
"condition": {
|
||||
"request": {
|
||||
"method": "/zitadel.user.v2beta.UserService/AddHumanUser"
|
||||
"method": "/zitadel.user.v2.UserService/AddHumanUser"
|
||||
}
|
||||
},
|
||||
"targets": [
|
||||
@@ -125,7 +125,7 @@ If you define 2 Executions as follows:
|
||||
{
|
||||
"include": {
|
||||
"request": {
|
||||
"service": "zitadel.user.v2beta.UserService"
|
||||
"service": "zitadel.user.v2.UserService"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -133,7 +133,7 @@ If you define 2 Executions as follows:
|
||||
}
|
||||
```
|
||||
|
||||
The called Targets on "/zitadel.user.v2beta.UserService/AddHumanUser" would be, in order:
|
||||
The called Targets on "/zitadel.user.v2.UserService/AddHumanUser" would be, in order:
|
||||
|
||||
1. `<TargetID2>`
|
||||
2. `<TargetID1>`
|
||||
@@ -147,8 +147,8 @@ For Request and Response there are 3 levels the condition can be defined:
|
||||
- `All`, handling any request or response under the ZITADEL API
|
||||
|
||||
The available conditions can be found under:
|
||||
- [All available Methods](/apis/resources/action_service_v3/action-service-list-execution-methods), for example `/zitadel.user.v2beta.UserService/AddHumanUser`
|
||||
- [All available Services](/apis/resources/action_service_v3/action-service-list-execution-services), for example `zitadel.user.v2beta.UserService`
|
||||
- [All available Methods](/apis/resources/action_service_v3/action-service-list-execution-methods), for example `/zitadel.user.v2.UserService/AddHumanUser`
|
||||
- [All available Services](/apis/resources/action_service_v3/action-service-list-execution-services), for example `zitadel.user.v2.UserService`
|
||||
|
||||
### Condition for Functions
|
||||
|
||||
|
@@ -313,4 +313,10 @@ For easy copying to your reverse proxy configuration, here is the list of URL pa
|
||||
/zitadel.settings.v2beta.SettingsService/
|
||||
/zitadel.oidc.v2beta.OIDCService/
|
||||
/zitadel.org.v2beta.OrganizationService/
|
||||
/v2/
|
||||
/zitadel.user.v2.UserService/
|
||||
/zitadel.session.v2.SessionService/
|
||||
/zitadel.settings.v2.SettingsService/
|
||||
/zitadel.oidc.v2.OIDCService/
|
||||
/zitadel.org.v2.OrganizationService/
|
||||
```
|
||||
|
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: APIs V2 (Beta)
|
||||
title: APIs V2 (General Available)
|
||||
---
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
@@ -7,6 +7,4 @@ import DocCardList from '@theme/DocCardList';
|
||||
APIs V2 organize access by resources (users, settings, etc.), unlike context-specific V1 APIs.
|
||||
This simplifies finding the right API, especially for multi-organization resources.
|
||||
|
||||
**Note**: V2 is currently in [Beta](/support/software-release-cycles-support#beta) and not yet generally available (breaking changes possible). Check individual services for availability.
|
||||
|
||||
<DocCardList />
|
@@ -8,7 +8,7 @@ Request Example:
|
||||
|
||||
```bash
|
||||
curl --request GET \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/settings/login \
|
||||
--url https://$ZITADEL_DOMAIN/v2/settings/login \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''
|
||||
```
|
||||
|
@@ -16,7 +16,7 @@ Make sure that the provided token is from the authenticated user, resp. the mana
|
||||
|
||||
```bash
|
||||
curl --request DELETE \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions/218480890961985793 \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions/218480890961985793 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json'
|
||||
@@ -28,7 +28,7 @@ Send the session token in the body of the request:
|
||||
|
||||
```bash
|
||||
curl --request DELETE \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions/218480890961985793 \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions/218480890961985793 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -9,7 +9,7 @@ The list of session IDs can be sent in the “search sessions” request to get
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions/search \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions/search \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -8,7 +8,7 @@ Example Request:
|
||||
|
||||
```bash
|
||||
curl --request PATCH \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions/218480890961985793 \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions/218480890961985793 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -26,7 +26,7 @@ In the response, you will get an authentication URL of the provider you like.
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/idp_intents \
|
||||
--url https://$ZITADEL_DOMAIN/v2/idp_intents \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -73,7 +73,7 @@ To get the information of the provider, make a request to ZITADEL.
|
||||
### Request
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/idp_intents/$INTENT_ID \
|
||||
--url https://$ZITADEL_DOMAIN/v2/idp_intents/$INTENT_ID \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -129,7 +129,7 @@ This check requires that the previous step ended on the successful page and didn
|
||||
#### Request
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
|
||||
@@ -160,7 +160,7 @@ The display name is used to list the linkings on the users.
|
||||
#### Request
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/human \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/human \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -198,7 +198,7 @@ If you want to link/connect to an existing account you can perform the add ident
|
||||
#### Request
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/users/218385419895570689/links \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/users/218385419895570689/links \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -41,7 +41,7 @@ Request Example:
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/totp \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/totp \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -73,7 +73,7 @@ Request Example:
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/totp/verify \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/totp/verify \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -99,7 +99,7 @@ Example Request
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -136,7 +136,7 @@ More detailed information about the API: [Update session Documentation](/apis/re
|
||||
Example Request
|
||||
```bash
|
||||
curl --request PATCH \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions/$SESSION-ID \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions/$SESSION-ID \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
@@ -175,7 +175,7 @@ Example Request:
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER-ID/phone \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER-ID/phone \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -195,7 +195,7 @@ More detailed information about the API: [Verify phone](/apis/resources/user_ser
|
||||
Example Request:
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER-ID/phone/verify \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER-ID/phone/verify \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -213,7 +213,7 @@ More detailed information about the API: [Add OTP SMS for a user](/apis/resource
|
||||
Example Request:
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER-ID/otp_sms \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER-ID/otp_sms \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json'
|
||||
@@ -237,7 +237,7 @@ Example Request
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -264,7 +264,7 @@ Example Request
|
||||
|
||||
```bash
|
||||
curl --request PATCH \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions/225307381909694507 \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions/225307381909694507 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -301,7 +301,7 @@ More detailed information about the API: [Add OTP Email for a user](/apis/resour
|
||||
Example Request:
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER-ID/otp_email \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER-ID/otp_email \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json'
|
||||
@@ -325,7 +325,7 @@ Example Request
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -352,7 +352,7 @@ Example Request
|
||||
|
||||
```bash
|
||||
curl --request PATCH \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions/225307381909694507 \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions/225307381909694507 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -386,7 +386,7 @@ Request Example:
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/u2f \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/u2f \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -457,7 +457,7 @@ Example Request:
|
||||
```bash
|
||||
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/u2f/$PASSKEY_ID \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/u2f/$PASSKEY_ID \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -497,7 +497,7 @@ Example Request
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -55,7 +55,7 @@ With the ID from the redirect before you will now be able to get the information
|
||||
|
||||
```bash
|
||||
curl --request GET \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/oidc/auth_requests/V2_224908753244265546 \
|
||||
--url https://$ZITADEL_DOMAIN/v2/oidc/auth_requests/V2_224908753244265546 \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
```
|
||||
|
||||
@@ -100,7 +100,7 @@ Read more about the [Finalize Auth Request Documentation](/docs/apis/resources/o
|
||||
Make sure that the authorization header is from the same account that you originally sent in the client id header ```x-zitadel-login-client: <userid>``` on the authorize endpoint.
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url $ZITADEL_DOMAIN/v2beta/oidc/auth_requests/V2_224908753244265546 \
|
||||
--url $ZITADEL_DOMAIN/v2/oidc/auth_requests/V2_224908753244265546 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -34,7 +34,7 @@ Send either the sendLink or the returnCode (empty message) in the request body,
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/passkeys/registration_link \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/passkeys/registration_link \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -81,7 +81,7 @@ The code only has to be filled if the user did get a registration code.
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/passkeys \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/passkeys \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -185,7 +185,7 @@ Example Request:
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/passkeys/$PASSKEY_ID \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/passkeys/$PASSKEY_ID \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -223,7 +223,7 @@ More detailed information about the API: [Create Session Documentation](/apis/re
|
||||
Example Request:
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -29,7 +29,7 @@ Make sure to also include the URL Template to customize the reset link in the em
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/password_reset \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/password_reset \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -48,7 +48,7 @@ Send the request with asking for the return Code in the body of the request.
|
||||
#### Request
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/password_reset \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/password_reset \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -96,7 +96,7 @@ In this case it requires additionally the current password instead of the verifi
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/$USER_ID/password \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/$USER_ID/password \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -23,7 +23,7 @@ Read more about the metadata [here](/docs/guides/manage/customize/user-metadata)
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/users/human \
|
||||
--url https://$ZITADEL_DOMAIN/v2/users/human \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -111,7 +111,7 @@ Send it to the Get Session Endpoint to find out how the user has authenticated.
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"'' \
|
||||
--header 'Content-Type: application/json' \
|
||||
@@ -176,7 +176,7 @@ To update an existing session, add the session ID you got in the previous step t
|
||||
|
||||
```bash
|
||||
curl --request PATCH \
|
||||
--url https://$ZITADEL_DOMAIN/v2beta/sessions/$SESSION_ID \
|
||||
--url https://$ZITADEL_DOMAIN/v2/sessions/$SESSION_ID \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'Authorization: Bearer '"$TOKEN"''\
|
||||
--header 'Content-Type: application/json' \
|
||||
|
@@ -188,7 +188,7 @@ These preparation steps are needed for all Token Exchange interaction, including
|
||||
As Token Exchange is still a beta feature, the feature needs to be enabled for your instance by an `IAM_OWNER` first:
|
||||
|
||||
```bash
|
||||
curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/features/instance' \
|
||||
curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2/features/instance' \
|
||||
-H 'Content-Type: application/json' \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Authorization: Bearer <IAM_OWNER_TOKEN>' \
|
||||
|
@@ -49,6 +49,7 @@ Management endpoints:
|
||||
- /zitadel.*
|
||||
- /v2alpha*
|
||||
- /v2beta*
|
||||
- /v2*
|
||||
- /admin*
|
||||
- /management*
|
||||
- /system*
|
||||
|
@@ -284,39 +284,39 @@ module.exports = {
|
||||
categoryLinkSource: "tag",
|
||||
},
|
||||
},
|
||||
user: {
|
||||
specPath: ".artifacts/openapi/zitadel/user/v2beta/user_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/user_service",
|
||||
user_v2: {
|
||||
specPath: ".artifacts/openapi/zitadel/user/v2/user_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/user_service_v2",
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag",
|
||||
categoryLinkSource: "auto",
|
||||
categoryLinkSource: "tag",
|
||||
},
|
||||
},
|
||||
session: {
|
||||
specPath: ".artifacts/openapi/zitadel/session/v2beta/session_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/session_service",
|
||||
session_v2: {
|
||||
specPath: ".artifacts/openapi/zitadel/session/v2/session_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/session_service_v2",
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag",
|
||||
categoryLinkSource: "auto",
|
||||
categoryLinkSource: "tag",
|
||||
},
|
||||
},
|
||||
oidc: {
|
||||
specPath: ".artifacts/openapi/zitadel/oidc/v2beta/oidc_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/oidc_service",
|
||||
oidc_v2: {
|
||||
specPath: ".artifacts/openapi/zitadel/oidc/v2/oidc_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/oidc_service_v2",
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag",
|
||||
categoryLinkSource: "auto",
|
||||
categoryLinkSource: "tag",
|
||||
},
|
||||
},
|
||||
settings: {
|
||||
specPath: ".artifacts/openapi/zitadel/settings/v2beta/settings_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/settings_service",
|
||||
settings_v2: {
|
||||
specPath: ".artifacts/openapi/zitadel/settings/v2/settings_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/settings_service_v2",
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag",
|
||||
categoryLinkSource: "auto",
|
||||
categoryLinkSource: "tag",
|
||||
},
|
||||
},
|
||||
user_schema: {
|
||||
user_schema_v3: {
|
||||
specPath: ".artifacts/openapi/zitadel/user/schema/v3alpha/user_schema_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/user_schema_service_v3",
|
||||
sidebarOptions: {
|
||||
@@ -341,7 +341,7 @@ module.exports = {
|
||||
},
|
||||
},
|
||||
feature_v2: {
|
||||
specPath: ".artifacts/openapi/zitadel/feature/v2beta/feature_service.swagger.json",
|
||||
specPath: ".artifacts/openapi/zitadel/feature/v2/feature_service.swagger.json",
|
||||
outputDir: "docs/apis/resources/feature_service_v2",
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag",
|
||||
|
@@ -5,7 +5,7 @@ module.exports = {
|
||||
type: "category",
|
||||
label: "Get Started",
|
||||
collapsed: false,
|
||||
link: { type: "doc", id: "guides/start/quickstart" },
|
||||
link: {type: "doc", id: "guides/start/quickstart"},
|
||||
items: [
|
||||
"guides/start/quickstart",
|
||||
{
|
||||
@@ -52,7 +52,7 @@ module.exports = {
|
||||
{
|
||||
type: "category",
|
||||
label: "Examples & SDKs",
|
||||
link: { type: "doc", id: "sdk-examples/introduction" },
|
||||
link: {type: "doc", id: "sdk-examples/introduction"},
|
||||
items: [
|
||||
"sdk-examples/introduction",
|
||||
"sdk-examples/angular",
|
||||
@@ -232,7 +232,7 @@ module.exports = {
|
||||
"guides/integrate/login/oidc/logout",
|
||||
],
|
||||
},
|
||||
"guides/integrate/login/saml",
|
||||
"guides/integrate/login/saml",
|
||||
],
|
||||
},
|
||||
{
|
||||
@@ -548,7 +548,7 @@ module.exports = {
|
||||
items: [
|
||||
{
|
||||
type: "category",
|
||||
label: "V1 (General Available)",
|
||||
label: "V1 (Generally Available)",
|
||||
collapsed: false,
|
||||
link: {
|
||||
type: "generated-index",
|
||||
@@ -612,7 +612,7 @@ module.exports = {
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "V2 (Beta)",
|
||||
label: "V2 (Generally Available)",
|
||||
collapsed: false,
|
||||
link: {
|
||||
type: "doc",
|
||||
@@ -621,71 +621,61 @@ module.exports = {
|
||||
items: [
|
||||
{
|
||||
type: "category",
|
||||
label: "User Lifecycle (Beta)",
|
||||
label: "User Lifecycle",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "User Service API (Beta)",
|
||||
slug: "/apis/resources/user_service",
|
||||
title: "User Service API",
|
||||
slug: "/apis/resources/user_service_v2",
|
||||
description:
|
||||
"This API is intended to manage users in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
"This API is intended to manage users in a ZITADEL instance.\n"
|
||||
},
|
||||
items: require("./docs/apis/resources/user_service/sidebar.ts"),
|
||||
items: require("./docs/apis/resources/user_service_v2/sidebar.ts"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Session Lifecycle (Beta)",
|
||||
label: "Session Lifecycle",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Session Service API (Beta)",
|
||||
slug: "/apis/resources/session_service",
|
||||
title: "Session Service API",
|
||||
slug: "/apis/resources/session_service_v2",
|
||||
description:
|
||||
"This API is intended to manage sessions in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
"This API is intended to manage sessions in a ZITADEL instance.\n"
|
||||
},
|
||||
items: require("./docs/apis/resources/session_service/sidebar.ts"),
|
||||
items: require("./docs/apis/resources/session_service_v2/sidebar.ts"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "OIDC Lifecycle (Beta)",
|
||||
label: "OIDC Lifecycle",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "OIDC Service API (Beta)",
|
||||
slug: "/apis/resources/oidc_service",
|
||||
title: "OIDC Service API",
|
||||
slug: "/apis/resources/oidc_service_v2",
|
||||
description:
|
||||
"Get OIDC Auth Request details and create callback URLs.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
"Get OIDC Auth Request details and create callback URLs.\n"
|
||||
},
|
||||
items: require("./docs/apis/resources/oidc_service/sidebar.ts"),
|
||||
items: require("./docs/apis/resources/oidc_service_v2/sidebar.ts"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Settings Lifecycle (Beta)",
|
||||
label: "Settings Lifecycle",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Settings Service API (Beta)",
|
||||
slug: "/apis/resources/settings_service",
|
||||
title: "Settings Service API",
|
||||
slug: "/apis/resources/settings_service_v2",
|
||||
description:
|
||||
"This API is intended to manage settings in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue to break until the services provide the same functionality as the current login.",
|
||||
"This API is intended to manage settings in a ZITADEL instance.\n"
|
||||
},
|
||||
items: require("./docs/apis/resources/settings_service/sidebar.ts"),
|
||||
items: require("./docs/apis/resources/settings_service_v2/sidebar.ts"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Feature Lifecycle (Beta)",
|
||||
label: "Feature Lifecycle",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Feature Service API (Beta)",
|
||||
slug: "/apis/resources/feature_service",
|
||||
title: "Feature Service API",
|
||||
slug: "/apis/resources/feature_service/v2",
|
||||
description:
|
||||
'This API is intended to manage features for ZITADEL. Feature settings that are available on multiple "levels", such as instance and organization. The higher level instance acts as a default for the lower level. When a feature is set on multiple levels, the lower level takes precedence. Features can be experimental where ZITADEL will assume a sane default, such as disabled. When over time confidence in such a feature grows, ZITADEL can default to enabling the feature. As a final step we might choose to always enable a feature and remove the setting from this API, reserving the proto field number. Such removal is not considered a breaking change. Setting a removed field will effectively result in a no-op.\n' +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until a stable version is released.",
|
||||
'This API is intended to manage features for ZITADEL. Feature settings that are available on multiple "levels", such as instance and organization. The higher level instance acts as a default for the lower level. When a feature is set on multiple levels, the lower level takes precedence. Features can be experimental where ZITADEL will assume a sane default, such as disabled. When over time confidence in such a feature grows, ZITADEL can default to enabling the feature. As a final step we might choose to always enable a feature and remove the setting from this API, reserving the proto field number. Such removal is not considered a breaking change. Setting a removed field will effectively result in a no-op.\n'
|
||||
},
|
||||
items: require("./docs/apis/resources/feature_service_v2/sidebar.ts"),
|
||||
},
|
||||
|
Reference in New Issue
Block a user