Skip to main content

Create new SIM integration

POST 

/sim-integrations

Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.

Request

Body

required

DTO containing the details of the SIM integration

    name stringrequired

    Name of the Object

    description string

    The description of the integration

    type string

    The integration type

    attributes objectnullable

    The attributes map containing the credentials used to configure the integration.

    sources string[]

    The list of sources (managed resources)

    cluster string

    The cluster/proxy

    statusMap object

    Custom mapping between the integration result and the provisioning result

    request object

    Request data to customize desc and body of the created ticket

    beforeProvisioningRule

    Before provisioning rule of integration

    type DtoType

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

    An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

    id string

    ID of the rule

    name string

    Human-readable display name of the rule

Responses

details of the created integration

Schema
    name stringrequired

    Service Desk integration's name. The name must be unique.

    description stringrequired

    Service Desk integration's description.

    type stringrequired

    Default value: ServiceNowSDIM

    Service Desk integration types:

    • ServiceNowSDIM
    • ServiceNow
    ownerRef object

    Owner's identity.

    type string

    Possible values: [IDENTITY]

    Owner's DTO type.

    id string

    Owner's identity ID.

    name string

    Owner's name.

    clusterRef object

    Source cluster.

    type string

    Possible values: [CLUSTER]

    Source cluster DTO type.

    id string

    Source cluster ID.

    name string

    Source cluster display name.

    cluster stringdeprecated

    Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility).

    managedSources string[]deprecated

    Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility).

    provisioningConfig object

    The 'provisioningConfig' property specifies the configuration used to provision integrations.

    universalManager boolean

    Default value: false

    Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.

    managedResourceRefs object[]

    References to sources for the Service Desk integration template. May only be specified if universalManager is false.

  • Array [
  • type string

    Possible values: [SOURCE]

    The type of object being referenced

    id string

    ID of the source

    name string

    Human-readable display name of the source

  • ]
  • planInitializerScript object

    This is a reference to a plan initializer script.

    source string

    This is a Rule that allows provisioning instruction changes.

    noProvisioningRequests boolean

    Default value: false

    Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.

    provisioningRequestExpiration int32

    When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.

    attributes objectrequired

    Service Desk integration's attributes. Validation constraints enforced by the implementation.

    property name* any

    Service Desk integration's attributes. Validation constraints enforced by the implementation.

    beforeProvisioningRule object

    Before Provisioning Rule.

    type string

    Possible values: [RULE]

    Before Provisioning Rule DTO type.

    id string

    Before Provisioning Rule ID.

    name string

    Rule display name.

Loading...