Deprecated: Deactivate Identity Provider (IDP)
deprecated
This endpoint has been deprecated and may be removed in future versions of the API.
Sets the state of the provider to inactive. It can only be called for the provider with the state active. Users will not be able to log in with the given provider afterward. It might cause troubles if it is the only authentication method of the user.
Path Parameters
- idpId string required
Responses
- 200
- 400
- 403
- 404
- default
idp deactivated
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
Unable to deactivate IDP
- 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"
}
]
}
Returned when the user does not have permission to access the resource.
- 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"
}
]
}
Returned when the resource does not exist.
- 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"
}
]
}
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 /idps/:idpId/_deactivate
Authorization
type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud
Request
Request
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/idps/:idpId/_deactivate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/idps/:idpId/_deactivate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/idps/:idpId/_deactivate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/idps/:idpId/_deactivate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/idps/:idpId/_deactivate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/idps/:idpId/_deactivate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/idps/:idpId/_deactivate' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'