Org.IdentityConnectors.Framework.Api.Operations.ScriptOnResourceApiOp Interface Reference

Runs a script on the target resource that a connector manages. More...

Inherits Org.IdentityConnectors.Framework.Api.Operations.APIOperation.

Inherited by Org.IdentityConnectors.Framework.Api.ConnectorFacade.

Public Member Functions
Object	RunScriptOnResource (ScriptContext request, OperationOptions options)
	Runs a script on a specific target resource. More...

Detailed Description

Runs a script on the target resource that a connector manages.

This API operation is supported only for a connector that implements Org.IdentityConnectors.Framework.Spi.Operations.ScriptOnResourceOp.

The contract here at the API level is intentionally very loose. Each connector decides what script languages it supports, what running a script on a target resource actually means, and what script options (if any) that connector supports. Refer to the javadoc of each particular connector for more information.

Member Function Documentation

Object Org.IdentityConnectors.Framework.Api.Operations.ScriptOnResourceApiOp.RunScriptOnResource	(	ScriptContext	request,
		OperationOptions	options
	)

Runs a script on a specific target resource.

Parameters

request	The script and arguments to run.
options	Additional options which control how the script is run. Please refer to the connector documentation for supported options.

Returns

The result of the script. The return type must be a type that the connector framework supports for serialization. See Org.IdentityConnectors.Framework.Common.Serializer.ObjectSerializerFactory for a list of supported return types.

---

The documentation for this interface was generated from the following file:

• C:/ADE/icfbuild_docgen/icf/framework/.ade_path/dotnet/Framework/ApiOperations.cs