Skip to main content

Lists all sources in IdentityNow.​

This end-point lists all the sources in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API.

Query Parameters
  • limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
  • offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

  • count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
  • filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: co, eq, in, sw type: eq, in owner.id: eq, in features: ca, co created: eq modified: eq managementWorkgroup.id: eq description: eq authoritative: eq healthy: eq status: eq, in connectionType: eq connectorName: eq

    Example: name eq "#Employees"
  • sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: type, created, modified, name, owner.name, healthy, status

    Example: name
  • for-subadmin string

    Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value me indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned.

    Example: name
Responses

List of Source objects

Schema array
  • id string

    the id of the Source

  • name string

    Human-readable name of the source

  • description string

    Human-readable description of the source

  • owner object

    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 string

    Possible values: [CLUSTER]

    The type of object being referenced

  • id string

    ID of the cluster

  • name string

    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

  • 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.

  • 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 string[]

    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]

    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 string

    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

    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

    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)

  • connectorImplementstionId string

    The connector implementstion id

Loading...