Skip to main content

Get Source by ID

GET 

/sources/:id

This end-point gets a specific source in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.

Request

Path Parameters

    id stringrequired

    The Source ID

    Example: 2c9180835d191a86015d28455b4a2329

Responses

A Source object

Schema
    id string

    the id of the Source

    name stringrequired

    Human-readable name of the source

    description string

    Human-readable description of the source

    owner objectrequired

    Reference to an owning Identity Object

    type string

    Possible values: [IDENTITY]

    The type of object being referenced

    id string

    ID of the identity

    name string

    Human-readable display name of the identity

    cluster object

    Reference to the associated Cluster

    type stringrequired

    Possible values: [CLUSTER]

    The type of object being referenced

    id stringrequired

    ID of the cluster

    name stringrequired

    Human-readable display name of the cluster

    accountCorrelationConfig object

    Reference to an Account Correlation Config object

    type string

    Possible values: [ACCOUNT_CORRELATION_CONFIG]

    The type of object being referenced

    id string

    ID of the account correlation config

    name string

    Human-readable display name of the account correlation config

    accountCorrelationRule object

    Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.

    type string

    Possible values: [RULE]

    The type of object being referenced

    id string

    ID of the rule

    name string

    Human-readable display name of the rule

    managerCorrelationMapping object

    Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity

    accountAttribute string

    Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.

    identityAttribute string

    Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.

    managerCorrelationRule object

    Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.

    type string

    Possible values: [RULE]

    The type of object being referenced

    id string

    ID of the rule

    name string

    Human-readable display name of the rule

    beforeProvisioningRule object

    Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.

    type string

    Possible values: [RULE]

    The type of object being referenced

    id string

    ID of the rule

    name string

    Human-readable display name of the rule

    schemas object[]

    List of references to Schema objects

  • Array [
  • type string

    Possible values: [CONNECTOR_SCHEMA]

    The type of object being referenced

    id string

    ID of the schema

    name string

    Human-readable display name of the schema

  • ]
  • passwordPolicies object[]

    List of references to the associated PasswordPolicy objects.

  • Array [
  • type string

    Possible values: [PASSWORD_POLICY]

    The type of object being referenced

    id string

    ID of the policy

    name string

    Human-readable display name of the policy

  • ]
  • features SourceFeature[]

    Possible values: [AUTHENTICATE, COMPOSITE, DIRECT_PERMISSIONS, DISCOVER_SCHEMA, ENABLE, MANAGER_LOOKUP, NO_RANDOM_ACCESS, PROXY, SEARCH, TEMPLATE, UNLOCK, UNSTRUCTURED_TARGETS, SHAREPOINT_TARGET, PROVISIONING, GROUP_PROVISIONING, SYNC_PROVISIONING, PASSWORD, CURRENT_PASSWORD, ACCOUNT_ONLY_REQUEST, ADDITIONAL_ACCOUNT_REQUEST, NO_AGGREGATION, GROUPS_HAVE_MEMBERS, NO_PERMISSIONS_PROVISIONING, NO_GROUP_PERMISSIONS_PROVISIONING, NO_UNSTRUCTURED_TARGETS_PROVISIONING, NO_DIRECT_PERMISSIONS_PROVISIONING, PREFER_UUID]

    Optional features that can be supported by a source.

    type string

    Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the provisionasCsv query parameter to true.

    connector stringrequired

    Connector script name.

    connectorClass string

    The fully qualified name of the Java class that implements the connector interface.

    connectorAttributes object

    Connector specific configuration; will differ from type to type.

    deleteThreshold int32

    Number from 0 to 100 that specifies when to skip the delete phase.

    authoritative boolean

    Default value: false

    When true indicates the source is referenced by an IdentityProfile.

    managementWorkgroup object

    Reference to Management Workgroup for this Source

    type string

    Possible values: [GOVERNANCE_GROUP]

    The type of object being referenced

    id string

    ID of the management workgroup

    name string

    Human-readable display name of the management workgroup

    healthy boolean

    Default value: false

    When true indicates a healthy source

    status string

    A status identifier, giving specific information on why a source is healthy or not

    since string

    Timestamp showing when a source health check was last performed

    connectorId string

    The id of connector

    connectorName string

    The name of the connector that was chosen on source creation

    connectionType string

    The type of connection (direct or file)

    connectorImplementationId string

    The connector implementation id

    created date-time

    The date-time when the source was created

    modified date-time

    The date-time when the source was last modified

Loading...