Update a Subscription

PUT 
https://sailpoint.api.identitynow.com/beta/trigger-subscriptions/:id

This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable:

• id

• triggerId

Attempts to modify these fields result in 400.

Request

Path Parameters

id stringrequired
Subscription ID
Example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde

application/json

Bodyrequired

namestring
Subscription name.
Example: Access request subscription
descriptionstring
Subscription description.
Example: Access requested to site xyz
typestring
Subscription type. NOTE If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.
Possible values: [HTTP, EVENTBRIDGE, INLINE, SCRIPT, WORKFLOW]
Example: HTTP
responseDeadlinestring
Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.
Default value: PT1H
Example: PT1H
httpConfig object
urlstringrequired
URL of the external/custom integration.
Example: https://www.example.com
httpDispatchModestringrequired
HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.
Possible values: [SYNC, ASYNC, DYNAMIC]
Example: SYNC
httpAuthenticationTypestring
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.
Possible values: [NO_AUTH, BASIC_AUTH, BEARER_TOKEN]
Default value: NO_AUTH
Example: BASIC_AUTH
basicAuthConfig objectnullable
Config required if BASIC_AUTH is used.
userNamestring
The username to authenticate.
Example: user@example.com
passwordstringnullable
The password to authenticate. On response, this field is set to null as to not return secrets.
Example: null
bearerTokenAuthConfig objectnullable
Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets.
bearerTokenstringnullable
Bearer token
Example: null
eventBridgeConfig object
awsAccountstringrequired
AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.
Example: 123456789012
awsRegionstringrequired
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.
Example: us-west-1
enabledboolean
Whether subscription should receive real-time trigger invocations or not.
Test trigger invocations are always enabled regardless of this option.
Default value: true
Example: true
filterstring
JSONPath filter to conditionally invoke trigger when expression evaluates to true.
Example: $[?($.identityId == "201327fda1c44704ac01181e963d463c")]

Responses

200

Updated subscription.

application/json

Schema

Schema

idstringrequired
Subscription ID.
Example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
namestringrequired
Subscription name.
Example: Access request subscription
descriptionstring
Subscription description.
Example: Access requested to site xyz
triggerIdstringrequired
ID of trigger subscribed to.
Example: idn:access-request-post-approval
triggerNamestringrequired
Trigger name of trigger subscribed to.
Example: Access Requested
typestringrequired
Subscription type. NOTE If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.
Possible values: [HTTP, EVENTBRIDGE, INLINE, SCRIPT, WORKFLOW]
Example: HTTP
responseDeadlinestring
Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.
Default value: PT1H
Example: PT1H
httpConfig object
urlstringrequired
URL of the external/custom integration.
Example: https://www.example.com
httpDispatchModestringrequired
HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.
Possible values: [SYNC, ASYNC, DYNAMIC]
Example: SYNC
httpAuthenticationTypestring
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.
Possible values: [NO_AUTH, BASIC_AUTH, BEARER_TOKEN]
Default value: NO_AUTH
Example: BASIC_AUTH
basicAuthConfig objectnullable
Config required if BASIC_AUTH is used.
userNamestring
The username to authenticate.
Example: user@example.com
passwordstringnullable
The password to authenticate. On response, this field is set to null as to not return secrets.
Example: null
bearerTokenAuthConfig objectnullable
Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets.
bearerTokenstringnullable
Bearer token
Example: null
eventBridgeConfig object
awsAccountstringrequired
AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.
Example: 123456789012
awsRegionstringrequired
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.
Example: us-west-1
enabledbooleanrequired
Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option.
Default value: true
Example: true
filterstring
JSONPath filter to conditionally invoke trigger when expression evaluates to true.
Example: $[?($.identityId == "201327fda1c44704ac01181e963d463c")]

Example (auto)

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

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "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."
    }
  ]
}

401

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

application/json

Schema

Schema

error
A message describing the error
Example: JWT validation failed: JWT is expired

Example (auto)

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

403

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

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "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."
    }
  ]
}

403

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."
    }
  ]
}

404

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

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "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."
    }
  ]
}

404

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."
    }
  ]
}

429

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

Schema

message
A message describing the error
Example: Rate Limit Exceeded

Example (auto)

{
  "message": " Rate Limit Exceeded "
}

500

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

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "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."
    }
  ]
}

500

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."
    }
  ]
}

Authorization: oauth2

type: Personal Access Token
scopes: sp:trigger-service-subscriptions:manage

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

Request Collapse all

Base URL

https://sailpoint.api.identitynow.com/beta

Auth

Bearer Token

Parameters

id — pathrequired

Body required

• Example (from schema)
• HTTP Subscription
• HTTP Async Subscription
• EventBridge Subscription

{
  "name": "Access request subscription",
  "description": "Access requested to site xyz",
  "type": "HTTP",
  "responseDeadline": "PT1H",
  "httpConfig": {
    "url": "https://www.example.com",
    "httpDispatchMode": "SYNC",
    "httpAuthenticationType": "BASIC_AUTH",
    "basicAuthConfig": {
      "userName": "user@example.com",
      "password": null
    },
    "bearerTokenAuthConfig": {
      "bearerToken": null
    }
  },
  "eventBridgeConfig": {
    "awsAccount": "123456789012",
    "awsRegion": "us-west-1"
  },
  "enabled": true,
  "filter": "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"
}

ResponseClear

Click the Send API Request button above and see the response here!