HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

V2 API to create an identity source instance for a tenant.

post
https://{tenanturl}/v2.0/identitysources

The REST interface that creates an instance of particular type of identity source.

Entitlements required: manageIdentitySources

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

Note: V1 to V2 property changes. For identity sources types that support identity linking:

V1 PropertyV2 Migrated PropertyNotesidentityLinkingEnabledidentityLinkingEnabledNo change. Enable/disable identity linkingexternalId (SAML only)
external_id_attribute (EnterpriseOIDC only)
identityLinkingExternalId (WeChat only) identityLinkingExternalIdRequires identityLinkingEnable==trueexternalIdTransform (SAML only)identityLinkingExternalIdTransformRequires identityLinkingExternalId to be setidentityLinkingJitEnabledjitEnabledDoes not depend on identityLinkingEnabledidentityLinkingPrincipalAttributeprincipalAttributeDoes not depend on identityLinkingEnabled--principalAttributeTransformRequires principalAttribute to be set

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

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
enum

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

Allowed:
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.

properties
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*
attributeMappings
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
201

Success. The identity source was created.

Updated 2 months ago

Did this page help you?
Language
URL
LoadingLoading

Response
Choose an example:
*/*

Updated 2 months ago

Did this page help you?