Retrieve the details of a particular identity source instance of the tenant with the specified instance ID.

get https://{tenanturl}/v1.0/identitysources/{instanceId}

The REST interface that retrieves the details of a particular identity source instance of the tenant.

Entitlements required: readIdentitySources, manageIdentitySources

Responses

Response body

object

sourceTypeId

int32

required

1 to 17

The numeric identifier of identity provider type.

instanceName

string

required

The instance name to be displayed on login selection page.

enabled

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.

status

string

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

configured unconfigured

predefined

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*

object

sensitive

boolean

required

Indicates whether this property holds any secrets that should not be disclosed.
If the property is sensitive, then the property value will be masked out with asterisk characters.

key

string

required

Property key.

value

string

required

Property value. Secret values will be masked out with asterisk characters.

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

object

attrId

string

required

The IBM Security Verify Cloud Directory attribute identifier.

jitpOption

string

required

The IBM Security Verify Cloud Directory attribute identifier.

ALWAYS CREATE DISABLED NONE

idsAttrName

string

required

The external identity source attribute name. Only required if identity source is not Cloud Directory.

postEval

object

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://tenant_url/v1.0/identitysources/instanceId \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Success. The identity source was retrieved.

403You are not authorized to access this resource.

404The retrieval failed because the resource wasn't found.