Deprecated - Update an identity source instance of the tenant with the specified instance ID.

This API is deprecated and will be removed after June 1 2025. Use the Version 2.0 API: /v2.0/identitysources/{instanceId}

NOTE: The V1 PUT API will return an error if the existing identity source was created or modified with the V2 API.

The REST interface that updates a particular instance of identity source.

Entitlements required: manageIdentitySources

Note: The properties and the number of properties differ with the identity source type. More information about the properties associated with various identity source types can be found in the knowledge center here.

Path Params
string
required

The unique ID of identity source instance.

Body Params
int32
required
1 to 17

The numeric identifier of identity provider type.

string
required

The instance name to be displayed on login selection page.

boolean
required

A Boolean flag that indicates whether this instance is enabled or disabled. Only enabled identity source instances are displayed on the login selection page.

string

A string label that indicates whether this instance is configured. If specified, this property is ignored during creation.

boolean

This property is currently not in use. We do not support plugging-in any other custom types of identity providers.
However, the purpose was to indicate that this instance is special; it neither be created and nor deleted.

array of objects
required

A set of properties that are associated with the identity source instance.
It is an array of properties of identity source instance that are required to perform the runtime login flow.
The properties and the number of properties differ with the provider type.

properties*
array of objects

A set of attribute mappings that are associated with the identity source instance.
It is an array of attribute mappings that are not required but an optional input for certain runtime login flows.
The properties and the number of properties differe with the provider type.

attributeMappings
Responses
204

Success. Identity source was updated.

Language
URL
Choose an example:
*/*