diff --git a/docs/api/api-specifications.md b/docs/api/api-specifications.md index f3759c98c28..c45a51a7394 100644 --- a/docs/api/api-specifications.md +++ b/docs/api/api-specifications.md @@ -28,4 +28,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the ISC APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/tags/c/isc/6/apis). --> +To learn more about the ISC APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). --> diff --git a/docs/api/api-versioning-strategy.md b/docs/api/api-versioning-strategy.md index 77e645ebbb0..a1523f0010b 100644 --- a/docs/api/api-versioning-strategy.md +++ b/docs/api/api-versioning-strategy.md @@ -106,7 +106,7 @@ Individual APIs may be deprecated at anytime. The term “deprecation” means t ### Announcements -Communications will be sent out to notify impacted users of any deprecations. These communications may appear in the Admin page of the Identity Security Cloud UI, in the [Announcements](https://developer.sailpoint.com/discuss/c/announcements/14) category, in Compass, or in newsletters or emails. +Communications will be sent out to notify impacted users of any deprecations. These communications may appear in the Admin page of the Identity Security Cloud UI, in the [Announcements](https://platform.sailpoint.com) category, in Compass, or in newsletters or emails. ### API specification diff --git a/docs/api/authentication.md b/docs/api/authentication.md index 42e0955a399..ce2685e375b 100644 --- a/docs/api/authentication.md +++ b/docs/api/authentication.md @@ -132,7 +132,7 @@ There are several different authorization flows that OAuth 2.0 supports, and eac 2. [**Authorization Code**](https://oauth.net/2/grant-types/authorization-code/) - Clients use this grant type to exchange an authorization code for an `access_token`. Authorization codes are mainly used by web applications because there is a login into ISC with a subsequent redirect back to the web application/client. 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 can only be 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/docs/api/beta/list-access-profiles): +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://platform.sailpoint.com/docs/api/beta/list-access-profiles): ![Authorization Dropdown](./img/authorization/authorization-dropdown.png) @@ -285,7 +285,7 @@ POST https://[tenant].api.identitynow.com/oauth/token?grant_type=authorization_c :::info -The token endpoint URL is `[tenant].api.identitynow.com`, and the authorize URL is `[tenant].login.sailpoint.com`. Please be sure to use the correct URL when you're setting up your webapp to use this flow. You can read more about [finding your tenant OAuth details here](https://developer.sailpoint.com/docs/api/authentication/#find-your-tenants-oauth-details). +The token endpoint URL is `[tenant].api.identitynow.com`, and the authorize URL is `[tenant].login.sailpoint.com`. Please be sure to use the correct URL when you're setting up your webapp to use this flow. You can read more about [finding your tenant OAuth details here](https://platform.sailpoint.com/docs/api/authentication/#find-your-tenants-oauth-details). ::: diff --git a/docs/api/authorization.md b/docs/api/authorization.md index 84f157d235e..2d2a2dae129 100644 --- a/docs/api/authorization.md +++ b/docs/api/authorization.md @@ -44,7 +44,7 @@ sequenceDiagram When managing a user's access to the API, you must first assign the target user an appropriate [user level](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html). It is important to choose the correct user level as it will place a boundary on which APIs a user can call, which also affects the areas and functions of the UI they have access to. For example, if a user is in charge of creating reports for auditing requirements, consider granting them the "Report Admin" user level. -User levels are typically granted through the UI, [following the procedures from this document](https://documentation.sailpoint.com/saas/help/accounts/identities.html#setting-user-level-permissions). You can also set user levels via API using the [auth user update](https://developer.sailpoint.com/docs/api/v3/patch-auth-user) endpoint. +User levels are typically granted through the UI, [following the procedures from this document](https://documentation.sailpoint.com/saas/help/accounts/identities.html#setting-user-level-permissions). You can also set user levels via API using the [auth user update](https://platform.sailpoint.com/docs/api/v3/patch-auth-user) endpoint. User levels act as the first line of defense by applying a rigid boundary around the APIs that a user can call. The next section introduces scopes, which allow users to apply granular controls on the APIs an access token can call. @@ -55,7 +55,7 @@ Scopes are granular permissions you can add to personal access tokens (PATs) to Scopes contain one or more rights, which are low level permissions that grant access to individual endpoints. This means that a single scope, like `idn:access-request:manage`, can grant access to multiple API endpoints. To determine which scopes a PAT needs, you must first identify which endpoints the PAT needs to invoke. Each endpoint's API specification indicates which scope is necessary to call the endpoint. You can use this approach to curate a list of scopes that must be applied to the credential to call the necessary endpoints. [Learn more about how to find an API's required scopes here](#identifying-necessary-authorization-for-an-endpoint). -By default, each PAT has the scope `sp:scopes:default`, which is the least privileged scope. It 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). Access to the endpoint may still be determined by the user's [user level](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html). +By default, each PAT has the scope `sp:scopes:default`, which is the least privileged scope. It only grants access to endpoints that require no authorization at all, such as [List Public Identities](https://platform.sailpoint.com/idn/api/v3/get-public-identities). Access to the endpoint may still be determined by the user's [user level](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html). Alternatively, `sp:scopes:all` 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. @@ -72,7 +72,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/docs/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://platform.sailpoint.com/docs/api/beta/list-access-profiles) endpoint. ![Authorization Dropdown](./img/authorization/authorization-dropdown.png) @@ -94,7 +94,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/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. +You can [create PATs](https://platform.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` diff --git a/docs/api/getting-started.md b/docs/api/getting-started.md index f9ac44ab900..294859cd61a 100644 --- a/docs/api/getting-started.md +++ b/docs/api/getting-started.md @@ -73,4 +73,4 @@ There is a rate limit of 100 requests per `access_token` per 10 seconds for V3 A ## API Tools -There are several API tools that make exploring and testing APIs easier than using the command line or a programming language. One tool is [Postman](https://www.postman.com/downloads/). SailPoint provides an official Postman workspace where our collections are always up to date with the latest API changes. [Click here](https://developer.sailpoint.com/discuss/t/official-identitynow-postman-workspace/6153) to get started with our Postman workspace. +There are several API tools that make exploring and testing APIs easier than using the command line or a programming language. One tool is [Postman](https://www.postman.com/downloads/). SailPoint provides an official Postman workspace where our collections are always up to date with the latest API changes. [Click here](hhttps://platform.sailpoint.com/docs/api/postman-collections) to get started with our Postman workspace. diff --git a/docs/api/identity-security-cloud.md b/docs/api/identity-security-cloud.md index 0824eaecdb6..0ffd068d89b 100644 --- a/docs/api/identity-security-cloud.md +++ b/docs/api/identity-security-cloud.md @@ -26,4 +26,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the ISC APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/tags/c/isc/6/apis). --> +To learn more about the ISC APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). --> diff --git a/docs/api/nerm/getting-started.md b/docs/api/nerm/getting-started.md index 9d0445681f1..90358ff3818 100644 --- a/docs/api/nerm/getting-started.md +++ b/docs/api/nerm/getting-started.md @@ -21,4 +21,4 @@ To authenticate you will need to generate a token. That can be done by following ## API Tools -There are several API tools that make exploring and testing APIs easier than using the command line or a programming language. One tool is [Postman](https://www.postman.com/downloads/). SailPoint provides an official Postman workspace where our collections are always up to date with the latest API changes. NERM endpoints will be added soon, so be sure to check back often. [Click here](https://developer.sailpoint.com/discuss/t/official-identitynow-postman-workspace/6153) to get started with our Postman workspace. +There are several API tools that make exploring and testing APIs easier than using the command line or a programming language. One tool is [Postman](https://www.postman.com/downloads/). SailPoint provides an official Postman workspace where our collections are always up to date with the latest API changes. NERM endpoints will be added soon, so be sure to check back often. [Click here](https://platform.sailpoint.com/docs/api/postman-collections) to get started with our Postman workspace. diff --git a/docs/api/nerm/pagination-metadata-filtering.md b/docs/api/nerm/pagination-metadata-filtering.md index f44a87a1c1d..6dac4a8bde3 100644 --- a/docs/api/nerm/pagination-metadata-filtering.md +++ b/docs/api/nerm/pagination-metadata-filtering.md @@ -67,7 +67,7 @@ Example: ## Advanced Profile Filtering -More advanced filtering can be performed on **profiles** by using the [Advanced Search Endpoint](https://developer.sailpoint.com/nerm/api). +More advanced filtering can be performed on **profiles** by using the [Advanced Search Endpoint](https://platform.sailpoint.com/nerm/api). For example, if you wanted to find all profiles where the **personal_first_name** started with the letter "a", you would first need to find the **id** of the **personal_first_name** attribute, and provide a JSON body like so: diff --git a/docs/api/non-employee.md b/docs/api/non-employee.md index a5d9cff97e0..d35ad42ce7e 100644 --- a/docs/api/non-employee.md +++ b/docs/api/non-employee.md @@ -28,4 +28,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the NERM APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/tag/nerm). +To learn more about the NERM APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/api/patch-requests.md b/docs/api/patch-requests.md index b7f1806303b..b756d22e527 100644 --- a/docs/api/patch-requests.md +++ b/docs/api/patch-requests.md @@ -14,9 +14,9 @@ tags: ['patch', 'guide'] You can use the Identity Security Cloud 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/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 **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://platform.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 `identityId` attribute, you could use the [Patch Account](https://developer.sailpoint.com/docs/api/v3/update-account) endpoint to replace his existing `identityId` 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 `identityId` attribute, you could use the [Patch Account](https://platform.sailpoint.com/docs/api/v3/update-account) endpoint to replace his existing `identityId` 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 Identity Security Cloud 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 Identity Security Cloud 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. +For example, account IDs aren't avilable in the Identity Security Cloud UI. If you want to use the [Patch Account](https://platform.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/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. +You can use the [List Accounts](https://platform.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/docs/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://platform.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: @@ -166,7 +166,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/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. +You can find this example in the [Patch Source](https://platform.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. @@ -222,7 +222,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/docs/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://platform.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 [ @@ -250,7 +250,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/docs/api/v3/update-source) endpoint to remove an existing filter string from a source's connector: +This example uses the [Patch Source](https://platform.sailpoint.com/docs/api/v3/update-source) endpoint to remove an existing filter string from a source's connector: ```json [ @@ -267,7 +267,7 @@ Because there is only one value for the path, the request removes that value. 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/docs/api/v3/update-source) endpoint to remove the first feature from a source's list of features. +This example uses the [Patch Source](https://platform.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". @@ -286,7 +286,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/docs/api/v3/update-source) endpoint to replace a source's existing features with new ones: +This example uses the [Patch Source](https://platform.sailpoint.com/docs/api/v3/update-source) endpoint to replace a source's existing features with new ones: ```json [ @@ -298,7 +298,7 @@ This example uses the [Patch Source](https://developer.sailpoint.com/docs/api/v3 ] ``` -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: +You can also replace a value within an array. This example uses the [Patch Source](https://platform.sailpoint.com/docs/api/v3/update-source) endpoint to replace the first value in the array with the specified value: ```json [ @@ -316,7 +316,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/docs/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://platform.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 [ @@ -332,7 +332,7 @@ This example uses the [Patch Source Schema](https://developer.sailpoint.com/docs 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/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: +This example uses the [Patch Source Schema](https://platform.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 [ @@ -350,7 +350,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/docs/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://platform.sailpoint.com/docs/api/v3/update-source) endpoint to test a source's existing features to make sure they match the specified values.: ```json [ @@ -425,7 +425,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/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. +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://platform.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: @@ -581,7 +581,7 @@ PATCH https://{tenant}.api.identitynow.com//v3/sources/:sourceId/schemas/:schema ] ``` -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 request uses the [PATCH Source Schema](https://platform.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. @@ -591,7 +591,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/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: +This example request uses the [PATCH Source schema](https://platform.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 @@ -625,4 +625,4 @@ When the request is successful, the API will return the updated resource. Now you can use PATCH requests partially update resources. For more information about PATCH requests, refer to this [documentation](https://datatracker.ietf.org/doc/html/rfc6902). For more information about the Identity Security Cloud PATCH endpoints and which paths can be changed for each one, refer to their API specifications. -Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://platform.sailpoint.com! diff --git a/docs/api/postman-collections.md b/docs/api/postman-collections.md index c3a33cb8dea..12a43b38226 100644 --- a/docs/api/postman-collections.md +++ b/docs/api/postman-collections.md @@ -60,6 +60,6 @@ Once you have configured your environment, you can start using Postman with all :::tip -Anything you want to change about the Postman collection? We love feedback! Discuss the Postman collection [here](https://developer.sailpoint.com/discuss/t/official-identitynow-postman-workspace/6153). +Anything you want to change about the Postman collection? We love feedback! Discuss the Postman collection [here](https://platform.sailpoint.com). ::: diff --git a/docs/api/standard-collection-parameters.md b/docs/api/standard-collection-parameters.md index 70ecab956bc..91abfd906be 100644 --- a/docs/api/standard-collection-parameters.md +++ b/docs/api/standard-collection-parameters.md @@ -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/docs/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://platform.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/docs/api/v3/search) in Identity Security Cloud 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://platform.sailpoint.com/docs/api/v3/search) in Identity Security Cloud 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. diff --git a/docs/connectivity.md b/docs/connectivity.md index 0c1fdc37f5a..3adc3ecedee 100644 --- a/docs/connectivity.md +++ b/docs/connectivity.md @@ -26,4 +26,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about ISC connectivity and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about ISC connectivity and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-list.md b/docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-list.md index 4e374c53871..86d7a1a438d 100644 --- a/docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-list.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/account-list.md @@ -41,4 +41,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/docs/extensibility/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://platform.sailpoint.com/docs/extensibility/transforms/). diff --git a/docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/entitlement-list.md b/docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/entitlement-list.md index b7075394937..fa8b2e3f1d8 100644 --- a/docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/entitlement-list.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/customizer-commands/entitlement-list.md @@ -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/docs/extensibility/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://platform.sailpoint.com/docs/extensibility/transforms/). diff --git a/docs/extensibility.md b/docs/extensibility.md index 56914f222a1..ec95fcab87e 100644 --- a/docs/extensibility.md +++ b/docs/extensibility.md @@ -26,4 +26,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about ISC extensibility and discuss the different extensibility options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about ISC extensibility and discuss the different extensibility options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/extensibility/configuration-management/configuration-hub.md b/docs/extensibility/configuration-management/configuration-hub.md index 7160fbfc8a0..f252d1e0baa 100644 --- a/docs/extensibility/configuration-management/configuration-hub.md +++ b/docs/extensibility/configuration-management/configuration-hub.md @@ -20,4 +20,4 @@ To learn more about Configuration Hub, refer to the [Configuration Hub documenta The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the SaiLPoint Configuration Hub and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about the SaiLPoint Configuration Hub and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/extensibility/configuration-management/index.mdx b/docs/extensibility/configuration-management/index.mdx index fd5a56276b1..3d21161d77a 100644 --- a/docs/extensibility/configuration-management/index.mdx +++ b/docs/extensibility/configuration-management/index.mdx @@ -33,4 +33,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about ISC configuration management and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about ISC configuration management and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/extensibility/configuration-management/saas-configuration.mdx b/docs/extensibility/configuration-management/saas-configuration.mdx index 2d656c4cc41..6a913045318 100644 --- a/docs/extensibility/configuration-management/saas-configuration.mdx +++ b/docs/extensibility/configuration-management/saas-configuration.mdx @@ -128,7 +128,7 @@ Source passwords, secret token or other sensitive data is not exported. Those ne **Description** -[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. +[This endpoint](https://platform.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. @@ -233,7 +233,7 @@ Content-Type: application/json **Description** -[This endpoint](https://developer.sailpoint.com/docs/api/beta/export-sp-config) exports selected objects from the tenant to a JSON configuration file. +[This endpoint](https://platform.sailpoint.com/docs/api/beta/export-sp-config) exports selected objects from the tenant to a JSON configuration file. @@ -315,7 +315,7 @@ You can only use the `includedIds` and `includedNames` filters when you're expor **Description** -[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 endpoint](https://platform.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: @@ -356,7 +356,7 @@ Content-Type: application/json **Description** -[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 endpoint](https://platform.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: @@ -520,7 +520,7 @@ Content-Type: application/json **Description** -[This endpoint](https://developer.sailpoint.com/docs/api/beta/import-sp-config) imports objects from a JSON configuration file into a tenant. +[This endpoint](https://platform.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. @@ -576,7 +576,7 @@ Example: POST /beta/sp-config/import?preview=true **Description** -[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 endpoint](https://platform.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: @@ -617,7 +617,7 @@ Content-Type: application/json **Description** -[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. +[This endpoint](https://platform.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: diff --git a/docs/extensibility/event-triggers/available/access-request-decision.md b/docs/extensibility/event-triggers/available/access-request-decision.md index 901ac153b9f..61a9368ae12 100644 --- a/docs/extensibility/event-triggers/available/access-request-decision.md +++ b/docs/extensibility/event-triggers/available/access-request-decision.md @@ -86,4 +86,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/access-request-dynamic-approval.md b/docs/extensibility/event-triggers/available/access-request-dynamic-approval.md index 1fd2ee55f92..d453f90ca3c 100644 --- a/docs/extensibility/event-triggers/available/access-request-dynamic-approval.md +++ b/docs/extensibility/event-triggers/available/access-request-dynamic-approval.md @@ -38,7 +38,7 @@ This is a `REQUEST_RESPONSE` trigger type. For more information about how to res The subscribing service will receive the following input from the trigger service. - + ```json { @@ -68,7 +68,7 @@ The subscribing service will receive the following input from the trigger servic The subscribing service can use this information to make a decision about whether to add additional approvers to the access request. - + To add an identity to the approver list, the subscribing service responds to the event trigger with the following payload: @@ -103,6 +103,6 @@ If no identity or group should be added to a particular access request, then the ## Additional Information and Links - **Trigger Type**: [REQUEST_RESPONSE](../trigger-types.md#request-response) - + - [How to respond to a REQUEST_RESPONSE trigger](../responding-to-a-request-response-trigger.mdx) diff --git a/docs/extensibility/event-triggers/available/access-request-submitted.md b/docs/extensibility/event-triggers/available/access-request-submitted.md index fc73881c0b0..0797380d1ef 100644 --- a/docs/extensibility/event-triggers/available/access-request-submitted.md +++ b/docs/extensibility/event-triggers/available/access-request-submitted.md @@ -44,7 +44,7 @@ This is a `REQUEST_RESPONSE` trigger type. For more information about how to res The subscribing service will receive the following input from the trigger service. - + ```json { @@ -74,7 +74,7 @@ The subscribing service will receive the following input from the trigger servic The subscribing service can use this information to make a decision about whether to approve or deny the request. - + To approve an access request, the subscribing service responds to the event trigger with the following payload: @@ -113,6 +113,6 @@ If you see numerous access requests failing at this stage, verify that your subs ## Additional Information and Links - **Trigger Type**: [REQUEST_RESPONSE](../trigger-types.md#request-response) - + - [How to respond to a REQUEST_RESPONSE trigger](../responding-to-a-request-response-trigger.mdx) diff --git a/docs/extensibility/event-triggers/available/account-aggregation-completed.md b/docs/extensibility/event-triggers/available/account-aggregation-completed.md index 1451fbca779..a5f312a583a 100644 --- a/docs/extensibility/event-triggers/available/account-aggregation-completed.md +++ b/docs/extensibility/event-triggers/available/account-aggregation-completed.md @@ -76,4 +76,4 @@ The status of the aggregation can be one of two possible values: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/identity-attribute-changed.md b/docs/extensibility/event-triggers/available/identity-attribute-changed.md index c91036bebad..440abcc6b15 100644 --- a/docs/extensibility/event-triggers/available/identity-attribute-changed.md +++ b/docs/extensibility/event-triggers/available/identity-attribute-changed.md @@ -52,4 +52,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/identity-created.md b/docs/extensibility/event-triggers/available/identity-created.md index 678f7648485..989365de74d 100644 --- a/docs/extensibility/event-triggers/available/identity-created.md +++ b/docs/extensibility/event-triggers/available/identity-created.md @@ -41,4 +41,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/native-change-account-created.md b/docs/extensibility/event-triggers/available/native-change-account-created.md index 477693e53bd..15fb08e88b3 100644 --- a/docs/extensibility/event-triggers/available/native-change-account-created.md +++ b/docs/extensibility/event-triggers/available/native-change-account-created.md @@ -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/docs/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://platform.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. ::: diff --git a/docs/extensibility/event-triggers/available/native-change-account-deleted.md b/docs/extensibility/event-triggers/available/native-change-account-deleted.md index 18de61d9c21..972281705ee 100644 --- a/docs/extensibility/event-triggers/available/native-change-account-deleted.md +++ b/docs/extensibility/event-triggers/available/native-change-account-deleted.md @@ -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/docs/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://platform.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. ::: diff --git a/docs/extensibility/event-triggers/available/native-change-account-updated.md b/docs/extensibility/event-triggers/available/native-change-account-updated.md index 8281fb58676..ecfb84dd1d5 100644 --- a/docs/extensibility/event-triggers/available/native-change-account-updated.md +++ b/docs/extensibility/event-triggers/available/native-change-account-updated.md @@ -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/docs/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://platform.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. ::: diff --git a/docs/extensibility/event-triggers/available/provisioning-completed.md b/docs/extensibility/event-triggers/available/provisioning-completed.md index ca274ef0245..d03f71fd105 100644 --- a/docs/extensibility/event-triggers/available/provisioning-completed.md +++ b/docs/extensibility/event-triggers/available/provisioning-completed.md @@ -158,4 +158,4 @@ For password management setup, you must configure the following: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/scheduled-search.md b/docs/extensibility/event-triggers/available/scheduled-search.md index a84dde0ac51..e3d382df271 100644 --- a/docs/extensibility/event-triggers/available/scheduled-search.md +++ b/docs/extensibility/event-triggers/available/scheduled-search.md @@ -59,4 +59,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/source-created.md b/docs/extensibility/event-triggers/available/source-created.md index 938003fae81..63bc93743ac 100644 --- a/docs/extensibility/event-triggers/available/source-created.md +++ b/docs/extensibility/event-triggers/available/source-created.md @@ -37,4 +37,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/source-deleted.md b/docs/extensibility/event-triggers/available/source-deleted.md index 87ecdd89203..a079f0cfb87 100644 --- a/docs/extensibility/event-triggers/available/source-deleted.md +++ b/docs/extensibility/event-triggers/available/source-deleted.md @@ -37,4 +37,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/source-updated.md b/docs/extensibility/event-triggers/available/source-updated.md index 205bda20ec8..bd160c1fb36 100644 --- a/docs/extensibility/event-triggers/available/source-updated.md +++ b/docs/extensibility/event-triggers/available/source-updated.md @@ -37,4 +37,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/available/va-cluster-status-change.md b/docs/extensibility/event-triggers/available/va-cluster-status-change.md index 53fc16d1284..ad64a838361 100644 --- a/docs/extensibility/event-triggers/available/va-cluster-status-change.md +++ b/docs/extensibility/event-triggers/available/va-cluster-status-change.md @@ -68,4 +68,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/early-access/identity-deleted.md b/docs/extensibility/event-triggers/early-access/identity-deleted.md index c7935d62418..28a37574d2e 100644 --- a/docs/extensibility/event-triggers/early-access/identity-deleted.md +++ b/docs/extensibility/event-triggers/early-access/identity-deleted.md @@ -62,4 +62,4 @@ This is an example input from this trigger: ## Additional Information and Links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/early-access/source-account-created.md b/docs/extensibility/event-triggers/early-access/source-account-created.md index ad100ac6620..5442741f8a4 100644 --- a/docs/extensibility/event-triggers/early-access/source-account-created.md +++ b/docs/extensibility/event-triggers/early-access/source-account-created.md @@ -52,4 +52,4 @@ This is an example input from this trigger: ## Additional information and links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/early-access/source-account-deleted.md b/docs/extensibility/event-triggers/early-access/source-account-deleted.md index 80f4b289f1b..419ea0a7233 100644 --- a/docs/extensibility/event-triggers/early-access/source-account-deleted.md +++ b/docs/extensibility/event-triggers/early-access/source-account-deleted.md @@ -52,4 +52,4 @@ This is an example input from this trigger: ## Additional information and links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/early-access/source-account-updated.md b/docs/extensibility/event-triggers/early-access/source-account-updated.md index 91a79ab483e..8d03b7e2d0e 100644 --- a/docs/extensibility/event-triggers/early-access/source-account-updated.md +++ b/docs/extensibility/event-triggers/early-access/source-account-updated.md @@ -57,4 +57,4 @@ This is an example input from this trigger: ## Additional Information and links - **Trigger Type**: [FIRE_AND_FORGET](../trigger-types.md#fire-and-forget) - + diff --git a/docs/extensibility/event-triggers/responding-to-a-request-response-trigger.mdx b/docs/extensibility/event-triggers/responding-to-a-request-response-trigger.mdx index 5a7acd65f9a..e2f09e975f5 100644 --- a/docs/extensibility/event-triggers/responding-to-a-request-response-trigger.mdx +++ b/docs/extensibility/event-triggers/responding-to-a-request-response-trigger.mdx @@ -30,7 +30,7 @@ You can specify how your application interacts with a response required (`REQUES +The custom application responds to the trigger invocation with an appropriate payload. For example, the application may receive a request from the [Access Request Dynamic Approver](https://platform.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) trigger. The application will have **10 seconds** to analyze the event details and respond with a 200 (OK) status code and a [response payload](https://platform.sailpoint.com/apis/beta/#section/Access-Request-Dynamic-Approver-Event-Trigger-Output) that contains the identity to add to the approval chain. --> The custom application responds to the trigger invocation with an appropriate payload. For example, the application may receive a request from the Access Request Dynamic Approver trigger. The application will have **10 seconds** to analyze the event details and respond with a 200 (OK) status code and a response payload that contains the identity to add to the approval chain. For example, the response may look like this: @@ -48,8 +48,8 @@ The custom application responds to the trigger invocation with an appropriate pa - +The custom application only needs to acknowledge that it has received the trigger invocation request by returning an HTTP status of 200 (OK) with ) trigger. An example of the request payload that the application might receive is as follows: --> +an empty JSON object (ex. `{}`) in the response body within **10 seconds** of receiving the event. It then has until the configured deadline on the subscription to provide a full response to the invocation. For example, the application may receive a request from the [Access Request Dynamic Approver](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) The custom application only needs to acknowledge that it has received the trigger invocation request by returning an HTTP status of 200 (OK) with an empty JSON object (ex. `{}`) in the response body within **10 seconds** of receiving the event. It then has until the configured deadline on the subscription to provide a full response to the invocation. For example, the application may receive a request from the Access Request Dynamic Approver trigger. An example of the request payload that the application might receive is as follows: ```json diff --git a/docs/extensibility/rules/connector-rules/index.md b/docs/extensibility/rules/connector-rules/index.md index 70b50e61742..b401074e76b 100644 --- a/docs/extensibility/rules/connector-rules/index.md +++ b/docs/extensibility/rules/connector-rules/index.md @@ -13,7 +13,7 @@ tags: ['Rules'] **Connector-Executed Rules** or **Connector Rules** are rules that are executed in the Identity Security Cloud virtual appliance, and they are usually extensions of the connector itself. The rules are commonly used to perform complex connector-related functions, so they are specific to only certain connectors. Because these rules execute in the virtual appliance, they do not have access to query the Identity Security Cloud data model or fetch information from Identity Security Cloud. They rely instead on contextual information sent from Identity Security Cloud. Connector-executed rules may also have managed connections provided in their contexts to support querying end systems or sources. Though these managed connections may be used, making additional connections or call-outs is not allowed. -Unlike cloud rules, connector rules do not have a rule review process and are directly editable with the [Connector Rule REST APIs](https://developer.sailpoint.com/docs/api/beta/connector-rule-management). For more details, see [Configuration Process](#configuration-process). +Unlike cloud rules, connector rules do not have a rule review process and are directly editable with the [Connector Rule REST APIs](https://platform.sailpoint.com/docs/api/beta/connector-rule-management). For more details, see [Configuration Process](#configuration-process). ## Supported Connector Rules @@ -35,7 +35,7 @@ Unlike cloud rules, connector rules do not have a rule review process and are di ## Configuration Process -Connector Rules are directly editable with the [Connector Rule REST APIs](https://developer.sailpoint.com/docs/api/beta/connector-rule-management), which provide ability to interact with rules directly. +Connector Rules are directly editable with the [Connector Rule REST APIs](https://platform.sailpoint.com/docs/api/beta/connector-rule-management), which provide ability to interact with rules directly. | Name | Path | | --- | --- | diff --git a/docs/extensibility/rules/rule-java-docs/index.mdx b/docs/extensibility/rules/rule-java-docs/index.mdx index 7f45e331cdd..7ab24e21cb5 100644 --- a/docs/extensibility/rules/rule-java-docs/index.mdx +++ b/docs/extensibility/rules/rule-java-docs/index.mdx @@ -11,4 +11,4 @@ slug: /extensibility/rules/java-docs tags: ['Rules', 'Java', 'Docs'] --- - \ No newline at end of file + \ No newline at end of file diff --git a/docs/extensibility/transforms/guides/identity-context.md b/docs/extensibility/transforms/guides/identity-context.md index 7d9e47023f4..bebeb0e7ffd 100644 --- a/docs/extensibility/transforms/guides/identity-context.md +++ b/docs/extensibility/transforms/guides/identity-context.md @@ -23,7 +23,7 @@ The following variables are available to the Apache Velocity template engine whe | attributeDefinition | sailpoint.object.AttributeDefinition | This is the definition of the attribute being promoted. | | oldValue | Object | This is the attribute's previous value. | -For available methods on these objects see our [Rules Java Docs](https://developer.sailpoint.com/docs/extensibility/rules/java-docs). +For available methods on these objects see our [Rules Java Docs](https://platform.sailpoint.com/docs/extensibility/rules/java-docs). ## Examples diff --git a/docs/extensibility/transforms/guides/provisioning-policy-transform.md b/docs/extensibility/transforms/guides/provisioning-policy-transform.md index 6d2cce22633..70359af9eeb 100644 --- a/docs/extensibility/transforms/guides/provisioning-policy-transform.md +++ b/docs/extensibility/transforms/guides/provisioning-policy-transform.md @@ -350,4 +350,4 @@ This is the example response with the full policy, along with the new attribute: ## Next Steps -For more information on all available transforms, refer to [Transform Operations](/docs/extensibility/transforms/operations). If you're having trouble creating your transform in provisioning policies, reach out with your question in the [Developer Community Forum](https://developer.sailpoint.com/discuss/)! +For more information on all available transforms, refer to [Transform Operations](/docs/extensibility/transforms/operations). If you're having trouble creating your transform in provisioning policies, reach out with your question in the [Developer Community Forum](https://platform.sailpoint.com)! diff --git a/docs/extensibility/transforms/guides/temporary-password.md b/docs/extensibility/transforms/guides/temporary-password.md index d3702b4bb01..5cbd0afbe7f 100644 --- a/docs/extensibility/transforms/guides/temporary-password.md +++ b/docs/extensibility/transforms/guides/temporary-password.md @@ -596,4 +596,4 @@ This is an example table of values with the temporary password for each user: ## Next Steps -Looking for more examples or having trouble with one of your complex transforms? Reach out in the [Developer Community Forum](https://developer.sailpoint.com/discuss/). +Looking for more examples or having trouble with one of your complex transforms? Reach out in the [Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/extensibility/transforms/index.md b/docs/extensibility/transforms/index.md index 33d83f173c0..96c75a54600 100644 --- a/docs/extensibility/transforms/index.md +++ b/docs/extensibility/transforms/index.md @@ -281,7 +281,7 @@ To test a transform for account data, you must provision a new account on that s - **JSON Editor** - Because transforms are JSON objects, it is recommended that you use a good JSON editor. Atom, Sublime Text, and Microsoft Code work well because they have JSON formatting and plugins that can do JSON validation, completion, formatting, and folding. This is very useful for large complex JSON objects. -- **Leverage Examples** - Many implementations use similar sets of transforms, and a lot of common solutions can be found in examples. Feel free to share your own transform examples on the [Developer Community forum](https://developer.sailpoint.com/discuss)! +- **Leverage Examples** - Many implementations use similar sets of transforms, and a lot of common solutions can be found in examples. Feel free to share your own transform examples on the [Developer Community forum](https://platform.sailpoint.com)! - **Same Problem, Multiple Solutions** - There can be multiple ways to solve the same problem, but use the solution that makes the most sense to your implementation and is easiest to administer and understand. diff --git a/docs/guides.md b/docs/guides.md index 1fd825bb6f3..eb7312d3723 100644 --- a/docs/guides.md +++ b/docs/guides.md @@ -26,4 +26,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about these ISC topics and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about these ISC topics and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/guides/disable-access-profile-requests.md b/docs/guides/disable-access-profile-requests.md index b6863db4f96..d69e2d10216 100644 --- a/docs/guides/disable-access-profile-requests.md +++ b/docs/guides/disable-access-profile-requests.md @@ -15,7 +15,7 @@ tags: ['AccessProfileRequestManagement'] In Identity Security Cloud, [access profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) are groups of [entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html), which represent access rights on [sources](https://documentation.sailpoint.com/saas/help/sources/index.html). By default, all access profiles are marked as requestable. This means that an organization's users can submit [access requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for the access profiles in the Identity Security Cloud [Request Center](https://documentation.sailpoint.com/saas/user-help/requests/request_center.html), where all access profiles are listed. -You can disable requests for access profiles to prevent users from gaining inappropriate or undesired access. In the UI, you can edit the [individual access profile](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#configuring-access-profiles-for-requests) to disable requests for the access profile. You can also use the [PATCH Access Profile endpoint](https://developer.sailpoint.com/docs/api/v3/patch-access-profile) to mark the individual access profile as non-requestable. +You can disable requests for access profiles to prevent users from gaining inappropriate or undesired access. In the UI, you can edit the [individual access profile](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#configuring-access-profiles-for-requests) to disable requests for the access profile. You can also use the [PATCH Access Profile endpoint](https://platform.sailpoint.com/docs/api/v3/patch-access-profile) to mark the individual access profile as non-requestable. You may have many access profiles that you want to disable requests for, and you don't want one to get overlooked and then inappropriately accessed. There are three different processes you can use to ensure that you have disabled requests for all access profiles that aren't currently associated with [applications](https://documentation.sailpoint.com/saas/help/common/app-config.html) configured for access requests. Read this guide to learn how to perform these processes. @@ -39,7 +39,7 @@ Once you have performed this process, all the access profiles that aren't curren Follow these steps to use two API endpoints to individually disable access requests for all access profiles that aren't currently associated with applications: -1. Use the [Search endpoint](https://developer.sailpoint.com/docs/api/v3/search-post) to identify the access profiles that are **not** associated with applications configured for access requests. Sending the following query will return a list of these unassociated access profiles. +1. Use the [Search endpoint](https://platform.sailpoint.com/docs/api/v3/search-post) to identify the access profiles that are **not** associated with applications configured for access requests. Sending the following query will return a list of these unassociated access profiles. - Provide this request body. It will return all access profiles that have a null or empty `apps` list. @@ -73,7 +73,7 @@ Follow these steps to use two API endpoints to individually disable access reque - The response body will include all the details of each unassociated access profile. Extract the `id` for each access profile returned. -2. Use the [PATCH Access Profile endpoint](https://developer.sailpoint.com/docs/api/v3/patch-access-profile) and provide the unassociated access profile's `id` to update the specified access profile's `requestable` field. +2. Use the [PATCH Access Profile endpoint](https://platform.sailpoint.com/docs/api/v3/patch-access-profile) and provide the unassociated access profile's `id` to update the specified access profile's `requestable` field. - Provide this request body. It will use the `replace` operation to update the value in the specified access profile's `requestable` path to `false`. @@ -95,7 +95,7 @@ Once you have performed this process for each of the unassociated access profile Follow these steps to use two API endpoints to bulk disable access requests for all access profiles that aren't currently associated with applications: -1. Use the [Search endpoint](https://developer.sailpoint.com/docs/api/v3/search-post) to identify the access profiles that are **not** associated with applications configured for access requests. Sending the following query will return a list of these unassociated access profiles. +1. Use the [Search endpoint](https://platform.sailpoint.com/docs/api/v3/search-post) to identify the access profiles that are **not** associated with applications configured for access requests. Sending the following query will return a list of these unassociated access profiles. - Provide this request body. It will return all access profiles that have a null or empty `apps` list. @@ -129,7 +129,7 @@ Follow these steps to use two API endpoints to bulk disable access requests for - The response body will include all the details of each unassociated access profile. Extract the `id` for each access profile returned. -2. Use the [Update Requestability for Access Profiles endpoint](https://developer.sailpoint.com/docs/api/beta/update-access-profiles-in-bulk) and provide every unassociated access profile's `id`, along with the updated values for their `requestable` fields. +2. Use the [Update Requestability for Access Profiles endpoint](https://platform.sailpoint.com/docs/api/beta/update-access-profiles-in-bulk) and provide every unassociated access profile's `id`, along with the updated values for their `requestable` fields. - Provide this request body. It can bulk update all the access profiles you specify - you just need to specify each access profile's `id` and the `requestable` value you want for the access profile. diff --git a/docs/index.md b/docs/index.md index ab451b6a269..493f2cf8a9c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -46,4 +46,4 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about ISC and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about ISC and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/reporting.md b/docs/reporting.md index 68bcd3512d1..bea5a027ee4 100644 --- a/docs/reporting.md +++ b/docs/reporting.md @@ -26,4 +26,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about ISC data reporting and discuss the different options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about ISC data reporting and discuss the different options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/reporting/secure-data-share/index.md b/docs/reporting/secure-data-share/index.md index c56bafcbbaf..ac2cbe40b4e 100644 --- a/docs/reporting/secure-data-share/index.md +++ b/docs/reporting/secure-data-share/index.md @@ -47,4 +47,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about SDS and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/identity-security-cloud/6). +To learn more about SDS and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com/). diff --git a/docs/sidebar.js b/docs/sidebar.js index c4fd5107a50..5862bdbf2d5 100644 --- a/docs/sidebar.js +++ b/docs/sidebar.js @@ -44,7 +44,7 @@ // type: 'generated-index', // title: 'V3 APIs', // description: -// 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.', +// 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://platform.sailpoint.com to connect with other developers using our APIs.', // slug: '/api/v3', // }, // // @ts-ignore @@ -57,7 +57,7 @@ // type: 'generated-index', // title: 'Beta APIs', // description: -// 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.', +// 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://platform.sailpoint.com to connect with other developers using our APIs.', // slug: '/api/beta', // }, // // @ts-ignore @@ -108,7 +108,7 @@ const sidebars = { type: 'generated-index', title: 'IdentityIQ API', description: - "These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", + "These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. We encourage you to join the SailPoint Developer Community forum at https://platform.sailpoint.com to connect with other developers using our APIs.", slug: '/api/iiq', }, // @ts-ignore diff --git a/docs/tools.md b/docs/tools.md index 667f1cf44a5..35d0a878317 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -26,4 +26,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about ISC tools and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about ISC tools and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com). diff --git a/docs/tools/cli/Templates/search.md b/docs/tools/cli/Templates/search.md index b6d39f8e8a7..b999294c3c1 100644 --- a/docs/tools/cli/Templates/search.md +++ b/docs/tools/cli/Templates/search.md @@ -106,4 +106,4 @@ For example, the variable in this template is configured so you can choose how m } ``` -Everything inside this searchQuery object matches the standard format of an [Identity Security Cloud search query](https://documentation.sailpoint.com/saas/help/search/building-query.html). A limited number of examples are provided [here](https://developer.sailpoint.com/docs/api/v3/search-post), but the searchQuery object is mapped to the full search object. This means that you can add any search query values missing from this object. +Everything inside this searchQuery object matches the standard format of an [Identity Security Cloud search query](https://documentation.sailpoint.com/saas/help/search/building-query.html). A limited number of examples are provided [here](https://platform.sailpoint.com/docs/api/v3/search-post), but the searchQuery object is mapped to the full search object. This means that you can add any search query values missing from this object. diff --git a/docs/tools/cli/Templates/spconfig.md b/docs/tools/cli/Templates/spconfig.md index 827a594a573..1936e7d6287 100644 --- a/docs/tools/cli/Templates/spconfig.md +++ b/docs/tools/cli/Templates/spconfig.md @@ -69,7 +69,7 @@ Use variables to dynamically populate values in the following content during com "exportBody": { ``` -The following object matches that detailed in the [API docs](https://developer.sailpoint.com/docs/api/beta/export-sp-config) +The following object matches that detailed in the [API docs](https://platform.sailpoint.com/docs/api/beta/export-sp-config) ```json "description": "Export all available objects", diff --git a/docs/tools/cli/cluster.md b/docs/tools/cli/cluster.md index 7795a810fc1..daeac50246a 100644 --- a/docs/tools/cli/cluster.md +++ b/docs/tools/cli/cluster.md @@ -33,7 +33,7 @@ sail cluster list This command returns a table of the clusters, along with their IDs. -This command uses the [Get all clusters endpoint](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters). +This command uses the [Get all clusters endpoint](https://platform.sailpoint.com/docs/api/beta/get-managed-clusters). ## Get cluster by ID @@ -57,7 +57,7 @@ You can also get multiple clusters at once. Here is an example: sail cluster get f48e8c9c7dce4672bead8222a767dce7 3652192cc2264ad5827fdc1eb2d88f01 ``` -This command uses the [Get cluster endpoint](https://developer.sailpoint.com/docs/api/beta/get-managed-cluster). +This command uses the [Get cluster endpoint](https://platform.sailpoint.com/docs/api/beta/get-managed-cluster). ## Get cluster's log configuration @@ -73,13 +73,13 @@ Here is an example: sail cluster log get 2c91808580f6cc1a01811af8cf5f18cb ``` -This command uses the [Get cluster's log configuration endpoint](https://developer.sailpoint.com/docs/api/beta/get-client-log-configuration). +This command uses the [Get cluster's log configuration endpoint](https://platform.sailpoint.com/docs/api/beta/get-client-log-configuration). ## Set cluster's log configuration You can update a cluster's root logging level, the duration of its logging, and the connector logging class. To set a cluster's log configuration, run this command: -This command uses the [Update cluster's log configuration endpoint](https://developer.sailpoint.com/docs/api/beta/put-client-log-configuration). +This command uses the [Update cluster's log configuration endpoint](https://platform.sailpoint.com/docs/api/beta/put-client-log-configuration). ```shell sail cluster log set {cluster ID} -r {rootLevel} -d {durationMinutes} -c {connector logging class} diff --git a/docs/tools/cli/index.md b/docs/tools/cli/index.md index 72f488edce9..b58f8f7ded7 100644 --- a/docs/tools/cli/index.md +++ b/docs/tools/cli/index.md @@ -191,8 +191,8 @@ Please use GitHub [issues](https://github.com/sailpoint-oss/sailpoint-cli/issues Do you have an idea to help improve the CLI? You can contribute directly! -Before you contribute, you must sign our [CLA](https://cla-assistant.io/sailpoint-oss/sailpoint-cli) and read the [Contribution Guidelines](https://github.com/sailpoint-oss/developer.sailpoint.com/blob/main/CONTRIBUTING.md). +Before you contribute, you must sign our [CLA](https://cla-assistant.io/sailpoint-oss/sailpoint-cli) and read the [Contribution Guidelines](https://github.com/sailpoint-oss/platform.sailpoint.com/blob/main/CONTRIBUTING.md). ## Questions -If you have questions about the CLI, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +If you have questions about the CLI, don't hesitate to reach out on the SailPoint Developer Community forum at https://platform.sailpoint.com! diff --git a/docs/tools/cli/search.md b/docs/tools/cli/search.md index a9ea2eecad8..ee799e811c6 100644 --- a/docs/tools/cli/search.md +++ b/docs/tools/cli/search.md @@ -47,7 +47,7 @@ The basic format of a query is "field:term", so an example `query` command would sail search query "name:a*" --indices identities ``` -The CLI will use the [V3 Search endpoint](https://developer.sailpoint.com/docs/api/v3/search-post) to search for all identities starting with names starting with the letter "a". The CLI will then generate a JSON file containing the search results. This JSON file will be located in a folder titled "search_results", within the current working directory, unless a folder path is specified. +The CLI will use the [V3 Search endpoint](https://platform.sailpoint.com/docs/api/v3/search-post) to search for all identities starting with names starting with the letter "a". The CLI will then generate a JSON file containing the search results. This JSON file will be located in a folder titled "search_results", within the current working directory, unless a folder path is specified. ### Command diff --git a/docs/tools/cli/workflow.md b/docs/tools/cli/workflow.md index 942a9bc44ed..d00dd5223ab 100644 --- a/docs/tools/cli/workflow.md +++ b/docs/tools/cli/workflow.md @@ -43,7 +43,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from The CLI will return a table of the available workflows in your tenant, with their IDs. - This command uses the [List Workflows endpoint](https://developer.sailpoint.com/docs/api/beta/list-workflows). + This command uses the [List Workflows endpoint](https://platform.sailpoint.com/docs/api/beta/list-workflows). ## Get workflow @@ -61,7 +61,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from The CLI will return the workflow, along with all its details. - This command uses the [Get workflow endpoint](https://developer.sailpoint.com/docs/api/beta/get-workflow). + This command uses the [Get workflow endpoint](https://platform.sailpoint.com/docs/api/beta/get-workflow). ## Create workflow @@ -85,7 +85,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from Once you create the workflow, it will be located in the file path you specified. - This command uses the [Create workflow endpoint](https://developer.sailpoint.com/docs/api/beta/create-workflow). + This command uses the [Create workflow endpoint](https://platform.sailpoint.com/docs/api/beta/create-workflow). ### File path @@ -131,7 +131,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from The updated workflow will be located in the file path you specified. - This command uses the [Update workflow endpoint](https://developer.sailpoint.com/docs/api/beta/update-workflow). + This command uses the [Update workflow endpoint](https://platform.sailpoint.com/docs/api/beta/update-workflow). ### File path @@ -175,7 +175,7 @@ The `workflow` command makes it easy to create, manage, and test workflows from sail workflow delete $(cat list_of_workflowIDs.txt) ``` - This command uses the [Delete workflow endpoint](https://developer.sailpoint.com/docs/api/beta/delete-workflow). + This command uses the [Delete workflow endpoint](https://platform.sailpoint.com/docs/api/beta/delete-workflow). ## Download workflow diff --git a/docs/tools/community-toolbox/index.md b/docs/tools/community-toolbox/index.md index c223916f7f9..797de87b714 100644 --- a/docs/tools/community-toolbox/index.md +++ b/docs/tools/community-toolbox/index.md @@ -110,7 +110,7 @@ Once you have provided your tenant information, the Community Toolbox prompts yo Once you log in, the Community Toolbox's home page displays. The home page has four panels with different links. You can access these different Community Toolbox functionalities from the home page panels: - **Status**: The Status panel shows you the platform's status, such as "All Systems Operational". Click the status to open https://status.sailpoint.com in an Community Toolbox window. You will see the latest status updates for the platform there. - **Tenant Links**: Use these links for direct access to some areas of your tenant common for administrative functions. Click these links to open your ISC tenant UI within an Community Toolbox window. From the Community Toolbox window, you can also access the entirety of your tenant. -- **Resources**: Use these links to access common SailPoint resources, such as the [SailPoint Developer Community](https://developer.sailpoint.com/discuss/c/identity-security-cloud/6) and the different forms of SailPoint documentation. +- **Resources**: Use these links to access common SailPoint resources, such as the [SailPoint Developer Community](https://platform.sailpoint.com/) and the different forms of SailPoint documentation. - **Support**: Use these links to access [SailPoint Customer Support](https://support.sailpoint.com/csm) and submit support tickets. ## Community Toolbox side tab features @@ -162,4 +162,4 @@ When you open the Courier tab, the Community Toolbox displays its Courier tool. The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the ISC Community Toolbox and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/identity-security-cloud/6). +To learn more about the ISC Community Toolbox and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com/). diff --git a/docs/tools/rule-development-kit/index.md b/docs/tools/rule-development-kit/index.md index 243fb1944f2..1f56c2cbf6f 100644 --- a/docs/tools/rule-development-kit/index.md +++ b/docs/tools/rule-development-kit/index.md @@ -617,4 +617,4 @@ When your test runs, you will see the output of your logs. These logs can help w Have an issue using the RDK? Reach out to us on GitHub [here](https://github.com/sailpoint-oss/rule-development-kit/issues) -Discuss the tool and other rule-specific topics in the [SailPoint Developer Community](https://developer.sailpoint.com/discuss/). +Discuss the tool and other rule-specific topics in the [SailPoint Developer Community](https://platform.sailpoint.com//). diff --git a/docs/tools/sdk/go/index.mdx b/docs/tools/sdk/go/index.mdx index 4e8e6bcf0b0..12535d7407b 100644 --- a/docs/tools/sdk/go/index.mdx +++ b/docs/tools/sdk/go/index.mdx @@ -29,7 +29,7 @@ You need the following to use the Go SDK:
CLI Assisted (Recommended) -The SailPoint CLI offers a few commands that will allow you to quickly get started with the Go SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). +The SailPoint CLI offers a few commands that will allow you to quickly get started with the Go SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://platform.sailpoint.com/idn/tools/cli#get-the-cli). Once the CLI is installed and configured, run this command to create a new Go project with the Go SDK: @@ -189,7 +189,7 @@ To get your environment variables to persist across PowerShell sessions, run the ## Discuss -You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://platform.sailpoint.com! ## Getting Started diff --git a/docs/tools/sdk/index.md b/docs/tools/sdk/index.md index 68d5e9f7cfa..e7b49f7ed5f 100644 --- a/docs/tools/sdk/index.md +++ b/docs/tools/sdk/index.md @@ -26,4 +26,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the ISC SDKs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). +To learn more about the ISC SDKs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com/). diff --git a/docs/tools/sdk/powershell/getting-started.md b/docs/tools/sdk/powershell/getting-started.md index 20a7b7bd364..5743e58124d 100644 --- a/docs/tools/sdk/powershell/getting-started.md +++ b/docs/tools/sdk/powershell/getting-started.md @@ -87,21 +87,21 @@ DESCRIPTION PARAMETERS -Offset Offset into the full result set. Usually specified with *limit* to paginate through the results. For more information, refer to [V3 API Standard Collection - Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters). + Parameters](https://platform.sailpoint.com/docs/api/standard-collection-parameters). -Limit - Max number of results to return. For more information, refer to [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters). + Max number of results to return. For more information, refer to [V3 API Standard Collection Parameters](https://platform.sailpoint.com/docs/api/standard-collection-parameters). -Count If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. For more information, refer to [V3 API Standard Collection - Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters). + Parameters](https://platform.sailpoint.com/docs/api/standard-collection-parameters). -Name Name of the transform to retrieve from the list. -Filters - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results). Filtering is + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://platform.sailpoint.com/docs/api/standard-collection-parameters#filtering-results). Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* -WithHttpInfo [] diff --git a/docs/tools/sdk/powershell/index.mdx b/docs/tools/sdk/powershell/index.mdx index 852bc951929..3df44830e06 100644 --- a/docs/tools/sdk/powershell/index.mdx +++ b/docs/tools/sdk/powershell/index.mdx @@ -28,7 +28,7 @@ You need the following to use the PowerShell SDK:
CLI Assisted (Recommended) -The SailPoint CLI offers a few commands that will allow you to quickly get started with the PowerShell SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). +The SailPoint CLI offers a few commands that will allow you to quickly get started with the PowerShell SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://platform.sailpoint.com/idn/tools/cli#get-the-cli). Once the CLI is installed and configured, run this command to create a new PowerShell project with the PowerShell SDK: @@ -193,7 +193,7 @@ To get your environment variables to persist across PowerShell sessions, run the ## Discuss -You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://platform.sailpoint.com! ## Getting Started diff --git a/docs/tools/sdk/python/index.mdx b/docs/tools/sdk/python/index.mdx index 6a1c955f1e0..b4b6b4f29fb 100644 --- a/docs/tools/sdk/python/index.mdx +++ b/docs/tools/sdk/python/index.mdx @@ -29,7 +29,7 @@ You need the following to use the Python SDK:
CLI Assisted (Recommended) -The SailPoint CLI offers a few commands that will allow you to quickly get started with the Python SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). +The SailPoint CLI offers a few commands that will allow you to quickly get started with the Python SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://platform.sailpoint.com/idn/tools/cli#get-the-cli). Once the CLI is installed and configured, run this command to create a new Python project with the Python SDK: @@ -186,7 +186,7 @@ To get your environment variables to persist across PowerShell sessions, run the ## Discuss -You can use this SDK to build new tools that extend your Identity Security Cloud platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +You can use this SDK to build new tools that extend your Identity Security Cloud platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://platform.sailpoint.com! ## Getting Started diff --git a/docs/tools/sdk/typescript/getting-started.md b/docs/tools/sdk/typescript/getting-started.md index 22fa2d1de91..44cce5b871b 100644 --- a/docs/tools/sdk/typescript/getting-started.md +++ b/docs/tools/sdk/typescript/getting-started.md @@ -47,7 +47,7 @@ To run the SDK, run the `node src/index.js` command. This command sends the requ Using the same SDK function, you can list your transforms but limit the results to only what you want. This example wants a list of no more than 10 transforms that start with the name "Test": -Refer to [List Transforms](https://developer.sailpoint.com/docs/api/v3/list-transforms) for all its supported query parameters. +Refer to [List Transforms](https://platform.sailpoint.com/docs/api/v3/list-transforms) for all its supported query parameters. ```typescript import {Configuration, TransformsApi} from 'sailpoint-api-client'; diff --git a/docs/tools/sdk/typescript/index.mdx b/docs/tools/sdk/typescript/index.mdx index a038e329189..1d0964ef969 100644 --- a/docs/tools/sdk/typescript/index.mdx +++ b/docs/tools/sdk/typescript/index.mdx @@ -36,7 +36,7 @@ npm install -g typescript
CLI Assisted (Recommended) -The SailPoint CLI offers a few commands that will allow you to quickly get started with the Typescript SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli). +The SailPoint CLI offers a few commands that will allow you to quickly get started with the Typescript SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://platform.sailpoint.com/idn/tools/cli#get-the-cli). Once the CLI is installed and configured, run this command to create a new Typescript project with the Typescript SDK: @@ -229,7 +229,7 @@ To get your environment variables to persist across PowerShell sessions, run the ## Discuss -You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss! +You can use this SDK to build new tools that extend your ISC platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://platform.sailpoint.com! ## Getting Started diff --git a/docs/tools/ui-development-kit/accounts-list.mdx b/docs/tools/ui-development-kit/accounts-list.mdx index 8ebd03bcc0d..58af721c470 100644 --- a/docs/tools/ui-development-kit/accounts-list.mdx +++ b/docs/tools/ui-development-kit/accounts-list.mdx @@ -23,12 +23,12 @@ At the end of this guide you will be able to do the following: - Paginate accounts by page limits of 5, 10, 50, 100, 250 - Click through each page of results - View the JSON response of the account from your tenant -- Sort the results, using the sort syntax on the [List Accounts endpoint](https://developer.sailpoint.com/docs/api/v3/list-accounts). -- Filter the results, using the filter syntax on the [List Accounts endpoint](https://developer.sailpoint.com/docs/api/v3/list-accounts). +- Sort the results, using the sort syntax on the [List Accounts endpoint](https://platform.sailpoint.com/docs/api/v3/list-accounts). +- Filter the results, using the filter syntax on the [List Accounts endpoint](https://platform.sailpoint.com/docs/api/v3/list-accounts). ## Get account data -The first thing your new page needs to do is get the account data to show. You can implement this by using the [List Accounts endpoint](https://developer.sailpoint.com/docs/api/v3/list-accounts). +The first thing your new page needs to do is get the account data to show. You can implement this by using the [List Accounts endpoint](https://platform.sailpoint.com/docs/api/v3/list-accounts). To do so, add this logic to the server side of the accounts list page at `src/routes/accounts/account-list/+page.server.ts`: @@ -370,7 +370,7 @@ To implement sorting and filtering, add the following highlighted code. It allow With this implementation, once a user types in a filter or sorter and clicks the 'Go' button, the UI Development Kit calls the `onCreateGo` function and reloads the page with the new sorters and filters. On the server side, the kit uses the `getFilters` and `getSorters` functions to get the filters and sorters from the URL. -The kit then passes these functions to the [List Accounts endpoint](https://developer.sailpoint.com/docs/api/v3/list-accounts) to filter and sort the accounts. +The kit then passes these functions to the [List Accounts endpoint](https://platform.sailpoint.com/docs/api/v3/list-accounts) to filter and sort the accounts. @@ -566,4 +566,4 @@ To learn more about handling errors in your UI, refer to [Error Handling](./erro The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/identity-security-cloud/6). \ No newline at end of file +To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com/). \ No newline at end of file diff --git a/docs/tools/ui-development-kit/error-handling.md b/docs/tools/ui-development-kit/error-handling.md index 3af51d463b2..f6c632a7407 100644 --- a/docs/tools/ui-development-kit/error-handling.md +++ b/docs/tools/ui-development-kit/error-handling.md @@ -19,7 +19,7 @@ Read this guide to learn how to use the UI Development Kit to handle errors. ## 400 Bad Request -If you provide an invalid filter or sorter, the [List Accounts Endpoint](https://developer.sailpoint.com/docs/api/v3/list-accounts) returns a 400 error. This example awaits the response and doesn't exit the program when a 4xx level status is received. If a 4xx level status is received, the user is redirected to an error page. +If you provide an invalid filter or sorter, the [List Accounts Endpoint](https://platform.sailpoint.com/docs/api/v3/list-accounts) returns a 400 error. This example awaits the response and doesn't exit the program when a 4xx level status is received. If a 4xx level status is received, the user is redirected to an error page. Refer to this code block to learn how to implement error handling for invalid filters or sorters: @@ -62,7 +62,7 @@ export const load = async ({url, locals}) => { 'an error occurred while fetching accounts. Please examine your filters and and sorters and try again.', context: {params: {page, limit, filters, sorters}}, urls: [ - 'https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results', + 'https://platform.sailpoint.com/idn/api/standard-collection-parameters#filtering-results', ], errData: reportResp.data, }); @@ -122,7 +122,7 @@ export const load = async ({url, locals}) => { 'an error occurred while fetching accounts. Please examine your filters and and sorters and try again.', context: {params: {page, limit, filters, sorters}}, urls: [ - 'https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results', + 'https://platform.sailpoint.com/idn/api/standard-collection-parameters#filtering-results', ], errData: reportResp.data, }); @@ -139,4 +139,4 @@ export const load = async ({url, locals}) => { The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/identity-security-cloud/6). +To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com/). diff --git a/docs/tools/ui-development-kit/getting-started.mdx b/docs/tools/ui-development-kit/getting-started.mdx index 6c14d8157b2..32bf7c37d28 100644 --- a/docs/tools/ui-development-kit/getting-started.mdx +++ b/docs/tools/ui-development-kit/getting-started.mdx @@ -163,4 +163,4 @@ Now that you have the new sidebar item, its new route, and its new page, you can The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/identity-security-cloud/6). \ No newline at end of file +To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com/). \ No newline at end of file diff --git a/docs/tools/ui-development-kit/index.md b/docs/tools/ui-development-kit/index.md index b952d84cbe7..92882918603 100644 --- a/docs/tools/ui-development-kit/index.md +++ b/docs/tools/ui-development-kit/index.md @@ -99,4 +99,4 @@ To start learning how to use the UI Development Kit and explore its possibilitie The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions. -To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/identity-security-cloud/6). +To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://platform.sailpoint.com/).