Deactivate Application​
Set the state of an application to deactivated. It is not possible to request tokens for deactivated apps. Request returns an error if the application is already deactivated.
Path Parameters
projectId string required
appId string required
Header Parameters
x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data.
application/json
application/grpc
application/grpc-web+proto
Request Body required
object
Request Body required
object
Request Body required
object
Responses
- 200
- default
A successful response.
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.140Z",
"changeDate": "2024-03-27T10:05:51.140Z",
"resourceOwner": "69629023906488334"
}
}
Schema
Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.141Z",
"changeDate": "2024-03-27T10:05:51.141Z",
"resourceOwner": "69629023906488334"
}
}
Schema
Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.144Z",
"changeDate": "2024-03-27T10:05:51.144Z",
"resourceOwner": "69629023906488334"
}
}
An unexpected error response.
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
POST /projects/:projectId/apps/:appId/_deactivate
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "authorizationCode": { "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize", "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token", "scopes": { "openid": "openid", "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud" } } }
Request
Request
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'
python / requests
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'
go / native
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'
nodejs / axios
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'
ruby / Net::HTTP
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'
csharp / RestSharp
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'
php / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'
java / OkHttp
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'
powershell / RestMethod
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'