Skip to main content

Deprecated: Deactivate Identity Provider (IDP)

POST 
https://$CUSTOM-DOMAIN/management/v1/idps/:idpId/_deactivate
deprecated

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.

Request​

Path Parameters

    idpId stringrequired

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Body

required

    object

Responses​

A successful response.

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L 'https://$CUSTOM-DOMAIN/management/v1/idps/:idpId/_deactivate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— header
Body required
{}
ResponseClear

Click the Send API Request button above and see the response here!