Update Application

Update an existing application’s configuration

Endpoint

PATCH /v2/applications/{application_id}

Description

Changes the configuration of an OIDC, API, or SAML type application, as well as the application name.

Required Permission

• project.app.write

Path Parameters

application_id · string · required

The unique ID of the application to be updated.

Min Length: 1
Max Length: 200

Request Body

projectId · string · required

The ID of the project the application belongs to.

Min Length: 1
Max Length: 200

name · string

Updated name for the application. If not set, the name will not be changed.

Max Length: 200

oidcConfiguration · object

Updated OIDC configuration. Only provided fields will be updated.

redirectUris · array

Updated redirect URIs (replaces all existing URIs).

responseTypes · array

Updated response types.

grantTypes · array

Updated grant types.

applicationType · string

Updated application type.

authMethodType · string

Updated authentication method.

postLogoutRedirectUris · array

Updated post-logout redirect URIs.

developmentMode · boolean

Updated dev mode setting.

accessTokenType · string

Updated access token type.

accessTokenRoleAssertion · boolean

Updated access token role assertion.

idTokenRoleAssertion · boolean

Updated ID token role assertion.

idTokenUserinfoAssertion · boolean

Updated ID token userinfo assertion.

samlConfiguration · object

Updated SAML configuration.

metadataXml · bytes

Updated SAML metadata XML.

metadataUrl · string

Updated metadata URL.

apiConfiguration · object

Updated API configuration.

authMethodType · string

Updated authentication method.

Response

changeDate · timestamp

The timestamp of the application update. If no changes were made, the previous change date is returned.

Example Request

curl -X PATCH https://your-domain.zitadel.cloud/v2/applications/1035496534033449 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "69629026806489455",
    "name": "My Updated Web App",
    "oidcConfiguration": {
      "redirectUris": [
        "https://myapp.com/callback",
        "https://myapp.com/auth/callback"
      ],
      "developmentMode": false
    }
  }'

Example Response

{
  "changeDate": "2024-12-18T07:50:47.492Z"
}

Error Responses

• 404 Not Found - Application not found
• 400 Bad Request - Invalid configuration
• 403 Forbidden - Insufficient permissions

Important Notes

• When updating arrays (like redirect URIs), the entire array is replaced
• Optional fields that are not provided will remain unchanged
• Changing authentication methods may require regenerating secrets