Skip to main content

Connector-Rule by ID

GET 

/connector-rules/:id

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Returns the connector rule specified by ID.

Request

Path Parameters

    id stringrequired

    ID of the connector rule to retrieve

    Example: 8c190e6787aa4ed9a90bd9d5344523fb

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

Connector rule with the given ID

Schema

    name stringrequired

    Possible values: non-empty and <= 128 characters

    the name of the rule

    description string

    a description of the rule's purpose

    type stringrequired

    Possible values: [BuildMap, ConnectorAfterCreate, ConnectorAfterDelete, ConnectorAfterModify, ConnectorBeforeCreate, ConnectorBeforeDelete, ConnectorBeforeModify, JDBCBuildMap, JDBCOperationProvisioning, JDBCProvision, PeopleSoftHRMSBuildMap, PeopleSoftHRMSOperationProvisioning, PeopleSoftHRMSProvision, RACFPermissionCustomization, SAPBuildMap, SapHrManagerRule, SapHrOperationProvisioning, SapHrProvision, SuccessFactorsOperationProvisioning, WebServiceAfterOperationRule, WebServiceBeforeOperationRule]

    the type of rule

    signature

    object

    The rule's function signature. Describes the rule's input arguments and output (if any)

    input

    object[]

    required

  • Array [

  • name stringrequired

    the name of the argument

    description string

    the description of the argument

    type stringnullable

    the programmatic type of the argument

  • ]

  • output

    object

    nullable

    name stringrequired

    the name of the argument

    description string

    the description of the argument

    type stringnullable

    the programmatic type of the argument

    sourceCode

    object

    required

    SourceCode

    version stringrequired

    the version of the code

    script stringrequired

    The code

    attributes objectnullable

    a map of string to objects

    id stringrequired

    the ID of the rule

    created stringrequired

    an ISO 8601 UTC timestamp when this rule was created

    modified stringnullable

    an ISO 8601 UTC timestamp when this rule was last modified

Loading...