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 string required

  ID of the Subscription to patch

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

application/json-patch+json

Request Body array required

• op string required

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

  The operation to be performed

• path string required

  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

  anyOf

  • MOD1
  • MOD2
  • MOD4

  ---

  string

  integer

  anyOf

  • MOD1
  • MOD2

  ---

  string

  integer

Responses

• 200
• 400
• 401
• 403
• 404
• 429
• 500

---

Updated subscription.

application/json

• Schema
• Example (from schema)

---

Schema

• id string

  Subscription ID.

• name string

  Subscription name.

• description string

  Subscription description.

• triggerId string

  ID of trigger subscribed to.

• triggerName string

  Trigger name of trigger subscribed to.

• type string

  Possible values: [HTTP, EVENTBRIDGE]

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

• responseDeadline string

  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 string

  URL of the external/custom integration.

  httpDispatchMode string

  Possible values: [SYNC, ASYNC, DYNAMIC]

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

  httpAuthenticationType string

  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 object

  Config required if BASIC_AUTH is used.

  userName string

  The username to authenticate.

  password string

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

  bearerTokenAuthConfig object

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

  bearerToken string

  Bearer token

• eventBridgeConfig object

  Config required if EVENTBRIDGE subscription type is used.

  awsAccount string

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

  awsRegion string

  AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.

• enabled boolean

  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.

{
  "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
  "name": "Access request subscription",
  "description": "Access requested to site xyz",
  "triggerId": "idn:access-requested",
  "triggerName": "Access Requested",
  "type": "HTTP",
  "responseDeadline": "PT1H",
  "httpConfig": {
    "url": "https://www.example.com",
    "httpDispatchMode": "SYNC",
    "httpAuthenticationType": "BASIC_AUTH",
    "basicAuthConfig": {
      "userName": "[email protected]",
      "password": null
    },
    "bearerTokenAuthConfig": {
      "bearerToken": null
    }
  },
  "eventBridgeConfig": {
    "awsAccount": "123456789012",
    "awsRegion": "us-west-1"
  },
  "enabled": true,
  "filter": "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"
}

Client Error - Returned if the request body is invalid.

application/json

• Schema
• Example (from schema)

---

Schema

• detailCode string

  Fine-grained error code providing more detail of the error.

• trackingId string

  Unique tracking id for the error.

• messages object[]

  Generic localized reason for error

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

• causes object[]

  Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

{
  "error": "JWT validation failed: JWT is expired"
}

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

• Schema
• Example (from schema)
• 403

---

Schema

• detailCode string

  Fine-grained error code providing more detail of the error.

• trackingId string

  Unique tracking id for the error.

• messages object[]

  Generic localized reason for error

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

• causes object[]

  Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

• Schema
• Example (from schema)
• 404

---

Schema

• detailCode string

  Fine-grained error code providing more detail of the error.

• trackingId string

  Unique tracking id for the error.

• messages object[]

  Generic localized reason for error

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

• causes object[]

  Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

• Schema
• Example (from schema)

---

Schema

• message

  A message describing the error

{
  "message": " Rate Limit Exceeded "
}

Internal Server Error - Returned if there is an unexpected error.

application/json

• Schema
• Example (from schema)
• 500

---

Schema

• detailCode string

  Fine-grained error code providing more detail of the error.

• trackingId string

  Unique tracking id for the error.

• messages object[]

  Generic localized reason for error

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

• causes object[]

  Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...