LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix broken links

Browse Source
This commit is contained in:
Tyler Mairose
2024-02-28 12:14:29 -05:00
parent c2d2f29e89
commit 0b52bfff19
196 changed files with 320 additions and 320 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
algolia/config.json
View File

@@ -2,74 +2,74 @@
"index_name": "prod_DEVELOPER_SAILPOINT_COM",
"start_urls": [
{
"url": "https://developer.sailpoint.com/idn/docs/transforms",
"url": "https://developer.sailpoint.com/docs/extensibility/transforms",
"tags": ["IDN Documentation", "Transforms"]
},
{
"url": "https://developer.sailpoint.com/idn/docs/rules",
"url": "https://developer.sailpoint.com/docs/extensibility/rules",
"tags": ["IDN Documentation", "Rules"]
},
{
"url": "https://developer.sailpoint.com/idn/docs/event-triggers",
"url": "https://developer.sailpoint.com/docs/extensibility/event-triggers",
"tags": ["IDN Documentation", "Event Triggers"]
},
{
"url": "https://developer.sailpoint.com/idn/docs/saas-configuration",
"url": "https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration",
"tags": ["IDN Documentation", "SaaS Configuration"]
},
{
"url": "https://developer.sailpoint.com/idn/docs/saas-connectivity",
"url": "https://developer.sailpoint.com/docs/connectivity/saas-connectivity",
"tags": ["IDN Documentation", "SaaS Connectivity"]
},
{
"url": "https://developer.sailpoint.com/idn/docs/",
"url": "https://developer.sailpoint.com/docs/",
"tags": ["IDN Documentation"]
},
{
"url": "https://developer.sailpoint.com/idn/tools/cli",
"url": "https://developer.sailpoint.com/docs/tools/cli",
"tags": ["IDN Tools", "CLI"],
"selectors_key": "tools"
},
{
"url": "https://developer.sailpoint.com/idn/tools/sdk",
"url": "https://developer.sailpoint.com/docs/tools/sdk",
"tags": ["IDN Tools", "SDKs"],
"selectors_key": "tools"
},
{
"url": "https://developer.sailpoint.com/idn/api/getting-started",
"url": "https://developer.sailpoint.com/docs/api/getting-started",
"selectors_key": "api_v3",
"tags": ["IDN API Documenation"]
},
{
"url": "https://developer.sailpoint.com/idn/api/authentication",
"url": "https://developer.sailpoint.com/docs/api/authentication",
"selectors_key": "api_v3",
"tags": ["IDN API Documenation"]
},
{
"url": "https://developer.sailpoint.com/idn/api/standard-collection-parameters",
"url": "https://developer.sailpoint.com/docs/api/standard-collection-parameters",
"selectors_key": "api_v3",
"tags": ["IDN API Documenation"]
},
{
"url": "https://developer.sailpoint.com/idn/api/rate-limit",
"url": "https://developer.sailpoint.com/docs/api/rate-limit",
"selectors_key": "api_v3",
"tags": ["IDN API Documenation"]
},
{
"url": "https://developer.sailpoint.com/idn/api/v3",
"url": "https://developer.sailpoint.com/docs/api/v3",
"selectors_key": "api_v3",
"tags": ["IDN V3 APIs"]
},
{
"url": "https://developer.sailpoint.com/idn/api/beta",
"url": "https://developer.sailpoint.com/docs/api/beta",
"selectors_key": "api_v3",
"tags": ["IDN Beta APIs"]
},
{
"url": "https://developer.sailpoint.com/iiq/api",
"url": "https://developer.sailpoint.com/docs/api/iiq",
"selectors_key": "api_iiq",
"tags": ["IIQ APIs"]
}

2
algolia/dev_config.json
View File

@@ -2,7 +2,7 @@
"index_name": "dev_DEVELOPER_SAILPOINT_COM",
"start_urls": [
{
"url": "https://developer.sailpoint.com/idn/docs/transforms",
"url": "https://developer.sailpoint.com/docs/extensibility/transforms",
"tags": ["IDN Documentation", "Transforms"]
}
],

8
docs/api/authentication.md
View File

@@ -133,7 +133,7 @@ After you create the token, the value of the `Client ID` will be visible in the
4. Copy both values somewhere that will be secure and accessible to you when you need to use the the token.
To generate a personal access token from the API, use the [create personal access token endpoint](/idn/api/beta/create-personal-access-token).
To generate a personal access token from the API, use the [create personal access token endpoint](/docs/api/beta/create-personal-access-token).
Once you have created the PAT and you know its `Client ID` and `Client Secret`, you have everything you need to follow the [Client Credentials Grant Flow](#request-access-token-with-client-credentials-grant-flow) and use the PAT to generate an `access_token`.
You will need this `access_token` to authenticate your requests to the APIs.
@@ -149,7 +149,7 @@ This document covers these three common flows:
3. [**Refresh Token**](https://oauth.net/2/grant-types/refresh-token/) - Clients use this grant type to exchange a refresh token for a new `access_token` when the existing `access_token` has expired. This allows clients to continue using the APIs without having to re-authenticate as frequently. This grant type is commonly used together with `Authorization Code` to prevent a user from having to log in several times per day.
One way to determine which authorization flow you need to use is to look at the specification for the endpoint you want to use.
The endpoint will have the supported OAuth flows listed under the 'Authorization' dropdown, like the [List Access Profiles endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-profiles):
The endpoint will have the supported OAuth flows listed under the 'Authorization' dropdown, like the [List Access Profiles endpoint](https://developer.sailpoint.com/docs/api/beta/list-access-profiles):
![Authorization Dropdown](./img/authorization/authorization-dropdown.png)
@@ -440,7 +440,7 @@ However, the `refresh_token` will only be present if the API client has the `REF
- The `user_id` and `identity_id` define the identity context of the person who authenticated.
However, these values aren't set for the client credentials grant type because it doesn't have a user context.
With the JWT `access_token`, you can now successfully send authenticated IDN API requests. To learn more about authorization and the scopes you can apply to further control access to the APIs, refer to [Authorization](/idn/api/authorization).
With the JWT `access_token`, you can now successfully send authenticated IDN API requests. To learn more about authorization and the scopes you can apply to further control access to the APIs, refer to [Authorization](/docs/api/authorization).
## More Information
@@ -614,7 +614,7 @@ You can also view all of the active clients in the UI by going to `https://{tena
```
4. If you're using an [Authorization Code](#authorization-code-grant-flow) grant flow, verify that the redirect URL(s) for your application match the `redirectUris` value in the client.
You can check this by calling the [List OAuth Clients endpoint](/idn/api/beta/list-oauth-clients).
You can check this by calling the [List OAuth Clients endpoint](/docs/api/beta/list-oauth-clients).
### Verify OAuth calls
Verify that the OAuth call flow is going to the right URLs, with the correct query parameters and data values.

6
docs/api/authorization.md
View File

@@ -61,7 +61,7 @@ Scopes contain one or more rights, which are low level permissions that grant ac
By default, each PAT has the scope, `sp:scopes:all`, which grants access to all the rights appropriate for the [user level](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html). For example, a user with the **Admin** user level has access to all APIs, so `sp:scopes:all` grants **Admin** users access to all APIs. A user with the **Cert Admin** user level, however, has access to only a subset of APIs necessary to perform their role, most notably the certification APIs, so `sp:scopes:all` grants **Cert Admin** users access to only that subset of APIs.
Alternatively, `sp:scopes:default` is the least privileged scope that only grants access to endpoints that require no authorization at all, such as [list public identities](https://developer.sailpoint.com/idn/api/v3/get-public-identities).
Alternatively, `sp:scopes:default` is the least privileged scope that only grants access to endpoints that require no authorization at all, such as [list public identities](https://developer.sailpoint.com/docs/api/v3/get-public-identities).
Scopes are additive, which means the final right set is the intersection of all the rights granted by the scopes assigned to a PAT, excluding any rights that fall outside of the user level. Each scope added to an PAT builds up the credential's permission set, incrementally increasing access to the API. If a PAT has `sp:scopes:all` granted, then any additional scope is ignored because `sp:scopes:all` already contains the complete set of rights available to the user level.
@@ -76,7 +76,7 @@ If the API requirements for the personal access token exceed the scopes allowed
## Identifying Necessary Authorization for an Endpoint
Each endpoint document specifies how to authorize with the endpoint in the **Authorization** dropdown, which is located on the right side column below the endpoint path. Selecting **Authorization** expands the dropdown menu showing the details of how to authorize with the endpoint. The following image shows the authorization details of the [List Access Profiles](https://developer.sailpoint.com/idn/api/beta/list-access-profiles) endpoint.
Each endpoint document specifies how to authorize with the endpoint in the **Authorization** dropdown, which is located on the right side column below the endpoint path. Selecting **Authorization** expands the dropdown menu showing the details of how to authorize with the endpoint. The following image shows the authorization details of the [List Access Profiles](https://developer.sailpoint.com/docs/api/beta/list-access-profiles) endpoint.
![Authorization Dropdown](./img/authorization/authorization-dropdown.png)
@@ -98,7 +98,7 @@ When you create a PAT in the UI, you can apply scopes to the token. More informa
## Assigning Scopes with the API
You can [create PATs](https://developer.sailpoint.com/idn/api/v3/create-personal-access-token) programmatically with the API. The request body for the endpoint allows the caller to specify a list of scopes to be applied to the PAT. If the `scope` property is omitted from the request body, then `sp:scopes:all` is granted to the credentials. The following example shows how to generate a PAT with the `idn:access-request:manage` and `idn:nelm:manage` scopes.
You can [create PATs](https://developer.sailpoint.com/docs/api/v3/create-personal-access-token) programmatically with the API. The request body for the endpoint allows the caller to specify a list of scopes to be applied to the PAT. If the `scope` property is omitted from the request body, then `sp:scopes:all` is granted to the credentials. The following example shows how to generate a PAT with the `idn:access-request:manage` and `idn:nelm:manage` scopes.
POST <https://{tenant}.api.identitynow.com/v3/personal-access-tokens>

34
docs/api/patch-requests.md
View File

@@ -14,9 +14,9 @@ tags: ['patch', 'guide']
You can use the IdentityNow APIs to update existing resources. Many of the APIs offer multiple ways to do so:
- You can send a **PUT** request to replace the existing resource with a new one. For example, if you wanted to update one of John Doe's source accounts, you could use the [Put Account](https://developer.sailpoint.com/idn/api/v3/put-account) endpoint to replace John Doe's existing source account with a new one. This is a viable way to update a resource, but it requires you to update the entire resource each time.
- You can send a **PUT** request to replace the existing resource with a new one. For example, if you wanted to update one of John Doe's source accounts, you could use the [Put Account](https://developer.sailpoint.com/docs/api/v3/put-account) endpoint to replace John Doe's existing source account with a new one. This is a viable way to update a resource, but it requires you to update the entire resource each time.
- You can send a **PATCH** request to make a specific change to the resource. For example, if you wanted to update John Doe's account's associated "city" attribute, you could use the [Patch Account](https://developer.sailpoint.com/idn/api/v3/update-account) endpoint to replace his existing "city" with a new one, all without affecting any of the other source account details. This can be very helpful when you want to make specific updates to resources, but it requires some knowledge of the types of changes, or "operations", that are possible, the specific paths of the fields you want to update, and some understanding of the basic data types.
- You can send a **PATCH** request to make a specific change to the resource. For example, if you wanted to update John Doe's account's associated "city" attribute, you could use the [Patch Account](https://developer.sailpoint.com/docs/api/v3/update-account) endpoint to replace his existing "city" with a new one, all without affecting any of the other source account details. This can be very helpful when you want to make specific updates to resources, but it requires some knowledge of the types of changes, or "operations", that are possible, the specific paths of the fields you want to update, and some understanding of the basic data types.
This guide will focus on the partial update method, PATCH requests. Read this guide to learn how to start sending PATCH requests.
@@ -26,15 +26,15 @@ To use PATCH to update a resource, you first need to know the resource ID.
Not all resource IDs are available in the IdentityNow UI, so you may need to use the API to find the ID for the resource you want to update.
For example, account IDs aren't avilable in the IdentityNow UI. If you want to use the [Patch Account](https://developer.sailpoint.com/idn/api/v3/update-account) endpoint to make a change to a specific account, you first need to find out the account's ID.
For example, account IDs aren't avilable in the IdentityNow UI. If you want to use the [Patch Account](https://developer.sailpoint.com/docs/api/v3/update-account) endpoint to make a change to a specific account, you first need to find out the account's ID.
You can use the [List Accounts](https://developer.sailpoint.com/idn/api/v3/list-accounts) endpoint to view all the accounts in your tenant, along with their details, such as their identities. You can find your account and its ID in this list.
You can use the [List Accounts](https://developer.sailpoint.com/docs/api/v3/list-accounts) endpoint to view all the accounts in your tenant, along with their details, such as their identities. You can find your account and its ID in this list.
## Get the resource details
Once you know the resource ID, you can use a GET request to get that resource's details. To successfully use a PATCH request to make changes to a resource, you need to know which paths you can update, what values they have, and the structure of those paths.
For example, once you know the ID for the source you want to update with a PATCH request, you can use the [Get Source by ID](https://developer.sailpoint.com/idn/api/v3/get-source) endpoint to view only that source and its details.
For example, once you know the ID for the source you want to update with a PATCH request, you can use the [Get Source by ID](https://developer.sailpoint.com/docs/api/v3/get-source) endpoint to view only that source and its details.
In this example, the API returns a source, "ubuntu", along with all its details. This JSON response shows the resource's structure and its different paths:
@@ -181,7 +181,7 @@ PATCH https://{tenant}.api.identitynow.com/v3/sources/:id
This example request uses a "replace" operation to replace the source's existing description with a new value, "new description". This example shows the parts involved in sending a PATCH request. You must specify an operation to apply to the target resource, a path to apply the operation to, and the change you want to make, often in the form of a value or a "from" location for "copy" and "move" operations.
You can find this example in the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) specification. The API specifications have examples on the right side of the page that you can copy and use to get started. You can tab between the different examples to see a variety of pre-built requests you can use.
You can find this example in the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) specification. The API specifications have examples on the right side of the page that you can copy and use to get started. You can tab between the different examples to see a variety of pre-built requests you can use.
A PATCH request can be more complex as well - the values can be simple or vast and detailed. You can use a PATCH request to apply multiple operations, with a path for each, or you can apply the same type of operation to multiple paths. The PATCH request will always have the same essential structure though.
@@ -239,7 +239,7 @@ These are the available PATCH operations:
The "add" operation adds a value to the target location. For more information about the "add" operation and how it behaves in different scenarios, refer to the [JSON PATCH documentation](https://datatracker.ietf.org/doc/html/rfc6902).
This example uses the [Patch Source Schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to add a new "office" attribute to the end of a source schema's array of attributes:
This example uses the [Patch Source Schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to add a new "office" attribute to the end of a source schema's array of attributes:
```json
[
@@ -268,7 +268,7 @@ You can use "0" to add a value to the beginning of the array. You can use "1" to
The "remove" operation removes a value from the target location. The target location must exist for the operation to be successful.
This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to remove an existing filter string from a source's connector:
This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to remove an existing filter string from a source's connector:
```json
[
@@ -285,7 +285,7 @@ This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/
If there is an array of values, you must specify the position within the array to remove that value.
This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to remove the first feature from a source's list of features.
This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to remove the first feature from a source's list of features.
The source has three features, "ENABLE", "PROVISIONING", AND "UNLOCK".
@@ -304,7 +304,7 @@ This request will remove the the first value from the list, "ENABLE".
The "replace" operation replaces the value at the target location with a new value. The operation object must contain a "value" member whose content specifies the replacement value, and the target location must exist for the operation to be successful. This operation is the equivalent of a "remove" followed by an "add".
This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to replace a source's existing features with new ones:
This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to replace a source's existing features with new ones:
```json
[
@@ -322,7 +322,7 @@ This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/
]
```
You can also replace a value within an array. This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to replace the first value in the array with the specified value:
You can also replace a value within an array. This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to replace the first value in the array with the specified value:
```json
[
@@ -340,7 +340,7 @@ This request removes the first feature ("PASSWORD") in the list and adds the "CU
The "move" operation removes the operation from a specified location and adds it to the target location. This operation object must contain a "from" member whose content specifies the location to remove the value from, and the "from" location must exist for the operation to be successful.
This example uses the [Patch Source Schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to move an attribute from the beginning to the end of the schema's array of attributes:
This example uses the [Patch Source Schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to move an attribute from the beginning to the end of the schema's array of attributes:
```json
[
@@ -356,7 +356,7 @@ This example uses the [Patch Source Schema](https://developer.sailpoint.com/idn/
The "copy" operation copies the value from a specified location to the target location. The operation object must contain a "from" member whose content specifies the location to copy the value from, and the "from" location must exist for the operation to be successful.
This example uses the [Patch Source Schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to copies an attribute from the beginning and duplicates it at the end of the schema's array of attributes:
This example uses the [Patch Source Schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to copies an attribute from the beginning and duplicates it at the end of the schema's array of attributes:
```json
[
@@ -374,7 +374,7 @@ The "test" operation is unique in that it does not apply changes to the resource
The "test" operation allows you to check that a resource has the values you expect it to have, and then you can make changes to those values from there with another PATCH request.
This example uses the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) endpoint to test a source's existing features to make sure they match the specified values.:
This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) endpoint to test a source's existing features to make sure they match the specified values.:
```json
[
@@ -455,7 +455,7 @@ PATCH https://{tenant}.api.identitynow.com/v3/sources/:id
]
```
However, you cannot make changes to all paths. Use the API specifications for the PATCH endpoint you want to use to find out which paths you can make changes to. The API specifications will list the paths, or fields, that are immutable, if there are any. For example, the [Patch Source](https://developer.sailpoint.com/idn/api/v3/update-source) specification lists paths like `id` and `type` as being immutable. Trying to use modify these paths results in a 400 error.
However, you cannot make changes to all paths. Use the API specifications for the PATCH endpoint you want to use to find out which paths you can make changes to. The API specifications will list the paths, or fields, that are immutable, if there are any. For example, the [Patch Source](https://developer.sailpoint.com/docs/api/v3/update-source) specification lists paths like `id` and `type` as being immutable. Trying to use modify these paths results in a 400 error.
The paths are often nested within other paths, like within the "connectorAttributes" path from the earlier example source's details:
@@ -616,7 +616,7 @@ PATCH https://{tenant}.api.identitynow.com//v3/sources/:sourceId/schemas/:schema
]
```
This request uses the [PATCH Source Schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to add a new attribute, along with its details, to the end of the array of a source's schema's attributes.
This request uses the [PATCH Source Schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to add a new attribute, along with its details, to the end of the array of a source's schema's attributes.
This example uses the "-" after the path to indicate that the value will be added to the end of the array. When you are adding a new value to an array of values, you can specify the position within the array where you want to add the new value. In this example, using the "-" expression at the end of the path specifies that the new attribute will be added to the end of the array of attributes.
@@ -626,7 +626,7 @@ You can use "0" to add a value to the beginning of the array. You can use "1" to
The "move" and "copy" operations allow you to remove or copy information from one path and add it to another path without your needing to specify the value, which could be an extensive array of information. To use the "move" and "copy" operations, you must specify a "from", a JSON Pointer representing the location you are moving or copying the value from.
This example request uses the [PATCH Source schema](https://developer.sailpoint.com/idn/api/v3/update-source-schema) endpoint to move an attribute, along with its details, from the beginning to the end of a source schema's array of attributes:
This example request uses the [PATCH Source schema](https://developer.sailpoint.com/docs/api/v3/update-source-schema) endpoint to move an attribute, along with its details, from the beginning to the end of a source schema's array of attributes:
```text
PATCH https://{tenant}.api.identitynow.com//v3/sources/:sourceId/schemas/:schemaId

4
docs/api/standard-collection-parameters.md
View File

@@ -22,7 +22,7 @@ Use the following optional query parameters to achieve pagination:
| Name | Description | Default | Constraints |
| --- | --- | --- | --- |
| `limit` | Integer specifying the maximum number of records to return in a single API call. If it is not specified, a default limit is used. | `250` for list endpoints, `10000` for search endpoint | Maxiumum of 250 records per page for list endpoints, 10000 records per page for the [Search endpoint](https://developer.sailpoint.com/idn/api/v3/search) |
| `limit` | Integer specifying the maximum number of records to return in a single API call. If it is not specified, a default limit is used. | `250` for list endpoints, `10000` for search endpoint | Maxiumum of 250 records per page for list endpoints, 10000 records per page for the [Search endpoint](https://developer.sailpoint.com/docs/api/v3/search) |
| `offset` | Integer specifying the offset of the first result from the beginning of the collection. The **offset** value is record-based, not page-based, and the index starts at 0. For example, **offset=0** and **limit=20** returns records 0-19, but **offset=1** and **limit=20** returns records 1-20. | `0` | Between 0 and the last record index. |
| `count` | Boolean indicating whether a total count is returned, factoring in any filter parameters, in the **X-Total-Count** response header. The value is the total size of the collection that would be returned if **limit** and **offset** were ignored. For example, if the total number of records is 1000, then count=true would return 1000 in the **X-Total-Count** header. Because requesting a total count can have performance impact, do not send **count=true** if that value is not being used. | `false` | Must be `true` or `false` |
@@ -34,7 +34,7 @@ Examples:
## Paginating Search Queries
The [search API](https://developer.sailpoint.com/idn/api/v3/search) in IdentityNow leverages [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html) functionality, which returns a maximum of 10,000 records by default. However, you can page more than 10,000 records by using the "searchAfter" property.
The [search API](https://developer.sailpoint.com/docs/api/v3/search) in IdentityNow leverages [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html) functionality, which returns a maximum of 10,000 records by default. However, you can page more than 10,000 records by using the "searchAfter" property.
The `searchAfter` capability provides the ability to page on sorted field values, instead of offset paging. For example, if you sort by ID and page 100 records at a time, you can take the 1st page of 100 records, pass the last ID from that record set into your next search, and the next search will return the next 100 records after that ID. You continue that pattern of using the last value passed into `searchAfter` until the end of the result set. This allows you to page past the 10,000 record limit until you reach the final record.

2
docs/connectivity/saas-connectivity/common-cli-commands.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 3
sidebar_class_name: commonCliCommands
keywords: ['connectivity', 'connectors', 'commands', 'cli']
description: These are the CLI commands most commonly used when building SaaS Connectors.
slug: /saas-connectivity/common-cli-commands
slug: /connectivity/saas-connectivity/common-cli-commands
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-create.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Create
sidebar_label: Account Create
keywords: ['connectivity', 'connectors', 'account create']
description: Create account on the source.
slug: /saas-connectivity/commands/account-create
slug: /connectivity/saas-connectivity/commands/account-create
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-delete.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Delete
sidebar_label: Account Delete
keywords: ['connectivity', 'connectors', 'account delete']
description: Remove account from a source.
slug: /saas-connectivity/commands/account-delete
slug: /connectivity/saas-connectivity/commands/account-delete
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-disable.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Disable
sidebar_label: Account Disable
keywords: ['connectivity', 'connectors', 'account disable']
description: Disable an account on the source.
slug: /saas-connectivity/commands/account-disable
slug: /connectivity/saas-connectivity/commands/account-disable
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-discover.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Discover
sidebar_label: Account Discover
keywords: ['connectivity', 'connectors', 'account discover']
description: Dynamically determine account schema from the source.
slug: /saas-connectivity/commands/account-discover
slug: /connectivity/saas-connectivity/commands/account-discover
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-enable.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Enable
sidebar_label: Account Enable
keywords: ['connectivity', 'connectors', 'account enable']
description: Enable an account on the source.
slug: /saas-connectivity/commands/account-enable
slug: /connectivity/saas-connectivity/commands/account-enable
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-list.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account List
sidebar_label: Account List
keywords: ['connectivity', 'connectors', 'account list']
description: Aggregate all accounts from the source into IdentityNow.
slug: /saas-connectivity/commands/account-list
slug: /connectivity/saas-connectivity/commands/account-list
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-read.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Read
sidebar_label: Account Read
keywords: ['connectivity', 'connectors', 'account read']
description: Aggregate a single account from the source into IdentityNow.
slug: /saas-connectivity/commands/account-read
slug: /connectivity/saas-connectivity/commands/account-read
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-unlock.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Unlock
sidebar_label: Account Unlock
keywords: ['connectivity', 'connectors', 'account unlock']
description: Lock and unlock an account on the source.
slug: /saas-connectivity/commands/account-unlock
slug: /connectivity/saas-connectivity/commands/account-unlock
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/account-update.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Update
sidebar_label: Account Update
keywords: ['connectivity', 'connectors', 'account update']
description: Update an account on the source.
slug: /saas-connectivity/commands/account-update
slug: /connectivity/saas-connectivity/commands/account-update
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/change-password.md
View File

@@ -5,7 +5,7 @@ pagination_label: Change Password
sidebar_label: Change Password
keywords: ['connectivity', 'connectors', 'change password']
description: Change password for an account on the source.
slug: /saas-connectivity/commands/change-password
slug: /connectivity/saas-connectivity/commands/change-password
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md
View File

@@ -5,7 +5,7 @@ pagination_label: Entitlement List
sidebar_label: Entitlement List
keywords: ['connectivity', 'connectors', 'entitlement list']
description: Gather a list of all entitlements available on the source.
slug: /saas-connectivity/commands/entitlement-list
slug: /connectivity/saas-connectivity/commands/entitlement-list
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md
View File

@@ -5,7 +5,7 @@ pagination_label: Entitlement Read
sidebar_label: Entitlement Read
keywords: ['connectivity', 'connectors', 'entitlement read']
description: Fetch a single entitlement’s attributes from the source.
slug: /saas-connectivity/commands/entitlement-read
slug: /connectivity/saas-connectivity/commands/entitlement-read
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/index.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 7
sidebar_class_name: connectorCommands
keywords: ['connectivity', 'connector', 'commands']
description: All commands available to implement in a SaaS Connector.
slug: /saas-connectivity/connector-commands
slug: /connectivity/saas-connectivity/connector-commands
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-commands/source-data-discover.md
View File

@@ -5,7 +5,7 @@ pagination_label: Source Data Discover
sidebar_label: Source Data Discover
keywords: ['connectivity', 'connectors', 'Source Data Discover']
description: Discover potential source data types.
slug: /saas-connectivity/commands/source-data-discover
slug: /connectivity/saas-connectivity/commands/source-data-discover
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/source-data-read.md
View File

@@ -5,7 +5,7 @@ pagination_label: Source Data Read
sidebar_label: Source Data Read
keywords: ['connectivity', 'connectors', 'Source Data Read']
description: Read source data.
slug: /saas-connectivity/commands/source-data-read
slug: /connectivity/saas-connectivity/commands/source-data-read
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-commands/test-connection.md
View File

@@ -5,7 +5,7 @@ pagination_label: Test Connection
sidebar_label: Test Connection
keywords: ['connectivity', 'connectors', 'test connection']
description: Ensure the connector can communicate with the source.
slug: /saas-connectivity/commands/test-connection
slug: /connectivity/saas-connectivity/commands/test-connection
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-create.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Create
sidebar_label: Account Create
keywords: ['connectivity', 'connectors', 'Account Create']
description: Intercept the account create command.
slug: /saas-connectivity/customizers/commands/account-create
slug: /connectivity/saas-connectivity/customizers/commands/account-create
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-delete.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Delete
sidebar_label: Account Delete
keywords: ['connectivity', 'connectors', 'Account Delete']
description: Intercept the account delete command.
slug: /saas-connectivity/customizers/commands/account-delete
slug: /connectivity/saas-connectivity/customizers/commands/account-delete
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-disable.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Disable
sidebar_label: Account Disable
keywords: ['connectivity', 'connectors', 'Account Disable']
description: Intercept the account disable command.
slug: /saas-connectivity/customizers/commands/account-disable
slug: /connectivity/saas-connectivity/customizers/commands/account-disable
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-enable.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Enable
sidebar_label: Account Enable
keywords: ['connectivity', 'connectors', 'Account Enable']
description: Intercept the account enable command.
slug: /saas-connectivity/customizers/commands/account-enable
slug: /connectivity/saas-connectivity/customizers/commands/account-enable
tags: ['Connectivity', 'Connector Command']
---

4
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-list.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account List
sidebar_label: Account List
keywords: ['connectivity', 'connectors', 'Account List']
description: Intercept the account list command.
slug: /saas-connectivity/customizers/commands/account-list
slug: /connectivity/saas-connectivity/customizers/commands/account-list
tags: ['Connectivity', 'Connector Command']
---
@@ -40,4 +40,4 @@ The `input` object can be mutated and returned, but the same data type must stil
### After account-list command
After account-list is not available for customization at this time. If you need to modify the values of the response, it is recommended that you use [Transforms](https://developer.sailpoint.com/idn/docs/transforms/).
After account-list is not available for customization at this time. If you need to modify the values of the response, it is recommended that you use [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/).

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-read.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Read
sidebar_label: Account Read
keywords: ['connectivity', 'connectors', 'Account Read']
description: Intercept the account read command.
slug: /saas-connectivity/customizers/commands/account-read
slug: /connectivity/saas-connectivity/customizers/commands/account-read
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-unlock.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Unlock
sidebar_label: Account Unlock
keywords: ['connectivity', 'connectors', 'Account Unlock']
description: Intercept the account unlock command.
slug: /saas-connectivity/customizers/commands/account-unlock
slug: /connectivity/saas-connectivity/customizers/commands/account-unlock
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-update.md
View File

@@ -5,7 +5,7 @@ pagination_label: Account Update
sidebar_label: Account Update
keywords: ['connectivity', 'connectors', 'Account Update']
description: Intercept the account update command.
slug: /saas-connectivity/customizers/commands/account-update
slug: /connectivity/saas-connectivity/customizers/commands/account-update
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/change-password.md
View File

@@ -5,7 +5,7 @@ pagination_label: Change Password
sidebar_label: Change Password
keywords: ['connectivity', 'connectors', 'Change Password']
description: Intercept the change password command.
slug: /saas-connectivity/customizers/commands/change-password
slug: /connectivity/saas-connectivity/customizers/commands/change-password
tags: ['Connectivity', 'Connector Command']
---

4
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/entitlement-list.md
View File

@@ -5,7 +5,7 @@ pagination_label: Entitlement List
sidebar_label: Entitlement List
keywords: ['connectivity', 'connectors', 'Entitlement List']
description: Intercept the entitlement list command.
slug: /saas-connectivity/customizers/commands/entitlement-list
slug: /connectivity/saas-connectivity/customizers/commands/entitlement-list
tags: ['Connectivity', 'Connector Command']
---
@@ -42,4 +42,4 @@ The `input` object can be mutated and returned, but the same data type must stil
### After entitlement-list command
After entitlement-list is not available for customization at this time. If you need to modify the values of the response, it is recommended that you use [Transforms](https://developer.sailpoint.com/idn/docs/transforms/).
After entitlement-list is not available for customization at this time. If you need to modify the values of the response, it is recommended that you use [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/).

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/entitlement-read.md
View File

@@ -5,7 +5,7 @@ pagination_label: Entitlement Read
sidebar_label: Entitlement Read
keywords: ['connectivity', 'connectors', 'Entitlement Read']
description: Intercept the entitlement read command.
slug: /saas-connectivity/customizers/commands/entitlement-read
slug: /connectivity/saas-connectivity/customizers/commands/entitlement-read
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/index.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 7
sidebar_class_name: connectorCommands
keywords: ['connectivity', 'connector', 'commands']
description: Available connectivity customizer commands.
slug: /saas-connectivity/customizers/commands
slug: /connectivity/saas-connectivity/customizers/commands
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/source-data-discover.md
View File

@@ -5,7 +5,7 @@ pagination_label: Source Data Discover
sidebar_label: Source Data Discover
keywords: ['connectivity', 'connectors', 'Source Data Discover']
description: Intercept the source data discover command.
slug: /saas-connectivity/customizers/commands/source-data-discover
slug: /connectivity/saas-connectivity/customizers/commands/source-data-discover
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/source-data-read.md
View File

@@ -5,7 +5,7 @@ pagination_label: Source Data Read
sidebar_label: Source Data Read
keywords: ['connectivity', 'connectors', 'Source Data Read']
description: Intercept the source data read command.
slug: /saas-connectivity/customizers/commands/source-data-read
slug: /connectivity/saas-connectivity/customizers/commands/source-data-read
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/test-connection.md
View File

@@ -5,7 +5,7 @@ pagination_label: Test Connection
sidebar_label: Test Connection
keywords: ['connectivity', 'connectors', 'test connection']
description: Intercept the test connection command.
slug: /saas-connectivity/customizers/commands/test-connection
slug: /connectivity/saas-connectivity/customizers/commands/test-connection
tags: ['Connectivity', 'Connector Command']
---

2
docs/connectivity/saas-connectivity/connector-customizers/full-example.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 7
sidebar_class_name: saasConnectivity
keywords: ['connectivity', 'connectors', customizers]
description: Full connectivity customizer example.
slug: /saas-connectivity/customizers/example
slug: /connectivity/saas-connectivity/customizers/example
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-customizers/getting-started.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 4
sidebar_class_name: saasConnectivity
keywords: ['connectivity', 'connectors', customizers]
description: Get started with connectivity customizers.
slug: /saas-connectivity/customizers/getting-started
slug: /connectivity/saas-connectivity/customizers/getting-started
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-customizers/index.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 7.1
sidebar_class_name: saasConnectivity
keywords: ['connectivity', 'connectors', customizers]
description: Connectivity customizers can customize out of the box SaaS connectors.
slug: /saas-connectivity/customizers
slug: /connectivity/saas-connectivity/customizers
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-customizers/link.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 6
sidebar_class_name: saasConnectivity
keywords: ['connectivity', 'connectors', customizers]
description: Link connectivity customizers to sources.
slug: /saas-connectivity/customizers/linking
slug: /connectivity/saas-connectivity/customizers/linking
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-customizers/testing.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 6
sidebar_class_name: saasConnectivity
keywords: ['connectivity', 'connectors', customizers]
description: Test and debug connectors with customizers.
slug: /saas-connectivity/customizers/testing
slug: /connectivity/saas-connectivity/customizers/testing
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-customizers/upload.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 5
sidebar_class_name: saasConnectivity
keywords: ['connectivity', 'connectors', customizers]
description: Build and upload connectivity customizers.
slug: /saas-connectivity/customizers/upload
slug: /connectivity/saas-connectivity/customizers/upload
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-spec/card.md
View File

@@ -5,7 +5,7 @@ pagination_label: Card
sidebar_label: Card
keywords: ['connectivity', 'connectors','connector-spec', 'card']
description: Details on using the card item
slug: /saas-connectivity/connector-spec/card
slug: /connectivity/saas-connectivity/connector-spec/card
tags: ['Connectivity', 'Connector Spec']
---

2
docs/connectivity/saas-connectivity/connector-spec/index.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 4
sidebar_class_name: connectorSpecFile
keywords: ['connectivity', 'connectors', 'spec', 'specification']
description: The connector spec file tells IDN how the connector should interact between IDN and the custom connector. It is the glue between IDN and the connector, so understanding the different sections are key to understanding how to build a custom connectors.
slug: /saas-connectivity/connector-spec
slug: /connectivity/saas-connectivity/connector-spec
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/connector-spec/initialValue.md
View File

@@ -5,7 +5,7 @@ pagination_label: Initial Value
sidebar_label: Initial Value
keywords: ['connectivity', 'connectors','connector-spec', 'sourceConfigInitialValues']
description: How to use the sourceConfigInitialValues field
slug: /saas-connectivity/connector-spec/initial-value
slug: /connectivity/saas-connectivity/connector-spec/initial-value
tags: ['Connectivity', 'Connector Spec']
---

2
docs/connectivity/saas-connectivity/connector-spec/keyValue.md
View File

@@ -5,7 +5,7 @@ pagination_label: Key Value
sidebar_label: Key Value
keywords: ['connectivity', 'connectors','connector-spec', 'keyValue']
description: Details on using the key value item
slug: /saas-connectivity/connector-spec/key-value
slug: /connectivity/saas-connectivity/connector-spec/key-value
tags: ['Connectivity', 'Connector Spec']
---

2
docs/connectivity/saas-connectivity/connector-spec/list.md
View File

@@ -5,7 +5,7 @@ pagination_label: List
sidebar_label: List
keywords: ['connectivity', 'connectors','connector-spec', 'list']
description: Details on using the list item
slug: /saas-connectivity/connector-spec/list
slug: /connectivity/saas-connectivity/connector-spec/list
tags: ['Connectivity', 'Connector Spec']
---

2
docs/connectivity/saas-connectivity/connector-spec/radio.md
View File

@@ -5,7 +5,7 @@ pagination_label: Radio
sidebar_label: Radio
keywords: ['connectivity', 'connectors','connector-spec', 'radio']
description: Details on using the Radio item
slug: /saas-connectivity/connector-spec/radio
slug: /connectivity/saas-connectivity/connector-spec/radio
tags: ['Connectivity', 'Connector Spec']
---

2
docs/connectivity/saas-connectivity/connector-spec/select.md
View File

@@ -5,7 +5,7 @@ pagination_label: Select
sidebar_label: Select
keywords: ['connectivity', 'connectors','connector-spec', 'select']
description: Details on using the select item
slug: /saas-connectivity/connector-spec/select
slug: /connectivity/saas-connectivity/connector-spec/select
tags: ['Connectivity', 'Connector Spec']
---

2
docs/connectivity/saas-connectivity/example-connectors.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 5
sidebar_class_name: exampleConnectors
keywords: ['connectivity', 'connectors', 'example']
description: Here are a few example connectors that were built for you to download and learn from.
slug: /saas-connectivity/example-connectors
slug: /connectivity/saas-connectivity/example-connectors
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/api-calls.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 1
sidebar_class_name: apiCalls
keywords: ['connectivity', 'connectors', 'api calls']
description: Calling API endpoints sequentially for hundreds or thousands of accounts is slow. If several API calls are required to build a user’s account, then it is recommended that you use asynchronous functions to speed up this task.
slug: /saas-connectivity/in-depth/api-calls
slug: /connectivity/saas-connectivity/in-depth/api-calls
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/cli-advanced.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 1
sidebar_class_name: cliAdvanced
keywords: ['connectivity', 'connectors', 'cli']
description: Using the CLI to properly test and debug your connector in IdentityNow
slug: /saas-connectivity/in-depth/cli-advanced
slug: /connectivity/saas-connectivity/in-depth/cli-advanced
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/connector-timeouts.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 1.2
sidebar_class_name: connectorTimeouts
keywords: ['connectivity', 'connectors', 'timeout']
description: IdentityNow will throw an error if your connector does not send a response in 3 minutes. For connector commands that might take longer than 3 minutes, make sure to send data at regular intervals to prevent a timeout.
slug: /saas-connectivity/in-depth/connector-timeouts
slug: /connectivity/saas-connectivity/in-depth/connector-timeouts
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/debugging.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 2
sidebar_class_name: debugging
keywords: ['connectivity', 'connectors', 'debugging']
description: An easy way to debug locally is to use console.log() to print debug information to your console.
slug: /saas-connectivity/in-depth/debugging
slug: /connectivity/saas-connectivity/in-depth/debugging
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/error-handling.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 3
sidebar_class_name: errorHandling
keywords: ['connectivity', 'connectors', 'error handling']
description: If the code fails due to validation issues, connectivity, or configuration errors, you can handle the error and provide the user with information about what went wrong.
slug: /saas-connectivity/in-depth/error-handling
slug: /connectivity/saas-connectivity/in-depth/error-handling
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/linting.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 4
sidebar_class_name: linting
keywords: ['connectivity', 'connectors', 'linting']
description: Automatically check your connector source code for programmatic and stylistic errors.
slug: /saas-connectivity/in-depth/linting
slug: /connectivity/saas-connectivity/in-depth/linting
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/logging.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 5
sidebar_class_name: logging
keywords: ['connectivity', 'connectors', 'logging']
description: You can use this feature to read the logs of your connectors.
slug: /saas-connectivity/in-depth/logging
slug: /connectivity/saas-connectivity/in-depth/logging
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/rate-limits.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 6
sidebar_class_name: handlingRateLimits
keywords: ['connectivity', 'connectors', 'rate limits']
description: Rate limiting for SaaS Connectivity.
slug: /saas-connectivity/in-depth/handling-rate-limits
slug: /connectivity/saas-connectivity/in-depth/handling-rate-limits
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/in-depth/testing.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 7
sidebar_class_name: testing
keywords: ['connectivity', 'connectors', 'testing']
description: Testing SaaS Connectivity.
slug: /saas-connectivity/in-depth/testing
slug: /connectivity/saas-connectivity/in-depth/testing
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/index.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 4
sidebar_class_name: saasConnectivity
keywords: ['connectivity', 'connectors']
description: SaaS Connectivity is a cloud based connector runtime that makes developing and deploying web service connectors easy.
slug: /saas-connectivity
slug: /connectivity/saas-connectivity
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/limits.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 6.8
sidebar_class_name: limits
keywords: ['connectivity', 'connectors', 'commands', 'cli']
description: This describes certain limits that are in place when running a SaaS Connector
slug: /saas-connectivity/limits
slug: /connectivity/saas-connectivity/limits
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/postman-collection.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 6
sidebar_class_name: postmanCollection
keywords: ['connectivity', 'connectors', 'postman']
description: Use the following Postman Collection file to run tests for each of the commands locally.
slug: /saas-connectivity/postman-collection
slug: /connectivity/saas-connectivity/postman-collection
tags: ['Connectivity', 'Postman']
---

4
docs/connectivity/saas-connectivity/prerequisites.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 1
sidebar_class_name: prerequisites
keywords: ['connectivity', 'connectors', 'prerequisites']
description: These are some prerequisites you must have before you start building SaaS Connectors.
slug: /saas-connectivity/prerequisites
slug: /connectivity/saas-connectivity/prerequisites
tags: ['Connectivity']
---
@@ -19,7 +19,7 @@ To develop a connector, Node >= 18.0.0 is required. Download node from the [node
### SailPoint CLI
SailPoint provides a CLI tool to manage the connectors' lifecycles. To install and set up the CLI, [follow the instructions here](../../../idn/tools/cli) or you can directly download and install from the [GitHub releases page](https://github.com/sailpoint-oss/sailpoint-cli/releases)
SailPoint provides a CLI tool to manage the connectors' lifecycles. To install and set up the CLI, [follow the instructions here](../../tools/cli) or you can directly download and install from the [GitHub releases page](https://github.com/sailpoint-oss/sailpoint-cli/releases)
## Recommended Software

2
docs/connectivity/saas-connectivity/test-build-deploy.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 2
sidebar_class_name: testBuildDeploy
keywords: ['connectivity', 'connectors', 'test', 'build', 'deploy']
description: As you implement command handlers, you must test them. The connector SDK provides some utility methods to locally run your connector to test, build, and deploy.
slug: /saas-connectivity/test-build-deploy
slug: /connectivity/saas-connectivity/test-build-deploy
tags: ['Connectivity']
---

2
docs/connectivity/saas-connectivity/videos.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 1.5
sidebar_class_name: videos
keywords: ['connectivity', 'connectors', 'videos']
description: Helpful videos on using SaaS connectivity
slug: /saas-connectivity/videos
slug: /connectivity/saas-connectivity/videos
tags: ['Connectivity']
---
import Video from '@site/src/components/Video';

2
docs/extensibility/configuration-management/index.mdx
View File

@@ -13,7 +13,7 @@ keywords:
'documentation',
]
description: This is the intoduction documentation regarding SailPoint's configuration management.
slug: /configuration-management
slug: /extensibility/configuration-management
tags: ['Introduction', 'Getting Started']
---

16
docs/extensibility/configuration-management/saas-configuration.mdx
View File

@@ -6,7 +6,7 @@ sidebar_position: 3
sidebar_class_name: saasConfiguration
keywords: ['configuration']
description: Use SaaS Configuration APIs to import and export configurations.
slug: /configuration-management/saas-configuration
slug: /extensibility/configuration-management/saas-configuration
tags: ['SaaS Configuration']
---
@@ -111,7 +111,7 @@ The available supported objects are also available via REST API! See List Config
**Description**
[This endpoint](https://developer.sailpoint.com/idn/api/beta/list-sp-config-objects) gets the list of object configurations known to the tenant export/import service.
[This endpoint](https://developer.sailpoint.com/docs/api/beta/list-sp-config-objects) gets the list of object configurations known to the tenant export/import service.
Object configurations containing "importUrl" and "exportUrl" are available for export/import.
<Tabs>
@@ -216,7 +216,7 @@ Content-Type: application/json
**Description**
[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config) exports selected objects from the tenant to a JSON configuration file.
[This endpoint](https://developer.sailpoint.com/docs/api/beta/export-sp-config) exports selected objects from the tenant to a JSON configuration file.
<Tabs>
<TabItem value="request" label="Request" default>
@@ -298,7 +298,7 @@ You can only use the `includedIds` and `includedNames` filters when you're expor
**Description**
[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config-job-status) gets the status of the export job identified by its `id` parameter.
[This endpoint](https://developer.sailpoint.com/docs/api/beta/export-sp-config-job-status) gets the status of the export job identified by its `id` parameter.
This request requires one of the following security scopes:
@@ -339,7 +339,7 @@ Content-Type: application/json
**Description**
[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config-download) gets the export job's resulting export file by using the requested `id` and downloads it to a file.
[This endpoint](https://developer.sailpoint.com/docs/api/beta/export-sp-config-download) gets the export job's resulting export file by using the requested `id` and downloads it to a file.
This request requires one of the following security scopes:
@@ -503,7 +503,7 @@ Content-Type: application/json
**Description**
[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config) imports objects from a JSON configuration file into a tenant.
[This endpoint](https://developer.sailpoint.com/docs/api/beta/import-sp-config) imports objects from a JSON configuration file into a tenant.
By default, every import job first exports all existing objects supported by sp-config as a backup before attempting the import.
The import job provides a backup so the configuration's import status is available for inspection or restore if needed.
You can skip the backup by setting `excludeBackup` to `true` in the import options.
@@ -559,7 +559,7 @@ Example: POST /beta/sp-config/import?preview=true
**Description**
[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config-job-status) gets the status of the import job identified by its `id` parameter.
[This endpoint](https://developer.sailpoint.com/docs/api/beta/import-sp-config-job-status) gets the status of the import job identified by its `id` parameter.
This request requires the following security scope:
@@ -600,7 +600,7 @@ Content-Type: application/json
**Description**
[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config-download) gets the import job's resulting import file by using the requested `id` and downloads the file.
[This endpoint](https://developer.sailpoint.com/docs/api/beta/import-sp-config-download) gets the import job's resulting import file by using the requested `id` and downloads the file.
The downloaded file will contain the import job's results, including any associated error, warning or informational messages.
This request requires the following security scope:

2
docs/extensibility/event-triggers/available/access-request-decision.md
View File

@@ -17,7 +17,7 @@ keywords:
'available',
]
description: Fires after an access request is approved.
slug: /event-triggers/triggers/access-request-decision
slug: /extensibility/event-triggers/triggers/access-request-decision
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/access-request-dynamic-approval.md
View File

@@ -7,7 +7,7 @@ sidebar_class_name: accessRequestDynamicApproval
keywords:
['event', 'trigger', 'access', 'request', 'dynamic', 'approval', 'available']
description: Fires after an access request is submitted.
slug: /event-triggers/triggers/access-request-dynamic-approval
slug: /extensibility/event-triggers/triggers/access-request-dynamic-approval
tags: ['Event Triggers', 'Available Event Triggers', 'Request Response']
---

2
docs/extensibility/event-triggers/available/access-request-submitted.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Access Request Submitted
sidebar_class_name: accessRequestSubmitted
keywords: ['event', 'trigger', 'access', 'request', 'submitted', 'preapproval', 'available']
description: Fires after an access request is submitted.
slug: /event-triggers/triggers/access-request-submitted
slug: /extensibility/event-triggers/triggers/access-request-submitted
tags: ['Event Triggers', 'Available Event Triggers', 'Request Response']
---

2
docs/extensibility/event-triggers/available/account-aggregation-completed.md
View File

@@ -7,7 +7,7 @@ sidebar_class_name: accountAggregationCompleted
keywords:
['event', 'trigger', 'account', 'aggregation', 'completed', 'available']
description: Fires after an account aggregation completed, terminated, or failed.
slug: /event-triggers/triggers/account-aggregation-completed
slug: /extensibility/event-triggers/triggers/account-aggregation-completed
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/campaign-activated.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Campaign Activated
sidebar_class_name: campaignActivated
keywords: ['event', 'trigger', 'campaign', 'activated', 'available']
description: Triggered when a campaign is activated.
slug: /event-triggers/triggers/campaign-activated
slug: /extensibility/event-triggers/triggers/campaign-activated
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/campaign-ended.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Campaign Ended
sidebar_class_name: campaignEnded
keywords: ['event', 'trigger', 'campaign', 'ended', 'available']
description: Triggered when a campaign is ended.
slug: /event-triggers/triggers/campaign-ended
slug: /extensibility/event-triggers/triggers/campaign-ended
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/campaign-generated.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Campaign Generated
sidebar_class_name: campaignGenerated
keywords: ['event', 'trigger', 'campaign', 'generated', 'available']
description: Triggered when a campaign finishes generating.
slug: /event-triggers/triggers/campaign-generated
slug: /extensibility/event-triggers/triggers/campaign-generated
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/certification-signed-off.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Certification Signed Off
sidebar_class_name: certificationSignedOff
keywords: ['event', 'trigger', 'certification', 'available']
description: Triggered when a certification is signed off by its reviewer.
slug: /event-triggers/triggers/certification-signed-off
slug: /extensibility/event-triggers/triggers/certification-signed-off
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/form-submitted.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Form Submitted
sidebar_class_name: formSubmitted
keywords: ['event', 'trigger', 'form', 'submitted', 'available']
description: Triggered when a form is submitted.
slug: /event-triggers/triggers/form-submitted
slug: /extensibility/event-triggers/triggers/form-submitted
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/identity-attribute-changed.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Identity Attributes Changed
sidebar_class_name: identityAttributesChanged
keywords: ['event', 'trigger', 'identity', 'attributes', 'changed', 'available']
description: Fires after one or more identity attributes changed.
slug: /event-triggers/triggers/identity-attribute-changed
slug: /extensibility/event-triggers/triggers/identity-attribute-changed
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/identity-created.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Identity Created
sidebar_class_name: identityCreated
keywords: ['event', 'trigger', 'identity', 'created', 'available']
description: Fires after an identity is created.
slug: /event-triggers/triggers/identity-created
slug: /extensibility/event-triggers/triggers/identity-created
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/index.mdx
View File

@@ -7,7 +7,7 @@ sidebar_class_name: availableEventTriggers
keywords: ['event', 'trigger', 'available']
description: Event triggers that are generally available.
sidebar_position: 7
slug: /event-triggers/available
slug: /extensibility/event-triggers/available
tags: ['Event Triggers', 'Available Event Triggers']
---

4
docs/extensibility/event-triggers/available/native-change-account-created.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Native Change Account Created
sidebar_class_name: nativeChangeAccountCreated
keywords: ['account', 'created', 'available']
description: Fires after Account Aggregations detects that a new account is created external to Identity Security Platform on sources
slug: /event-triggers/triggers/native-change-account-created
slug: /extensibility/event-triggers/triggers/native-change-account-created
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---
@@ -16,7 +16,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
You must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger. There are two ways you can configure a source for NCD:
1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/idn/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD.
1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD.
2. Configure the NCD options on the source in the source configuration UI.
:::

4
docs/extensibility/event-triggers/available/native-change-account-deleted.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Native Change Account Deleted
sidebar_class_name: nativeChangeAccountDeleted
keywords: ['account', 'deleted', 'available']
description: Fires after Account Aggregations detects that an account is deleted external to Identity Security Platform on sources
slug: /event-triggers/triggers/native-change-account-deleted
slug: /extensibility/event-triggers/triggers/native-change-account-deleted
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---
@@ -16,7 +16,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
You must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger. There are two ways you can configure a source for NCD:
1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/idn/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD.
1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD.
2. Configure the NCD options on the source in the source configuration UI.
:::

4
docs/extensibility/event-triggers/available/native-change-account-updated.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Native Change Account Updated
sidebar_class_name: nativeChangeAccountUpdated
keywords: ['account', 'updated', 'available']
description: Fires after an account is updated outside of Identity Security Platform
slug: /event-triggers/triggers/native-change-account-updated
slug: /extensibility/event-triggers/triggers/native-change-account-updated
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---
@@ -16,7 +16,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
You must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger. There are two ways you can configure a source for NCD:
1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/idn/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD.
1. Invoke the [update native change detection configuration](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) for each source you want to receive events for NCD.
2. Configure the NCD options on the source in the source configuration UI.
:::

2
docs/extensibility/event-triggers/available/outlier-detected.md
View File

@@ -7,7 +7,7 @@ sidebar_class_name: outlierDetected
keywords:
['event', 'trigger', 'outlier', 'detected']
description: Fires after an identity was detected as an outlier.
slug: /event-triggers/triggers/outlier-detected
slug: /extensibility/event-triggers/triggers/outlier-detected
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/provisioning-completed.md
View File

@@ -7,7 +7,7 @@ sidebar_class_name: provisioningCompleted
keywords:
['event', 'trigger', 'provisioning', 'action', 'completed', 'available']
description: Fires after a provisioning action completed on a source.
slug: /event-triggers/triggers/provisioning-completed
slug: /extensibility/event-triggers/triggers/provisioning-completed
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

4
docs/extensibility/event-triggers/available/scheduled-search.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Scheduled Search
sidebar_class_name: scheduledSearch
keywords: ['event', 'trigger', 'saved', 'scheduled', 'search', 'complete', 'available']
description: Fires after a scheduled search completes.
slug: /event-triggers/triggers/scheduled-search
slug: /extensibility/event-triggers/triggers/scheduled-search
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---
@@ -16,7 +16,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
Users can subscribe to saved searches and receive an email of a report generated from the saved search. For example, a user can save a search query called "Identities with upcoming end dates" and create a subscription to receive a daily report showing identities with an end date within 10 days from the current date. This event trigger can also notify an external HTTP application that a report generated from a saved search subscription is available to be processed.
'Scheduled search' events occur based on the schedules set for saved search subscriptions. For example, if you have a scheduled saved search for Monday, Tuesday, Wednesday, Thursday, Friday at 6:00 GMT, your HTTP endpoint will also receive a notification at those times. This can be set using the `schedule` object in the [create scheduled search endpoint](/idn/api/v3/create-scheduled-search).
'Scheduled search' events occur based on the schedules set for saved search subscriptions. For example, if you have a scheduled saved search for Monday, Tuesday, Wednesday, Thursday, Friday at 6:00 GMT, your HTTP endpoint will also receive a notification at those times. This can be set using the `schedule` object in the [create scheduled search endpoint](/docs/api/v3/create-scheduled-search).
To receive this event when a saved search query does not have any results, set `emailEmptyResults` to `TRUE`. You can also set the expiration date in the `expiration` field within the `schedule` object. Your HTTP endpoint will stop receiving these events when the scheduled search expires.

2
docs/extensibility/event-triggers/available/source-created.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Source Created
sidebar_class_name: sourceCreated
keywords: ['event', 'trigger', 'source', 'created', 'available']
description: Fires after a source is created.
slug: /event-triggers/triggers/source-created
slug: /extensibility/event-triggers/triggers/source-created
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/source-deleted.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Source Deleted
sidebar_class_name: sourceDeleted
keywords: ['event', 'trigger', 'source', 'deleted', 'available']
description: Fires after a source is deleted.
slug: /event-triggers/triggers/source-deleted
slug: /extensibility/event-triggers/triggers/source-deleted
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/source-updated.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Source Updated
sidebar_class_name: sourceUpdated
keywords: ['event', 'trigger', 'source', 'updated', 'available']
description: Fires after a source is updated.
slug: /event-triggers/triggers/source-updated
slug: /extensibility/event-triggers/triggers/source-updated
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/available/va-cluster-status-change.md
View File

@@ -6,7 +6,7 @@ sidebar_label: VA Cluster Status Change
sidebar_class_name: vaClusterStatusChange
keywords: ['event', 'trigger', 'va', 'cluster', 'status', 'change', 'available']
description: Fires after the status of a VA cluster has changed.
slug: /event-triggers/triggers/va-cluster-status-change
slug: /extensibility/event-triggers/triggers/va-cluster-status-change
tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/early-access/identity-deleted.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Identity Deleted
sidebar_class_name: identityDeleted
keywords: ['event', 'trigger', 'identity', 'deleted', 'early access']
description: Fires after an identity is deleted.
slug: /event-triggers/triggers/identity-deleted
slug: /extensibility/event-triggers/triggers/identity-deleted
tags: ['Event Triggers', 'Early Access Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/early-access/index.mdx
View File

@@ -7,7 +7,7 @@ sidebar_class_name: earlyAccessEventTriggers
keywords: ['event', 'trigger', 'early access']
description: Event triggers that require a support ticket to enable.
sidebar_position: 8
slug: /event-triggers/early-access
slug: /extensibility/event-triggers/early-access
tags: ['Event Triggers', 'Early Access Event Triggers']
---

2
docs/extensibility/event-triggers/early-access/source-account-created.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Source Account Created
sidebar_class_name: sourceAccountCreated
keywords: ['event', 'trigger', 'source', 'account', 'created', 'early access']
description: Fires after a source account is created.
slug: /event-triggers/triggers/source-account-created
slug: /extensibility/event-triggers/triggers/source-account-created
tags: ['Event Triggers', 'Early Access Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/early-access/source-account-deleted.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Source Account Deleted
sidebar_class_name: sourceAccountDeleted
keywords: ['event', 'trigger', 'source', 'account', 'deleted', 'early access']
description: Fires after a source account is deleted.
slug: /event-triggers/triggers/source-account-deleted
slug: /extensibility/event-triggers/triggers/source-account-deleted
tags: ['Event Triggers', 'Early Access Event Triggers', 'Fire and Forget']
---

2
docs/extensibility/event-triggers/early-access/source-account-updated.md
View File

@@ -6,7 +6,7 @@ sidebar_label: Source Account Updated
sidebar_class_name: sourceAccountUpdated
keywords: ['event', 'trigger', 'source', 'account', 'updated', 'early access']
description: Fires after a source account is updated.
slug: /event-triggers/triggers/source-account-updated
slug: /extensibility/event-triggers/triggers/source-account-updated
tags: ['Event Triggers', 'Early Access Event Triggers', 'Fire and Forget']
---

8
docs/extensibility/event-triggers/filtering-events.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 4
sidebar_class_name: filteringEvents
keywords: ['filtering', 'events']
description: Many triggers can produce a staggering amount of events if left unfiltered. Event filtering helps you solve this problem.
slug: /event-triggers/filtering-events
slug: /extensibility/event-triggers/filtering-events
tags: ['Event Triggers']
---
@@ -81,7 +81,7 @@ Developing a filter can be faster when you use a tool like an online [JSONpath e
![JSONPath editor](./img/jsonpath-editor.png)
Most of the examples provided in the operator tables above can be used against the Identity Attributes Changed event trigger input, as seen below. You can find all of the input/output schemas for the other available triggers in our [API specification](/idn/api/beta/triggers#available-event-triggers).
Most of the examples provided in the operator tables above can be used against the Identity Attributes Changed event trigger input, as seen below. You can find all of the input/output schemas for the other available triggers in our [API specification](/docs/api/beta/triggers#available-event-triggers).
```json
{
@@ -130,7 +130,7 @@ To validate a filter using the UI, subscribe to a new event trigger or edit an e
### Validating Filters Using the API
You can validate a trigger filter by using the [test filter](/idn/api/beta/test-subscription-filter) API endpoint. You must escape any double quotes, as seen in the example payload in the API description. Also, you must provide a sample input for the validation engine to run against. It is best to use the input example included in the input/output schemas for the event trigger you want to apply your filter to. Refer to [this table](/idn/api/beta/triggers#available-event-triggers) to find the schema of your event trigger. This is an example request:
You can validate a trigger filter by using the [test filter](/docs/api/beta/test-subscription-filter) API endpoint. You must escape any double quotes, as seen in the example payload in the API description. Also, you must provide a sample input for the validation engine to run against. It is best to use the input example included in the input/output schemas for the event trigger you want to apply your filter to. Refer to [this table](/docs/api/beta/triggers#available-event-triggers) to find the schema of your event trigger. This is an example request:
```text
POST https://{tenant}.api.identitynow.com/beta/trigger-subscriptions/validate-filter
@@ -182,4 +182,4 @@ If SailPoint accepts your trigger filter, you must test whether it actually work
Once you fire off a test event, monitor your webhook.site webpage for an incoming event. If the filter matches the test input, you will an event come in. If the filter does not match the input, then it will nott fire. Test both scenarios to make sure your filter is not always evaluating to `true`, and that it will indeed evaluate to `false` under the correct circumstances. For example, the filter `$[?($.identity.name contains "john")]` will match the test event for Identity Attributes Changed and you will see an event in webhook.site, but you also want to make sure that `$[?($.identity.name contains "archer")]` doesn't fire because the test input is always the same.
If you want to control the test input to validate your filter against a more robust set of data, use the [test invocation](/idn/api/beta/start-test-trigger-invocation) API endpoint.
If you want to control the test input to validate your filter against a more robust set of data, use the [test invocation](/docs/api/beta/start-test-trigger-invocation) API endpoint.

2
docs/extensibility/event-triggers/index.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 3
sidebar_class_name: eventTriggers
keywords: ['event', 'triggers', 'webhooks']
description: The result of any action performed in a service is called an event. Services like IdentityNow constantly generate events like an update to a setting or the completion of an account aggregation.
slug: /event-triggers
slug: /extensibility/event-triggers
tags: ['Event Triggers']
---

2
docs/extensibility/event-triggers/preparing-a-subscriber-service.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 2
sidebar_class_name: preparingSubscriberService
keywords: ['event', 'triggers', 'subscriber']
description: Before you can subscribe to an event trigger, you must prepare a service that can accept incoming HTTP requests from the event trigger service.
slug: /event-triggers/preparing-subscriber-service
slug: /extensibility/event-triggers/preparing-subscriber-service
tags: ['Event Triggers']
---

4
docs/extensibility/event-triggers/responding-to-a-request-response-trigger.mdx
View File

@@ -7,7 +7,7 @@ sidebar_position: 6
sidebar_class_name: respondingResponseRequiredTriggers
keywords: ['event', 'trigger', 'request_response']
description: Specify how your application interacts with response required type trigger services.
slug: /event-triggers/responding-request-response-trigger
slug: /extensibility/event-triggers/responding-request-response-trigger
tags: ['Event Triggers']
---
@@ -190,4 +190,4 @@ POST `https://{tenant}.api.identitynow.com/beta/trigger-invocations/e9103ca9-02c
## Trigger invocation status
To check the status of a particular trigger invocation, you can use the [list invocation statuses](/idn/api/beta/list-trigger-invocation-status) endpoint. The status endpoint works for both `REQUEST_RESPONSE` and `FIRE_AND_FORGET` triggers. However, the status of `FIRE_AND_FORGET` trigger invocations will contain null values in their `completeInvocationInput` since `FIRE_AND_FORGET` triggers don't need a response to complete.
To check the status of a particular trigger invocation, you can use the [list invocation statuses](/docs/api/beta/list-trigger-invocation-status) endpoint. The status endpoint works for both `REQUEST_RESPONSE` and `FIRE_AND_FORGET` triggers. However, the status of `FIRE_AND_FORGET` trigger invocations will contain null values in their `completeInvocationInput` since `FIRE_AND_FORGET` triggers don't need a response to complete.

Some files were not shown because too many files have changed in this diff Show More