Skip to main content

Deprecated: Update Identity Provider (IDP)

PUT 
https://$CUSTOM-DOMAIN/admin/v1/idps/:idpId
deprecated

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

Request​

Path Parameters

    idpId stringrequired

Body

required

    name stringrequired

    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​

idp updated

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 -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/idps/:idpId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "google",
  "stylingType": "STYLING_TYPE_UNSPECIFIED",
  "autoRegister": true
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Parameters
— pathrequired
Body required
{
  "name": "google",
  "stylingType": "STYLING_TYPE_UNSPECIFIED",
  "autoRegister": true
}
ResponseClear

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