Skip to main content

Deprecated: Update Identity Provider (IDP)​

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Update an existing IDP. All fields are updated. If you do not send a value in a field, it will be empty afterward.

Path Parameters
  • idpId string required
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.

Request Body required
  • name string required

    Possible values: non-empty and <= 200 characters

  • stylingType string

    Possible values: [STYLING_TYPE_UNSPECIFIED, STYLING_TYPE_GOOGLE]

    Default value: STYLING_TYPE_UNSPECIFIED

    some identity providers specify the styling of the button to their login

  • autoRegister boolean
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
PUT /idps/:idpId

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/management/v1
Bearer Token
idpId — path required
x-zitadel-orgid — header
Content-Type
Body required
{

  "name": "google",

  "stylingType": "STYLING_TYPE_UNSPECIFIED",

  "autoRegister": true

}
Accept
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/idps/:idpId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "google",
  "stylingType": "STYLING_TYPE_UNSPECIFIED",
  "autoRegister": true
}'