Skip to main content

Patch a Subscription



This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable:

name, description, enabled, type, filter, responseDeadline, httpConfig, eventBridgeConfig, workflowConfig


Path Parameters

    id stringrequired

    ID of the Subscription to patch

    Example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde


  • Array [
  • op stringrequired

    Possible values: [add, remove, replace, move, copy]

    The operation to be performed

    path stringrequired

    A string JSON Pointer representing the target path to an element to be affected by the operation

    value object

    The value to be used for the operation, required for "add" and "replace" operations



  • ]


Updated subscription.

    id stringrequired

    Subscription ID.

    name stringrequired

    Subscription name.

    description string

    Subscription description.

    triggerId stringrequired

    ID of trigger subscribed to.

    triggerName stringrequired

    Trigger name of trigger subscribed to.

    type SubscriptionTyperequired


    Subscription type. NOTE If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.

    responseDeadline stringrequired

    Default value: PT1H

    Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.

    httpConfig object

    Config required if HTTP subscription type is used.

    url stringrequired

    URL of the external/custom integration.

    httpDispatchMode HttpDispatchModerequired

    Possible values: [SYNC, ASYNC, DYNAMIC]

    HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.

    httpAuthenticationType HttpAuthenticationType

    Possible values: [NO_AUTH, BASIC_AUTH, BEARER_TOKEN]

    Default value: NO_AUTH

    Defines the HTTP Authentication type. Additional values may be added in the future.

    If NO_AUTH is selected, no extra information will be in HttpConfig.

    If BASIC_AUTH is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.

    If BEARER_TOKEN is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.

    basicAuthConfig objectnullable

    Config required if BASIC_AUTH is used.

    userName string

    The username to authenticate.

    password stringnullable

    The password to authenticate. On response, this field is set to null as to not return secrets.

    bearerTokenAuthConfig objectnullable

    Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets.

    bearerToken stringnullable

    Bearer token

    eventBridgeConfig object

    Config required if EVENTBRIDGE subscription type is used.

    awsAccount stringrequired

    AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.

    awsRegion stringrequired

    AWS Region that has the EventBridge Partner Event Source Resource. See for a full list of available values.

    enabled booleanrequired

    Default value: true

    Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option.

    filter string

    JSONPath filter to conditionally invoke trigger when expression evaluates to true.