diff --git a/docs/ai-policy.md b/docs/ai-policy.md index 002b13318d301..7c3191260b10f 100644 --- a/docs/ai-policy.md +++ b/docs/ai-policy.md @@ -57,7 +57,7 @@ When posting content that was generated or significantly assisted by AI tools, y Include a disclosure statement such as: - "This response was generated with assistance from [AI tool name] and validated against SailPoint documentation." -- "AI-assisted response - verified against my personal experience with SHF." +- "AI-assisted response - verified against my personal experience with SailPoint Identity Security." - "Generated using [AI tool name] and tested in my sandbox environment." Place the disclosure at the beginning or end of your post in a clear, visible manner. @@ -119,7 +119,7 @@ When AI provides information, you must: - Request sources from the AI tool - Verify those sources exist and are accurate -- Include citations in your post (e.g., "According to the SHF API documentation page X…") +- Include citations in your post (e.g., "According to the SailPoint Identity Security API documentation page X…") - Link to official documentation when available **Do not:** @@ -173,7 +173,7 @@ When AI provides information, you must: **Example 1: Code Solution with Context** ```text -AI-assisted response - validated in my SHF sandbox +AI-assisted response - validated in my SailPoint Identity Security sandbox Based on the requirement to transform account data, here's an approach using a transform. I used AI to help structure the JSON, then tested @@ -185,7 +185,7 @@ Note: This worked in my tenant but you may need to adjust the attribute mappings based on your source schema. The key is ensuring the input attribute exists before the transform runs. -Reference: SHF Transform Documentation - [link] +Reference: SailPoint Identity Security Transform Documentation - [link] ``` **Example 2: Research Assistance** @@ -233,7 +233,7 @@ all generic, just to accumulate points] **Best practices when using external AI tools:** 1. **Be specific in your prompts** - - Include SailPoint product names (SHF, IIQ, File Access Manager, etc.) + - Include SailPoint product names (SailPoint Identity Security, IIQ, File Access Manager, etc.) - Mention version numbers when relevant - Provide context about your use case diff --git a/docs/api/api-specifications.md b/docs/api/api-specifications.md index 818f6061582f5..a977ada4659f2 100644 --- a/docs/api/api-specifications.md +++ b/docs/api/api-specifications.md @@ -6,14 +6,14 @@ sidebar_label: API Specifications sidebar_position: 1 sidebar_class_name: apiSpecifications keywords: ['api', 'specifications'] -description: SailPoint Human Fabric API specifications. +description: SailPoint Identity Security API specifications. slug: /api/api-specifications tags: ['API Specifications'] --- ## Overview -The SailPoint Human Fabric (SHF) APIs provide developers with a way to interact with the SHF platform and extend it. Developers can leverage these APIs to customize their platform experiences and build new solutions and integrations that meet their needs. +The SailPoint Identity Security APIs provide developers with a way to interact with the platform and extend it. Developers can leverage these APIs to customize their platform experiences and build new solutions and integrations that meet their needs. The API specifications contain detailed information of how to send requests to each API endpoint, as well as example requests and responses. They also include essential information about how to use the APIs and guides you can follow to get started. @@ -26,6 +26,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about the SHF 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 SailPoint Identity Security 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). --> diff --git a/docs/api/api-versioning-migration.md b/docs/api/api-versioning-migration.md index 67ba7b31e9a5a..ae081d2b49f36 100644 --- a/docs/api/api-versioning-migration.md +++ b/docs/api/api-versioning-migration.md @@ -1,12 +1,12 @@ --- id: api-versioning-migration -title: Migration guide for SHF APIs to new versioning model. +title: Migration guide for SailPoint Identity Security APIs to new versioning model. pagination_label: API Versioning Migration sidebar_label: API Versioning Migration sidebar_position: 8 sidebar_class_name: apiVersioning keywords: ['api', 'versioning', 'announcement'] -description: Migration guide for SHF APIs to new versioning model. +description: Migration guide for SailPoint Identity Security APIs to new versioning model. slug: /api/api-versioning-migration tags: ['API Versioning Strategy'] --- @@ -14,7 +14,7 @@ tags: ['API Versioning Strategy'] import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -We have made a significant update to how SailPoint Human Fabric APIs are versioned. This document outlines what changed, why we made these changes, how to migrate to the new API versioning system, and what they mean for you as an API consumer or integration developer. +We have made a significant update to how SailPoint Identity Security APIs are versioned. This document outlines what changed, why we made these changes, how to migrate to the new API versioning system, and what they mean for you as an API consumer or integration developer. ## What Has Changed diff --git a/docs/api/api-versioning-strategy.md b/docs/api/api-versioning-strategy.md index 2c2645ec52959..6177ef1845c9e 100644 --- a/docs/api/api-versioning-strategy.md +++ b/docs/api/api-versioning-strategy.md @@ -6,12 +6,12 @@ sidebar_label: API Versioning Strategy sidebar_position: 7 sidebar_class_name: apiVersioning keywords: ['api', 'versioning'] -description: SailPoint Human Fabric API Versioning Strategy. +description: SailPoint Identity Security API Versioning Strategy. slug: /api/api-versioning-strategy tags: ['API Versioning Strategy'] --- -SailPoint Human Fabric (SHF) REST APIs follow true semantic versioning, where each service is versioned independently. A service's major version only increments when its core usage contract changes. This gives you a stable, predictable integration target: as long as a version's contract is unchanged, your integrations continue to work without modification. +SailPoint Identity Security REST APIs follow true semantic versioning, where each service is versioned independently. A service's major version only increments when its core usage contract changes. This gives you a stable, predictable integration target: as long as a version's contract is unchanged, your integrations continue to work without modification. When breaking changes are required, a new major version is released in parallel and the previous version enters a clearly defined deprecation schedule on its own timeline. Services are documented once and maintained in place, rather than duplicated across yearly releases. @@ -23,7 +23,7 @@ SailPoint's API versioning process is subject to change at any time. SailPoint w ## How versioning works -Each SHF service is versioned independently using a URL structure that follows this pattern: +Each SailPoint Identity Security service is versioned independently using a URL structure that follows this pattern: ``` /service/v1/action @@ -115,7 +115,7 @@ Individual API versions may be deprecated at any time. The term "deprecation" me ### Announcements -Communications will be sent out to notify impacted users of any deprecations. These communications may appear in the Admin page of the SailPoint Human Fabric 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 SailPoint Identity Security UI, in the [Announcements](https://developer.sailpoint.com/discuss/c/announcements/14) category, in Compass, or in newsletters or emails. ### API specification diff --git a/docs/api/authentication.md b/docs/api/authentication.md index 76934fcfc8c3e..394237b393274 100644 --- a/docs/api/authentication.md +++ b/docs/api/authentication.md @@ -6,7 +6,7 @@ sidebar_label: Authentication sidebar_position: 2 sidebar_class_name: authentication keywords: ['authentication'] -description: Authenticate to the SHF APIs. +description: Authenticate to the SailPoint Identity Security APIs. slug: /api/authentication tags: ['Authentication'] --- @@ -15,7 +15,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ## Overview -With SailPoint Human Fabric (SHF) APIs, you can extend your SHF platform far beyond its current capabilities. To be able to do so, you must first authenticate to the SHF APIs. Authentication is the act of validating a user's identity, generally by passing some kind of credentials. A fast, simple way to authenticate to the APIs is to generate a [personal access token](#generate-a-personal-access-token) and pass that token. +With SailPoint Identity Security APIs, you can extend your platform far beyond its current capabilities. To be able to do so, you must first authenticate to the SailPoint Identity Security APIs. Authentication is the act of validating a user's identity, generally by passing some kind of credentials. A fast, simple way to authenticate to the APIs is to generate a [personal access token](#generate-a-personal-access-token) and pass that token. If the PAT is valid, the API responds with a JSON Web Token (JWT) `access_token` that you can provide to authorize your API requests. Authorization is the act of validating the user's permission to access a given resource. A successful API request must include the `access_token` in the `Authorization` request header. @@ -29,14 +29,14 @@ This diagram shows the flow of this authentication/authorization process: sequenceDiagram autonumber participant H as HTTP Client - participant I as SailPoint Human Fabric + participant I as SailPoint Identity Security H->>I: Access Token Request I->>H: Access Token Response loop Until token expires H->>I: API Request + Access Token - I->>H: SailPoint Human Fabric API Response + I->>H: SailPoint Identity Security API Response end ``` @@ -44,20 +44,20 @@ sequenceDiagram The flow involves these four key steps: -1. **Access Token Request**: The HTTP client (a script, application, Postman, cURL, etc.) makes a request to SHF to get a JWT `access_token`. -2. **Access Token Response**: If the request is valid, SHF responds to the HTTP client with a JWT `access_token`. -3. **API Request**: The HTTP client makes a request to an SHF endpoint with the header, `Authorization: Bearer {access_token}`. -4. **API Response**: If both the request itself and the JWT `access_token` in its header are valid, SHF responds to the client. If you encounter unexpected errors, refer to the [Troubleshooting](#troubleshooting) section of this document. +1. **Access Token Request**: The HTTP client (a script, application, Postman, cURL, etc.) makes a request to SailPoint Identity Security to get a JWT `access_token`. +2. **Access Token Response**: If the request is valid, SailPoint Identity Security responds to the HTTP client with a JWT `access_token`. +3. **API Request**: The HTTP client makes a request to a SailPoint Identity Security endpoint with the header, `Authorization: Bearer {access_token}`. +4. **API Response**: If both the request itself and the JWT `access_token` in its header are valid, SailPoint Identity Security responds to the client. If you encounter unexpected errors, refer to the [Troubleshooting](#troubleshooting) section of this document. -The idea is that once you have authenticated to the SHF APIs and you have received an `access_token`, you can use that `access_token` to provide authorization for your API requests. +The idea is that once you have authenticated to the SailPoint Identity Security APIs and you have received an `access_token`, you can use that `access_token` to provide authorization for your API requests. This document includes all the information you need to know to engage in this authentication/authorization process, as well as a guide on how to get started. ## Get started -Read this guide to learn how to authenticate to SailPoint's SHF APIs. +Read this guide to learn how to authenticate to SailPoint Identity Security APIs. -To authenticate to the SHF APIs, you must be able to connect to your tenant to send the access token request. To do so, you need to do the following: +To authenticate to the SailPoint Identity Security APIs, you must be able to connect to your tenant to send the access token request. To do so, you need to do the following: 1. [Find your tenant's OAuth details](#find-your-tenants-oauth-details) 2. [Generate personal access token](#generate-a-personal-access-token) @@ -68,12 +68,12 @@ To authenticate to the SHF APIs, you must be able to connect to your tenant to s Your tenant's OAuth details refer to the details you need to know to connect it to the APIs. You need to know your tenant's name, its `authorizeEndpoint` URL, and its `tokenEndpoint` URL. -Your SHF instance is likely using the domain name supplied by SailPoint (`[tenant].api.identitynow.com`), in which case, the tenant name is in the URL. This is assumed to be the case in this guide. -However, if your SHF instance is using a vanity URL, you must enter this URL into your browser to get your OAuth info: `https://[tenant].api.identitynow.com/oauth/info` +Your SailPoint Identity Security instance is likely using the domain name supplied by SailPoint (`[tenant].api.identitynow.com`), in which case, the tenant name is in the URL. This is assumed to be the case in this guide. +However, if your SailPoint Identity Security instance is using a vanity URL, you must enter this URL into your browser to get your OAuth info: `https://[tenant].api.identitynow.com/oauth/info` If you have admin access but don't know your tenant name, you can learn it by following these steps: -1. Log into your SHF instance. +1. Log into your SailPoint Identity Security instance. 2. Select the 'Dashboard' dropdown. 3. Select 'Overview'. 4. Find the tenant name ('Org Name') in the dashboard's `Org Details` section. @@ -111,9 +111,9 @@ You can use the `authorizeEndpoint` and `tokenEndpoint` URLs from your tenant to A personal access token (PAT) is a method of authenticating to an API as a user without providing a username and password. PATs are primarily used in scripts or programs that lack an easy way to implement an OAuth2 flow but need to call API endpoints that require user context. PATs are also convenient for use in tools like [Postman](https://www.postman.com/) when you are exploring and testing the APIs. -Any SHF user can generate a PAT. To do so, follow these steps: +Any SailPoint Identity Security user can generate a PAT. To do so, follow these steps: -1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. You can also go directly to the page by using this URL (replace `[tenant]` with your SailPoint Human Fabric tenant): `https://[tenant].identitynow.com/ui/d/user-preferences/personal-access-tokens` +1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. You can also go directly to the page by using this URL (replace `[tenant]` with your SailPoint Identity Security tenant): `https://[tenant].identitynow.com/ui/d/user-preferences/personal-access-tokens` 2. Click **New Token** and enter a meaningful description to help differentiate the token from others. @@ -142,7 +142,7 @@ Once you have created the PAT and you know its `Client ID` and `Client Secret`, There are several different authorization flows that OAuth 2.0 supports, and each has a grant-type defining its different use cases. You must choose the one that best serves your purposes. This document covers these three common flows: 1. [**Client Credentials**](https://oauth.net/2/grant-types/client-credentials/) - Clients use this grant type to obtain a JWT `access_token` without user involvement such as scripts, programs or system to system integration. -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 SHF with a subsequent redirect back to the web application/client. +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 SailPoint Identity Security 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/list-access-profiles-v-1): @@ -157,9 +157,9 @@ The guide will detail the three different authorization grant flows you can use Clients use the 'Client Credentials' grant type to obtain access tokens without user involvement. This is the simplest authentication flow. -API endpoints that require [user level permissions](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html) require the use of Personal access tokens (PATs). Correspondingly, the endpoints a personal access token (PAT) can call depends on the permissions of the user who generated it and the configuration of SHF. +API endpoints that require [user level permissions](https://documentation.sailpoint.com/saas/help/common/users/user_level_matrix.html) require the use of Personal access tokens (PATs). Correspondingly, the endpoints a personal access token (PAT) can call depends on the permissions of the user who generated it and the configuration of SailPoint Identity Security. -Note: If an API Key is used then SHF API calls are made outside of the context of a user and some API calls will not work. +Note: If an API Key is used then SailPoint Identity Security API calls are made outside of the context of a user and some API calls will not work. An OAuth 2.0 client using the client credentials grant flow must have `CLIENT_CREDENTIALS` as one of its grantTypes (PATs are implicitly granted the `CLIENT_CREDENTIALS` grant type): @@ -180,7 +180,7 @@ An OAuth 2.0 client using the client credentials grant flow must have `CLIENT_CR This is the overall authorization flow: -1. The client first submits an OAuth 2.0 token request to SHF in this form: +1. The client first submits an OAuth 2.0 token request to SailPoint Identity Security in this form: ```text POST https://[tenant].api.identitynow.com/oauth/token @@ -217,7 +217,7 @@ curl --location 'https://[tenant].api.identitynow.com/oauth/token' \ --form 'client_secret="{clientSecret}"' ``` -2. SHF validates the token request and responds. If the request is successful, the response contains a JWT access token. For more information about the JWT access token in the response, refer to [#OAuth-token-response](#oauth-token-response). +2. SailPoint Identity Security validates the token request and responds. If the request is successful, the response contains a JWT access token. For more information about the JWT access token in the response, refer to [#OAuth-token-response](#oauth-token-response). Once you have the JWT access token, you can pass the token as a basic "Authorization" header in your requests using the OAuth endpoints. @@ -227,7 +227,7 @@ To learn more about the OAuth client credentials grant flow, refer [here](https: Further Reading: [https://oauth.net/2/grant-types/authorization-code/](https://oauth.net/2/grant-types/authorization-code/) -Clients use this grant type to exchange an authorization code for an `access_token`. This is mainly used for web apps because there is a login into SHF with a subsequent redirect back to the web app/client. +Clients use this grant type to exchange an authorization code for an `access_token`. This is mainly used for web apps because there is a login into SailPoint Identity Security with a subsequent redirect back to the web app/client. The OAuth 2.0 client you are using must have `AUTHORIZATION_CODE` as one of its grant types. The redirect URLs must also match the list in the client as well: @@ -261,7 +261,7 @@ sequenceDiagram autonumber participant U as User participant W as Web App - participant I as SailPoint Human Fabric + participant I as SailPoint Identity Security U->>W: Click login link W->>I: Authorization request to https://[tenant].login.sailpoint.com/oauth/authorize @@ -278,19 +278,19 @@ This is the overall authorization flow: 1. The user clicks the login link on a web app. -2. The web app sends an authorization request to SHF in this form: +2. The web app sends an authorization request to SailPoint Identity Security in this form: ```Text GET https://[tenant].login.sailpoint.com/oauth/authorize?client_id={client-id}&response_type=code&redirect_uri={redirect-url} ``` -3. SHF redirects the user to a login prompt to authenticate to SailPoint Human Fabric. +3. SailPoint Identity Security redirects the user to a login prompt to authenticate. -4. The user authenticates to SHF. +4. The user authenticates to SailPoint Identity Security. -5. Once authentication is successful, SHF issues an authorization code back to the web app. +5. Once authentication is successful, SailPoint Identity Security issues an authorization code back to the web app. -6. The web app submits an OAuth 2.0 token request to SHF in this form: +6. The web app submits an OAuth 2.0 token request to SailPoint Identity Security in this form: ```text POST https://[tenant].api.identitynow.com/oauth/token?grant_type=authorization_code&client_id={client-id}&code={code}&redirect_uri={redirect-url} @@ -302,7 +302,7 @@ The token endpoint URL is `[tenant].api.identitynow.com`, and the authorize URL ::: -7. SHF validates the token request and submits a response. If the request is successful, the response contains a JWT `access_token`. For more information about the JWT access token in the response, refer to [#OAuth-token-response](#oauth-token-response). +7. SailPoint Identity Security validates the token request and submits a response. If the request is successful, the response contains a JWT `access_token`. For more information about the JWT access token in the response, refer to [#OAuth-token-response](#oauth-token-response). These are the query parameters in the OAuth 2.0 token request for the authorization code grant: @@ -345,7 +345,7 @@ These are the steps: `redirect_uri=https://developer.sailpoint.com/sailapps`, `code_challenge_method=S256`, and the `state`. -3. The user signs in. Identity Security Cloud redirects the browser to the page +3. The user signs in. SailPoint Identity Security redirects the browser to the page with `code` and `state` in the query string. 4. The page removes the query string from the address bar, and it displays one @@ -407,13 +407,13 @@ This is the overall authorization flow: 1. The client application receives an `access_token` and a `refresh_token` when using the `AUTHORIZATION_CODE` grant flow. 2. The client application detects that the `access_token` is about to expire, based on the `expires_in` attribute contained within the JWT token. -3. The client submits an OAuth 2.0 token request to SHF in this form: +3. The client submits an OAuth 2.0 token request to SailPoint Identity Security in this form: ```text POST https://[tenant].api.identitynow.com/oauth/token?grant_type=refresh_token&client_id={client_id}&client_secret={client_secret}&refresh_token={refresh_token} ``` -4. SHF validates the token request and submits a response. If the request is successful, the response contains a new `access_token` and `refresh_token`. +4. SailPoint Identity Security validates the token request and submits a response. If the request is successful, the response contains a new `access_token` and `refresh_token`. These are the query parameters in the OAuth 2.0 token request for the refresh token grant flow: @@ -461,7 +461,7 @@ A successful request using any of the grant flows to `https://[tenant].api.ident } ``` -You can use the JWT `access_token` to authorize REST API calls through the SHF API gateway. To use the `access_token`, simply include it in the `Authorization` header as a `Bearer` token. This is an example API request that has the access token in the header: +You can use the JWT `access_token` to authorize REST API calls through the SailPoint Identity Security API gateway. To use the `access_token`, simply include it in the `Authorization` header as a `Bearer` token. This is an example API request that has the access token in the header: ```bash curl -X GET \ @@ -478,7 +478,7 @@ Some of the other values can also be useful to know: - The `user_id` and `identity_id` define the identity context of the person who authenticated. However, these values aren't set for the client credentials grant type because it doesn't have a user context. -With the JWT `access_token`, you can now successfully send authenticated SHF API requests. To learn more about authorization and the scopes you can apply to further control access to the APIs, refer to [Authorization](/docs/api/authorization). +With the JWT `access_token`, you can now successfully send authenticated SailPoint Identity Security API requests. To learn more about authorization and the scopes you can apply to further control access to the APIs, refer to [Authorization](/docs/api/authorization). ## More Information @@ -558,25 +558,25 @@ For daily work or short, quick administrative actions, you can just use a PAT. T Follow these steps to do so: -1. Log in to SHF. +1. Log in to SailPoint Identity Security. 2. Go to 'Preferences', then 'Personal Access Tokens', and [generate a PAT](#generate-a-personal-access-token). 3. The PAT's `client_id` and `client_secret` provide the necessary authentication to send API requests, without any grant flow. #### Postman -[Postman](https://www.postman.com/) is a popular HTTP client you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a [public workspace for the SailPoint Human Fabric API collections](https://www.postman.com/sailpoint/workspace/identitynow). You can use this workspace to access all the SHF API collections and stay up to date. +[Postman](https://www.postman.com/) is a popular HTTP client you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a [public workspace for the SailPoint Identity Security API collections](https://www.postman.com/sailpoint/workspace/identitynow). You can use this workspace to access all the SailPoint Identity Security API collections and stay up to date. If you're using Postman, you have some different ways to set up your authorization. You can just leverage the accessToken as mentioned above, or you can configure Postman to use OAuth 2.0 directly. For more information about how to do so, refer [here](https://learning.postman.com/docs/sending-requests/authorization/). #### Web applications -If you are making a web application, the best grant flow to use is the [Authorization Code grant flow](#request-access-token-with-authorization-code-grant-flow). This will allow users to be directed to SHF to login and then redirected back to the web application through a URL redirect. This also works well with Single Sign-on (SSO), strong authentication, and pass-through authentication mechanisms. +If you are making a web application, the best grant flow to use is the [Authorization Code grant flow](#request-access-token-with-authorization-code-grant-flow). This will allow users to be directed to SailPoint Identity Security to login and then redirected back to the web application through a URL redirect. This also works well with Single Sign-on (SSO), strong authentication, and pass-through authentication mechanisms. -SailPoint doesn't recommend using a password grant flow for web applications because doing so would involve entering SHF credentials in the web application. This flow also doesn't allow you to work with SSO, strong authentication, or pass-through authentication. +SailPoint doesn't recommend using a password grant flow for web applications because doing so would involve entering SailPoint Identity Security credentials in the web application. This flow also doesn't allow you to work with SSO, strong authentication, or pass-through authentication. #### Scripts, programs or system to system integration -If you are writing scripts, programs or system integrations that leverage the SHF APIs, the OAuth 2.0 grant you should use typically depends on what you're doing and the user context you need to operate under. +If you are writing scripts, programs or system integrations that leverage the SailPoint Identity Security APIs, the OAuth 2.0 grant you should use typically depends on what you're doing and the user context you need to operate under. Because scripts, code, and programs lack an interactive web-interface, it is difficult, but not impossible, to implement a working authorization code grant flow. System to system integrations may require an elevated level of access and utilize a service account to make API calls beyond the privileges of the authenticated user. diff --git a/docs/api/authorization.md b/docs/api/authorization.md index 92266c66a43ff..8c684bba3281d 100644 --- a/docs/api/authorization.md +++ b/docs/api/authorization.md @@ -6,7 +6,7 @@ sidebar_label: Authorization sidebar_position: 3 sidebar_class_name: authorization keywords: ['authorization', 'scope', 'permission'] -description: Authorize your SHF API requests. +description: Authorize your SailPoint Identity Security API requests. slug: /api/authorization tags: ['Authorization', 'Scopes', 'Permissions'] --- @@ -23,7 +23,7 @@ Authorization and authentication are two related concepts that help secure APIs. sequenceDiagram autonumber participant H as HTTP Client - participant I as SailPoint Human Fabric + participant I as SailPoint Identity Security H->>I: Request to delete a source I->>I: Authenticate access token @@ -76,7 +76,7 @@ Each endpoint document specifies how to authorize with the endpoint in the **Aut ![Authorization Dropdown](./img/authorization/authorization-dropdown.png) -- **type**: The type of authorization method supported for this endpoint. SailPoint uses the [OAuth2 standard](./authentication.md#oauth-20) for all the SHF APIs. +- **type**: The type of authorization method supported for this endpoint. SailPoint uses the [OAuth2 standard](./authentication.md#oauth-20) for all the SailPoint Identity Security APIs. - **flow**: One or more OAuth flows supported by the endpoint. A token only needs to be generated by one flow to be valid. Refer to [Authentication Details](./authentication.md#choose-authorization-grant-flow) for more information about the available flows. - **scopes**: A list of scopes necessary to access the endpoint. A token only needs one of the scopes to authorize with the endpoint. When possible, choose the least privileged scope. Scopes ending in `read` can only retrieve data. Scopes ending in `manage` can retrieve, modify, and delete data. diff --git a/docs/api/getting-started.md b/docs/api/getting-started.md index dd667f752bf05..5323aac1e8b86 100644 --- a/docs/api/getting-started.md +++ b/docs/api/getting-started.md @@ -6,14 +6,14 @@ sidebar_label: Getting Started sidebar_position: 1 sidebar_class_name: gettingStarted keywords: ['getting started'] -description: Start using the SHF APIs. +description: Start using the SailPoint Identity Security APIs. slug: /api/getting-started tags: ['Getting Started'] --- ## Overview -This guide is intended to help you quickly Make your first API call to SailPoint Human Fabric and assumes an intermediate level of understanding of APIs. For beginners to APIs, we recommend you watch this presentation that covers the fundamentals of APIs with visual demonstrations of how to make an API call in SailPoint. +This guide is intended to help you quickly Make your first API call to SailPoint Identity Security and assumes an intermediate level of understanding of APIs. For beginners to APIs, we recommend you watch this presentation that covers the fundamentals of APIs with visual demonstrations of how to make an API call in SailPoint.
@@ -21,13 +21,13 @@ This guide is intended to help you quickly Make your first API call to SailPoint ## Find Your Tenant Name -To form the proper URL for an API request, you must know your tenant name. To find your tenant name, log into SailPoint Human Fabric, navigate to Admin, select the Dashboard dropdown, and select Overview. The org name is displayed within the Org Details section of the dashboard. If you do not have admin access, you can still find your tenant name and the API base URL you will use for API calls. To do so, view your session details when you are logged into your SailPoint Human Fabric instance. Change your URL to the following: `https://{your-tenant-hostname}.com/ui/session`, where `{your-tenant-hostname}` is your company's domain name for accessing SailPoint Human Fabric. The session detail you want is the `baseUrl`, which has the form of `https://{tenant}.api.identitynow.com`. +To form the proper URL for an API request, you must know your tenant name. To find your tenant name, log into SailPoint Identity Security, navigate to Admin, select the Dashboard dropdown, and select Overview. The org name is displayed within the Org Details section of the dashboard. If you do not have admin access, you can still find your tenant name and the API base URL you will use for API calls. To do so, view your session details when you are logged into your SailPoint Identity Security instance. Change your URL to the following: `https://{your-tenant-hostname}.com/ui/session`, where `{your-tenant-hostname}` is your company's domain name for accessing SailPoint Identity Security. The session detail you want is the `baseUrl`, which has the form of `https://{tenant}.api.identitynow.com`. ## Make your first API call -To get started, create a [personal access token](./authentication.md#generate-a-personal-access-token), which can then be used to generate access tokens to authenticate your API calls. To generate a personal access token from SailPoint Human Fabric, after logging into your SailPoint Human Fabric instance, do the following: +To get started, create a [personal access token](./authentication.md#generate-a-personal-access-token), which can then be used to generate access tokens to authenticate your API calls. To generate a personal access token from SailPoint Identity Security, after logging into your instance, do the following: -1. Select **Preferences** from the drop-down menu under your username. Then select **Personal Access Tokens** on the left. You can also go straight to the page using this URL, replacing `{tenant}` with your SailPoint Human Fabric tenant: `https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens`. +1. Select **Preferences** from the drop-down menu under your username. Then select **Personal Access Tokens** on the left. You can also go straight to the page using this URL, replacing `{tenant}` with your SailPoint Identity Security tenant: `https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens`. 2. Select **New Token** and enter a meaningful description to differentiate the token from others. @@ -47,13 +47,13 @@ The **New Token** button will be disabled when you reach the limit of 10 persona 4. Copy both values somewhere that will be secure and accessible to you when you need to use the the token. -5. To create an `access_token` that can be used to authenticate API requests, use the following cURL command, replacing `{tenant}` with your SailPoint Human Fabric tenant. The response body will contain an `access_token`, which will look like a long string of random characters. +5. To create an `access_token` that can be used to authenticate API requests, use the following cURL command, replacing `{tenant}` with your SailPoint Identity Security tenant. The response body will contain an `access_token`, which will look like a long string of random characters. ```bash curl --location --request POST 'https://{tenant}.api.identitynow.com/oauth/token?grant_type=client_credentials&client_id={client_id}&client_secret={secret}' ``` -6. To test your `access_token`, execute the following cURL command, replacing `{tenant}` with your SailPoint Human Fabric tenant and `access_token` with the token you generated in the previous step. If this is successful, you should get a JSON representation of an identity in your tenant. +6. To test your `access_token`, execute the following cURL command, replacing `{tenant}` with your SailPoint Identity Security tenant and `access_token` with the token you generated in the previous step. If this is successful, you should get a JSON representation of an identity in your tenant. ```bash curl --request GET --url 'https://{tenant}.api.identitynow.com/public-identities/v1?limit=1' --header 'authorization: Bearer {access_token}' diff --git a/docs/api/identity-security-cloud.md b/docs/api/identity-security-cloud.md index a02000a8953cb..77bcb9a9a90cb 100644 --- a/docs/api/identity-security-cloud.md +++ b/docs/api/identity-security-cloud.md @@ -1,19 +1,19 @@ +To learn more about the SailPoint Identity Security 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). --> diff --git a/docs/api/nerm/v1/authentication.md b/docs/api/nerm/v1/authentication.md index 9e474ce1b693d..f3ec85d8d858f 100644 --- a/docs/api/nerm/v1/authentication.md +++ b/docs/api/nerm/v1/authentication.md @@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem'; NERM supports two authentication methods to allow customers to authenticate to NERM API endpoints: 1. **NERM API Key (Legacy)** - NERM-specific bearer tokens -2. **SailPoint Human Fabric (SHF) API Token (Recommended)** - OAuth 2.0 JWT access tokens from SHF +2. **SailPoint Identity Security API Token (Recommended)** - OAuth 2.0 JWT access tokens from your tenant Both authentication methods use bearer tokens in the request header. @@ -32,7 +32,7 @@ Both authentication methods use bearer tokens in the request header. :::caution Deprecated -Legacy NERM API keys are deprecated and do not support scopes. Use SailPoint Human Fabric (SHF) API tokens instead. For details on the scopes available with SHF API tokens, refer to [Authorization](./authorization.md). +Legacy NERM API keys are deprecated and do not support scopes. Use SailPoint Identity Security API tokens instead. For details on the scopes available with SailPoint Identity Security API tokens, refer to [Authorization](./authorization.md). ::: @@ -48,19 +48,19 @@ curl --location 'https://mycompany.nonemployee.com/api/v1/non-employee-sources' ``` - + -### SHF API Token Authentication +### SailPoint Identity Security API Token Authentication -NERM now supports authentication using SailPoint Human Fabric (SHF) personal access tokens. This allows you to use the same authentication method across both SHF and NERM APIs. +NERM now supports authentication using SailPoint Identity Security personal access tokens. This allows you to use the same authentication method across both SailPoint Identity Security and NERM APIs. #### Generate a Personal Access Token -A personal access token (PAT) is a method of authenticating to an API as a user without providing a username and password. Any SHF user can generate a PAT by following these steps: +A personal access token (PAT) is a method of authenticating to an API as a user without providing a username and password. Any SailPoint Identity Security user can generate a PAT by following these steps: -1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. You can also go directly to the page by using this URL (replace `[tenant]` with your SailPoint Human Fabric tenant): `https://[tenant].identitynow.com/ui/d/user-preferences/personal-access-tokens` +1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. You can also go directly to the page by using this URL (replace `[tenant]` with your SailPoint Identity Security tenant): `https://[tenant].identitynow.com/ui/d/user-preferences/personal-access-tokens` 2. Click **New Token** and enter a meaningful description to help differentiate the token from others. @@ -123,8 +123,8 @@ The `expires_in` value in the token response describes the lifetime, in seconds, ## More Information -For detailed information about SHF authentication methods, grant flows, and troubleshooting, refer to the [SHF Authentication Guide](/docs/api/authentication). +For detailed information about SailPoint Identity Security authentication methods, grant flows, and troubleshooting, refer to the [Authentication Guide](/docs/api/authentication). For information about Non-Employee Risk Management authorization and scopes, refer to [Authorization](./authorization.md). -For information about how scopes work across SHF APIs, refer to the [SHF Authorization Guide](/docs/api/authorization). +For information about how scopes work across SailPoint Identity Security APIs, refer to the [Authorization Guide](/docs/api/authorization). diff --git a/docs/api/nerm/v1/authorization.md b/docs/api/nerm/v1/authorization.md index e729a05dc850a..0fafa9036af77 100644 --- a/docs/api/nerm/v1/authorization.md +++ b/docs/api/nerm/v1/authorization.md @@ -6,20 +6,20 @@ sidebar_label: Authorization sidebar_position: 3 sidebar_class_name: authorization keywords: ['authorization', 'scopes'] -description: Control what SHF API tokens can access with scopes. +description: Control what SailPoint Identity Security API tokens can access with scopes. slug: /api/nerm/v1/authorization tags: ['Authorization', 'Scopes'] --- ## Overview -SailPoint Human Fabric (SHF) API tokens support scopes. Scopes grant certain kinds of access to certain resource types in Non-Employee Risk Management, so you can give each integration only the access it needs instead of full administrator access. +SailPoint Identity Security API tokens support scopes. Scopes grant certain kinds of access to certain resource types in Non-Employee Risk Management, so you can give each integration only the access it needs instead of full administrator access. -When Non-Employee Risk Management receives a request authenticated with an SHF API token, it checks the scopes on that token against the resource type being requested and the kind of access the request needs. If none of the token's scopes grant that access, Non-Employee Risk Management rejects the request. +When Non-Employee Risk Management receives a request authenticated with a SailPoint Identity Security API token, it checks the scopes on that token against the resource type being requested and the kind of access the request needs. If none of the token's scopes grant that access, Non-Employee Risk Management rejects the request. -## SHF API Tokens Required for Scopes +## SailPoint Identity Security API Tokens Required for Scopes -Scopes only work with SHF API tokens. Legacy Non-Employee Risk Management API tokens do not support scopes. Legacy Non-Employee Risk Management API tokens are deprecated — use SHF API tokens instead. Refer to [Authentication](./authentication.md) for details on generating and using SHF API tokens. +Scopes only work with SailPoint Identity Security API tokens. Legacy Non-Employee Risk Management API tokens do not support scopes. Legacy Non-Employee Risk Management API tokens are deprecated — use SailPoint Identity Security API tokens instead. Refer to [Authentication](./authentication.md) for details on generating and using SailPoint Identity Security API tokens. ## Resource Types @@ -31,7 +31,7 @@ Scopes grant access to groups of related Non-Employee Risk Management resources: | Profile types | Profile types and profile type namings | | Workflows | Workflows, condition rules, workflow actions, and workflow action performers | | Workflow sessions | Workflow sessions | -| Users & roles | Users, roles, delegations, user profiles, user roles, user managers, role profiles, and SHF integration settings | +| Users & roles | Users, roles, delegations, user profiles, user roles, user managers, role profiles, and SailPoint Identity Security integration settings | | Templates/Configuration | Forms, form attributes, pages, page contents, page elements, page content translations, attributes, attribute options, attribute roles, risk levels, validations, and tables | | Advanced search | Advanced searches, advanced search profile types, and advanced search roles | | Audit | Audit events | @@ -85,7 +85,7 @@ A token can carry more than one scope. When it does, the token's access is the c If a token carries `nerm:general:manage`, it has full administrator access regardless of any other scopes on the token. -An SHF API token must carry at least one of the scopes listed above to call the Non-Employee Risk Management API. +A SailPoint Identity Security API token must carry at least one of the scopes listed above to call the Non-Employee Risk Management API. ## Denied Requests @@ -99,4 +99,4 @@ If a token's scopes don't grant the access a request needs, Non-Employee Risk Ma ## More Information -For information about how scopes work across SHF APIs, refer to the [SHF Authorization Guide](/docs/api/authorization). +For information about how scopes work across SailPoint Identity Security APIs, refer to the [Authorization Guide](/docs/api/authorization). diff --git a/docs/api/nerm/v1/getting-started.md b/docs/api/nerm/v1/getting-started.md index cb1fa9021ac83..36a0d0596fa9f 100644 --- a/docs/api/nerm/v1/getting-started.md +++ b/docs/api/nerm/v1/getting-started.md @@ -23,7 +23,7 @@ NERM supports two authentication methods: :::caution Deprecated -Legacy NERM API keys are deprecated and do not support scopes. Use SailPoint Human Fabric (SHF) API tokens instead, as described below. For details on the scopes available with SHF API tokens, refer to [Authorization](./authorization.md). +Legacy NERM API keys are deprecated and do not support scopes. Use SailPoint Identity Security API tokens instead, as described below. For details on the scopes available with SailPoint Identity Security API tokens, refer to [Authorization](./authorization.md). ::: @@ -31,13 +31,13 @@ To authenticate with a NERM-specific API key, you will need to generate a token -### 2. SailPoint Human Fabric (SHF) API Token (Recommended) +### 2. SailPoint Identity Security API Token (Recommended) -NERM now supports authentication using SailPoint Human Fabric (SHF) personal access tokens. This allows you to use the same authentication method across both SHF and NERM APIs. +NERM now supports authentication using SailPoint Identity Security personal access tokens. This allows you to use the same authentication method across both SailPoint Identity Security and NERM APIs. -To authenticate with an SHF token: +To authenticate with a SailPoint Identity Security token: -1. **Find your SHF tenant's OAuth details** - Your SHF instance is likely using the domain name supplied by SailPoint (`[tenant].api.identitynow.com`). If you have admin access but don't know your tenant name, you can find it in your SHF instance under Dashboard > Overview > Org Details. +1. **Find your SailPoint Identity Security tenant's OAuth details** - Your tenant is likely using the domain name supplied by SailPoint (`[tenant].api.identitynow.com`). If you have admin access but don't know your tenant name, you can find it in your tenant under Dashboard > Overview > Org Details. 2. **Generate a personal access token (PAT)** - Follow these steps: - Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left @@ -62,7 +62,7 @@ curl --location 'https://mycompany.nonemployee.com/api/v1/non-employee-sources' --header 'Authorization: Bearer {access_token}' ``` -For more detailed information about SHF authentication, refer to the [SHF Authentication Guide](/docs/api/authentication). +For more detailed information about SailPoint Identity Security authentication, refer to the [Authentication Guide](/docs/api/authentication). ## API Tools diff --git a/docs/api/nerm/v2025/authentication.md b/docs/api/nerm/v2025/authentication.md index d8939e0f5f77d..98c4301769a11 100644 --- a/docs/api/nerm/v2025/authentication.md +++ b/docs/api/nerm/v2025/authentication.md @@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem'; NERM supports two authentication methods to allow customers to authenticate to NERM API endpoints: 1. **NERM API Key (Legacy)** - NERM-specific bearer tokens -2. **SailPoint Human Fabric (SHF) API Token (Recommended)** - OAuth 2.0 JWT access tokens from SHF +2. **SailPoint Identity Security API Token (Recommended)** - OAuth 2.0 JWT access tokens from your tenant Both authentication methods use bearer tokens in the request header. @@ -32,7 +32,7 @@ Both authentication methods use bearer tokens in the request header. :::caution Deprecated -Legacy NERM API keys are deprecated and do not support scopes. Use SailPoint Human Fabric (SHF) API tokens instead. For details on the scopes available with SHF API tokens, refer to [Authorization](./authorization.md). +Legacy NERM API keys are deprecated and do not support scopes. Use SailPoint Identity Security API tokens instead. For details on the scopes available with SailPoint Identity Security API tokens, refer to [Authorization](./authorization.md). ::: @@ -48,19 +48,19 @@ curl --location 'https://mycompany.nonemployee.com/api/v2025/non-employee-source ``` - + -### SHF API Token Authentication +### SailPoint Identity Security API Token Authentication -NERM now supports authentication using SailPoint Human Fabric (SHF) personal access tokens. This allows you to use the same authentication method across both SHF and NERM APIs. +NERM now supports authentication using SailPoint Identity Security personal access tokens. This allows you to use the same authentication method across both SailPoint Identity Security and NERM APIs. #### Generate a Personal Access Token -A personal access token (PAT) is a method of authenticating to an API as a user without providing a username and password. Any SHF user can generate a PAT by following these steps: +A personal access token (PAT) is a method of authenticating to an API as a user without providing a username and password. Any SailPoint Identity Security user can generate a PAT by following these steps: -1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. You can also go directly to the page by using this URL (replace `[tenant]` with your SailPoint Human Fabric tenant): `https://[tenant].identitynow.com/ui/d/user-preferences/personal-access-tokens` +1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. You can also go directly to the page by using this URL (replace `[tenant]` with your SailPoint Identity Security tenant): `https://[tenant].identitynow.com/ui/d/user-preferences/personal-access-tokens` 2. Click **New Token** and enter a meaningful description to help differentiate the token from others. @@ -123,8 +123,8 @@ The `expires_in` value in the token response describes the lifetime, in seconds, ## More Information -For detailed information about SHF authentication methods, grant flows, and troubleshooting, refer to the [SHF Authentication Guide](/docs/api/authentication). +For detailed information about SailPoint Identity Security authentication methods, grant flows, and troubleshooting, refer to the [Authentication Guide](/docs/api/authentication). For information about Non-Employee Risk Management authorization and scopes, refer to [Authorization](./authorization.md). -For information about how scopes work across SHF APIs, refer to the [SHF Authorization Guide](/docs/api/authorization). +For information about how scopes work across SailPoint Identity Security APIs, refer to the [Authorization Guide](/docs/api/authorization). diff --git a/docs/api/nerm/v2025/authorization.md b/docs/api/nerm/v2025/authorization.md index 2fafe7f8f4598..f400aa4516f49 100644 --- a/docs/api/nerm/v2025/authorization.md +++ b/docs/api/nerm/v2025/authorization.md @@ -6,20 +6,20 @@ sidebar_label: Authorization sidebar_position: 3 sidebar_class_name: authorization keywords: ['authorization', 'scopes'] -description: Control what SHF API tokens can access with scopes. +description: Control what SailPoint Identity Security API tokens can access with scopes. slug: /api/nerm/v2025/authorization tags: ['Authorization', 'Scopes'] --- ## Overview -SailPoint Human Fabric (SHF) API tokens support scopes. Scopes grant certain kinds of access to certain resource types in Non-Employee Risk Management, so you can give each integration only the access it needs instead of full administrator access. +SailPoint Identity Security API tokens support scopes. Scopes grant certain kinds of access to certain resource types in Non-Employee Risk Management, so you can give each integration only the access it needs instead of full administrator access. -When Non-Employee Risk Management receives a request authenticated with an SHF API token, it checks the scopes on that token against the resource type being requested and the kind of access the request needs. If none of the token's scopes grant that access, Non-Employee Risk Management rejects the request. +When Non-Employee Risk Management receives a request authenticated with a SailPoint Identity Security API token, it checks the scopes on that token against the resource type being requested and the kind of access the request needs. If none of the token's scopes grant that access, Non-Employee Risk Management rejects the request. -## SHF API Tokens Required for Scopes +## SailPoint Identity Security API Tokens Required for Scopes -Scopes only work with SHF API tokens. Legacy Non-Employee Risk Management API tokens do not support scopes. Legacy Non-Employee Risk Management API tokens are deprecated — use SHF API tokens instead. Refer to [Authentication](./authentication.md) for details on generating and using SHF API tokens. +Scopes only work with SailPoint Identity Security API tokens. Legacy Non-Employee Risk Management API tokens do not support scopes. Legacy Non-Employee Risk Management API tokens are deprecated — use SailPoint Identity Security API tokens instead. Refer to [Authentication](./authentication.md) for details on generating and using SailPoint Identity Security API tokens. ## Resource Types @@ -31,7 +31,7 @@ Scopes grant access to groups of related Non-Employee Risk Management resources: | Profile types | Profile types and profile type namings | | Workflows | Workflows, condition rules, workflow actions, and workflow action performers | | Workflow sessions | Workflow sessions | -| Users & roles | Users, roles, delegations, user profiles, user roles, user managers, role profiles, and SHF integration settings | +| Users & roles | Users, roles, delegations, user profiles, user roles, user managers, role profiles, and SailPoint Identity Security integration settings | | Templates/Configuration | Forms, form attributes, pages, page contents, page elements, page content translations, attributes, attribute options, attribute roles, risk levels, validations, and tables | | Advanced search | Advanced searches, advanced search profile types, and advanced search roles | | Audit | Audit events | @@ -85,7 +85,7 @@ A token can carry more than one scope. When it does, the token's access is the c If a token carries `nerm:general:manage`, it has full administrator access regardless of any other scopes on the token. -An SHF API token must carry at least one of the scopes listed above to call the Non-Employee Risk Management API. +A SailPoint Identity Security API token must carry at least one of the scopes listed above to call the Non-Employee Risk Management API. ## Denied Requests @@ -99,4 +99,4 @@ If a token's scopes don't grant the access a request needs, Non-Employee Risk Ma ## More Information -For information about how scopes work across SHF APIs, refer to the [SHF Authorization Guide](/docs/api/authorization). +For information about how scopes work across SailPoint Identity Security APIs, refer to the [Authorization Guide](/docs/api/authorization). diff --git a/docs/api/nerm/v2025/getting-started.md b/docs/api/nerm/v2025/getting-started.md index 6d076423dcaac..67b16fe0039aa 100644 --- a/docs/api/nerm/v2025/getting-started.md +++ b/docs/api/nerm/v2025/getting-started.md @@ -23,7 +23,7 @@ NERM supports two authentication methods: :::caution Deprecated -Legacy NERM API keys are deprecated and do not support scopes. Use SailPoint Human Fabric (SHF) API tokens instead, as described below. For details on the scopes available with SHF API tokens, refer to [Authorization](./authorization.md). +Legacy NERM API keys are deprecated and do not support scopes. Use SailPoint Identity Security API tokens instead, as described below. For details on the scopes available with SailPoint Identity Security API tokens, refer to [Authorization](./authorization.md). ::: @@ -31,13 +31,13 @@ To authenticate with a NERM-specific API key, you will need to generate a token -### 2. SailPoint Human Fabric (SHF) API Token (Recommended) +### 2. SailPoint Identity Security API Token (Recommended) -NERM now supports authentication using SailPoint Human Fabric (SHF) personal access tokens. This allows you to use the same authentication method across both SHF and NERM APIs. +NERM now supports authentication using SailPoint Identity Security personal access tokens. This allows you to use the same authentication method across both SailPoint Identity Security and NERM APIs. -To authenticate with an SHF token: +To authenticate with a SailPoint Identity Security token: -1. **Find your SHF tenant's OAuth details** - Your SHF instance is likely using the domain name supplied by SailPoint (`[tenant].api.identitynow.com`). If you have admin access but don't know your tenant name, you can find it in your SHF instance under Dashboard > Overview > Org Details. +1. **Find your SailPoint Identity Security tenant's OAuth details** - Your tenant is likely using the domain name supplied by SailPoint (`[tenant].api.identitynow.com`). If you have admin access but don't know your tenant name, you can find it in your tenant under Dashboard > Overview > Org Details. 2. **Generate a personal access token (PAT)** - Follow these steps: - Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left @@ -62,7 +62,7 @@ curl --location 'https://mycompany.nonemployee.com/api/v2025/non-employee-source --header 'Authorization: Bearer {access_token}' ``` -For more detailed information about SHF authentication, refer to the [SHF Authentication Guide](/docs/api/authentication). +For more detailed information about SailPoint Identity Security authentication, refer to the [Authentication Guide](/docs/api/authentication). ## API Tools diff --git a/docs/api/nerm/v2025/pagination-filtering.md b/docs/api/nerm/v2025/pagination-filtering.md index cca4741f119f4..4c716f8656b96 100644 --- a/docs/api/nerm/v2025/pagination-filtering.md +++ b/docs/api/nerm/v2025/pagination-filtering.md @@ -11,7 +11,7 @@ slug: /api/nerm/v2025/pagination-filtering tags: ['Pagination Filtering'] --- -Many endpoints in the SailPoint Human Fabric API support a generic syntax for paginating, filtering and sorting the results. A collection endpoint has the following characteristics: +Many endpoints in the SailPoint Identity Security API support a generic syntax for paginating, filtering and sorting the results. A collection endpoint has the following characteristics: - The HTTP verb is always GET. - The last component in the URL is a plural noun (ex. `/v3/public-identities`). diff --git a/docs/api/patch-requests.md b/docs/api/patch-requests.md index 703b705bb27c2..335bd6e9a4d56 100644 --- a/docs/api/patch-requests.md +++ b/docs/api/patch-requests.md @@ -6,13 +6,13 @@ sidebar_label: Patch Requests sidebar_position: 8 sidebar_class_name: patchRequests keywords: ['patch'] -description: Send PATCH SHF API requests. +description: Send PATCH SailPoint Identity Security API requests. tags: ['patch', 'guide'] --- ## PATCH requests -You can use the SailPoint Human Fabric APIs to update existing resources. Many of the APIs offer multiple ways to do so: +You can use the SailPoint Identity Security 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/put-account-v-1) 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. @@ -24,9 +24,9 @@ This guide will focus on the partial update method, PATCH requests. Read this gu To use PATCH to update a resource, you first need to know the resource ID. -Not all resource IDs are available in the SailPoint Human Fabric UI, so you may need to use the API to find the ID for the resource you want to update. +Not all resource IDs are available in the SailPoint Identity Security 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 SailPoint Human Fabric UI. If you want to use the [Patch Account](https://developer.sailpoint.com/docs/api/update-account-v-1) 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 SailPoint Identity Security UI. If you want to use the [Patch Account](https://developer.sailpoint.com/docs/api/update-account-v-1) 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/list-accounts-v-1) 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. @@ -623,6 +623,6 @@ When the request is successful, the API will return the updated resource. ## Get started -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 SailPoint Human Fabric PATCH endpoints and which paths can be changed for each one, refer to their API specifications. +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 SailPoint Identity Security 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! diff --git a/docs/api/postman-collections.md b/docs/api/postman-collections.md index a6fd621627485..6b14ca94ca99c 100644 --- a/docs/api/postman-collections.md +++ b/docs/api/postman-collections.md @@ -6,21 +6,21 @@ sidebar_label: Postman Collections sidebar_position: 7 sidebar_class_name: postmanCollections keywords: ['postman'] -description: Run SHF APIs in Postman. +description: Run SailPoint Identity Security APIs in Postman. tags: ['postman'] --- import CMSLinkComponent from '@site/src/components/PostmanLink'; -[Postman](https://www.postman.com/) is a platform you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a [public workspace for the SailPoint Human Fabric API collections](https://www.postman.com/sailpoint/workspace/identitynow). You can use this workspace to access all the SHF API collections and stay up to date. +[Postman](https://www.postman.com/) is a platform you can use to design, build, test, and iterate your APIs. Postman users and teams can create public workspaces they can use to make it easy to access their API collections and environments and get started. SailPoint maintains a [public workspace for the SailPoint Identity Security API collections](https://www.postman.com/sailpoint/workspace/identitynow). You can use this workspace to access all the SailPoint Identity Security API collections and stay up to date. ## Run in Postman -The following table lists the available SHF API collections. To import a collection into your workspace, select the 'Run in Postman' button for your desired collection. Doing so forks the collection into your workspace. +The following table lists the available SailPoint Identity Security API collections. To import a collection into your workspace, select the 'Run in Postman' button for your desired collection. Doing so forks the collection into your workspace. | API | Postman Collection | | --- | --- | -| SHF API | | +| SailPoint Identity Security API | | | NERM API | | | NERM 2025 API | | | SaaS Connectivity | [![Run in Postman](./img/button.svg)](https://god.gw.postman.com/run-collection/23226990-a0b5c429-d8dd-4fe2-a4a2-eb7ff85322ef?action=collection%2Ffork&collection-url=entityId%3D23226990-a0b5c429-d8dd-4fe2-a4a2-eb7ff85322ef%26entityType%3Dcollection%26workspaceId%3D80af54be-a333-4712-af5e-41aa9eccbdd0) | @@ -29,7 +29,7 @@ You can also fork a collection by selecting the ellipses to the right of the col ## Update your collections -SailPoint is often making improvements to the SHF API collections. In order to get the latest updates to the Postman collection, you will need to visit the [sailpoint workspace](https://www.postman.com/sailpoint/workspace/identitynow) or click the "Run in Postman" button for the desired collection above. This will create a new fork in your Postman workspace while leaving your previous forks as-is. +SailPoint is often making improvements to the SailPoint Identity Security API collections. In order to get the latest updates to the Postman collection, you will need to visit the [sailpoint workspace](https://www.postman.com/sailpoint/workspace/identitynow) or click the "Run in Postman" button for the desired collection above. This will create a new fork in your Postman workspace while leaving your previous forks as-is. ## Configure your environment @@ -37,13 +37,13 @@ The SailPoint workspace provides an environment, a set of variables you can use | Environment | | | --- | --- | -| SHF Environment | [![Run in Postman](./img/button.svg)](https://www.postman.com/sailpoint/workspace/identitynow/environment/23226990-ed571d4f-37a3-4a2c-9105-5d8d8cce1d20/fork) | +| SailPoint Identity Security Environment | [![Run in Postman](./img/button.svg)](https://www.postman.com/sailpoint/workspace/identitynow/environment/23226990-ed571d4f-37a3-4a2c-9105-5d8d8cce1d20/fork) | To send API requests in Postman, you must authenticate to the APIs. To authenticate to the APIs, you must specify these variables in your Postman environment: | Environment Variable | Required | Description | | --- | --- | --- | -| tenant | Yes | Your SHF tenant, typically your company's name | +| tenant | Yes | Your SailPoint Identity Security tenant, typically your company's name | | clientId | Yes | The client ID for the API client or personal access token | | clientSecret | Yes | The client secret for the API client or personal access token | | domain | No | This optional field is only necessary for those who have a domain in their API URL that isn't "identitynow". | @@ -64,7 +64,7 @@ Anything you want to change about the Postman collection? We love feedback! Disc ## Deprecated collections -The following collections are no longer actively maintained. They are provided here for reference, but we recommend migrating to the **SHF API** collection above. +The following collections are no longer actively maintained. They are provided here for reference, but we recommend migrating to the **SailPoint Identity Security API** collection above. | API | Postman Collection | | --- | --- | diff --git a/docs/api/rate-limit.md b/docs/api/rate-limit.md index e59fa79c16c04..f26e313bf2566 100644 --- a/docs/api/rate-limit.md +++ b/docs/api/rate-limit.md @@ -6,7 +6,7 @@ sidebar_label: Rate Limiting sidebar_position: 6 sidebar_class_name: rateLimit keywords: ['rate limit'] -description: SHF API rate limits. +description: SailPoint Identity Security API rate limits. tags: ['Rate Limit'] --- diff --git a/docs/api/standard-collection-parameters.md b/docs/api/standard-collection-parameters.md index 154e5a1ed5d9f..b798eddebcbb4 100644 --- a/docs/api/standard-collection-parameters.md +++ b/docs/api/standard-collection-parameters.md @@ -6,11 +6,11 @@ sidebar_label: Standard Collection Parameters sidebar_position: 5 sidebar_class_name: standardCollectionParameters keywords: ['standard collection parameters','filter','pagination','paginate','sort'] -description: SHF API pagination, filtering, and sorting. +description: SailPoint Identity Security API pagination, filtering, and sorting. tags: ['Standard Collection Parameters','Filter','Sort','Pagination'] --- -Many endpoints in the SailPoint Human Fabric API support a generic syntax for paginating, filtering and sorting the results. A collection endpoint has the following characteristics: +Many endpoints in the SailPoint Identity Security API support a generic syntax for paginating, filtering and sorting the results. A collection endpoint has the following characteristics: - The HTTP verb is always GET. - The last component in the URL is a plural noun (ex. `/public-identities/v1`). @@ -34,7 +34,7 @@ Examples: ## Paginating Search Queries -The [search API](https://developer.sailpoint.com/docs/api/search) in SailPoint Human Fabric leverages [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html) functionality, which returns a maximum of 10,000 records by default. However, you can page more than 10,000 records by using the "searchAfter" property. +The [search API](https://developer.sailpoint.com/docs/api/search) in SailPoint Identity Security 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 7b3f46739aee6..d2dfcce84e5e8 100644 --- a/docs/connectivity.md +++ b/docs/connectivity.md @@ -6,14 +6,14 @@ sidebar_label: Connectivity sidebar_position: 1 sidebar_class_name: connectivity keywords: ['connectivity'] -description: Build and expand SHF connectivity. +description: Build and expand SailPoint Identity Security connectivity. slug: /connectivity tags: ['connectivity'] --- ## Overview -Connectivity refers to SailPoint Human Fabric's (SHF) ability to connect to many different [sources](https://documentation.sailpoint.com/saas/help/sources/index.html) of many different types. Organizations can then manage access to the different sources and ensure that the access is secure. +Connectivity refers to SailPoint Identity Security's ability to connect to many different [sources](https://documentation.sailpoint.com/saas/help/sources/index.html) of many different types. Organizations can then manage access to the different sources and ensure that the access is secure. ```mdx-code-block import DocCardList from '@theme/DocCardList'; @@ -24,6 +24,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about SHF 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 SailPoint Identity Security connectivity and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/docs/connectivity/saas-connectivity/build-basic-connector.md b/docs/connectivity/saas-connectivity/build-basic-connector.md index a23c7aa207cd2..9432e3d38fe6c 100644 --- a/docs/connectivity/saas-connectivity/build-basic-connector.md +++ b/docs/connectivity/saas-connectivity/build-basic-connector.md @@ -13,7 +13,7 @@ tags: ['Connectivity'] ## Objectives -This guide will walk you through the process of building a SaaS connector. You will learn how to build a SaaS connector that connects SailPoint Human Fabric (SHF) to a cloud-based source called [Airtable](https://airtable.com). +This guide will walk you through the process of building a SaaS connector. You will learn how to build a SaaS connector that connects SailPoint Identity Security to a cloud-based source called [Airtable](https://airtable.com). In addition to learning how to build the SaaS connector, you will learn how to deploy, debug, and test it as well. @@ -32,13 +32,13 @@ Once you have learned how to build an Airtable connector, you will know how to b ## SaaS connectivity -[Connectors](https://documentation.sailpoint.com/saas/help/sources/index.html) are the bridges between SHF and the various source systems SHF needs to communicate with and aggregate data from. These connectors require the use of virtual appliances (VAs). +[Connectors](https://documentation.sailpoint.com/saas/help/sources/index.html) are the bridges between SailPoint Identity Security and the various source systems it needs to communicate with and aggregate data from. These connectors require the use of virtual appliances (VAs). -**SaaS connectors** use [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity), a framework you can use to connect SHF, a SaaS platform, to other cloud-based sources without the use of a VA as a go-between. +**SaaS connectors** use [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity), a framework you can use to connect SailPoint Identity Security, a SaaS platform, to other cloud-based sources without the use of a VA as a go-between. SaaS Connectivity provides these benefits: -- The ability to develop, debug, and test custom connectors locally, without any dependencies on SHF. +- The ability to develop, debug, and test custom connectors locally, without any dependencies on SailPoint Identity Security. - Features you can use to customize the user interface (UI) in ways specific to the source. - Support for modern languages and frameworks. @@ -51,7 +51,7 @@ To build an Airtable connector, you will need these resources: - [SailPoint CLI](https://developer.sailpoint.com/docs/tools/cli): The SailPoint command line interface (CLI) is a command line tool you can use to leverage the SaaS Connectivity functionality and start building SaaS connectors much more quickly and easily. Get the latest release [here](https://github.com/sailpoint-oss/sailpoint-cli/releases). - [IDE](https://code.visualstudio.com/): Use an integrated development environment (IDE), like [VSCode](https://code.visualstudio.com/), to develop, deploy, and debug the SaaS connector. You can get the latest release [here](https://code.visualstudio.com/Download). - [Postman](https://www.postman.com/): Postman is an API platform you can use to send test API requests. SailPoint maintains a collection of SaaS Connectivity commands in Postman that you can access [here](https://www.postman.com/sailpoint/identitynow/folder/kv75eb5/connector-commands). This collection of commands makes it quick and easy for you to test SaaS connector commands. -- [SHF](https://documentation.sailpoint.com/saas/help/setup/get_started.html): You need an SHF tenant you can connect to Airtable. +- [SailPoint Identity Security](https://documentation.sailpoint.com/saas/help/setup/get_started.html): You need a SailPoint Identity Security tenant you can connect to Airtable. - [Airtable](https://airtable.com/): You need to create an account on Airtable, the source you are connecting to. Airtable is a cloud-based relational database platform - it is a bit like Excel, but it is useful for this example because you can send API requests to modify the data in the tables. ## Create project @@ -177,7 +177,7 @@ Open [Airtable](https://airtable.com/). Follow these steps to create the table y - Name the fourth column, 'fullname'. 5. Populate the table with some dummy data. Create at least two accounts, along with their attributes. -You will use your SaaS connector to aggregate this table's accounts into SHF and make changes to those accounts. +You will use your SaaS connector to aggregate this table's accounts into SailPoint Identity Security and make changes to those accounts. The table will look something like this example: @@ -418,26 +418,26 @@ Your SaaS connector is now configured to authenticate its API requests to Airtab Once your SaaS connector's authentication is configured, you can configure Postman to test the connection between the SaaS connector and Airtable. -1. Open Postman. In the upper right corner, you can select the environment variables you will store so you can use them whenever you send API requests to Airtable or SHF. +1. Open Postman. In the upper right corner, you can select the environment variables you will store so you can use them whenever you send API requests to Airtable or SailPoint Identity Security. 2. Use the '+' button to create a new environment. - The first three environment variables you need, `tenant`, `clientId`, and `clientSecret`, will authenticate your API requests to SHF. If you have configured your SailPoint CLI, you can the same variables from your CLI's PAT. Otherwise, you can refer to [Authentication](/docs/api/authentication/#generate-a-personal-access-token) to learn how to create a PAT and get these variables. + The first three environment variables you need, `tenant`, `clientId`, and `clientSecret`, will authenticate your API requests to SailPoint Identity Security. If you have configured your SailPoint CLI, you can the same variables from your CLI's PAT. Otherwise, you can refer to [Authentication](/docs/api/authentication/#generate-a-personal-access-token) to learn how to create a PAT and get these variables. The fourth environment variable, `airtableAPIKey` will authenticate your API requests. You will use the PAT you generated in Airtable for this variable. -3. To authenticate your API requests to SHF, specify values for these variables in their 'Initial value' and 'Current value' fields: +3. To authenticate your API requests to SailPoint Identity Security, specify values for these variables in their 'Initial value' and 'Current value' fields: | Environment Variable | Required | Description | | --- | --- | --- | - | `tenant` | Yes | Your SHF tenant, typically your company's name. | + | `tenant` | Yes | Your SailPoint Identity Security tenant, typically your company's name. | | `clientId` | Yes | The client ID for the API client or personal access token. Keep this private and secure. | | `clientSecret` | Yes | The client secret for the API client or personal access token. Keep this private and secure. | | `airtableAPIKey` | Yes | The Airtable PAT. Keep this private and secure. | 4. Save your environment to finalize your changes. -5. Select the environment from the environment dropdown menu. All your API requests will automatically include these variables, authenticating them for both Airtable and SHF. +5. Select the environment from the environment dropdown menu. All your API requests will automatically include these variables, authenticating them for both Airtable and SailPoint Identity Security. ## Implement test connection command @@ -708,7 +708,7 @@ Click the breakpoint again to remove it so that you can run your connector witho ## Implement Account List Command -The next command you're going to run is [Account List](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/commands/account-list). This command allows you to get all the accounts from your table, along with their account attributes. This command also allows you to manually aggregate Airtable account data within SHF. +The next command you're going to run is [Account List](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/commands/account-list). This command allows you to get all the accounts from your table, along with their account attributes. This command also allows you to manually aggregate Airtable account data within SailPoint Identity Security. To implement Account List, follow these steps: @@ -718,7 +718,7 @@ To implement Account List, follow these steps: ### Create AirtableAccount Typescript file -To implement Account List and successfully aggregate account data into SHF, the first thing you must do is create a new Typescript file, titled 'AirtableAccount.ts'. You will use this file to create a class that will act as a wrapper around the Airtable account record data, which you can then convert to standard output formats and back to Airtable-compatible objects. +To implement Account List and successfully aggregate account data into SailPoint Identity Security, the first thing you must do is create a new Typescript file, titled 'AirtableAccount.ts'. You will use this file to create a class that will act as a wrapper around the Airtable account record data, which you can then convert to standard output formats and back to Airtable-compatible objects. Follow these steps to configure your 'AirtableAccount.ts' file: @@ -764,9 +764,9 @@ Follow these steps to configure your 'AirtableAccount.ts' file: } ``` - The `createwithRecords` static method takes a `Record` and its `Fieldset` from the Airtable table as an input and uses it to create an `AirtableAccount` instance with all the account's attributes. You will then be able to use this instance to create the Airtable account's corresponding SHF account. This is essential for aggregating the Airtable account data into SHF. + The `createwithRecords` static method takes a `Record` and its `Fieldset` from the Airtable table as an input and uses it to create an `AirtableAccount` instance with all the account's attributes. You will then be able to use this instance to create the Airtable account's corresponding SailPoint Identity Security account. This is essential for aggregating the Airtable account data into SailPoint Identity Security. - The `identity` refers to the actual table row of the account in Airtable. SHF will use the `identity` for an 'Native Identity ID', as well as their 'Account ID' on the source. + The `identity` refers to the actual table row of the account in Airtable. SailPoint Identity Security will use the `identity` for an 'Native Identity ID', as well as their 'Account ID' on the source. 6. Write the `buildStandardObject` private method within the `AirtableAccount` class, after the `createwithRecords` static method: @@ -878,7 +878,7 @@ Once you have finished creating your 'AirtableAccount.ts' file, you can implemen } ``` - This command now uses the `AirtableAccount` class to not only return all the Airtable table's lists but also create an instance you can later use to aggregate the account data into SHF. + This command now uses the `AirtableAccount` class to not only return all the Airtable table's lists but also create an instance you can later use to aggregate the account data into SailPoint Identity Security. 5. To simplify the file, remove the `getAccount` asynchronous function for now. You will implement it correctly later. @@ -1097,7 +1097,7 @@ Your SaaS connector will get a successful response from Airtable, listing all th At this point, your SaaS connector can successfully connect to Airtable and list accounts along with their attributes. -Before implementing more commands, you will learn how to configure the other side of the bridge, the connection to SHF. +Before implementing more commands, you will learn how to configure the other side of the bridge, the connection to SailPoint Identity Security. This is a good time to stop and examine your code. This is how your code should currently look: @@ -1251,33 +1251,33 @@ export class AirtableAccount { -## Connect to SHF +## Connect to SailPoint Identity Security -Before implementing any more new commands, this is a good time to connect your SaaS connector to SHF. +Before implementing any more new commands, this is a good time to connect your SaaS connector to SailPoint Identity Security. -You're going to use your terminal in VSCode and your command line to leverage the SailPoint CLI. You will build your SaaS connector project, create an empty SaaS connector in SHF, and then upload your connector to SHF. +You're going to use your terminal in VSCode and your command line to leverage the SailPoint CLI. You will build your SaaS connector project, create an empty SaaS connector in SailPoint Identity Security, and then upload your connector to your tenant. -To create your SaaS connector in SHF and load account data from Airtable, you must follow these steps: +To create your SaaS connector in SailPoint Identity Security and load account data from Airtable, you must follow these steps: 1. [Build Project](#build-project) -2. [Create Empty SHF Connector](#create-empty-shf-connector) -3. [Upload Connector to SHF](#upload-connector-to-shf) +2. [Create Empty SailPoint Identity Security Connector](#create-empty-sailpoint-identity-security-connector) +3. [Upload Connector to SailPoint Identity Security](#upload-connector-to-sailpoint-identity-security) 4. [Test Connector](#test-connector) -5. [Create Empty SHF Connector](#create-empty-shf-connector) -6. [Configure SHF Connector](#configure-shf-connector) +5. [Create Empty SailPoint Identity Security Connector](#create-empty-sailpoint-identity-security-connector) +6. [Configure SailPoint Identity Security Connector](#configure-sailpoint-identity-security-connector) 7. [Aggregate Airtable Account Data](#aggregate-airtable-account-data) ### Build project -Building your SaaS connector project means compressing your SaaS connector project's files into a zip file before uploading the connector to SHF. Before you can build your connector, however, you must update your 'connector-spec.json' file. +Building your SaaS connector project means compressing your SaaS connector project's files into a zip file before uploading the connector to SailPoint Identity Security. Before you can build your connector, however, you must update your 'connector-spec.json' file. -The 'connector-spec.json' file tells SHF how the connector works. At a high level, it provides this information: +The 'connector-spec.json' file tells SailPoint Identity Security how the connector works. At a high level, it provides this information: - Commands the connector supports - The `config` values the user must provide when they create the connector - Account schema definitions - Entitlement schema definitions -- Definitions for the Account Create template that maps fields between SHF and the connector +- Definitions for the Account Create template that maps fields between SailPoint Identity Security and the connector You must make some edits to this file because the authentication configuration and account schema are currently incorrect. To do so, follow these steps: @@ -1373,7 +1373,7 @@ The authentication process now looks for the correct keys, `apiKey` and `airtabl ] ``` - The `entitlementSchemas` tell SHF the format and data types to expect for entitlement objects. + The `entitlementSchemas` tell SailPoint Identity Security the format and data types to expect for entitlement objects. 4. Add the `accountCreateTemplate` account mapping after the `entitlementSchemas`: @@ -1420,7 +1420,7 @@ The authentication process now looks for the correct keys, `apiKey` and `airtabl } ``` - The `accountCreateTemplate` is provides SHF with a template it can use to map incoming values to their respective fields in SHF. + The `accountCreateTemplate` is provides SailPoint Identity Security with a template it can use to map incoming values to their respective fields. 5. Save these changes and run the project with `npm run dev` to ensure that the changes didn't break anything. @@ -1430,13 +1430,13 @@ The authentication process now looks for the correct keys, `apiKey` and `airtabl npm run pack-zip ``` - This command bundles the SaaS connector project's files into a zip file, 'your-projectname-0.1.0.zip', located in your project's 'dist' folder. You can now send this zip file to SHF. + This command bundles the SaaS connector project's files into a zip file, 'your-projectname-0.1.0.zip', located in your project's 'dist' folder. You can now send this zip file to SailPoint Identity Security. -### Create empty SHF connector +### Create empty SailPoint Identity Security connector -Before you can upload your SaaS connector to SHF, you must create an entry for the connector in your SHF tenant. +Before you can upload your SaaS connector to SailPoint Identity Security, you must create an entry for the connector in your tenant. To create an empty connector to upload your file to, run this command in your terminal or command line: @@ -1444,7 +1444,7 @@ To create an empty connector to upload your file to, run this command in your te sail conn create my-projectname ``` -This command creates an empty connector in your SHF tenant. You will use this empty connector's ID to upload your connector to SHF. When you run the command successfully, the terminal outputs a response like this: +This command creates an empty connector in your SailPoint Identity Security tenant. You will use this empty connector's ID to upload your connector to SailPoint Identity Security. When you run the command successfully, the terminal outputs a response like this: ```powershell +--------------------------------------+--------------------+ @@ -1460,15 +1460,15 @@ You can use the the `sail conn list` command to list the available connectors at -### Upload connector to SHF +### Upload connector to SailPoint Identity Security -Once you have created the SaaS connector in SHF and gotten its connector ID, you can upload your SaaS connector project to SHF. To upload your connector, run this command: +Once you have created the SaaS connector in SailPoint Identity Security and gotten its connector ID, you can upload your SaaS connector project to your tenant. To upload your connector, run this command: ```powershell sail conn upload -c [connector ID] -f dist/[connector filename].zip ``` -You must provide the connector ID, name (alias), and zip filename to upload it to SHF. +You must provide the connector ID, name (alias), and zip filename to upload it to SailPoint Identity Security. A successful response looks like this: @@ -1482,9 +1482,9 @@ A successful response looks like this: ### Test connector -It can be very helpful to test your SaaS connector before you go through all the steps of configuring it in SHF. +It can be very helpful to test your SaaS connector before you go through all the steps of configuring it in SailPoint Identity Security. -The SailPoint CLI has a [validate command](/docs/tools/cli/connectors/#validate-a-connector) you can use to run a suite of integration tests against your connector to ensure that all the basic functionality works. The CLI also has an [invoke command](/docs/tools/cli/connectors/#invoke-command) you can use to test specific connector commands. The `validate` and `invoke` commands allow you to use the CLI to run tests without ever having to actually go into SHF. +The SailPoint CLI has a [validate command](/docs/tools/cli/connectors/#validate-a-connector) you can use to run a suite of integration tests against your connector to ensure that all the basic functionality works. The CLI also has an [invoke command](/docs/tools/cli/connectors/#invoke-command) you can use to test specific connector commands. The `validate` and `invoke` commands allow you to use the CLI to run tests without ever having to actually go into SailPoint Identity Security. Before you can run the tests, you must create a 'config.json' file. You must include your `apiKey` and `airtableBase` credentials in the 'config.json' file to authenticate the requests you want to send for the tests. @@ -1533,19 +1533,19 @@ The CLI will go through the different commands and skip tests for any commands t -### Configure SHF connector +### Configure SailPoint Identity Security connector -Once you have uploaded the SaaS connector to SHF and tested it, you can configure it in SHF. Follow these steps to configure your connector in SHF: +Once you have uploaded the SaaS connector to SailPoint Identity Security and tested it, you can configure it in your tenant. Follow these steps to configure your connector in SailPoint Identity Security: -1. Open SHF and log in. Go to 'Admin' and expand the 'Connections' dropdown menu. Select 'Sources' from the menu. +1. Open SailPoint Identity Security and log in. Go to 'Admin' and expand the 'Connections' dropdown menu. Select 'Sources' from the menu. - You will see a list of the available sources in your SHF tenant. + You will see a list of the available sources in your SailPoint Identity Security tenant. -2. To create a new source in SHF to connect to Airtable, select the 'Create New' button. +2. To create a new source in SailPoint Identity Security to connect to Airtable, select the 'Create New' button. 3. You will see a list of available connectors, or source types. Find your connector by its name. Select 'Configure'. -4. You will see a panel with the connector's 'Base Configuration', fields you can use to provide your connector's required details: 'Source Name', 'Description', and 'Source Owner'. Name your source, provide a description, and select a source owner in SHF from the list. +4. You will see a panel with the connector's 'Base Configuration', fields you can use to provide your connector's required details: 'Source Name', 'Description', and 'Source Owner'. Name your source, provide a description, and select a source owner in SailPoint Identity Security from the list. 5. Once you have provided those details, you will see the full source configuration page. Open the next section, 'Configuration'. You will see the 'apiKey' and 'airtableBase' fields from your connector listed. Provide your Airtable API key and the base ID and save your changes. @@ -1553,11 +1553,11 @@ Once you have uploaded the SaaS connector to SHF and tested it, you can configur ### Aggregate Airtable account data -Once you have configured your SaaS connector in SHF and successfully connected to your Airtable base, you can aggregate the Airtable account data into SHF. To do so, follow these steps: +Once you have configured your SaaS connector in SailPoint Identity Security and successfully connected to your Airtable base, you can aggregate the Airtable account data into your tenant. To do so, follow these steps: -First, open the SaaS connector and open its 'Account Aggregation' tab, under 'Account Management. To load the account data into SHF, click 'Start Aggregation' in the upper right. Doing so starts an aggregation whose progress you can track at the bottom of the window. +First, open the SaaS connector and open its 'Account Aggregation' tab, under 'Account Management. To load the account data into SailPoint Identity Security, click 'Start Aggregation' in the upper right. Doing so starts an aggregation whose progress you can track at the bottom of the window. -Once the accounts have been successfully loaded into SHF, you can view them by opening the 'Accounts' tab. +Once the accounts have been successfully loaded into SailPoint Identity Security, you can view them by opening the 'Accounts' tab. If you click an account in the list, you can see the account's attributes: `fullname`, `email`, `id`, and `entitlements`. @@ -1577,7 +1577,7 @@ To implement Account Read, follow these steps: } ``` - This command now uses the `buildStandardObject` private method to build a standard SHF account object when you get the account. You can now leverage the `toStdAccountReadOutput` method in your 'index.ts' file. + This command now uses the `buildStandardObject` private method to build a standard SailPoint Identity Security account object when you get the account. You can now leverage the `toStdAccountReadOutput` method in your 'index.ts' file. 3. Open 'index.ts' and write the `.stdAccountRead` command handler like this, after `.stdAccountList`: @@ -1618,7 +1618,7 @@ To implement Account Read, follow these steps: } ``` - This is the logic: First, you must provide the Airtable record `id`. Then, the connector will loop through the records until it finds the one that matches your specified value. Once it finds the value, it will create an array of the one account record and return that array of one. It uses that record to build an SHF object for the account. If it can't find the record, it throws an error. + This is the logic: First, you must provide the Airtable record `id`. Then, the connector will loop through the records until it finds the one that matches your specified value. Once it finds the value, it will create an array of the one account record and return that array of one. It uses that record to build a SailPoint Identity Security object for the account. If it can't find the record, it throws an error. ## Read Airtable account @@ -2106,7 +2106,7 @@ To implement the Account Create command, follow these steps: ## Create Airtable account -Once you have configured the Account Create command, you can use your connector to create accounts in Airtable, which can then be synced with SHF. +Once you have configured the Account Create command, you can use your connector to create accounts in Airtable, which can then be synced with SailPoint Identity Security. To test the Account Create command, open Postman and open the 'Test local stdAccountCreate' command. @@ -2365,7 +2365,7 @@ To check your changes, you can open Airtable and see the identity's updated enti ## Complete code -You now have a SaaS connector that can get account data from Airtable and send it to SHF. You can also use the connector to make changes to the Airtable account data without opening Airtable at all. +You now have a SaaS connector that can get account data from Airtable and send it to SailPoint Identity Security. You can also use the connector to make changes to the Airtable account data without opening Airtable at all. Your completed code will look something like this: @@ -2822,6 +2822,6 @@ export class AirtableAccount { Now that you know how to build a SaaS connector to Airtable, you know everything you need to build a basic SaaS connector. The only things you need are some way to retrieve and modify your source account data and some way to authenticate your requests for that data. Then you can go further and customize the SaaS connector to truly suit your organization's needs. -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. To learn more about SaaS Connectivity and discuss the different SaaS Connectivity options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/tag/saas-connector). \ No newline at end of file diff --git a/docs/connectivity/saas-connectivity/common-cli-commands.md b/docs/connectivity/saas-connectivity/common-cli-commands.md index b432327f18a14..74c909f043289 100644 --- a/docs/connectivity/saas-connectivity/common-cli-commands.md +++ b/docs/connectivity/saas-connectivity/common-cli-commands.md @@ -18,21 +18,21 @@ Below is a list of commands and their usages: - Create a customizer on your local system `sail conn customizers init "my-customizer-project"` - Test your connector or customizer locally: `npm run debug` - **Deployment** - - Create an empty connector in your SHF Org (used to get id so you can upload): `sail conn create "my-project"` - - Create an empty customizer in your SHF Org (used to get id so you can upload): `sail conn customizers create "my-customizer-project"` + - Create an empty connector in your SailPoint Identity Security Org (used to get id so you can upload): `sail conn create "my-project"` + - Create an empty customizer in your SailPoint Identity Security Org (used to get id so you can upload): `sail conn customizers create "my-customizer-project"` - Build a project: `npm run pack-zip` - - Upload your connector to your SHF Org: `sail conn upload -c [connectorID | connectorAlias] -f dist/[connector filename].zip` - - Upload your customizer to your SHF Org: `sail conn customizers upload -c [customizerID] -f dist/[customizer filename].zip` + - Upload your connector to your SailPoint Identity Security Org: `sail conn upload -c [connectorID | connectorAlias] -f dist/[connector filename].zip` + - Upload your customizer to your SailPoint Identity Security Org: `sail conn customizers upload -c [customizerID] -f dist/[customizer filename].zip` - **Exploring** - - List connectors in your SHF Org: `sail conn list` - - List customizers in your SHF Org: `sail conn customizers list` - - List source instances in your SHF Org: `sail conn instances list` + - List connectors in your SailPoint Identity Security Org: `sail conn list` + - List customizers in your SailPoint Identity Security Org: `sail conn customizers list` + - List source instances in your SailPoint Identity Security Org: `sail conn instances list` - List your connector tags: `sail conn tags list -c [connectorID | connectorAlias]` - **Testing and Debugging** - - Test your connector on the SHF Org: `sail connectors invoke [action] -c [connectorID | connectorAlias] -p config.json` + - Test your connector on the SailPoint Identity Security Org: `sail connectors invoke [action] -c [connectorID | connectorAlias] -p config.json` - Get a list of actions: `sail conn invoke -h` - Run read-only integration tests against your connector: `sail conn validate -p config.json -c [connectorID | connectorAlias] -r` - - Tail SHF Org connector logs: `sail conn logs tail` + - Tail SailPoint Identity Security Org connector logs: `sail conn logs tail` - **Delete** - Delete a connector: `sail conn delete -c [connectorID | connectorAlias]` - **Linking** diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-create.md b/docs/connectivity/saas-connectivity/connector-commands/account-create.md index 4407b4d79368e..2c0c9806acf4f 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-create.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-create.md @@ -57,15 +57,15 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account create command triggers whenever SHF is told to provision entitlements for an identity on the target source, but no account for the identity on the target source exists yet. For example, if you create an access profile that grants a group on the target source and then add that access profile to a role, any identity matching that role’s membership criteria will be granted to the group. SHF determines which identities do not have accounts on the target source and triggers the account create command for each identity. If an identity already has an account, then it invokes the account update command. +The account create command triggers whenever SailPoint Identity Security is told to provision entitlements for an identity on the target source, but no account for the identity on the target source exists yet. For example, if you create an access profile that grants a group on the target source and then add that access profile to a role, any identity matching that role’s membership criteria will be granted to the group. SailPoint Identity Security determines which identities do not have accounts on the target source and triggers the account create command for each identity. If an identity already has an account, then it invokes the account update command. To use this command, you must specify this value in the `commands` array: `std:account:create` ## The Provisioning Plan -The account create command accepts a provisioning plan from SHF and creates the corresponding account(s) in the target source. When you configure your source in SHF, you must set up ‘Create Profile’ to tell SHF how to provision new accounts for your source. +The account create command accepts a provisioning plan from SailPoint Identity Security and creates the corresponding account(s) in the target source. When you configure your source in SailPoint Identity Security, you must set up ‘Create Profile’ to tell the platform how to provision new accounts for your source. -You can create the provisioning plan through the `accountCreateTemplate` in the `connector-spec.json` file, and you can also modify its behavior in SHF using the create profile screen: +You can create the provisioning plan through the `accountCreateTemplate` in the `connector-spec.json` file, and you can also modify its behavior in SailPoint Identity Security using the create profile screen: ![Account Create](./img/account_create_idn.png) @@ -179,7 +179,7 @@ public static createWithStdAccountCreateInput(record: StdAccountCreateInput): Ai ## The return object -When the account is returned to SHF, any values you set are updated in SHF. So if an account ID is auto-generated on the source system, you must send the account ID back to SHF so SHF is aware of it for future account update activities. This is useful for the compound key type. +When the account is returned to SailPoint Identity Security, any values you set are updated in the tenant. So if an account ID is auto-generated on the source system, you must send the account ID back to SailPoint Identity Security so the platform is aware of it for future account update activities. This is useful for the compound key type. ## Password Handling @@ -228,9 +228,9 @@ async createAccount(input: StdAccountCreateInput): Promise { -## Testing in SailPoint Human Fabric +## Testing in SailPoint Identity Security -One way to test whether the account create code works in SHF is to set up an access profile and role that grants members an entitlement from the connector’s target source. Start by creating an access profile that grants one or more entitlements from the target source. +One way to test whether the account create code works in SailPoint Identity Security is to set up an access profile and role that grants members an entitlement from the connector’s target source. Start by creating an access profile that grants one or more entitlements from the target source. ![Testing 1](./img/testing1.png) diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-delete.md b/docs/connectivity/saas-connectivity/connector-commands/account-delete.md index 46eb0cc4fcf3d..cf96ad497cb3b 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-delete.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-delete.md @@ -36,10 +36,10 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account delete command sends the account's key from SHF, which your connector uses to permanently remove the account from the source system. +The account delete command sends the account's key from SailPoint Identity Security, which your connector uses to permanently remove the account from the source system. :::caution Important -Although SaaS Connectivity supports the `std:account:delete` command, SHF does **not** send it automatically during normal leaver lifecycle events. SHF sends the `std:account:disable` command during standard offboarding. Account delete must be triggered explicitly by a `BeforeProvisioning` rule. For more information, see the [documentation](https://community.sailpoint.com/t5/Identity-Security-Cloud-Articles/Identity-Security-Cloud-Rule-Guide/ta-p/76665) and an [example implementation](https://community.sailpoint.com/t5/Identity-Security-Cloud-Wiki/Identity-Security-Cloud-Rule-Guide-Before-Provisioning-Rule/ta-p/77415). If you want to permanently remove accounts on leaver events, implement that logic in your [Account Disable](./account-disable.md) handler instead. +Although SaaS Connectivity supports the `std:account:delete` command, it is **not** sent automatically during normal leaver lifecycle events. The `std:account:disable` command is sent during standard offboarding. Account delete must be triggered explicitly by a `BeforeProvisioning` rule. For more information, see the [documentation](https://community.sailpoint.com/t5/Identity-Security-Cloud-Articles/Identity-Security-Cloud-Rule-Guide/ta-p/76665) and an [example implementation](https://community.sailpoint.com/t5/Identity-Security-Cloud-Wiki/Identity-Security-Cloud-Rule-Guide-Before-Provisioning-Rule/ta-p/77415). If you want to permanently remove accounts on leaver events, implement that logic in your [Account Disable](./account-disable.md) handler instead. ::: To use this command, you must specify this value in the `commands` array: `std:account:delete` diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-disable.md b/docs/connectivity/saas-connectivity/connector-commands/account-disable.md index 00456a4ea60fa..d67d51ae4e71b 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-disable.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-disable.md @@ -54,17 +54,17 @@ You typically invoke the `account disable` command during the joiner, mover, lea Disabling accounts is generally preferred if the source supports account disabling so the account data remains for later reactivation or inspection. If the source does not support account disabling, or deleting accounts is preferred when an identity leaves the organization, the connector can perform the necessary steps to delete an account with the account disable function. -> 🚧 It is important to note that although SaaS Connectivity supports the account delete command, SHF never sends the account delete command, only the account disable command. The connector’s developer determines the appropriate action for account disable on the source. +> 🚧 It is important to note that although SaaS Connectivity supports the account delete command, SailPoint Identity Security never sends the account delete command, only the account disable command. The connector’s developer determines the appropriate action for account disable on the source. To use this command, you must specify this value in the `commands` array: `std:account:disable` :::caution Important -Although SaaS Connectivity supports a separate `std:account:delete` command, SHF **never** sends it automatically. The `std:account:disable` command is the only command SHF sends during normal leaver lifecycle events. If your organization's policy is to delete accounts on offboarding rather than disable them, implement the delete logic inside your `account disable` handler. +Although SaaS Connectivity supports a separate `std:account:delete` command, SailPoint Identity Security **never** sends it automatically. The `std:account:disable` command is the only command SailPoint Identity Security sends during normal leaver lifecycle events. If your organization's policy is to delete accounts on offboarding rather than disable them, implement the delete logic inside your `account disable` handler. ::: ## Implementation -Account disable is similar to the account update command. After disabling the account, return the updated account with `disabled: true` so SHF reflects the new state. +Account disable is similar to the account update command. After disabling the account, return the updated account with `disabled: true` so SailPoint Identity Security reflects the new state. ```typescript import { diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-discover.md b/docs/connectivity/saas-connectivity/connector-commands/account-discover.md index 8a227b4920828..abb7a2e6ed642 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-discover.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-discover.md @@ -51,7 +51,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account discover schema command tells SHF to dynamically create the account schema for the source rather than use the account schema provided by the connector in connector-spec.json. It is often ideal to statically define the account schema because it is generally more performant and easier to develop and reason about the code. However, some sources have schemas that can be different for each customer deployment. It can also be difficult to determine which account attributes to statically expose, which requires the schema to be dynamically generated. SalesForce is an example of a source that can have thousands of account attributes, which makes it impractical to statically define a set of attributes that satisfies all connector users. Although the SalesForce connector defines a standard set of account attributes out of the box, it also allows schema discovery for users looking for more attributes. +The account discover schema command tells SailPoint Identity Security to dynamically create the account schema for the source rather than use the account schema provided by the connector in connector-spec.json. It is often ideal to statically define the account schema because it is generally more performant and easier to develop and reason about the code. However, some sources have schemas that can be different for each customer deployment. It can also be difficult to determine which account attributes to statically expose, which requires the schema to be dynamically generated. SalesForce is an example of a source that can have thousands of account attributes, which makes it impractical to statically define a set of attributes that satisfies all connector users. Although the SalesForce connector defines a standard set of account attributes out of the box, it also allows schema discovery for users looking for more attributes. To use this command, you must specify this value in the `commands` array: `std:account:discover-schema` @@ -231,7 +231,7 @@ export const connector = async () => { } ``` -Next, implement the `discoverSchema()` function in your client code. The following function calls the necessary endpoints to get the full schema of the user account you want to represent in SHF. After you receive a response from your call, you must build your account schema object that will return to SHF. The response has a structure like the accountSchema property in the connector-spec.json file. The following is an example from [airtable.ts](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/src/airtable.ts). +Next, implement the `discoverSchema()` function in your client code. The following function calls the necessary endpoints to get the full schema of the user account you want to represent in SailPoint Identity Security. After you receive a response from your call, you must build your account schema object that will return to SailPoint Identity Security. The response has a structure like the accountSchema property in the connector-spec.json file. The following is an example from [airtable.ts](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/src/airtable.ts). ```javascript async getAccountSchema(): Promise { @@ -278,7 +278,7 @@ async getAccountSchema(): Promise { } ``` -This code produces the following payload that will be sent back to SHF. +This code produces the following payload that will be sent back to SailPoint Identity Security. ```javascript { @@ -347,9 +347,9 @@ There are many properties in this payload, so you may want to remove some, but i -## Test in SailPoint Human Fabric +## Test in SailPoint Identity Security -To test the account discover schema command in SHF, ensure that you upload your latest connector code and create a new source in SHF. After you configure and test your source connection, go to the ‘Account Schema’ page. You will see an empty schema. +To test the account discover schema command in SailPoint Identity Security, ensure that you upload your latest connector code and create a new source in your tenant. After you configure and test your source connection, go to the ‘Account Schema’ page. You will see an empty schema. ![Discover Schema 1](./img/discover_schema_idn1.png) @@ -357,7 +357,7 @@ To discover the schema for this source, click the ‘Options’ dropdown in the ![Discover Schema 2](./img/discover_schema_idn2.png) -SHF then asks you to assign attributes to ‘Account ID’ and 'Account Name.' +SailPoint Identity Security then asks you to assign attributes to ‘Account ID’ and 'Account Name.' ![Discover Schema 3](./img/discover_schema_idn3.png) diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-enable.md b/docs/connectivity/saas-connectivity/connector-commands/account-enable.md index 8367ce052204a..3252b555eed80 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-enable.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-enable.md @@ -56,7 +56,7 @@ To use this command, you must specify this value in the `commands` array: `std:a ## Implementation -Implementing account enable is similar to implementing the account update command. Most source APIs expose either a dedicated enable endpoint or accept a status field via PATCH/PUT. After enabling the account, return the updated account object so SHF reflects the new `disabled: false` state. +Implementing account enable is similar to implementing the account update command. Most source APIs expose either a dedicated enable endpoint or accept a status field via PATCH/PUT. After enabling the account, return the updated account object so SailPoint Identity Security reflects the new `disabled: false` state. ```typescript import { diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-list.md b/docs/connectivity/saas-connectivity/connector-commands/account-list.md index 91c324179ea80..e7f922db61526 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-list.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-list.md @@ -4,7 +4,7 @@ title: Account List pagination_label: Account List sidebar_label: Account List keywords: ['connectivity', 'connectors', 'account list'] -description: Aggregate all accounts from the source into SailPoint Human Fabric. +description: Aggregate all accounts from the source into SailPoint Identity Security. slug: /connectivity/saas-connectivity/commands/account-list tags: ['Connectivity', 'Connector Command'] --- @@ -47,7 +47,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account list command aggregates all accounts from the target source into SailPoint Human Fabric. SHF calls this command during a manual or scheduled account aggregation. +The account list command aggregates all accounts from the target source into SailPoint Identity Security. This command is called during a manual or scheduled account aggregation. To use this command, you must specify this value in the `commands` array: `std:account:list` @@ -75,13 +75,13 @@ async getAllAccounts(): Promise { :::caution Important -SHF will throw a connection timeout error if your connector doesn't respond within 3 minutes, and there are memory limitations involved with aggregating data. To prevent large memory utilization or timeout errors, you should set up your connectors to send data to SHF as it's retrieved from your source system. For more details and an example, refer to [Connector Timeouts](../in-depth/connector-timeouts.md). +A connection timeout error will be thrown if your connector doesn't respond within 3 minutes, and there are memory limitations involved with aggregating data. To prevent large memory utilization or timeout errors, you should set up your connectors to send data as it's retrieved from your source system. For more details and an example, refer to [Connector Timeouts](../in-depth/connector-timeouts.md). ::: :::caution Important -SHF supports [delta aggregation](#delta-aggregation-state). If your source has a large number of accounts that will be syncronized with SHF, then it is highly recommended to utilize [delta aggregation](#delta-aggregation-state) for the source. +SailPoint Identity Security supports [delta aggregation](#delta-aggregation-state). If your source has a large number of accounts that will be synchronized, then it is highly recommended to utilize [delta aggregation](#delta-aggregation-state) for the source. ::: @@ -107,7 +107,7 @@ export const connector = async () => { ... ``` -SHF expects each user in the target source to be converted into a format SHF understands. The specific attributes the web service returns depend on what your source provides. +SailPoint Identity Security expects each user in the target source to be converted into a format it understands. The specific attributes the web service returns depend on what your source provides. ```javascript public toStdAccountListOutput(): StdAccountListOutput { @@ -132,7 +132,7 @@ private buildStandardObject(): StdAccountListOutput | StdAccountCreateOutput | S } ``` -The result of the account list command is not an array of objects but several individual objects. This is the format SHF expects, so if you see something like the following result while testing, it is normal: +The result of the account list command is not an array of objects but several individual objects. This is the format SailPoint Identity Security expects, so if you see something like the following result while testing, it is normal: ```javascript { @@ -195,7 +195,7 @@ If your source can keep track of changes to the data in some way, then delta agg } ``` -2. In the `stdAccountList` command, when you are done sending accounts, you need to also send the state to SHF so it knows where to start the next time it sends a list request: +2. In the `stdAccountList` command, when you are done sending accounts, you need to also send the state to SailPoint Identity Security so it knows where to start the next time it sends a list request: ```javascript const state = {"data": Date.now().toString()} @@ -308,7 +308,7 @@ curl -X PATCH \ -2. In the `stdAccountList` command, before sending the Resource Object (accounts), you need to filter the accounts. Accounts which match the filter string will be filtered. Accounts which do not match, will be sent to SHF as normal. +2. In the `stdAccountList` command, before sending the Resource Object (accounts), you need to filter the accounts. Accounts which match the filter string will be filtered. Accounts which do not match, will be sent to SailPoint Identity Security as normal. ```javascript export class GitHubConnector { @@ -339,7 +339,7 @@ In the above example, we are setting the constructor with filter string value fe const filterEvaluator = new Filter(ro.attributes); - // process the RO if the filterString is not provided by the user or matcher returns false else skip the RO from sending it to SHF + // process the RO if the filterString is not provided by the user or matcher returns false else skip the RO from sending it to SailPoint Identity Security if (this.filterString === undefined || !filterEvaluator.matcher(this.filterString)) { res.send(ro); accountCount++; diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-read.md b/docs/connectivity/saas-connectivity/connector-commands/account-read.md index 04ce50c07a2fb..782bf93c3775c 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-read.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-read.md @@ -4,7 +4,7 @@ title: Account Read pagination_label: Account Read sidebar_label: Account Read keywords: ['connectivity', 'connectors', 'account read'] -description: Aggregate a single account from the source into SailPoint Human Fabric. +description: Aggregate a single account from the source into SailPoint Identity Security. slug: /connectivity/saas-connectivity/commands/account-read tags: ['Connectivity', 'Connector Command'] --- @@ -50,7 +50,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account read command aggregates a single account from the target source into SailPoint Human Fabric. SHF can call this command during a “one-off” account refresh, which you can trigger by aggregating an individual account in SHF. +The account read command aggregates a single account from the target source into SailPoint Identity Security. SailPoint Identity Security can call this command during a “one-off” account refresh, which you can trigger by aggregating an individual account in your tenant. To use this command, you must specify this value in the `commands` array: `std:account:read` @@ -60,7 +60,7 @@ To use this command, you must specify this value in the `commands` array: `std:a ### Extracting the account ID from the input -SHF passes the account's key in `input.key`. For connectors using `keyType: "simple"`, extract the native ID like this: +SailPoint Identity Security passes the account's key in `input.key`. For connectors using `keyType: "simple"`, extract the native ID like this: ```typescript const id = input.key.simple?.id ?? input.identity @@ -91,7 +91,7 @@ import { const account = await myClient.getAccount(id) - // If the account is not found, throw NotFound — SHF will then trigger account create + // If the account is not found, throw NotFound — SailPoint Identity Security will then trigger account create if (!account) { throw new ConnectorError('Account not found', ConnectorErrorType.NotFound) } @@ -112,7 +112,7 @@ import { ### The NotFound error type -If an account cannot be found in the source, throw a `ConnectorError` with type `ConnectorErrorType.NotFound`. This is a special signal to SHF that the account does not exist on the source. When SHF receives this error during an account read triggered by a provisioning event, it will automatically call the `std:account:create` command to provision the account. Without this specific error type, SHF treats the failure as a generic error and does not attempt to create the account. +If an account cannot be found in the source, throw a `ConnectorError` with type `ConnectorErrorType.NotFound`. This is a special signal to SailPoint Identity Security that the account does not exist on the source. When SailPoint Identity Security receives this error during an account read triggered by a provisioning event, it will automatically call the `std:account:create` command to provision the account. Without this specific error type, SailPoint Identity Security treats the failure as a generic error and does not attempt to create the account. The following snippet from the Airtable example connector shows this pattern: diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-unlock.md b/docs/connectivity/saas-connectivity/connector-commands/account-unlock.md index df66fceb26bc7..19981d160a7af 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-unlock.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-unlock.md @@ -50,7 +50,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account lock and account unlock commands provide ways to temporarily prevent access to an account. SHF only supports the **unlock** command — accounts can only be locked at the source system level, but they can be unlocked through SHF. +The account lock and account unlock commands provide ways to temporarily prevent access to an account. SailPoint Identity Security only supports the **unlock** command — accounts can only be locked at the source system level, but they can be unlocked through the platform. The `locked` state is distinct from the `disabled` state: - `disabled: true` means the account has been intentionally deactivated (e.g., a leaver event). Use the [Account Disable](./account-disable.md) command for this. diff --git a/docs/connectivity/saas-connectivity/connector-commands/account-update.md b/docs/connectivity/saas-connectivity/connector-commands/account-update.md index 110193562e496..c31636fdc7d96 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/account-update.md +++ b/docs/connectivity/saas-connectivity/connector-commands/account-update.md @@ -59,13 +59,13 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The account update command triggers whenever SHF is told to modify an identity's attributes or entitlements on the target source. For example, granting an identity a new entitlement through a role, changing an identity’s lifecycle state, or modifying an identity attribute tied to an account attribute all trigger the account update command. +The account update command triggers whenever SailPoint Identity Security is told to modify an identity's attributes or entitlements on the target source. For example, granting an identity a new entitlement through a role, changing an identity’s lifecycle state, or modifying an identity attribute tied to an account attribute all trigger the account update command. To use this command, you must specify this value in the `commands` array: `std:account:update` ## Input Schema -The payload from SHF contains the ID of the identity to modify, the configuration items the connector needs to call the source API, and one or more change operations to apply to the identity. Each operation has the following special considerations: +The payload from SailPoint Identity Security contains the ID of the identity to modify, the configuration items the connector needs to call the source API, and one or more change operations to apply to the identity. Each operation has the following special considerations: - **Set:** Set tells the connector to overwrite the current value of the attribute or entitlement with the new value provided in the payload. The entire entitlement array resets if there are multi-valued entitlements. @@ -97,7 +97,7 @@ The following example payload tells the connector to perform the following updat ## Response Schema -After the connector applies the operations defined in the input payload, the connector must respond to SHF with the changes to the account so SHF can update the identity accordingly. If an account update operation results in no changes to the account, the connector responds with an empty object `{}`. If the update operation results in one or more changes to the account, the connector responds with the complete account as it exists in the source, just like an account read response. SHF can parse the response and apply the differences accordingly. +After the connector applies the operations defined in the input payload, the connector must respond to SailPoint Identity Security with the changes to the account so the platform can update the identity accordingly. If an account update operation results in no changes to the account, the connector responds with an empty object `{}`. If the update operation results in one or more changes to the account, the connector responds with the complete account as it exists in the source, just like an account read response. SailPoint Identity Security can parse the response and apply the differences accordingly. ## Implementation @@ -132,7 +132,7 @@ import { } else if (change.op === AttributeChangeOp.Add) { // Add one or more values to a multi-valued attribute. - // SHF sends a single string when one value is added, or an array when multiple are added. + // SailPoint Identity Security sends a single string when one value is added, or an array when multiple are added. const valuesToAdd = Array.isArray(change.value) ? change.value : [change.value] const existing: string[] = Array.isArray(current[change.attribute]) ? current[change.attribute] @@ -157,7 +157,7 @@ import { // Send the changes to the source system const updated = await myClient.updateAccount(input.identity, updates) - // Return the updated account so SHF reflects the new state + // Return the updated account so SailPoint Identity Security reflects the new state res.send({ key: SimpleKey(updated.id), disabled: !updated.active, @@ -178,12 +178,12 @@ Check whether your source API accepts a partial update (PATCH with only changed -## Testing in SailPoint Human Fabric +## Testing in SailPoint Identity Security -You can test the account update command the way you test the [Account Create](./account-create.md) command. Follow the steps in “Testing in SailPoint Human Fabric” from “Account Create” to set up an access profile and role. Be sure to run the aggregation so the account(s) are created in the target source. Once the account(s) are created in the target source, modify the access profile to grant an additional entitlement. Return to the role and click the ‘Update’ button in the upper right corner. Doing so triggers the account update command because the accounts are already created in the target source. Once the update is complete, ensure the account(s) have the additional entitlement. +You can test the account update command the way you test the [Account Create](./account-create.md) command. Follow the steps in “Testing in SailPoint Identity Security” from “Account Create” to set up an access profile and role. Be sure to run the aggregation so the account(s) are created in the target source. Once the account(s) are created in the target source, modify the access profile to grant an additional entitlement. Return to the role and click the ‘Update’ button in the upper right corner. Doing so triggers the account update command because the accounts are already created in the target source. Once the update is complete, ensure the account(s) have the additional entitlement. -Note: Testing the account update command for removing entitlements using this method does not work. You can remove the entitlement from the access profile and run an update, but SHF will not send an update command to the connector to remove the entitlement. We are looking for suggestions on how to test the removal of entitlements. +Note: Testing the account update command for removing entitlements using this method does not work. You can remove the entitlement from the access profile and run an update, but SailPoint Identity Security will not send an update command to the connector to remove the entitlement. We are looking for suggestions on how to test the removal of entitlements. ## Handling an account that is not found -If an account can't be found in the source system, SHF can recreate the account by using the `ConnectorErrorType.NotFound` error type. For details and implementation, refer to [Error Handling](../in-depth/error-handling.md#not-found-error-type). +If an account can't be found in the source system, SailPoint Identity Security can recreate the account by using the `ConnectorErrorType.NotFound` error type. For details and implementation, refer to [Error Handling](../in-depth/error-handling.md#not-found-error-type). diff --git a/docs/connectivity/saas-connectivity/connector-commands/change-password.md b/docs/connectivity/saas-connectivity/connector-commands/change-password.md index aa0c6e115435a..3d01dc535a53c 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/change-password.md +++ b/docs/connectivity/saas-connectivity/connector-commands/change-password.md @@ -35,7 +35,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The change password command is triggered in SHF when a user changes their password through SHF. When this occurs, if your source has change password enabled, then you can change the user password on the source system through SHF. +The change password command is triggered in SailPoint Identity Security when a user changes their password through the platform. When this occurs, if your source has change password enabled, then you can change the user password on the source system through SailPoint Identity Security. To use this command, you must specify this value in the `commands` array: `std:change-password` @@ -45,7 +45,7 @@ The `input` object contains three relevant fields: | Field | Description | |---|---| -| `input.key` | The account's key as stored in SHF. Use `input.key.simple?.id` to extract the native account ID. | +| `input.key` | The account's key as stored in SailPoint Identity Security. Use `input.key.simple?.id` to extract the native account ID. | | `input.identity` | The account's identity string (usually the same as the key ID). | | `input.password` | The new plaintext password to set on the source system. | @@ -79,11 +79,11 @@ import { ``` :::caution -The password in `input.password` is the new plaintext password that has already been validated against the source's password policy by SHF. Do not perform additional policy validation in your connector — pass it directly to the source API. +The password in `input.password` is the new plaintext password that has already been validated against the source's password policy by SailPoint Identity Security. Do not perform additional policy validation in your connector — pass it directly to the source API. ::: -## Testing in SailPoint Human Fabric +## Testing in SailPoint Identity Security -In order to test in SailPoint Human Fabric, the source application must be configured so that it is able to accept password change requests through the Password Manager. Once this setup is complete, you can log in as a user whose identity exists in the configured application and change their password in the Password Manager. +In order to test in SailPoint Identity Security, the source application must be configured so that it is able to accept password change requests through the Password Manager. Once this setup is complete, you can log in as a user whose identity exists in the configured application and change their password in the Password Manager. diff --git a/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md b/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md index b621c9cbf0dad..c249c87ea4f71 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md +++ b/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md @@ -57,7 +57,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -The entitlement list command triggers during a manual or scheduled entitlement aggregation operation within SHF. This operation gathers a list of all entitlements available on the target source, usually multi-valued entitlements like groups or roles. This operation provides SHF administrators with a list of entitlements available on the source so they can create access profiles and roles accordingly, and it provides SHF with more details about the entitlements. The entitlement schema’s minimum requirements are name and ID, but you can add other values, such as created date, updated date, status, etc. +The entitlement list command triggers during a manual or scheduled entitlement aggregation operation within SailPoint Identity Security. This operation gathers a list of all entitlements available on the target source, usually multi-valued entitlements like groups or roles. This operation provides SailPoint Identity Security administrators with a list of entitlements available on the source so they can create access profiles and roles accordingly, and it provides the platform with more details about the entitlements. The entitlement schema’s minimum requirements are name and ID, but you can add other values, such as created date, updated date, status, etc. To use this command, you must specify this value in the `commands` array: `std:entitlement:list` @@ -124,13 +124,13 @@ private buildStandardObject(): StdEntitlementReadOutput | StdEntitlementListOutp :::caution Important -SHF will throw a connection timeout error if your connector doesn't respond within 3 minutes, and there are memory limitations involved with aggregating data. To prevent large memory utilization or timeout errors, you should set up your connectors to send data to SHF as it's retrieved from your source system. For more details and an example, refer to [Connector Timeouts](../in-depth/connector-timeouts.md). +SailPoint Identity Security will throw a connection timeout error if your connector doesn't respond within 3 minutes, and there are memory limitations involved with aggregating data. To prevent large memory utilization or timeout errors, you should set up your connectors to send data to SailPoint Identity Security as it's retrieved from your source system. For more details and an example, refer to [Connector Timeouts](../in-depth/connector-timeouts.md). ::: :::caution Important -SHF supports [delta aggregation](#delta-aggregation-state). If your source has a large number of entitlements that will be syncronized with SHF, then it is highly recommended to utilize [delta aggregation](#delta-aggregation-state) for the source. +SailPoint Identity Security supports [delta aggregation](#delta-aggregation-state). If your source has a large number of entitlements that will be syncronized with SailPoint Identity Security, then it is highly recommended to utilize [delta aggregation](#delta-aggregation-state) for the source. ::: @@ -151,7 +151,7 @@ If your source can keep track of changes to the data in some way, then delta agg } ``` -2. In the `stdEntitlementList` command, when you are done sending entitlments, you need to also send the state to SHF so it knows where to start the next time it sends a list request: +2. In the `stdEntitlementList` command, when you are done sending entitlments, you need to also send the state to SailPoint Identity Security so it knows where to start the next time it sends a list request: ```javascript const state = {"data": Date.now().toString()} @@ -193,7 +193,7 @@ The state that you send using the `saveState` command MUST be a json object, and ## Permissions -Entitlements can include a `permissions` array in their output. Each permission object describes a specific access right that the entitlement grants on a particular target resource. SHF uses this information to give administrators more visibility into what an entitlement actually allows. +Entitlements can include a `permissions` array in their output. Each permission object describes a specific access right that the entitlement grants on a particular target resource. SailPoint Identity Security uses this information to give administrators more visibility into what an entitlement actually allows. ### Permission Object Structure @@ -207,7 +207,7 @@ Each entry in the `permissions` array has the following fields: ### Enabling Permissions in the Schema -To tell SHF that your connector supports permissions, set `includePermissions: true` in the entitlement schema in [connector-spec.json](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/connector-spec.json): +To tell SailPoint Identity Security that your connector supports permissions, set `includePermissions: true` in the entitlement schema in [connector-spec.json](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/connector-spec.json): ```javascript "entitlementSchemas": [ @@ -232,7 +232,7 @@ To tell SHF that your connector supports permissions, set `includePermissions: t ] ``` -When `includePermissions` is `true` in the schema, SHF passes `input.schema.includePermissions = true` in the `StdEntitlementListInput`. Your connector should check this flag before fetching and returning permissions, since retrieving permissions may require additional API calls. +When `includePermissions` is `true` in the schema, SailPoint Identity Security passes `input.schema.includePermissions = true` in the `StdEntitlementListInput`. Your connector should check this flag before fetching and returning permissions, since retrieving permissions may require additional API calls. ### Implementation @@ -250,7 +250,7 @@ When `includePermissions` is `true` in the schema, SHF passes `input.schema.incl } } - // Only fetch and include permissions if SHF requested them + // Only fetch and include permissions if SailPoint Identity Security requested them if (input.schema?.includePermissions) { const perms = await mySource.getPermissionsForGroup(group.id) entitlement.permissions = perms.map(p => ({ @@ -362,7 +362,7 @@ curl -X PATCH \ -2. In the `.stdEntitlementList` command, before sending the Resource Object (groups), you need to filter the groups. Groups which match the filter string will be filtered. Groups which do not match, will be sent to SHF as normal. +2. In the `.stdEntitlementList` command, before sending the Resource Object (groups), you need to filter the groups. Groups which match the filter string will be filtered. Groups which do not match, will be sent to SailPoint Identity Security as normal. ```javascript export class GitHubConnector { @@ -394,7 +394,7 @@ In the above example, we are setting the constructor with filter string value fe const filterEvaluator = new Filter(ro.attributes); - // process the RO if the filterString is not provided by the user or matcher returns false else skip the RO from sending it to SHF + // process the RO if the filterString is not provided by the user or matcher returns false else skip the RO from sending it to SailPoint Identity Security if (this.filterString === undefined || !filterEvaluator.matcher(this.filterString)) { res.send(ro); accountCount++; diff --git a/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md b/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md index 2e66eef3b5773..f4f4e893a7e37 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md +++ b/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md @@ -11,7 +11,7 @@ tags: ['Connectivity', 'Connector Command'] :::note -At this time Entitlement Read is not triggered from SHF for any specific workflow and as such it is not necessary to implement this in order to have a fully functional connector. +At this time Entitlement Read is not triggered from SailPoint Identity Security for any specific workflow and as such it is not necessary to implement this in order to have a fully functional connector. ::: @@ -67,7 +67,7 @@ To use this command, you must specify this value in the `commands` array: `std:e ## Response Schema -Entitlement read fetches a single entitlement’s attributes and returns the resulting object to SHF, similar to how entitlement list does. You can implement this in the main connector file, [index.ts](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/src/index.ts): +Entitlement read fetches a single entitlement’s attributes and returns the resulting object to SailPoint Identity Security, similar to how entitlement list does. You can implement this in the main connector file, [index.ts](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/src/index.ts): ```javascript ... diff --git a/docs/connectivity/saas-connectivity/connector-commands/source-data-discover.md b/docs/connectivity/saas-connectivity/connector-commands/source-data-discover.md index bfdee374190e9..ae79d07071b49 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/source-data-discover.md +++ b/docs/connectivity/saas-connectivity/connector-commands/source-data-discover.md @@ -44,9 +44,9 @@ tags: ['Connectivity', 'Connector Command'] ## Description -Use the source data discover command to identify the types of data your source can return. Different sources can send different types of data to SailPoint Human Fabric. For example, one source may be able to send a list of the different languages it supports, while another may be able to send values describing source details normally sent through accounts and entitlements. You can use the source data discover command to discover these possibilities. +Use the source data discover command to identify the types of data your source can return. Different sources can send different types of data to SailPoint Identity Security. For example, one source may be able to send a list of the different languages it supports, while another may be able to send values describing source details normally sent through accounts and entitlements. You can use the source data discover command to discover these possibilities. -One typical use for the source data discover command is found in SailPoint Human Fabric customer forms for dropdown menus: they use the command to identify the additional source types their sources can provide to SailPoint Human Fabric and use that information to populate the dropdown menus. +One typical use for the source data discover command is found in SailPoint Identity Security customer forms for dropdown menus: they use the command to identify the additional source types their sources can provide to the platform and use that information to populate the dropdown menus. To use this command, you must specify this value in the `commands` array: `std:source-data:discover` diff --git a/docs/connectivity/saas-connectivity/connector-commands/source-data-read.md b/docs/connectivity/saas-connectivity/connector-commands/source-data-read.md index 15da5b326c6f6..89cfa1e575201 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/source-data-read.md +++ b/docs/connectivity/saas-connectivity/connector-commands/source-data-read.md @@ -45,7 +45,7 @@ tags: ['Connectivity', 'Connector Command'] ## Description -Use the source data read command to query a source in SailPoint Human Fabric and return a set of data. This data is typically used to populate a dropdown menu for selection purposes. This functionality is typically useful for SailPoint Human Fabric forms, but it can be used for any type of implementation that requires you to get other information from a source, information that is not normally retrieved from identites or entitlements. +Use the source data read command to query a source in SailPoint Identity Security and return a set of data. This data is typically used to populate a dropdown menu for selection purposes. This functionality is typically useful for SailPoint Identity Security forms, but it can be used for any type of implementation that requires you to get other information from a source, information that is not normally retrieved from identites or entitlements. To use this command, you must specify this value in the `commands` array: `std:source-data:read` diff --git a/docs/connectivity/saas-connectivity/connector-commands/test-connection.md b/docs/connectivity/saas-connectivity/connector-commands/test-connection.md index 40898d36dc12f..71a628740ba52 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/test-connection.md +++ b/docs/connectivity/saas-connectivity/connector-commands/test-connection.md @@ -27,7 +27,7 @@ The test connection command ensures the connector can communicate with the targe To use this command, you must specify this value in the `commands` array: `std:test-connection` -Use ‘Test Connection’ in the SHF UI after an admin has finished entering configuration information for a new instance of the connector. +Use ‘Test Connection’ in the SailPoint Identity Security UI after an admin has finished entering configuration information for a new instance of the connector. ![Test Connection](./img/test_command_idn.png) @@ -35,7 +35,7 @@ Use ‘Test Connection’ in the SHF UI after an admin has finished entering con ### Validating configuration on startup -Before making any API calls, validate that all required configuration properties are present. Throw an `InvalidConfigurationError` (not a generic `ConnectorError`) so SHF surfaces a clear message to the administrator rather than a generic failure. Do this in your client class constructor: +Before making any API calls, validate that all required configuration properties are present. Throw an `InvalidConfigurationError` (not a generic `ConnectorError`) so SailPoint Identity Security surfaces a clear message to the administrator rather than a generic failure. Do this in your client class constructor: ```typescript import { ConnectorError, createConnectorHttpClient } from '@sailpoint/connector-sdk' diff --git a/docs/connectivity/saas-connectivity/connector-customizers/index.md b/docs/connectivity/saas-connectivity/connector-customizers/index.md index 7686eaa9119ed..9379a635c46e8 100644 --- a/docs/connectivity/saas-connectivity/connector-customizers/index.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/index.md @@ -13,7 +13,7 @@ tags: ['Connectivity'] # Overview -SaaS Connectivity Customizers are cloud-based connector customizers that make customizing out of the box SaaS connectors possible. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors. By using a customizer, you can change a connector's input before the connector ingests the data, or you can change the connector's output before to the output is sent to SailPoint Human Fabric. +SaaS Connectivity Customizers are cloud-based connector customizers that make customizing out of the box SaaS connectors possible. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors. By using a customizer, you can change a connector's input before the connector ingests the data, or you can change the connector's output before to the output is sent to SailPoint Identity Security.
@@ -21,7 +21,7 @@ SaaS Connectivity Customizers are cloud-based connector customizers that make cu ## How do they work? -SaaS Connectivity Customizers work by sitting in between SailPoint Human Fabric and the connector. They intercept calls from SailPoint Human Fabric to the connector and calls from the connector to SailPoint Human Fabric. When the customizer intercepts a call, it can call custom code to mutate the data in any way necessary to change the connector behavior. +SaaS Connectivity Customizers work by sitting in between SailPoint Identity Security and the connector. They intercept calls from SailPoint Identity Security to the connector and calls from the connector to the platform. When the customizer intercepts a call, it can call custom code to mutate the data in any way necessary to change the connector behavior. This chart shows an example of this interception process - the `stdAccountRead` command is implemented with the customizer in place: @@ -30,14 +30,14 @@ This chart shows an example of this interception process - the `stdAccountRead` ```mermaid sequenceDiagram autonumber - participant SHF as SailPoint Human Fabric + participant SailPoint Identity Security as SailPoint Identity Security participant CUS as Customizer participant CON as SaaS Connector - SHF->>CUS: StdAccountRead Request + SailPoint Identity Security->>CUS: StdAccountRead Request CUS->>CON: Mutated StdAccountRead Request CON->>CUS: StdAccountRead Response - CUS->>SHF: Mutated StdAccountRead Response + CUS->>SailPoint Identity Security: Mutated StdAccountRead Response ``` diff --git a/docs/connectivity/saas-connectivity/connector-customizers/link.md b/docs/connectivity/saas-connectivity/connector-customizers/link.md index 8b951087543dc..e33339214df81 100644 --- a/docs/connectivity/saas-connectivity/connector-customizers/link.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/link.md @@ -15,7 +15,7 @@ tags: ['Connectivity'] ### Initial requirements -Before you can link a connector customizer to a source, you must have a SaaS source in SailPoint Human Fabric, as well as a Customizer built and deployed. You can use the following commands to get a list of valid sources, as well as customizers: +Before you can link a connector customizer to a source, you must have a SaaS source in SailPoint Identity Security, as well as a Customizer built and deployed. You can use the following commands to get a list of valid sources, as well as customizers: Use this command to find sources: diff --git a/docs/connectivity/saas-connectivity/connector-customizers/upload.md b/docs/connectivity/saas-connectivity/connector-customizers/upload.md index b4390a8921015..f16f61f288457 100644 --- a/docs/connectivity/saas-connectivity/connector-customizers/upload.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/upload.md @@ -1,6 +1,6 @@ --- id: connectivity-customizers-uploading -title: Build and Upload into SailPoint Human Fabric +title: Build and Upload into SailPoint Identity Security pagination_label: Build and Upload sidebar_label: Build and Upload sidebar_position: 5 @@ -13,7 +13,7 @@ tags: ['Connectivity'] -# Building and uploading to SailPoint Human Fabric +# Building and uploading to SailPoint Identity Security ### Initial requirements @@ -52,9 +52,9 @@ Connector zip file created under dist folder: my-connector-customizer-0.1.0.zip -### Upload to SailPoint Human Fabric +### Upload to SailPoint Identity Security -To upload the customizer to SailPoint Human Fabric, use the upload command: +To upload the customizer to SailPoint Identity Security, use the upload command: ```bash sail conn customizers upload -c 7b968fab-0f40-49f0-b13b-8bf529fc0b82 -f .\dist\my-connector-customizer-0.1.0.zip diff --git a/docs/connectivity/saas-connectivity/connector-spec/index.md b/docs/connectivity/saas-connectivity/connector-spec/index.md index 58e661665abde..88da252c153b8 100644 --- a/docs/connectivity/saas-connectivity/connector-spec/index.md +++ b/docs/connectivity/saas-connectivity/connector-spec/index.md @@ -6,14 +6,14 @@ sidebar_label: Connector Spec File sidebar_position: 4 sidebar_class_name: connectorSpecFile keywords: ['connectivity', 'connectors', 'spec', 'specification'] -description: The connector spec file tells SHF how the connector should interact between SHF and the custom connector. It is the glue between SHF and the connector, so understanding the different sections are key to understanding how to build a custom connectors. +description: The connector spec file tells SailPoint Identity Security how the connector should interact between SailPoint Identity Security and the custom connector. It is the glue between SailPoint Identity Security and the connector, so understanding the different sections are key to understanding how to build a custom connectors. slug: /connectivity/saas-connectivity/connector-spec tags: ['Connectivity'] --- ## Summary -The connector spec file tells SHF how the connector should interact between SHF and the custom connector. It is the glue between SHF and the connector, so understanding the different sections are important to understand when building a custom connector. +The connector spec file tells SailPoint Identity Security how the connector should interact between the platform and the custom connector. It is the glue between SailPoint Identity Security and the connector, so understanding the different sections are important to understand when building a custom connector. For a complete example, see [connector-spec.json](https://github.com/sailpoint-oss/airtable-example-connector/blob/main/connector-spec.json). @@ -21,29 +21,29 @@ For a complete example, see [connector-spec.json](https://github.com/sailpoint-o | Property | Type | Required | Description | |---|---|---|---| -| `name` | string | Yes | The name of the connector as it appears in SHF. Tags can be appended to this name. | +| `name` | string | Yes | The name of the connector as it appears in SailPoint Identity Security. Tags can be appended to this name. | | `keyType` | string | Yes | Either `simple` or `compound`. Determines which key type the connector expects to receive and send back for each command. For example, if `simple`, then `StdAccountReadInput.key` will be of type `SimpleKey`. | | `commands` | string[] | Yes | The list of commands the connector supports. See the full list of [available commands](../connector-commands/index.md). | | `supportsStatefulCommands` | boolean | No | Set to `true` if the connector supports stateful commands. | -| `showDebugLoggingOption` | boolean | No | When `true`, exposes an **Enable Debug Logging** toggle in the SHF source's Administrator Settings UI. When enabled, the connector emits `debug`-level log entries in addition to `info` and `error` levels. Defaults to `false`. | +| `showDebugLoggingOption` | boolean | No | When `true`, exposes an **Enable Debug Logging** toggle in the SailPoint Identity Security source's Administrator Settings UI. When enabled, the connector emits `debug`-level log entries in addition to `info` and `error` levels. Defaults to `false`. | | `sourceConfigInitialValues` | object | No | Key-value pairs of source config item keys and their default values. See [Initial Values](./connector-spec/initial-value). | -| `sourceConfig` | object[] | Yes | A list of menus defining the configuration UI shown when creating a source in SHF. The order of items is preserved in the UI. See [sourceConfig](#sourceconfig). | -| `accountSchema` | object | Yes | The schema for accounts in SHF populated by data from the source. See [accountSchema](#accountschema). | -| `entitlementSchemas` | object[] | No | A list of entitlement schemas in SHF populated by data from the source. See [entitlementSchemas](#entitlementschemas). | -| `accountCreateTemplate` | object | No | A map of identity attributes SHF passes to the connector when creating an account in the target source. See [accountCreateTemplate](#accountcreatetemplate). | +| `sourceConfig` | object[] | Yes | A list of menus defining the configuration UI shown when creating a source in SailPoint Identity Security. The order of items is preserved in the UI. See [sourceConfig](#sourceconfig). | +| `accountSchema` | object | Yes | The schema for accounts in SailPoint Identity Security populated by data from the source. See [accountSchema](#accountschema). | +| `entitlementSchemas` | object[] | No | A list of entitlement schemas in SailPoint Identity Security populated by data from the source. See [entitlementSchemas](#entitlementschemas). | +| `accountCreateTemplate` | object | No | A map of identity attributes SailPoint Identity Security passes to the connector when creating an account in the target source. See [accountCreateTemplate](#accountcreatetemplate). | --- ## sourceConfig -`sourceConfig` is an array of menu objects that define the sidebar and configuration fields shown when creating a source in SHF. +`sourceConfig` is an array of menu objects that define the sidebar and configuration fields shown when creating a source in SailPoint Identity Security. ### Menu | Property | Type | Required | Description | |---|---|---|---| | `type` | string | Yes | Always `"menu"`. Indicates a new sidebar section. Multiple menus can be defined for complex configurations. | -| `label` | string | Yes | The text displayed on the sidebar in SHF. | +| `label` | string | Yes | The text displayed on the sidebar in SailPoint Identity Security. | | `items` | [Section](#section)[] | Yes | An array of section objects displayed within this menu. | ### Section @@ -92,14 +92,14 @@ For a complete example, see [connector-spec.json](https://github.com/sailpoint-o ## accountSchema -Defines the schema for accounts in SHF populated by data from the source. +Defines the schema for accounts in SailPoint Identity Security populated by data from the source. ### accountSchema Fields | Property | Type | Required | Description | |---|---|---|---| -| `displayAttribute` | string | Yes | The attribute used to map to `Account Name` in SHF. Should be unique so SHF can correlate accounts between SHF and the source. | -| `identityAttribute` | string | Yes | The attribute used to map to `Account ID` in SHF. Must be a globally unique identifier (e.g., email address, employee ID). | +| `displayAttribute` | string | Yes | The attribute used to map to `Account Name` in SailPoint Identity Security. Should be unique so SailPoint Identity Security can correlate accounts between itself and the source. | +| `identityAttribute` | string | Yes | The attribute used to map to `Account ID` in SailPoint Identity Security. Must be a globally unique identifier (e.g., email address, employee ID). | | `groupAttribute` | string | No | The attribute used to map accounts to entitlements (e.g., `"groups"`). | | `attributes` | [Account Attribute](#account-attribute)[] | Yes | One or more attributes mapping to user attributes on the target source. | @@ -107,11 +107,11 @@ Defines the schema for accounts in SHF populated by data from the source. | Property | Type | Required | Description | |---|---|---|---| -| `name` | string | Yes | The attribute's name as it appears in SHF. | +| `name` | string | Yes | The attribute's name as it appears in SailPoint Identity Security. | | `type` | string | Yes | The attribute's data type. Valid values: `string`, `boolean`, `long`, `int`. | | `description` | string | No | A helpful description of the attribute, useful to source owners reviewing the account schema. | | `entitlement` | boolean | No | Whether this attribute is an entitlement. Entitlements grant identities privileges on the source system. | -| `managed` | boolean | No | Whether the entitlements are manageable through SHF (`true`) or read-only (`false`). | +| `managed` | boolean | No | Whether the entitlements are manageable through SailPoint Identity Security (`true`) or read-only (`false`). | | `multi` | boolean | No | Whether this attribute stores multiple entitlements in an array format. | --- @@ -133,7 +133,7 @@ An array of entitlement schema objects defining the entitlement types available | Property | Type | Required | Description | |---|---|---|---| -| `name` | string | Yes | The attribute's name as it appears in SHF. | +| `name` | string | Yes | The attribute's name as it appears in SailPoint Identity Security. | | `type` | string | Yes | The attribute's data type. Valid values: `string`, `boolean`, `long`, `int`. | | `description` | string | No | A helpful description of the attribute, useful to source owners reviewing the entitlement schema. | @@ -141,7 +141,7 @@ An array of entitlement schema objects defining the entitlement types available ## accountCreateTemplate -Maps identity attributes SHF will pass to the connector when creating an account in the target source. +Maps identity attributes SailPoint Identity Security will pass to the connector when creating an account in the target source. ### accountCreateTemplate Fields @@ -153,10 +153,10 @@ Maps identity attributes SHF will pass to the connector when creating an account | Property | Type | Required | Description | |---|---|---|---| -| `key` | string | Yes | The unique identifier for the attribute. Also the name shown in the Create Profile screen in SHF. | +| `key` | string | Yes | The unique identifier for the attribute. Also the name shown in the Create Profile screen in SailPoint Identity Security. | | `label` | string | Yes | A friendly display name for the attribute. | | `type` | string | Yes | The attribute's data type. Valid values: `string`, `boolean`, `long`, `int`. | -| `required` | boolean | No | Whether this attribute is required for account creation. If `true` and SHF encounters an identity missing this attribute, the account will not be sent to the connector for creation. Defaults to `false`. | +| `required` | boolean | No | Whether this attribute is required for account creation. If `true` and SailPoint Identity Security encounters an identity missing this attribute, the account will not be sent to the connector for creation. Defaults to `false`. | | `initialValue` | [Initial Value](#initial-value) | No | Specifies a default, identity-mapped, or generated value for the attribute. | ### Initial Value diff --git a/docs/connectivity/saas-connectivity/connector-spec/keyValue.md b/docs/connectivity/saas-connectivity/connector-spec/keyValue.md index 76824c15283a0..51fd5d5fba9d2 100644 --- a/docs/connectivity/saas-connectivity/connector-spec/keyValue.md +++ b/docs/connectivity/saas-connectivity/connector-spec/keyValue.md @@ -18,7 +18,7 @@ You can use the `keyValue` type to allow users to enter multiple key-value pairs | Property | Type | Required | Description | |---|---|---|---| | `key` | string | Yes | The config key used to access the key-value map in connector code. | -| `label` | string | Yes | The label displayed for the field in the SHF UI. | +| `label` | string | Yes | The label displayed for the field in the SailPoint Identity Security UI. | | `type` | string | Yes | Must be `"keyValue"`. | | `required` | boolean | No | Whether at least one entry is required before saving. Defaults to `false`. | | `keyValueKey` | object | Yes | Defines the input field for the key side of each pair. Supports `key`, `label`, `type`, `required`, and `maxlength`. | diff --git a/docs/connectivity/saas-connectivity/connector-spec/list.md b/docs/connectivity/saas-connectivity/connector-spec/list.md index df7f08b0bfd31..22fd8acd7cf62 100644 --- a/docs/connectivity/saas-connectivity/connector-spec/list.md +++ b/docs/connectivity/saas-connectivity/connector-spec/list.md @@ -18,7 +18,7 @@ You can use the `list` type to allow users to enter multiple items in a single e | Property | Type | Required | Description | |---|---|---|---| | `key` | string | Yes | The config key used to access the value in connector code. | -| `label` | string | Yes | The label displayed for the field in the SHF UI. | +| `label` | string | Yes | The label displayed for the field in the SailPoint Identity Security UI. | | `type` | string | Yes | Must be `"list"`. | | `required` | boolean | No | Whether the field must be populated before saving configuration. Defaults to `false`. | | `helpKey` | string | No | Help text shown alongside the field to guide the administrator. | diff --git a/docs/connectivity/saas-connectivity/connector-spec/radio.md b/docs/connectivity/saas-connectivity/connector-spec/radio.md index 62d87e36f05f4..3f43048883d97 100644 --- a/docs/connectivity/saas-connectivity/connector-spec/radio.md +++ b/docs/connectivity/saas-connectivity/connector-spec/radio.md @@ -18,7 +18,7 @@ You can use the `radio` type to create radio buttons for users to interact with | Property | Type | Required | Description | |---|---|---|---| | `key` | string | Yes | The config key used to access the selected value in connector code. | -| `label` | string | Yes | The label displayed for the radio group in the SHF UI. | +| `label` | string | Yes | The label displayed for the radio group in the SailPoint Identity Security UI. | | `type` | string | Yes | Must be `"radio"`. | | `required` | boolean | No | Whether the user must select an option before saving. Defaults to `false`. | | `options` | object[] | Yes | The list of radio options. Each option has a `label` (displayed text) and a `value` (the string stored in config). | diff --git a/docs/connectivity/saas-connectivity/connector-spec/select.md b/docs/connectivity/saas-connectivity/connector-spec/select.md index 7d75810c41bfe..39394584592fe 100644 --- a/docs/connectivity/saas-connectivity/connector-spec/select.md +++ b/docs/connectivity/saas-connectivity/connector-spec/select.md @@ -18,7 +18,7 @@ You can use the `select` type to create a dropdown for users to select from a pr | Property | Type | Required | Description | |---|---|---|---| | `key` | string | Yes | The config key used to access the selected value in connector code. | -| `label` | string | Yes | The label displayed for the dropdown in the SHF UI. | +| `label` | string | Yes | The label displayed for the dropdown in the SailPoint Identity Security UI. | | `type` | string | Yes | Must be `"select"`. | | `required` | boolean | No | Whether the user must make a selection before saving. Defaults to `false`. | | `options` | object[] | Yes | The list of dropdown options. Each option has a `label` (displayed text) and a `value` (the string stored in config). | diff --git a/docs/connectivity/saas-connectivity/in-depth/cli-advanced.md b/docs/connectivity/saas-connectivity/in-depth/cli-advanced.md index 253f5e503a391..a54e343da252b 100644 --- a/docs/connectivity/saas-connectivity/in-depth/cli-advanced.md +++ b/docs/connectivity/saas-connectivity/in-depth/cli-advanced.md @@ -6,12 +6,12 @@ sidebar_label: CLI - Advanced sidebar_position: 1 sidebar_class_name: cliAdvanced keywords: ['connectivity', 'connectors', 'cli'] -description: Using the CLI to properly test and debug your connector in SailPoint Human Fabric +description: Using the CLI to properly test and debug your connector in SailPoint Identity Security slug: /connectivity/saas-connectivity/in-depth/cli-advanced tags: ['Connectivity'] --- -You can use the CLI to invoke a number of calls in SailPoint Human Fabric, including calls that aren't specifically defined by the CLI. This section includes examples that show how you can invoke those calls: +You can use the CLI to invoke a number of calls in SailPoint Identity Security, including calls that aren't specifically defined by the CLI. This section includes examples that show how you can invoke those calls: ## Use provided CLI invoke calls diff --git a/docs/connectivity/saas-connectivity/in-depth/connector-timeouts.md b/docs/connectivity/saas-connectivity/in-depth/connector-timeouts.md index dd37ca50d0bf7..c99163090cb10 100644 --- a/docs/connectivity/saas-connectivity/in-depth/connector-timeouts.md +++ b/docs/connectivity/saas-connectivity/in-depth/connector-timeouts.md @@ -6,14 +6,14 @@ sidebar_label: Connector Timeouts sidebar_position: 1.2 sidebar_class_name: connectorTimeouts keywords: ['connectivity', 'connectors', 'timeout'] -description: SailPoint Human Fabric will throw an error if your connector does not send a response in 3 minutes. For connector commands that might take longer than 3 minutes, make sure to send data at regular intervals to prevent a timeout. +description: SailPoint Identity Security will throw an error if your connector does not send a response in 3 minutes. For connector commands that might take longer than 3 minutes, make sure to send data at regular intervals to prevent a timeout. slug: /connectivity/saas-connectivity/in-depth/connector-timeouts tags: ['Connectivity'] --- -An SailPoint Human Fabric SaaS Connectivity connector will send a timeout error if it doesn't send a response within 3 minutes. If the connector is sending thousands of records, the record fetching process will likely exceed this timeout limit. If you are storing all those records in memory before sending them to SHF, you can run into memory utilization issues. To prevent these issues, you should paginate through your source data and send the data back in regular intervals. +An SailPoint Identity Security SaaS Connectivity connector will send a timeout error if it doesn't send a response within 3 minutes. If the connector is sending thousands of records, the record fetching process will likely exceed this timeout limit. If you are storing all those records in memory before sending them to SailPoint Identity Security, you can run into memory utilization issues. To prevent these issues, you should paginate through your source data and send the data back in regular intervals. -In the case of a long running API call to the source system, you can also optionally send `res.keepAlive()` to keep the connection to SailPoint Human Fabric open without having to send any data to SailPoint Human Fabric. If `res.keepAlive()` or `res.send()` is not called within 3 minutes, a connector timeout will occur. +In the case of a long running API call to the source system, you can also optionally send `res.keepAlive()` to keep the connection to SailPoint Identity Security open without having to send any data. If `res.keepAlive()` or `res.send()` is not called within 3 minutes, a connector timeout will occur. This is an example of how to set up this pagination: @@ -25,8 +25,8 @@ async getAccounts(res: Response): Promise { // each page will be called recursively until there are no more records to fetch, at which case the promise is fulfilled ).eachPage((records, fetchNextPage) => { for (let record of records) { - // this is the part that sends the data to SailPoint Human Fabric. Since eachPage is called with just 10 records, - // if there are 100 records total, we would send data back to SHF in 10 sets of 10 records. + // this is the part that sends the data to SailPoint Identity Security. Since eachPage is called with just 10 records, + // if there are 100 records total, we would send data back to SailPoint Identity Security in 10 sets of 10 records. res.send({ identity: record.id, attributes: { diff --git a/docs/connectivity/saas-connectivity/in-depth/data-store.md b/docs/connectivity/saas-connectivity/in-depth/data-store.md index 6ed3a3d3f4376..efa9ab06167d5 100644 --- a/docs/connectivity/saas-connectivity/in-depth/data-store.md +++ b/docs/connectivity/saas-connectivity/in-depth/data-store.md @@ -11,7 +11,7 @@ slug: /connectivity/saas-connectivity/in-depth/data-store tags: ['Connectivity'] --- -The connector SDK provides a persistent key-value data store backed by your source's `connectorAttributes`. Unlike the [in-memory cache](./caching), data stored here survives container recycling and cold starts — it is persisted in the source configuration on the SHF platform. +The connector SDK provides a persistent key-value data store backed by your source's `connectorAttributes`. Unlike the [in-memory cache](./caching), data stored here survives container recycling and cold starts — it is persisted in the source configuration on the SailPoint Identity Security platform. Under the hood, the data store uses the `patchConfig` mechanism to write JSON Patch operations to `connectorAttributes`. The SDK handles the patch format for you and only sends patches when values actually change, avoiding unnecessary writes. @@ -46,7 +46,7 @@ export const connector = createConnector() // Store the new sync timestamp dataStore.set('lastSyncTimestamp', new Date().toISOString()) - // Send all changes to SHF + // Send all changes to SailPoint Identity Security dataStore.flush() }) ``` @@ -124,7 +124,7 @@ if (dataStore.hasPendingChanges) { ### `dataStore.reload(context): Promise` -Reload the connector config from SHF via the command context and update the data store's baseline. Call this during long aggregations to pick up config changes that occurred mid-run — including values written by a previous `flush()` call in the same invocation. +Reload the connector config from SailPoint Identity Security via the command context and update the data store's baseline. Call this during long aggregations to pick up config changes that occurred mid-run — including values written by a previous `flush()` call in the same invocation. Pending changes are preserved across a reload. @@ -136,7 +136,7 @@ await dataStore.reload(context) ``` :::info -`flush()` also updates the local config baseline automatically, so in most cases an explicit `reload()` is only needed if the config may have changed externally — for example, if SHF or another process has updated `connectorAttributes` mid-aggregation. +`flush()` also updates the local config baseline automatically, so in most cases an explicit `reload()` is only needed if the config may have changed externally — for example, if SailPoint Identity Security or another process has updated `connectorAttributes` mid-aggregation. ::: ## Change Detection @@ -229,7 +229,7 @@ If an API uses cursor-based pagination and you need to resume across invocations ### Reloading config during long aggregations -For very long aggregations, SHF may update the source config externally while the connector is running. Use `reload()` to pick up any changes and keep the data store's baseline in sync: +For very long aggregations, SailPoint Identity Security may update the source config externally while the connector is running. Use `reload()` to pick up any changes and keep the data store's baseline in sync: ```typescript .stdAccountList(async (context, input, res) => { diff --git a/docs/connectivity/saas-connectivity/in-depth/debugging.md b/docs/connectivity/saas-connectivity/in-depth/debugging.md index f12278e0a224e..a7af202ae8d83 100644 --- a/docs/connectivity/saas-connectivity/in-depth/debugging.md +++ b/docs/connectivity/saas-connectivity/in-depth/debugging.md @@ -39,7 +39,7 @@ export const connector = async () => { }; ``` -`console.log()` statements work anywhere, and they work when you deploy your connector to SHF. However, these statements can create clutter in your code. You will often have to clean up debug statements once you are done. +`console.log()` statements work anywhere, and they work when you deploy your connector to SailPoint Identity Security. However, these statements can create clutter in your code. You will often have to clean up debug statements once you are done. If your IDE supports debugging JavaScript, then your IDE’s built-in debugger can be a powerful and easy way to debug your code. @@ -89,6 +89,6 @@ With these configurations set, you can run the debugger by selecting the options -## Debug in SailPoint Human Fabric +## Debug in SailPoint Identity Security -You can use the `sail conn logs` command to gain insight into how your connector is performing while running in SHF. See the section on logging for more information. +You can use the `sail conn logs` command to gain insight into how your connector is performing while running in SailPoint Identity Security. See the section on logging for more information. diff --git a/docs/connectivity/saas-connectivity/in-depth/error-handling.md b/docs/connectivity/saas-connectivity/in-depth/error-handling.md index b1cea986ea5ef..735664759e888 100644 --- a/docs/connectivity/saas-connectivity/in-depth/error-handling.md +++ b/docs/connectivity/saas-connectivity/in-depth/error-handling.md @@ -45,7 +45,7 @@ export class AirtableClient { ## Not Found Error Type -The connector SDK offers a special error type `ConnectorErrorType.NotFound`. This error signals to SHF that a specific account does not exist in the source system. When SHF receives this error during a provisioning event (such as an account update triggered by a role assignment), it will automatically call `std:account:create` to provision the account rather than treating the failure as an error. +The connector SDK offers a special error type `ConnectorErrorType.NotFound`. This error signals to SailPoint Identity Security that a specific account does not exist in the source system. When SailPoint Identity Security receives this error during a provisioning event (such as an account update triggered by a role assignment), it will automatically call `std:account:create` to provision the account rather than treating the failure as an error. ```typescript import { ConnectorError, ConnectorErrorType } from '@sailpoint/connector-sdk' @@ -54,8 +54,8 @@ import { ConnectorError, ConnectorErrorType } from '@sailpoint/connector-sdk' const account = await myClient.getAccount(input.identity) if (!account) { - // Signal to SHF that the account does not exist. - // SHF will automatically trigger std:account:create for this identity. + // Signal to SailPoint Identity Security that the account does not exist. + // SailPoint Identity Security will automatically trigger std:account:create for this identity. throw new ConnectorError('Account not found', ConnectorErrorType.NotFound) } @@ -100,7 +100,7 @@ export class MyClient { ## Recommended error types and when to use them -The following custom error classes cover the most common failure scenarios. Each maps to a `ConnectorErrorType` that SHF understands. +The following custom error classes cover the most common failure scenarios. Each maps to a `ConnectorErrorType` that SailPoint Identity Security understands. ### `InvalidConfigurationError` @@ -116,7 +116,7 @@ constructor(config: any) { ### `InsufficientPermissionError` -Use when the source API returns a 403 or an equivalent "access denied" error. This tells SHF the connector's credentials do not have the required permissions. +Use when the source API returns a 403 or an equivalent "access denied" error. This tells SailPoint Identity Security the connector's credentials do not have the required permissions. ```typescript async getAccount(id: string): Promise { @@ -165,7 +165,7 @@ async listAccounts(): Promise { ### `TimeoutError` -Use when the source system returns a timeout error or when an operation takes longer than expected. This is distinct from the SHF-level 3-minute connector timeout. +Use when the source system returns a timeout error or when an operation takes longer than expected. This is distinct from the SailPoint Identity Security-level 3-minute connector timeout. ```typescript async runLongOperation(): Promise { diff --git a/docs/connectivity/saas-connectivity/in-depth/logging.md b/docs/connectivity/saas-connectivity/in-depth/logging.md index 9d90b88b78fc7..1da14417ef28c 100644 --- a/docs/connectivity/saas-connectivity/in-depth/logging.md +++ b/docs/connectivity/saas-connectivity/in-depth/logging.md @@ -13,7 +13,7 @@ tags: ['Connectivity'] ## Printing Logs with the CLI -Fetch logs from SHF by issuing the `sail conn logs` command: +Fetch logs from SailPoint Identity Security by issuing the `sail conn logs` command: ```bash $ sail conn logs @@ -117,7 +117,7 @@ export const connector = async () => { ### Adding the option to your connector spec -To expose a debug logging toggle in the SHF source configuration UI, add `"showDebugLoggingOption": true` to your `connector-spec.json`: +To expose a debug logging toggle in the SailPoint Identity Security source configuration UI, add `"showDebugLoggingOption": true` to your `connector-spec.json`: ```json { @@ -132,7 +132,7 @@ To expose a debug logging toggle in the SHF source configuration UI, add `"showD Once `showDebugLoggingOption` is enabled in the spec, an administrator can activate debug logging without redeploying the connector: -1. In SHF, go to **Admin** > **Connections** > **Sources** and open the source. +1. In SailPoint Identity Security, go to **Admin** > **Connections** > **Sources** and open the source. 2. Click **Edit Configuration**, then open the **Administrator Settings** tab. 3. Enable the **Enable Debug Logging** toggle. 4. Select an expiry duration for how long debug logging should remain active. @@ -158,7 +158,7 @@ export const connector = async () => { logger.debug({count: accounts.length}, 'Fetched accounts from Airtable') for (const account of accounts) { - logger.debug({accountId: account.id}, 'Sending account to SHF') + logger.debug({accountId: account.id}, 'Sending account to SailPoint Identity Security') res.send(account.toStdAccountListOutput()) } }) @@ -174,7 +174,7 @@ $ sail conn logs tail [2022-07-14T11:23:05.100-04:00] DEBUG | connectorMessage ▶︎ {"commandType":"std:account:list","connectorName":"Airtable","message":"Starting account list fetch",...} [2022-07-14T11:23:05.200-04:00] DEBUG | connectorMessage ▶︎ {"commandType":"std:account:list","connectorName":"Airtable","count":3,"message":"Fetched accounts from Airtable",...} -[2022-07-14T11:23:05.210-04:00] DEBUG | connectorMessage ▶︎ {"commandType":"std:account:list","connectorName":"Airtable","accountId":"recdUN76q9KibYMir","message":"Sending account to SHF",...} +[2022-07-14T11:23:05.210-04:00] DEBUG | connectorMessage ▶︎ {"commandType":"std:account:list","connectorName":"Airtable","accountId":"recdUN76q9KibYMir","message":"Sending account to SailPoint Identity Security",...} ``` When debug logging is **not** enabled, these `logger.debug` calls produce no output, so there is no performance or noise impact in normal operation. diff --git a/docs/connectivity/saas-connectivity/index.md b/docs/connectivity/saas-connectivity/index.md index 5b03effdf67de..6d84b68df1cd5 100644 --- a/docs/connectivity/saas-connectivity/index.md +++ b/docs/connectivity/saas-connectivity/index.md @@ -19,13 +19,13 @@ SaaS Connectivity is a cloud based connector runtime that makes developing and d ## What are connectors -Connectors are the bridges between the SailPoint Human Fabric (SHF) SaaS platform and the source systems that SHF needs to communicate with and aggregate data from. An example of a source system SHF may need to communicate with would be an Oracle HR system or GitHub. In these cases, SHF synchronizes data between systems to ensure account entitlements and state are correct through the organization. +Connectors are the bridges between the SailPoint Identity Security SaaS platform and the source systems that it needs to communicate with and aggregate data from. An example of a source system SailPoint Identity Security may need to communicate with would be an Oracle HR system or GitHub. In these cases, the platform synchronizes data between systems to ensure account entitlements and state are correct through the organization. ## Why we are introducing SaaS Connectivity The primary driver for introducing the SaaS Connectivity framework is to allow a way to connect to other cloud based sources in a truly SaaS architecture, without the need to rely on a VA. There are also other benefits that come with the SaaS Connectivity framework: -- Ability to develop, debug and test custom connectors locally without any dependencies on SailPoint Human Fabric +- Ability to develop, debug and test custom connectors locally without any dependencies on SailPoint Identity Security - Features to customize the user interface when configuring the connector that are specific to the source - Support for more modern languages and frameworks @@ -35,7 +35,7 @@ VA connectors always communicate with external sources through the Virtual Appli ![Old Connectivity](./img/old_connectivity_diagram.png) -The new Cloud connectors work differently - they run on the SHF platform instead: +The new Cloud connectors work differently - they run on the SailPoint Identity Security platform instead: ![New Connectivity](./img/new_connectivity_diagram.png) diff --git a/docs/connectivity/saas-connectivity/limits.md b/docs/connectivity/saas-connectivity/limits.md index 5546660594dcf..77b9ea639f46e 100644 --- a/docs/connectivity/saas-connectivity/limits.md +++ b/docs/connectivity/saas-connectivity/limits.md @@ -15,7 +15,7 @@ Below is a list of limits set in SaaS Connectivity: - **Max Run Time** - The actual run time of a connector is not limited at this time, however a response in the form of `res.send()` must be recieved from a command at least every 3 minutes - - If you have a long running call, you can use `res.keepAlive()` to send a heartbeat to SailPoint Human Fabric in between `res.send()` calls to let it know the connector is still running + - If you have a long running call, you can use `res.keepAlive()` to send a heartbeat to SailPoint Identity Security in between `res.send()` calls to let it know the connector is still running - **Response Size** - The maximum size of a single `res.send()` call is 256 KiB. Note that some metadata is sent along with the call, so the max size of the payload sent will be slightly less than 256 KiB - **Memory Limits** diff --git a/docs/connectivity/saas-connectivity/prerequisites.md b/docs/connectivity/saas-connectivity/prerequisites.md index 2ee5d39e333c6..0ba7ca2cc561b 100644 --- a/docs/connectivity/saas-connectivity/prerequisites.md +++ b/docs/connectivity/saas-connectivity/prerequisites.md @@ -29,7 +29,7 @@ Although you can develop connectors in a text editor, use an Integrated Developm ### Postman -A convenient way to test your connector before deploying to SHF is to use Postman. You can get it from the [postman.com downloads page](https://www.postman.com/downloads/) +A convenient way to test your connector before deploying to SailPoint Identity Security is to use Postman. You can get it from the [postman.com downloads page](https://www.postman.com/downloads/) ## Creating your first project @@ -61,15 +61,15 @@ my-first-project This directory contains three main files: -- **index.ts:** Use this file to register all the available commands the connector supports, provide the necessary configuration options to the client code implementing the API for the source, and pass data the client code obtains to SailPoint Human Fabric. This file can either use a vendor supplied client Software Development Kit (SDK) to interact with the web service or reference custom client code within the project. +- **index.ts:** Use this file to register all the available commands the connector supports, provide the necessary configuration options to the client code implementing the API for the source, and pass data the client code obtains to SailPoint Identity Security. This file can either use a vendor supplied client Software Development Kit (SDK) to interact with the web service or reference custom client code within the project. - **my-client.ts:** Use this template to create custom client code to interact with a web service’s APIs. If the web service does not provide an SDK, you can modify this file to implement the necessary API calls to interact with the source web service. -- **connector-spec.ts** This file describes how the connector works to SHF. More information about the connector spec is available in the next section. At a high level, it has the information for the following: +- **connector-spec.ts** This file describes how the connector works to SailPoint Identity Security. More information about the connector spec is available in the next section. At a high level, it has the information for the following: - What commands the connector supports - What config values the user must provide when creating the connector - Defining the account schema - Defining the entitlment schema - - Defining the account create template that maps fields from SHF to the connector + - Defining the account create template that maps fields from SailPoint Identity Security to the connector These files are templates that provide guidance to begin implementing the connector on the target web service. Although you can implement a connector's entire functionality within these three files (or even just one if the web service provides an SDK), you can implement your own code architecture, like breaking out common utility functions into a separate file or creating separate files for each operation. diff --git a/docs/connectivity/saas-connectivity/test-build-deploy.md b/docs/connectivity/saas-connectivity/test-build-deploy.md index b52a18c68c89b..a239b8620d7e5 100644 --- a/docs/connectivity/saas-connectivity/test-build-deploy.md +++ b/docs/connectivity/saas-connectivity/test-build-deploy.md @@ -37,17 +37,17 @@ As you implement command handlers, you must test them. The connector SDK provide ## Create and upload connector bundle -Follow these steps to use the CLI to package a connector bundle, create it in your SailPoint Human Fabric org, and upload it to SailPoint Human Fabric. +Follow these steps to use the CLI to package a connector bundle, create it in your SailPoint Identity Security org, and upload it to your tenant. ### Package connector files -You must compress the files in the connector project into a zip file before uploading them to SailPoint Human Fabric. +You must compress the files in the connector project into a zip file before uploading them to SailPoint Identity Security. Use the CLI to run `npm run pack-zip` to build and package the connector bundle. Put the resulting zip file in the `dist` folder. ### Create connector in your org -Before uploading the zip file, you must create an entry for the connector in your SailPoint Human Fabric org. Run `sail conn create "my-project"` to create a connector entry. +Before uploading the zip file, you must create an entry for the connector in your SailPoint Identity Security org. Run `sail conn create "my-project"` to create a connector entry. The response to this command contains a connector ID you can use to manage this connector. @@ -78,9 +78,9 @@ $ sail conn list -### Upload connector zip file to SailPoint Human Fabric +### Upload connector zip file to SailPoint Identity Security -Run `sail conn upload -c [connectorID | connectorAlias] -f dist/[connector filename].zip` to upload the zip file built from the previous step to SailPoint Human Fabric. +Run `sail conn upload -c [connectorID | connectorAlias] -f dist/[connector filename].zip` to upload the zip file built from the previous step to SailPoint Identity Security. ```bash $ sail conn upload -c example-connector -f dist/example-connector-0.1.0.zip @@ -104,19 +104,19 @@ $ sail conn tags list -c example-connector :::caution Important -Make sure that you implement a form of version control or regular backup process for your connectors. You cannot recover the source code from SHF because it gets sent to SHF as a compiled and minified JavaScript (JS) bundle that cannot be easily expanded into its original source code structure. +Make sure that you implement a form of version control or regular backup process for your connectors. You cannot recover the source code from SailPoint Identity Security because it gets sent to the platform as a compiled and minified JavaScript (JS) bundle that cannot be easily expanded into its original source code structure. ::: -## Test your connector in SailPoint Human Fabric +## Test your connector in SailPoint Identity Security -Follow these steps to test a connector bundle in both SailPoint Human Fabric and the SailPoint Human Fabric user interface (UI). +Follow these steps to test a connector bundle in both SailPoint Identity Security and its user interface (UI). -### Test your connector bundle in SailPoint Human Fabric +### Test your connector bundle in SailPoint Identity Security The connector CLI provides ways to test invoking commands with any connector upload version. Before running a command, create a file, **config.json**, in the root project folder. Include any configuration items required to interact with the target web service in this file, such as API token, username, password, organization, version, etc. The following snippet is an example: @@ -148,8 +148,8 @@ $ sail connectors invoke account-list -c example-connector -p config.json -## Test your connector from SailPoint Human Fabric UI +## Test your connector from SailPoint Identity Security UI -Go to your SailPoint Human Fabric org’s source section. Create a source from the connector you just uploaded. This connector will display in the dropdown list: **example-connector (tag: latest)** +Go to your SailPoint Identity Security org’s source section. Create a source from the connector you just uploaded. This connector will display in the dropdown list: **example-connector (tag: latest)** -After creating a source, you can to test connection, aggregate account, etc. from the SailPoint Human Fabric UI. +After creating a source, you can to test connection, aggregate account, etc. from the SailPoint Identity Security UI. diff --git a/docs/connectivity/saas-connectivity/zero-knowledge-encryption.md b/docs/connectivity/saas-connectivity/zero-knowledge-encryption.md index b35d875aca208..7102bde9068e5 100644 --- a/docs/connectivity/saas-connectivity/zero-knowledge-encryption.md +++ b/docs/connectivity/saas-connectivity/zero-knowledge-encryption.md @@ -15,20 +15,20 @@ tags: ['Connectivity'] Organizations are rapidly adopting cloud-delivered software, or SaaS, which often uses sensitive user data such as account credentials. This data is often sent across the Internet and potentially stored in databases and directories that may not be under the direct control of the company’s IT department. -Many enterprises take advantage of SailPoint Human Fabric (SHF) to govern access, enhance productivity, and automate IT processes across both cloud and on-premises resources. +Many enterprises take advantage of SailPoint Identity Security to govern access, enhance productivity, and automate IT processes across both cloud and on-premises resources. Protecting this sensitive data is paramount, so SailPoint handles it with the utmost commitment. Passwords are a ubiquitous, time-honored method of securing access to critical data. Even more important than user passwords are administrative account credentials, which allow privileged access to systems. Today’s enterprises use additional measures like security questions, which are equally as important to protect as passwords. -SHF secures all credentials and sensitive identity data while at rest and in motion. SailPoint’s solution for securing sensitive data is built upon two tenets: +SailPoint Identity Security secures all credentials and sensitive identity data while at rest and in motion. SailPoint’s solution for securing sensitive data is built upon two tenets: 1. All sensitive data must be protected by at least two layers of encryption, and those two layers must be dissimilar so if one is compromised, the other cannot be compromised the same way. For example, encrypt credentials using 4096-bit RSA encryption (since February 2026), and then use Transport Layer Security (TLS) to encrypt the encrypted credentials while in motion. 2. SailPoint never has access to the unencrypted form of sensitive data. It is always encrypted with a key that is controlled by the user or customer and is not accessible to SailPoint. The key is always kept separate from the encrypted data. -SHF delivers this level of security using a scalable and redundant architecture that, unlike many other solutions in the market, does not rely on using agents or opening the corporate firewall, and never exposes sensitive data to attack. +SailPoint Identity Security delivers this level of security using a scalable and redundant architecture that, unlike many other solutions in the market, does not rely on using agents or opening the corporate firewall, and never exposes sensitive data to attack. ## Patented zero knowledge encryption @@ -47,10 +47,10 @@ Since unencrypted credentials are never stored or sent over the internet, they a *Zero Knowledge Encryption* uses the SailPoint virtual appliance (VA) to provide a secure, scalable, and redundant interface to both on-premises and cloud resources. VAs are deployed in clusters behind the firewall of the enterprise datacenter without requiring ports to be opened, so the enterprise’s intrusion prevention and network security perimeter enforcement remains intact. -The VA continuously polls SHF in the cloud, looking for tasks or for data that is waiting for action. +The VA continuously polls SailPoint Identity Security in the cloud, looking for tasks or for data that is waiting for action. The VA is scalable, highly-available, and because it's completely self-managed and updates automatically, it adds no administrative overhead. The company administrator specifies a passphrase that is unknown to SailPoint, which is used to generate a 2048-bit RSA public/private key pair. -The VA then serves the public key that SHF uses to encrypt account credentials. +The VA then serves the public key that SailPoint Identity Security uses to encrypt account credentials. This ensures that any credential exchange with systems that require administrative access are securely encrypted using a user-specified key that is not known to SailPoint, not stored on any SailPoint server, and is created and maintained within the enterprise security perimeter or firewall. The user-specified keys are then managed and rotated according to the administrator’s security policy. @@ -71,83 +71,83 @@ VA clusters can be deployed within each datacenter or geography to keep security ## Securing sensitive enterprise data Sensitive data in the enterprise is not limited to administrative credentials. -It is common for other critical information and credentials to be used as well, and their usage is not always obvious. SHF ensures this data is always secure. +It is common for other critical information and credentials to be used as well, and their usage is not always obvious. SailPoint Identity Security ensures this data is always secure. -### SailPoint Human Fabric login and authentication information +### SailPoint Identity Security login and authentication information -SailPoint uses *Zero Knowledge Encryption* along with multiple layers of encryption for authentication in SHF. +SailPoint uses *Zero Knowledge Encryption* along with multiple layers of encryption for authentication in SailPoint Identity Security. The specific methods of encryption are tailored for whichever authentication method is chosen by the administrator. -#### SailPoint Human Fabric password +#### SailPoint Identity Security password -When an SHF user creates their password, an SHA-256 hash is calculated, using a salt that itself is an SHA-256 hash of a random string. -This creates a cryptographic representation of the password that is then sent to SHF over a secure TLS connection, giving two layers of encryption. +When a SailPoint Identity Security user creates their password, an SHA-256 hash is calculated, using a salt that itself is an SHA-256 hash of a random string. +This creates a cryptographic representation of the password that is then sent to SailPoint Identity Security over a secure TLS connection, giving two layers of encryption. It's the SHA-256 one-way cryptographic hash that is stored, not the plain-text password. -Whenever the user signs in to SHF using their password on subsequent logins, this one-way hash is generated anew, authenticating the user into SHF based on the hash value. +Whenever the user signs in to SailPoint Identity Security using their password on subsequent logins, this one-way hash is generated anew, authenticating the user based on the hash value. #### Pass-Through authentication -Pass-through authentication allows SHF users to authenticate using a trusted source of authentication, such as the company’s Active Directory server. -When a pass-through authentication user creates or changes their password, SHF uses *Zero Knowledge Encryption* to encrypt the new password in the browser using the 2048-bit RSA public key hosted by the virtual appliance. +Pass-through authentication allows SailPoint Identity Security users to authenticate using a trusted source of authentication, such as the company’s Active Directory server. +When a pass-through authentication user creates or changes their password, SailPoint Identity Security uses *Zero Knowledge Encryption* to encrypt the new password in the browser using the 2048-bit RSA public key hosted by the virtual appliance. Inside the company’s firewall, the VA derives the password, using the 2048-bit RSA private key, and sets the password on the target system, without any chance of its being known outside the company’s network. -When the user signs in to SHF in the future, this 2048-bit encrypted representation of the password is sent to the VA where the target system password is derived, within the customer’s firewall. +When the user signs in to SailPoint Identity Security in the future, this 2048-bit encrypted representation of the password is sent to the VA where the target system password is derived, within the customer’s firewall. The target authentication system must then validate the user’s credentials. #### Security questions Most enterprises use security questions to provide strong authentication, such as validating the user’s identity for password changes or enabling access to higher security systems. -In SHF, the answers to users’ security questions are encrypted using SHA-256 to create a one-way hash, using a salt that includes a random string and the user’s Universally Unique Identifier (UUID). +In SailPoint Identity Security, the answers to users’ security questions are encrypted using SHA-256 to create a one-way hash, using a salt that includes a random string and the user’s Universally Unique Identifier (UUID). This makes the answers to the user’s security questions virtually impossible to hack. All of this is sent over TLS, providing at least two layers of encryption at all times. ### Third-Party authentication Many enterprises employ access management tools known as “Identity Providers” (or IdPs) to facilitate single sign-on and other features like self-service password reset for the applications and systems they use within their enterprise, multi-factor authentication, mobile device management and the like. -Because SHF enables many access-oriented actions for signed-in users, it becomes critical to understand how those users can be signed in to SHF. +Because SailPoint Identity Security enables many access-oriented actions for signed-in users, it becomes critical to understand how those users can be signed in to the platform. -When a user is signing in to SHF from a third-party SSO tool, the security of the credentials used for this sign-in depends on the protocols or methods that SSO tool uses. +When a user is signing in to SailPoint Identity Security from a third-party SSO tool, the security of the credentials used for this sign-in depends on the protocols or methods that SSO tool uses. There are two methods of single sign-on in common use in the industry: credential replay and federation. #### Credential replay With credential replay, the SSO tool automatically fills in the sign-in page username and password fields with a stored username and password when it's performing single sign-on. -To ensure that credentials cannot be compromised during credential replay, it's critical that you thoroughly evaluate how your SSO provider stores credentials and secures them when it's replaying into SHF. -Because these methods vary and don't conform to a recognized standard, credential replay for signing in to SHF is not the preferred method of single sign-on. +To ensure that credentials cannot be compromised during credential replay, it's critical that you thoroughly evaluate how your SSO provider stores credentials and secures them when it's replaying into SailPoint Identity Security. +Because these methods vary and don't conform to a recognized standard, credential replay for signing in to SailPoint Identity Security is not the preferred method of single sign-on. #### Federation Federation using Security Assertion Markup Language (SAML) is the industry-standard secure method for single sign-on and most enterprise-grade SSO products support it. With SAML, no password is used for signing in, and a password doesn't have to be stored by the SSO vendor. Because no credentials exist either at rest or in motion, SAML is very secure and has proven nearly impossible to hack. -SHF fully supports SAML for federated logins, which enables integration with the best in class access management products without putting critical credentials at risk. +SailPoint Identity Security fully supports SAML for federated logins, which enables integration with the best in class access management products without putting critical credentials at risk. ### Secure password management -When the user updates a password on a target application through SHF, they must use the administrative credentials for that target system or directory to set the new password. -SHF uses *Zero Knowledge Encryption* through the SailPoint VA to secure these sensitive administrative credentials. +When the user updates a password on a target application through SailPoint Identity Security, they must use the administrative credentials for that target system or directory to set the new password. +SailPoint Identity Security uses *Zero Knowledge Encryption* through the SailPoint VA to secure these sensitive administrative credentials. Also, the new password itself is first encrypted prior to transmission to the target system, and a second form of encryption is applied while the new password is in motion or at rest. ### Automated task authentication -SHF implements *Zero Knowledge Encryption* within the SailPoint virtual appliance to secure all these administrative actions that are used by automated tasks within the governance platform: +SailPoint Identity Security implements *Zero Knowledge Encryption* within the SailPoint virtual appliance to secure all these administrative actions that are used by automated tasks within the governance platform: -- **Account Aggregation** – SHF uses administrative credentials to learn about accounts on diverse types of connected systems. -- **User Provisioning** – SHF uses administrative account access to external systems to provision accounts, set entitlements, lock and unlock or enable and disable accounts, assign groups, and perform other actions on those systems. -- **Password Management** – Changing and updating passwords on external systems requires SHF to sign in to those systems with administrative access. +- **Account Aggregation** – SailPoint Identity Security uses administrative credentials to learn about accounts on diverse types of connected systems. +- **User Provisioning** – SailPoint Identity Security uses administrative account access to external systems to provision accounts, set entitlements, lock and unlock or enable and disable accounts, assign groups, and perform other actions on those systems. +- **Password Management** – Changing and updating passwords on external systems requires SailPoint Identity Security to sign in to those systems with administrative access. - **Access Certifications** – Remediation activity from an access certification is a provisioning action that uses administrative access to the target system. -All these automated tasks, and any other administrative action SHF takes as a part of the service of governance, are all secured using *Zero Knowledge Encryption* through the VA. +All these automated tasks, and any other administrative action SailPoint Identity Security takes as a part of the service of governance, are all secured using *Zero Knowledge Encryption* through the VA. ## Conclusion With a range of technologies including the patented *Zero Knowledge Encryption*, SailPoint shows its commitment to security with continuous innovation, creating the best-in-class security in their cloud governance platform. -SailPoint Human Fabric builds upon decades of enterprise security best practices, and unlike other vendors, does not require customers to change their firewall or intrusion protection practices. +SailPoint Identity Security builds upon decades of enterprise security best practices, and unlike other vendors, does not require customers to change their firewall or intrusion protection practices. The powerful combination of multiple encryption technologies ensures sensitive data is always protected with the most advanced technology available, securing your organization’s adoption of cloud technologies today and into the future. © 2024 SailPoint Technologies, Inc. All rights reserved. SailPoint, the SailPoint logo and all techniques are trademarks or registered trademarks of SailPoint Technologies, Inc. in the U.S. and/or other countries. All other products or services are trademarks of their respective companies. diff --git a/docs/extensibility.md b/docs/extensibility.md index 652006b482e29..3cad48a2bb5ca 100644 --- a/docs/extensibility.md +++ b/docs/extensibility.md @@ -6,14 +6,14 @@ sidebar_label: Extensibility sidebar_position: 1 sidebar_class_name: extensibility keywords: ['extensibility'] -description: Extend your SHF platform. +description: Extend your SailPoint Identity Security platform. slug: /extensibility tags: ['extensibility'] --- ## Overview -The SailPoint Human Fabric (SHF) platform is designed for extensibility, which means that it's designed to allow the addition of new capabilities or functionalities. In addition to the APIs, SailPoint provides a number of extensibility options you can use to build custom solutions and integrations that meet your organization's needs. +The SailPoint Identity Security platform is designed for extensibility, which means that it's designed to allow the addition of new capabilities or functionalities. In addition to the APIs, SailPoint provides a number of extensibility options you can use to build custom solutions and integrations that meet your organization's needs. ```mdx-code-block import DocCardList from '@theme/DocCardList'; @@ -24,6 +24,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about SHF 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 SailPoint Identity Security 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). diff --git a/docs/extensibility/configuration-management/configuration-hub.md b/docs/extensibility/configuration-management/configuration-hub.md index d931698f4215d..e28aafeb52673 100644 --- a/docs/extensibility/configuration-management/configuration-hub.md +++ b/docs/extensibility/configuration-management/configuration-hub.md @@ -5,19 +5,19 @@ pagination_label: Configuration Hub sidebar_position: 3 sidebar_class_name: configurationHub keywords: ['configuration'] -description: Manage tenant configurations with the SHF UI. +description: Manage tenant configurations with the SailPoint Identity Security UI. slug: /extensibility/configuration-management/configuration-hub tags: ['Configuration', 'Hub'] --- ## Overview -The SailPoint Configuration Hub supports management of configuration objects in your SailPoint Human Fabric (SHF) tenant through backup and deploy operations from the SHF UI. For example, you can back up configurations like sources and identity profiles defined for your business, restore them in the event of configuration errors or loss, or migrate and deploy them to your other tenants. +The SailPoint Configuration Hub supports management of configuration objects in your SailPoint Identity Security tenant through backup and deploy operations from the UI. For example, you can back up configurations like sources and identity profiles defined for your business, restore them in the event of configuration errors or loss, or migrate and deploy them to your other tenants. To learn more about Configuration Hub, refer to the [Configuration Hub documentation](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html). ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where 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). diff --git a/docs/extensibility/configuration-management/index.mdx b/docs/extensibility/configuration-management/index.mdx index d61ca454d7573..e32a00e72ae62 100644 --- a/docs/extensibility/configuration-management/index.mdx +++ b/docs/extensibility/configuration-management/index.mdx @@ -31,6 +31,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ``` ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about SHF 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 SailPoint Identity Security 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). 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 5285af7926dbc..3af7cc51c74d0 100644 --- a/docs/extensibility/event-triggers/available/access-request-dynamic-approval.md +++ b/docs/extensibility/event-triggers/available/access-request-dynamic-approval.md @@ -23,7 +23,7 @@ When an access request is submitted, the Access Request Dynamic Approval trigger - If the ID of the additional approver is wrong, then a random org admin is assigned. - You can choose to **NOT** add an additional approver by providing an empty object as the response to the triggered REST request. -You can use this trigger to develop logic outside of SailPoint Human Fabric’s out-of-the-box offerings to route an approval step to users such as the following: +You can use this trigger to develop logic outside of Human Fabric’s out-of-the-box offerings to route an approval step to users such as the following: - The recipient’s department head - The recipient’s cost center diff --git a/docs/extensibility/event-triggers/available/access-request-submitted.md b/docs/extensibility/event-triggers/available/access-request-submitted.md index 4fb786d118f27..d54e4450ebdc7 100644 --- a/docs/extensibility/event-triggers/available/access-request-submitted.md +++ b/docs/extensibility/event-triggers/available/access-request-submitted.md @@ -97,7 +97,7 @@ To deny an access request, the subscribing service responds to the event trigger ``` :::warning -The `approver` does not have to be the name of an existing identity in your SHF tenant. It can be anything you want it to be. However, if you have an active subscription to the [Access Request Decision](./access-request-decision.md) trigger, you **MUST** provide the **username** of an existing identity in your tenant in the `approver` field. If you do not provide the **username** of an existing identity, then your Access Request Decision subscriptions will never be triggered. +The `approver` does not have to be the name of an existing identity in your SailPoint Identity Security tenant. It can be anything you want it to be. However, if you have an active subscription to the [Access Request Decision](./access-request-decision.md) trigger, you **MUST** provide the **username** of an existing identity in your tenant in the `approver` field. If you do not provide the **username** of an existing identity, then your Access Request Decision subscriptions will never be triggered. ::: :::warning diff --git a/docs/extensibility/event-triggers/available/account-aggregation-completed.md b/docs/extensibility/event-triggers/available/account-aggregation-completed.md index caf8dc94acd99..a05fed00f5b03 100644 --- a/docs/extensibility/event-triggers/available/account-aggregation-completed.md +++ b/docs/extensibility/event-triggers/available/account-aggregation-completed.md @@ -19,8 +19,8 @@ The platform has introduced an event trigger within the Source Aggregation workf After the initial collection of accounts in the source system during aggregation completes, some uses cases for this trigger include the following: -- Notify an administrator that SailPoint Human Fabric was able to successfully connect to the source system and collect source accounts. -- Notify an administrator or system (e.g. PagerDuty) that SailPoint Human Fabric failed to collect accounts during aggregation and indicate required remediation for the source system. +- Notify an administrator that SailPoint Identity Security was able to successfully connect to the source system and collect source accounts. +- Notify an administrator or system (e.g. PagerDuty) that SailPoint Identity Security failed to collect accounts during aggregation and indicate required remediation for the source system. :::info diff --git a/docs/extensibility/event-triggers/available/account-created.md b/docs/extensibility/event-triggers/available/account-created.md index cb6400d385b3b..2d0831b15b723 100644 --- a/docs/extensibility/event-triggers/available/account-created.md +++ b/docs/extensibility/event-triggers/available/account-created.md @@ -12,7 +12,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] ## Event Context -This event trigger fires when a new account is created in SailPoint Human Fabric. +This event trigger fires when a new account is created in SailPoint Identity Security. Accounts can be created via aggregations or provisioning, including when entitlements are added or removed. diff --git a/docs/extensibility/event-triggers/available/account-deleted.md b/docs/extensibility/event-triggers/available/account-deleted.md index a95c68b58fbe9..efb7f8c185361 100644 --- a/docs/extensibility/event-triggers/available/account-deleted.md +++ b/docs/extensibility/event-triggers/available/account-deleted.md @@ -12,7 +12,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] ## Event Context -This event trigger fires when an account is deleted in SailPoint Human Fabric. +This event trigger fires when an account is deleted in SailPoint Identity Security. Accounts can be deleted via aggregations or provisioning. diff --git a/docs/extensibility/event-triggers/available/account-updated.md b/docs/extensibility/event-triggers/available/account-updated.md index 9d2198101f6da..cf61ad9f0cd9f 100644 --- a/docs/extensibility/event-triggers/available/account-updated.md +++ b/docs/extensibility/event-triggers/available/account-updated.md @@ -12,7 +12,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] ## Event Context -This event trigger fires when an account is updated in SailPoint Human Fabric. +This event trigger fires when an account is updated in SailPoint Identity Security. Accounts can be updated via aggregations or provisioning, including when entitlements are added or removed. diff --git a/docs/extensibility/event-triggers/available/identity-deleted.md b/docs/extensibility/event-triggers/available/identity-deleted.md index 08592a117c40f..170bcd5f2e9b3 100644 --- a/docs/extensibility/event-triggers/available/identity-deleted.md +++ b/docs/extensibility/event-triggers/available/identity-deleted.md @@ -27,7 +27,7 @@ After accounts are aggregated and the identity refresh process finds an identity :::info -SailPoint Human Fabric will **hide** an identity from the identity list in the UI when the authoritative account is removed. This does not necessarily mean that the identity has been deleted. The identity will only be deleted when the above criteria are met. The deletion task run each night, so there will be a delay from when the criteria are met to when the identity will actually be deleted. +Human Fabric will **hide** an identity from the identity list in the UI when the authoritative account is removed. This does not necessarily mean that the identity has been deleted. The identity will only be deleted when the above criteria are met. The deletion task run each night, so there will be a delay from when the criteria are met to when the identity will actually be deleted. ::: diff --git a/docs/extensibility/event-triggers/available/index.mdx b/docs/extensibility/event-triggers/available/index.mdx index 2442b2d5369f1..4671f1197c51d 100644 --- a/docs/extensibility/event-triggers/available/index.mdx +++ b/docs/extensibility/event-triggers/available/index.mdx @@ -14,6 +14,6 @@ tags: ['Event Triggers', 'Available Event Triggers'] import DocCardList from '@theme/DocCardList'; import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; -The event triggers in this section are generally available to all SHF tenants. Event triggers currently in development are considered [Early Access](../early-access/index.mdx) and require a support ticket to be enabled in a tenant. +The event triggers in this section are generally available to all SailPoint Identity Security tenants. Event triggers currently in development are considered [Early Access](../early-access/index.mdx) and require a support ticket to be enabled in a tenant. diff --git a/docs/extensibility/event-triggers/available/machine-identity-created.md b/docs/extensibility/event-triggers/available/machine-identity-created.md index f7917618969d3..3732940aef2c3 100644 --- a/docs/extensibility/event-triggers/available/machine-identity-created.md +++ b/docs/extensibility/event-triggers/available/machine-identity-created.md @@ -14,7 +14,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] ![Flow](./img/machine-identity-created-path.png) -This event trigger fires when a new machine identity is created in SailPoint Human Fabric. +This event trigger fires when a new machine identity is created in SailPoint Agentic Fabric. Machine identities can be created via the UI, endpoint, or aggregated. Machine identities can also be created via machine account to machine account mappings. diff --git a/docs/extensibility/event-triggers/available/machine-identity-deleted.md b/docs/extensibility/event-triggers/available/machine-identity-deleted.md index 73e6684913d9a..d4d621f3a66a1 100644 --- a/docs/extensibility/event-triggers/available/machine-identity-deleted.md +++ b/docs/extensibility/event-triggers/available/machine-identity-deleted.md @@ -14,7 +14,7 @@ tags: ['Event Triggers', 'Available Event Triggers','Fire and Forget'] ![Flow](img/machine-identity-deleted-path.png) -This event trigger fires when a machine identity is deleted in SailPoint Human Fabric. +This event trigger fires when a machine identity is deleted in SailPoint Agentic Fabric. Machine identities can be deleted via the UI, endpoint, or aggregations. Machine identities can also be auto-deleted when all account correlations to the machine identity are removed. diff --git a/docs/extensibility/event-triggers/available/machine-identity-updated.md b/docs/extensibility/event-triggers/available/machine-identity-updated.md index a1fe2cdacf5b9..f2bd2cf0d96ec 100644 --- a/docs/extensibility/event-triggers/available/machine-identity-updated.md +++ b/docs/extensibility/event-triggers/available/machine-identity-updated.md @@ -14,7 +14,7 @@ tags: ['Event Triggers', 'Available Event Triggers', 'Fire and Forget'] ![Flow](./img/machine-identity-updated-path.png) -This event trigger fires when a machine identity is updated in SailPoint Human Fabric. +This event trigger fires when a machine identity is updated in SailPoint Agentic Fabric. Machine identities can be updated via the UI, endpoint, or aggregations. 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 67ba36909fce0..3752032e13045 100644 --- a/docs/extensibility/event-triggers/available/native-change-account-created.md +++ b/docs/extensibility/event-triggers/available/native-change-account-created.md @@ -172,7 +172,7 @@ This is an example input from this trigger: - `multiValueAttributeChanges` List of multivalued attributes that were aggregated with the account. Only `addedValues` will appear for account created events. - it will include ALL account attributes if the config is `"allNonEntitlementAttributes": true` - it will include the enumerated list of attributes contained in `"selectedNonEntitlementAttributes": []` -- `account` The details of the account as it appears in SailPoint Human Fabric. This information can be used to query the account API for more information. +- `account` The details of the account as it appears in SailPoint Identity Security. This information can be used to query the account API for more information. ## Additional Information and Links 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 3242c20f043ac..7d75c27f90e98 100644 --- a/docs/extensibility/event-triggers/available/native-change-account-deleted.md +++ b/docs/extensibility/event-triggers/available/native-change-account-deleted.md @@ -165,7 +165,7 @@ This is an example input from this trigger: - `multiValueAttributeChanges` List of multivalued attributes that were aggregated with the account. Only `removedValues` will appear for account deleted events. - it will include ALL account attributes if the config is `"allNonEntitlementAttributes": true` - it will include the enumerated list of attributes contained in `"selectedNonEntitlementAttributes": []` -- `account` The details of the account as it appears in SailPoint Human Fabric. This information can be used to query the account API for more information. +- `account` The details of the account as it appears in SailPoint Identity Security. This information can be used to query the account API for more information. ## Additional Information and Links 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 eedcc3e006491..2b476d9175698 100644 --- a/docs/extensibility/event-triggers/available/native-change-account-updated.md +++ b/docs/extensibility/event-triggers/available/native-change-account-updated.md @@ -143,7 +143,7 @@ This is an example input from this trigger: - `multiValueAttributeChanges` List of multivalued attributes that were added and/or removed on the account. - it will include ALL account attributes if the config is `"allNonEntitlementAttributes": true` - it will include the enumerated list of attributes contained in `"selectedNonEntitlementAttributes": []` -- `account` The details of the account as it appears in SailPoint Human Fabric. This information can be used to query the account API for more information. +- `account` The details of the account as it appears in SailPoint Identity Security. This information can be used to query the account API for more information. ## Additional Information and Links diff --git a/docs/extensibility/event-triggers/available/provisioning-completed.md b/docs/extensibility/event-triggers/available/provisioning-completed.md index 53d1d5cc08d67..cfa50956df76d 100644 --- a/docs/extensibility/event-triggers/available/provisioning-completed.md +++ b/docs/extensibility/event-triggers/available/provisioning-completed.md @@ -89,7 +89,7 @@ To provision to a target application, the connector for the source must support - `PROVISIONING` - Can write to accounts. Currently, the trigger does not include attribute synchronization. - `PASSWORD` - Can update password for accounts. -For a list of supported connectors and features, see [Supported Connectors for SailPoint Human Fabric](https://community.sailpoint.com/t5/IdentityNow-Connectors/Identity-Security-Cloud-Connectors/ta-p/80019). +For a list of supported connectors and features, see [Supported Connectors for SailPoint Identity Security](https://community.sailpoint.com/t5/IdentityNow-Connectors/Identity-Security-Cloud-Connectors/ta-p/80019). For information about configuring sources for provisioning, see [Configuring Source Account Provisioning](https://documentation.sailpoint.com/saas/help/provisioning/create_profile.html). @@ -116,7 +116,7 @@ The following steps must be completed: - Access profile using source entitlements. Role setup is optional. - Application enabled for Access Request. -> **NOTE:** There is no indication to the approver in the SailPoint Human Fabric UI that the approval is for a revoke action. This must be considered for all usage of these APIs. +> **NOTE:** There is no indication to the approver in the SailPoint Identity Security UI that the approval is for a revoke action. This must be considered for all usage of these APIs. ![Flow](./img/provisioning-access-request-2.png) 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 f9e6c101f6ec8..7eb73f479f589 100644 --- a/docs/extensibility/event-triggers/available/va-cluster-status-change.md +++ b/docs/extensibility/event-triggers/available/va-cluster-status-change.md @@ -23,7 +23,7 @@ Additional notes about VA Cluster Status Changes: - VA cluster health checks run every 30 minutes. - This trigger will invoke on any VA cluster health status change (i.e. healthy -> unhealthy, unhealthy -> healthy). -- See [troubleshooting virtual appliances](https://community.sailpoint.com/t5/SailPoint Human Fabric-Connectors/Virtual-Appliance-Troubleshooting-Guide/ta-p/78735) for more information. +- See [troubleshooting virtual appliances](https://community.sailpoint.com/t5/SailPoint Identity Security-Connectors/Virtual-Appliance-Troubleshooting-Guide/ta-p/78735) for more information. Healthy Cluster Source diff --git a/docs/extensibility/event-triggers/index.md b/docs/extensibility/event-triggers/index.md index 0a20d88bd308f..20ccc08f652a4 100644 --- a/docs/extensibility/event-triggers/index.md +++ b/docs/extensibility/event-triggers/index.md @@ -13,7 +13,7 @@ tags: ['Event Triggers'] ## What Are triggers -The result of any action performed in a service is called an **event**. Services like SailPoint Human Fabric constantly generate events like an update to a setting or the completion of an account aggregation. Most events a service generates are of little value to clients, so services create event triggers, also known as web hooks, that allow clients to subscribe to specific events they are interested in. Similar to news letters or RSS feeds, each subscription tells the service what event a client is interested in and where to send the client the notification. +The result of any action performed in a service is called an **event**. Services like SailPoint Identity Security constantly generate events like an update to a setting or the completion of an account aggregation. Most events a service generates are of little value to clients, so services create event triggers, also known as web hooks, that allow clients to subscribe to specific events they are interested in. Similar to news letters or RSS feeds, each subscription tells the service what event a client is interested in and where to send the client the notification. ## How are triggers different from APIs diff --git a/docs/extensibility/event-triggers/preparing-a-subscriber-service.md b/docs/extensibility/event-triggers/preparing-a-subscriber-service.md index 8982d76ea0078..474d6f261179b 100644 --- a/docs/extensibility/event-triggers/preparing-a-subscriber-service.md +++ b/docs/extensibility/event-triggers/preparing-a-subscriber-service.md @@ -15,7 +15,7 @@ Before you can subscribe to an event trigger, you must prepare a service that ca ## Webhook testing service -There are many webhook testing websites that generate a unique URL you can use to subscribe to an event trigger and explore the data sent by the trigger. One site is https://webhook.site. This site generates a unique URL whenever you open it, which you can copy and paste into the subscription configuration in SailPoint Human Fabric. Any events that the trigger generates will be sent to this website for you to analyze. +There are many webhook testing websites that generate a unique URL you can use to subscribe to an event trigger and explore the data sent by the trigger. One site is https://webhook.site. This site generates a unique URL whenever you open it, which you can copy and paste into the subscription configuration in SailPoint Identity Security. Any events that the trigger generates will be sent to this website for you to analyze. ![Webhook.site](./img/webhook-site.png) @@ -39,14 +39,14 @@ A custom application is one you write in a language of your choosing and host in ### Visual Studio Code port forwarding -When you're developing a custom application that can consume event triggers, SHF needs a public URL (Integration URL) it can send event data to. However, you may want to test your custom application locally. If you're using Visual Studio Code (VSCode), you can use its [built-in port forwarding feature](https://code.visualstudio.com/docs/debugtest/port-forwarding) to generate a public URL and then forward its web traffic into your local web service. +When you're developing a custom application that can consume event triggers, SailPoint Identity Security needs a public URL (Integration URL) it can send event data to. However, you may want to test your custom application locally. If you're using Visual Studio Code (VSCode), you can use its [built-in port forwarding feature](https://code.visualstudio.com/docs/debugtest/port-forwarding) to generate a public URL and then forward its web traffic into your local web service. Follow these steps to set up port forwarding in your custom application: 1. Open the terminal in VSCode and select the 'Ports' tab. 2. Select 'Forward a Port'. 3. Specify the port that your application is using to listen for event data. In the event trigger examples project, the port is 8081 by default. Click 'Enter' to create a port. -4. VSCode will prompt you to log in to GitHub. Log in, and VS Code will create a URL in the 'Forwarded Address' column. This is the URL you will make public for SHF to send event data to. -5. Right click the URL, select 'Visibility', and set the visibility to 'Public'. SHF needs the URL to be public to send it event data. +4. VSCode will prompt you to log in to GitHub. Log in, and VS Code will create a URL in the 'Forwarded Address' column. This is the URL you will make public for SailPoint Identity Security to send event data to. +5. Right click the URL, select 'Visibility', and set the visibility to 'Public'. SailPoint Identity Security needs the URL to be public to send it event data. -You now have a public URL you can provide to SHF as an 'Integration URL' when you subscribe to an event trigger. Copy the URL and paste it into the 'Integration URL' when you subscribe to an event trigger. Then add the event trigger endpoint to the end of the URL so that your application reads the correct event data. For example, you would use a URL like https://w6wl7kkz-8081.usw3.devtunnels.ms/form-submitted to consume the [Form Submitted](https://developer.sailpoint.com/docs/api/form-submitted-event-v-1) event trigger. +You now have a public URL you can provide to SailPoint Identity Security as an 'Integration URL' when you subscribe to an event trigger. Copy the URL and paste it into the 'Integration URL' when you subscribe to an event trigger. Then add the event trigger endpoint to the end of the URL so that your application reads the correct event data. For example, you would use a URL like https://w6wl7kkz-8081.usw3.devtunnels.ms/form-submitted to consume the [Form Submitted](https://developer.sailpoint.com/docs/api/form-submitted-event-v-1) event trigger. diff --git a/docs/extensibility/event-triggers/subscribing-to-a-trigger.md b/docs/extensibility/event-triggers/subscribing-to-a-trigger.md index f5ed167559f0e..8fdf72793b977 100644 --- a/docs/extensibility/event-triggers/subscribing-to-a-trigger.md +++ b/docs/extensibility/event-triggers/subscribing-to-a-trigger.md @@ -6,20 +6,20 @@ sidebar_label: Subscribing to a Trigger sidebar_position: 3 sidebar_class_name: subscribingToTrigger keywords: ['event', 'trigger', 'subscribing'] -description: Usually, you will subscribe to event triggers using the user interface in SHF. Refer to subscribing to event triggers to learn how to subscribe to an event trigger through the SHF UI. +description: Usually, you will subscribe to event triggers using the user interface in SailPoint Identity Security. Refer to subscribing to event triggers to learn how to subscribe to an event trigger through the SailPoint Identity Security UI. slug: /extensibility/event-triggers/subscribing-to-trigger tags: ['Event Triggers'] --- ## View the available triggers -SailPoint is continuously developing new event triggers to satisfy different use cases. Some of these triggers are considered **early access** and are only available in an SHF tenant upon request. To see a list of available event triggers in your tenant, go to the **Event Triggers** tab in the **Admin** section of SailPoint Human Fabric. The first page is a list of your tenant's available event triggers. You can select each trigger to learn more about its type, what causes it to fire, and what the payload will look like. +SailPoint is continuously developing new event triggers to satisfy different use cases. Some of these triggers are considered **early access** and are only available in a SailPoint Identity Security tenant upon request. To see a list of available event triggers in your tenant, go to the **Event Triggers** tab in the **Admin** section of SailPoint Identity Security. The first page is a list of your tenant's available event triggers. You can select each trigger to learn more about its type, what causes it to fire, and what the payload will look like. ![Available triggers](./img/available-triggers.png) ## Subscribe to a trigger from the UI -Usually, you will subscribe to event triggers using the user interface in SHF. Refer to [subscribing to event triggers](https://documentation.sailpoint.com/saas/help/common/event_triggers.html#subscribing-to-event-triggers) to learn how to subscribe to an event trigger through the SHF UI. +Usually, you will subscribe to event triggers using the user interface in SailPoint Identity Security. Refer to [subscribing to event triggers](https://documentation.sailpoint.com/saas/help/common/event_triggers.html#subscribing-to-event-triggers) to learn how to subscribe to an event trigger through the SailPoint Identity Security UI. ## Subscribe to a trigger from the API diff --git a/docs/extensibility/model-context-protocol/index.md b/docs/extensibility/model-context-protocol/index.md index 1cc80dbfc94be..a48211bf528e9 100644 --- a/docs/extensibility/model-context-protocol/index.md +++ b/docs/extensibility/model-context-protocol/index.md @@ -13,7 +13,7 @@ tags: ['MCP'] ## Overview -The SailPoint Model Context Protocol (MCP) Server enables seamless integration between GenAI applications like Claude Desktop and n8n, and SailPoint Human Fabric. Through natural language interactions, users can: +The SailPoint Model Context Protocol (MCP) Server enables seamless integration between GenAI applications like Claude Desktop and n8n, and SailPoint Identity Security. Through natural language interactions, users can: * Search for requestable items (roles, entitlements, access profiles) using natural language (English or not) * Create access requests through guided AI interactions @@ -30,6 +30,6 @@ To learn how to use the SailPoint MCP Server and explore its possibilities, refe ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about the SHF 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 SailPoint Identity Security 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 diff --git a/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator.md b/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator.md index 5cf09728c7575..6dc8c305137ae 100644 --- a/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator.md +++ b/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator.md @@ -16,7 +16,7 @@ This rule generates complex account attribute values during provisioning, e.g. w ## Execution -- **Cloud Execution** - This rule executes in the SailPoint Human Fabric cloud, and it has read-only access to SailPoint Human Fabric data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the SailPoint Identity Security cloud, and it has read-only access to the platform's data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -26,7 +26,7 @@ This rule generates complex account attribute values during provisioning, e.g. w | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Human Fabric data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Identity Security data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | identity | sailpoint.object.Identity | Reference to identity object representing the identity being calculated. | | application | sailpoint.object.Application | Read-only reference to application object that represents the source to which provisioning is being done. | | field | sailpoint.object.Field | Field object used to get information about the attribute being generated. | diff --git a/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator_from_template.md b/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator_from_template.md index f08d2d937dc68..a139fab752799 100644 --- a/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator_from_template.md +++ b/docs/extensibility/rules/cloud-rules/account_profile_attribute_generator_from_template.md @@ -41,7 +41,7 @@ In the following example, the template is `${firstname}.${lastname}${uniqueCount ## Execution -- **Cloud Execution** - This rule executes in the SailPoint Human Fabric cloud, and it has read-only access to SailPoint Human Fabric data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the SailPoint Identity Security cloud, and it has read-only access to the platform's data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -51,7 +51,7 @@ In the following example, the template is `${firstname}.${lastname}${uniqueCount | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Human Fabric data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Identity Security data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | identity | sailpoint.object.Identity | Reference to identity object representing the identity being calculated. | | field | sailpoint.object.Field | Field object used to get information about the attribute being generated. | diff --git a/docs/extensibility/rules/cloud-rules/before_provisioning_rule.md b/docs/extensibility/rules/cloud-rules/before_provisioning_rule.md index 07230ef799824..f10ff847466af 100644 --- a/docs/extensibility/rules/cloud-rules/before_provisioning_rule.md +++ b/docs/extensibility/rules/cloud-rules/before_provisioning_rule.md @@ -22,7 +22,7 @@ These are some examples of when to use this rule: ## Execution -- **Cloud Execution** - This rule executes in the SailPoint Human Fabric cloud, and it has read-only access to SailPoint Human Fabric data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the SailPoint Identity Security cloud, and it has read-only access to the platform's data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -32,7 +32,7 @@ These are some examples of when to use this rule: | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Human Fabric data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Identity Security data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | plan | sailpoint.object.ProvisioningPlan | A set of provisioning instructions which are sent to the source connectors. | | application | sailpoint.object.Application | Read-only reference to application object that represents the source to which provisioning is being done. | | integration | sailpoint.object.IntegrationConfig | The target integration application object that references this rule. | diff --git a/docs/extensibility/rules/cloud-rules/build_map_rule.md b/docs/extensibility/rules/cloud-rules/build_map_rule.md index 790e5dec2580b..b13328b813230 100644 --- a/docs/extensibility/rules/cloud-rules/build_map_rule.md +++ b/docs/extensibility/rules/cloud-rules/build_map_rule.md @@ -24,7 +24,7 @@ This rule runs in the cloud, but it's really a connector rule because it execute ## Execution -- **Cloud Execution** - This rule executes in the SailPoint Human Fabric cloud, and has read-only access to the records from the Delimited File being imported. However, it doesn't have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the SailPoint Identity Security cloud, and has read-only access to the records from the Delimited File being imported. However, it doesn't have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) diff --git a/docs/extensibility/rules/cloud-rules/correlation_rule.md b/docs/extensibility/rules/cloud-rules/correlation_rule.md index efa2d002c7f39..8949a04a9c506 100644 --- a/docs/extensibility/rules/cloud-rules/correlation_rule.md +++ b/docs/extensibility/rules/cloud-rules/correlation_rule.md @@ -16,7 +16,7 @@ This rule associates or correlates an account to an identity, based on complex l ## Execution -- **Cloud Execution** - This rule executes in the SailPoint Human Fabric cloud, and it has read-only access to SailPoint Human Fabric data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the SailPoint Identity Security cloud, and it has read-only access to the platform's data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -26,7 +26,7 @@ This rule associates or correlates an account to an identity, based on complex l | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Human Fabric data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Identity Security data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | account | sailpoint.object.ResourceObject | Read-only representation of account data that has been aggregated. Use this as a basis to determine correlation linkages with a specific identity. | | application | sailpoint.object.Application | Read-only reference to application object that represents the source to which account correlation is being done. | diff --git a/docs/extensibility/rules/cloud-rules/identity_attribute_rule.md b/docs/extensibility/rules/cloud-rules/identity_attribute_rule.md index 5374b2ee2a4da..69091637dfd9c 100644 --- a/docs/extensibility/rules/cloud-rules/identity_attribute_rule.md +++ b/docs/extensibility/rules/cloud-rules/identity_attribute_rule.md @@ -20,7 +20,7 @@ An important consideration with IdentityAttribute rules is whether generation lo ## Execution -- **Cloud Execution** - This rule executes in the SailPoint Human Fabric cloud, and it has read-only access to SailPoint Human Fabric data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the SailPoint Identity Security cloud, and it has read-only access to the platform's data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. - **Usage** - To use this rule once installed, first select "Complex Data Source" option under the Source dropdown, then select the rule name under the Transform drop down. @@ -31,7 +31,7 @@ An important consideration with IdentityAttribute rules is whether generation lo | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Human Fabric data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Identity Security data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | identity | sailpoint.object.Identity | Reference to identity object representing the identity being calculated. | | oldValue | java.lang.Object | Attribute value for the identity attribute before the rule runs. | diff --git a/docs/extensibility/rules/cloud-rules/index.md b/docs/extensibility/rules/cloud-rules/index.md index 9e3d2a6ab8e86..0c786e78619bb 100644 --- a/docs/extensibility/rules/cloud-rules/index.md +++ b/docs/extensibility/rules/cloud-rules/index.md @@ -90,7 +90,7 @@ Once you have submitted your rule and you are in the review process, remember th - **Timing:** SailPoint will examine your rule as soon as possible. Most rules are reviewed within 24 hours of submission. However, if your rule is complex, poorly documented, hard to read, or if it presents new issues, it may require greater scrutiny and consideration. If your rule is repeatedly rejected for the same guideline violation, your rule's review may take longer to complete. - **Status Updates:** Your rule's current status will be reflected in your [SailPoint Expert Services request](https://www.sailpoint.com/services/professional/#contact-form), so you can monitor its progress there. - **Expedite Requests:** If you have a critical timing issue, you can request an expedited review. Respect your fellow implementers by seeking expedited review only when you truly need it. If you are found to be abusing this system, SailPoint may reject further requests going forward. -- **Rejections:** SailPoint's goal is to apply these guidelines fairly and consistently, but mistaken rejections can happen. If your rule has been rejected and you have questions or you would like to provide additional information, communicate directly with the rule review team. This may help get your rule into SailPoint Human Fabric, and it can help SailPoint improve the process or identify a need for clarity in its policies. If you still disagree with the outcome, let SailPoint know and someone can look into it. +- **Rejections:** SailPoint's goal is to apply these guidelines fairly and consistently, but mistaken rejections can happen. If your rule has been rejected and you have questions or you would like to provide additional information, communicate directly with the rule review team. This may help get your rule into SailPoint Identity Security, and it can help SailPoint improve the process or identify a need for clarity in its policies. If you still disagree with the outcome, let SailPoint know and someone can look into it. - **Changes:** Rule changes or modifications to meet guidelines are not the reviewer's responsibility. They are the responsibility of the person(s) submitting the rule. Reviewers may give advice, examples, etc. to help, but doing so does not guarantee a solution. You should test the rules with the changes before resubmission. ``` diff --git a/docs/extensibility/rules/cloud-rules/manager_correlation_rule.md b/docs/extensibility/rules/cloud-rules/manager_correlation_rule.md index 42dbe5abbf899..37cb5c863e2be 100644 --- a/docs/extensibility/rules/cloud-rules/manager_correlation_rule.md +++ b/docs/extensibility/rules/cloud-rules/manager_correlation_rule.md @@ -24,7 +24,7 @@ The manager correlation rule runs before configured manager account correlation. ## Execution -- **Cloud Execution** - This rule executes in the SailPoint Human Fabric cloud, and it has read-only access to SailPoint Human Fabric data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the SailPoint Identity Security cloud, and it has read-only access to the platform's data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -34,7 +34,7 @@ The manager correlation rule runs before configured manager account correlation. | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Human Fabric data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Identity Security data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | | link | sailpoint.object.Link | Read-only representation of account data that has been aggregated. Use this as a basis to determine manager linkages to a specific manager identity. | | managerAttributeValue | java.lang.Object | Attribute value stored in the manager attribute. | diff --git a/docs/extensibility/rules/cloud-rules/transform_rule.md b/docs/extensibility/rules/cloud-rules/transform_rule.md index 084a954fdc353..852e631d10073 100644 --- a/docs/extensibility/rules/cloud-rules/transform_rule.md +++ b/docs/extensibility/rules/cloud-rules/transform_rule.md @@ -45,7 +45,7 @@ return result[index]; ## Execution -- **Cloud Execution** - This rule executes in the SailPoint Human Fabric cloud, and it has read-only access to SailPoint Human Fabric data models, but it does not have access to on-premise sources or connectors. +- **Cloud Execution** - This rule executes in the SailPoint Identity Security cloud, and it has read-only access to the platform's data models, but it does not have access to on-premise sources or connectors. - **Logging** - Logging statements are currently only visible to SailPoint personnel. ![Rule Execution](../img/cloud_execution.png) @@ -55,7 +55,7 @@ return result[index]; | Argument | Type | Purpose | | --- | --- | --- | | log | org.apache.log4j.Logger | Logger to log statements. _Note: This executes in the cloud, and logging is currently not exposed to anyone other than SailPoint._ | -| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Human Fabric data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | +| idn | sailpoint.server.IdnRuleUtil | Provides a read-only starting point for using the SailPoint API. From this passed reference, the rule can interrogate the SailPoint Identity Security data model including identities or account information via helper methods as described in [IdnRuleUtil](../idn_rule_utility.md). | ## Output diff --git a/docs/extensibility/rules/connector-rules/before_after_operation_rule.md b/docs/extensibility/rules/connector-rules/before_after_operation_rule.md index c42fb993a2e35..b52d195d9b626 100644 --- a/docs/extensibility/rules/connector-rules/before_after_operation_rule.md +++ b/docs/extensibility/rules/connector-rules/before_after_operation_rule.md @@ -44,7 +44,7 @@ The following operations can be performed on a source: ## Architecture best practices -For supportability, it is recommended that you write these operation rules with only the most basic logic necessary to trigger a PowerShell script and shift the bulk of the downstream events and/or modifications to the PowerShell script itself. This script would reside on the client's servers and can therefore be easily maintained or modified by the client as needed. It also allows the client to implement changes to the PowerShell scripted functionality without requiring code review by SailPoint because the code runs outside of the SailPoint Human Fabric platform. +For supportability, it is recommended that you write these operation rules with only the most basic logic necessary to trigger a PowerShell script and shift the bulk of the downstream events and/or modifications to the PowerShell script itself. This script would reside on the client's servers and can therefore be easily maintained or modified by the client as needed. It also allows the client to implement changes to the PowerShell scripted functionality without requiring code review by SailPoint because the code runs outside of the SailPoint Identity Security platform. ## Rule template diff --git a/docs/extensibility/rules/connector-rules/index.md b/docs/extensibility/rules/connector-rules/index.md index 2094eee2c92c1..af0a5b7373512 100644 --- a/docs/extensibility/rules/connector-rules/index.md +++ b/docs/extensibility/rules/connector-rules/index.md @@ -11,7 +11,7 @@ slug: /extensibility/rules/connector-rules tags: ['Rules'] --- -**Connector-Executed Rules** or **Connector Rules** are rules that are executed in the SailPoint Human Fabric 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 SailPoint Human Fabric data model or fetch information from SailPoint Human Fabric. They rely instead on contextual information sent from SailPoint Human Fabric. 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. +**Connector-Executed Rules** or **Connector Rules** are rules that are executed in the SailPoint Identity Security 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 SailPoint Identity Security data model or fetch information from the platform. They rely instead on contextual information sent from SailPoint Identity Security. 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/connector-rule-management). For more details, see [Configuration Process](#configuration-process). diff --git a/docs/extensibility/rules/guides/your_first_rule.md b/docs/extensibility/rules/guides/your_first_rule.md index 7c904e519c7fe..e31f550a26a44 100644 --- a/docs/extensibility/rules/guides/your_first_rule.md +++ b/docs/extensibility/rules/guides/your_first_rule.md @@ -25,7 +25,7 @@ In this guide you'll learn the end to end process of writing a cloud rule to gen This rule generates complex account attribute values during provisioning, e.g. when creating an account. You would typically use this rule when you are creating an account to generate attributes like usernames. -This rule executes in the SailPoint Human Fabric (SHF) cloud, and it has read-only access to SHF data models, but it doesn't have access to on-premise sources or connectors. +This rule executes in the SailPoint Identity Security cloud, and it has read-only access to the platform's data models, but it doesn't have access to on-premise sources or connectors. Refer to [Attribute Generator Rule](../cloud-rules/account_profile_attribute_generator.md) to learn more about the inputs available to you during the rule execution. @@ -487,7 +487,7 @@ To submit your Cloud Rule for review, approval, and inclusion in the SailPoint p ## Add Rule to account creation -Log into your SHF tenant and navigate to **Admin** -\> **Connections** -\> **Sources** -\> **[Source Name]** -\> **Accounts** -\> **Create Account**. Scroll to the attribute you wish to use the rule for generating the username. Check the generator radio button and pick your new rule from the drop down. +Log into your SailPoint Identity Security tenant and navigate to **Admin** -\> **Connections** -\> **Sources** -\> **[Source Name]** -\> **Accounts** -\> **Create Account**. Scroll to the attribute you wish to use the rule for generating the username. Check the generator radio button and pick your new rule from the drop down. ![Account Create](./img/account-create.png) diff --git a/docs/extensibility/rules/idn_rule_utility.md b/docs/extensibility/rules/idn_rule_utility.md index 7766cc4d94a1c..18bb7bba15f3c 100644 --- a/docs/extensibility/rules/idn_rule_utility.md +++ b/docs/extensibility/rules/idn_rule_utility.md @@ -1,8 +1,8 @@ --- id: rule-utility title: Using IdnRuleUtil as a wrapper for common Rule operations -pagination_label: SailPoint Human Fabric Rule Utility -sidebar_label: SailPoint Human Fabric Rule Utility +pagination_label: SailPoint Identity Security Rule Utility +sidebar_label: SailPoint Identity Security Rule Utility sidebar_position: 4 sidebar_class_name: ruleUtility keywords: ['rule', 'utility'] @@ -13,13 +13,13 @@ tags: ['Rules'] ## Overview -Use this guide to learn how to configure searchable account attributes within SailPoint Human Fabric and then leverage them within the IdnRuleUtil wrapper class when searching accounts for attributes such as uniqueness checks. There are also methods in the IdnRuleUtil wrapper class you can use without the additional searchable attributes. +Use this guide to learn how to configure searchable account attributes within SailPoint Identity Security and then leverage them within the IdnRuleUtil wrapper class when searching accounts for attributes such as uniqueness checks. There are also methods in the IdnRuleUtil wrapper class you can use without the additional searchable attributes. -Search attributes allow you to search across accounts and sources to determine whether a specific attribute value is being used in your SailPoint Human Fabric environment. +Search attributes allow you to search across accounts and sources to determine whether a specific attribute value is being used in your SailPoint Identity Security environment. There are three critical components involves with working with searchable attributes: -- [Configuration of search attributes within SailPoint Human Fabric](#configuration-of-search-attributes-within-sailpoint-human-fabric) +- [Configuration of search attributes within SailPoint Identity Security](#configuration-of-search-attributes-within-sailpoint-identity-security) - Seed data for accounts already aggregated into the system. - Ensure attribute promotion happens for new/changed accounts that are aggregated. - [Create rules that can be used to query the newly created attribute values](#create-rules-that-can-be-used-to-query-the-newly-created-attribute-values) @@ -27,7 +27,7 @@ There are three critical components involves with working with searchable attrib -## Configuration of search attributes within SailPoint Human Fabric +## Configuration of search attributes within SailPoint Identity Security When you are planning to implement search attributes, it is important that you consider the way new accounts' values will be generated and which attributes should be used as references. @@ -43,7 +43,7 @@ You need the following information to create search attributes: The following example shows how to create a new attribute with the [Search Attributes API](/docs/api/create-search-attribute-config-v-1): -Your company has two sources. The first is Active Directory, and the second is Workday. When the system aggregates new accounts, the company wants to query SailPoint Human Fabric to see whether an email address already exists. If the email address is not in use, you can assign it to the new account. If it is in use, you can iterate on the email address value (add a 1 for example). You can then query SailPoint Human Fabric once more to see whether your incremented email address is in use. You can repeat this procedure until you have determined that an email address is unique. +Your company has two sources. The first is Active Directory, and the second is Workday. When the system aggregates new accounts, the company wants to query SailPoint Identity Security to see whether an email address already exists. If the email address is not in use, you can assign it to the new account. If it is in use, you can iterate on the email address value (add a 1 for example). You can then query SailPoint Identity Security once more to see whether your incremented email address is in use. You can repeat this procedure until you have determined that an email address is unique. The following information is necessary to create your search attribute: @@ -66,7 +66,7 @@ The following information is necessary to create your search attribute: -### Create the new search attribute in SailPoint Human Fabric +### Create the new search attribute in SailPoint Identity Security To call the APIs for search attributes, you need a personal access token and the name of your tenant to provide with the request. To retrieve a personal access token, see [Personal Access Tokens](../../api/authentication.md#generate-a-personal-access-token). To get the name of your tenant, see [Finding Your Organization Tenant Name](../../api/getting-started.md#find-your-tenant-name) @@ -95,7 +95,7 @@ Aggregation only processes new and/or changed accounts for many sources. If an a If this source has already been aggregated before the account search configuration was created, a non-optimized aggregation must now be performed to seed the new attribute data for all existing accounts. -At this point, the configuration exists to promote attributes on any new/changed account that comes into SailPoint Human Fabric. These attributes and their associated values are stored for use in custom rules. Each account that exists on either of these sources will now have a new attribute called “promotedEmailAddress”. _The value of this attribute will be the value of `mail` if it is the Active Directory Source or `emailAddress` if it is the Workday source._ +At this point, the configuration exists to promote attributes on any new/changed account that comes into SailPoint Identity Security. These attributes and their associated values are stored for use in custom rules. Each account that exists on either of these sources will now have a new attribute called “promotedEmailAddress”. _The value of this attribute will be the value of `mail` if it is the Active Directory Source or `emailAddress` if it is the Workday source._ ## Create Rules that can be used to query the newly created attribute values @@ -569,7 +569,7 @@ String lastName = acctAttrs.get("Last Name"); ### Check if an LDAP attribute value is unique -The `isUniqueLDAPValue` method calls an LDAP-type connector directly to determine whether a given attribute value is already in use. Unlike the promoted-attribute approach, this method queries the connector itself rather than relying on aggregated account data in SailPoint Human Fabric. +The `isUniqueLDAPValue` method calls an LDAP-type connector directly to determine whether a given attribute value is already in use. Unlike the promoted-attribute approach, this method queries the connector itself rather than relying on aggregated account data in SailPoint Identity Security. This is commonly used in field-level rules on a Create Profile to validate uniqueness (for example, `sAMAccountName`) before provisioning a new account. diff --git a/docs/extensibility/rules/index.md b/docs/extensibility/rules/index.md index 1cd89edbe934c..4b9cfe4babb83 100644 --- a/docs/extensibility/rules/index.md +++ b/docs/extensibility/rules/index.md @@ -17,40 +17,40 @@ In SailPoint solutions, rules serve as a flexible configuration framework implem ## Java Beanshell -Rules in SailPoint Human Fabric are written in Java Beanshell, a lightweight scripting language that allows you to define custom logic and behavior within the rules. Java Beanshell provides a familiar syntax similar to Java, making it easier for implementers to create and maintain rule configurations. +Rules in SailPoint Identity Security are written in Java Beanshell, a lightweight scripting language that allows you to define custom logic and behavior within the rules. Java Beanshell provides a familiar syntax similar to Java, making it easier for implementers to create and maintain rule configurations. For more information about Java Beanshell, you can refer to the [Java Beanshell Documentation](https://github.com/beanshell/beanshell/wiki). ## Rule execution -SailPoint Human Fabric (SHF) is a multi-tenant cloud solution, and its architecture varies differently from other SailPoint products like IdentityIQ (IIQ). Therefore, the way rules execute within SHF reflects the architectural design considerations the platform was built on. These considerations determine the rule's limitations. +SailPoint Identity Security is a multi-tenant cloud solution, and its architecture varies differently from other SailPoint products like IdentityIQ (IIQ). Therefore, the way rules execute within SailPoint Identity Security reflects the architectural design considerations the platform was built on. These considerations determine the rule's limitations. There are two primary places where you can execute rules: -- **Cloud Execution** - These rules are executed in the SHF multi-tenant cloud. -- **Connector Execution** - These rules are executed on the on-premise SHF virtual appliance. +- **Cloud Execution** - These rules are executed in the SailPoint Identity Security multi-tenant cloud. +- **Connector Execution** - These rules are executed on the on-premise SailPoint Identity Security virtual appliance. ![Rule Execution](./img/rule_execution.png) -**Cloud-Executed Rules** or **Cloud Rules** typically only perform a specific function, such as calculating attribute values. Many of these rules may be able to query the SHF data-model in a read-only fashion, but they do not have the ability to commit transactions, save objects, etc. +**Cloud-Executed Rules** or **Cloud Rules** typically only perform a specific function, such as calculating attribute values. Many of these rules may be able to query the SailPoint Identity Security data-model in a read-only fashion, but they do not have the ability to commit transactions, save objects, etc. Because these rules execute in a multi-tenant cloud environment, they have a restricted context, and they are closely scrutinized to ensure that they execute in an efficient and secure manner. For more details, see [Cloud Rules](./cloud-rules/index.md). -**Connector-Executed Rules** or **Connector Rules** are rules executed in the SHF virtual appliance, and they are often an extension connector itself. The rules are commonly used for performing 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 SHF data model or fetch information from SHF. They rely instead on contextual information sent from SHF. Connector-executed rules may also have managed connections supplied in their contexts to support querying end systems or sources. Though you may use these managed connections, you cannot make making additional connections or call-outs. +**Connector-Executed Rules** or **Connector Rules** are rules executed in the SailPoint Identity Security virtual appliance, and they are often an extension connector itself. The rules are commonly used for performing 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 SailPoint Identity Security data model or fetch information from the platform. They rely instead on contextual information sent from SailPoint Identity Security. Connector-executed rules may also have managed connections supplied in their contexts to support querying end systems or sources. Though you may use these managed connections, you cannot make making additional connections or call-outs. For more details, see the [Connector Rules](./connector-rules/index.md). ## Support considerations -Though SHF shares some common functionality with other SailPoint products like IIQ, the same rules are not necessarily supported, nor do they necessarily execute the same way or with the same context and variables. SailPoint recommends that you become familiar with which rules execute with which products, as well as the nuances in their execution contexts. +Though SailPoint Identity Security shares some common functionality with other SailPoint products like IIQ, the same rules are not necessarily supported, nor do they necessarily execute the same way or with the same context and variables. SailPoint recommends that you become familiar with which rules execute with which products, as well as the nuances in their execution contexts. -From a SailPoint support perspective, rules are considered configurations. SailPoint supports the underlying platform but not the rule configurations themselves. Any problems with the way rules are implemented or run over time are the responsibilities the customer or implementer must manage. SailPoint's SHF Expert Services need hours to cover any rule configuration work (e.g., creating rules, best practices reviews, application to your SHF environment, and promotion between sandbox & prod environments). Contact your Customer Success Manager with any questions. While rules allow some advanced flexibility, you must consider these support implications when you are deciding whether to implement rules. Consider rule usage a last resort, and use SailPoint Human Fabric features instead whenever you can. +From a SailPoint support perspective, rules are considered configurations. SailPoint supports the underlying platform but not the rule configurations themselves. Any problems with the way rules are implemented or run over time are the responsibilities the customer or implementer must manage. SailPoint Identity Security Expert Services need hours to cover any rule configuration work (e.g., creating rules, best practices reviews, application to your environment, and promotion between sandbox & prod environments). Contact your Customer Success Manager with any questions. While rules allow some advanced flexibility, you must consider these support implications when you are deciding whether to implement rules. Consider rule usage a last resort, and use SailPoint Identity Security features instead whenever you can. ## Best practices for Rule deployments -SailPoint SHF deployments often require the deployment of rules to the client’s SHF tenants. Because SHF is a multi-tenant solution, rules that are poorly written can have negative performance implications on other tenants in the same cloud. As such, SailPoint requires all rules to be reviewed prior to deployment. The time to complete these reviews requires an expert services contract to leverage billable hours. +SailPoint Identity Security deployments often require the deployment of rules to the client’s tenants. Because SailPoint Identity Security is a multi-tenant solution, rules that are poorly written can have negative performance implications on other tenants in the same cloud. As such, SailPoint requires all rules to be reviewed prior to deployment. The time to complete these reviews requires an expert services contract to leverage billable hours. This article covers common topics around this process including best practices, rule review expectations, and more. @@ -76,7 +76,7 @@ In the case of rejection, we recommend submitting a new ticket to avoid a scenar ## Promote Rules from sandbox to production -A rule that has been approved in a sandbox tenant through the SailPoint rule review process, like an IdentityAttribute, Correlation or ManagerCorrelation rule or any other rule type, for example, can be migrated to the production SHF tenant. +A rule that has been approved in a sandbox tenant through the SailPoint rule review process, like an IdentityAttribute, Correlation or ManagerCorrelation rule or any other rule type, for example, can be migrated to the production SailPoint Identity Security tenant. This applies to all rule types, as the signature has been approved/verified during the SailPoint rule review process, the sp-config API allows you to import ANY ‘approved’ tenant rules. (this includes cloud rules!) @@ -238,7 +238,7 @@ source( sourceRelative ``` -Note that the earlier code fragments are not allowed within [connector-executed rules](./connector-rules/index.md#supported-connector-rules) because they are not valid at the connector level. They will, for a short time, still be allowed for pre-existing [cloud-executed rules](./cloud-rules/index.md) as a review exception. However, any new rules using these constructs will be returned to the submitter, and the submitter will be asked to rewrite the rule, using the [SHF Rule Utility](./idn_rule_utility.md) helper methods instead: +Note that the earlier code fragments are not allowed within [connector-executed rules](./connector-rules/index.md#supported-connector-rules) because they are not valid at the connector level. They will, for a short time, still be allowed for pre-existing [cloud-executed rules](./cloud-rules/index.md) as a review exception. However, any new rules using these constructs will be returned to the submitter, and the submitter will be asked to rewrite the rule, using the [SailPoint Identity Security Rule Utility](./idn_rule_utility.md) helper methods instead: - context - .getObjectById() @@ -249,11 +249,11 @@ Note that the earlier code fragments are not allowed within [connector-executed ## Other Rules -While SHF shares some common functionality with other SailPoint products like IIQ, the same rules are not necessarily supported, nor do they necessarily execute the same way. SailPoint recommends that you become familiar with which rules execute with which products, as well as the nuances in their execution contexts. SHF considers any other rules not mentioned in the Cloud-Executed Rules or Connector-Executed Rules sections to be unsupported. +While SailPoint Identity Security shares some common functionality with other SailPoint products like IIQ, the same rules are not necessarily supported, nor do they necessarily execute the same way. SailPoint recommends that you become familiar with which rules execute with which products, as well as the nuances in their execution contexts. SailPoint Identity Security considers any other rules not mentioned in the Cloud-Executed Rules or Connector-Executed Rules sections to be unsupported. ## Deprecated Rules -The following rules have been deprecated in SHF. SailPoint recommends using supported product functionality instead of these rules: +The following rules have been deprecated in SailPoint Identity Security. SailPoint recommends using supported product functionality instead of these rules: - **Certification Exclusion Rules** - Use configurable certification campaign filters instead. - **Identity Selector Rules** - Use role standard assignment criteria instead. diff --git a/docs/extensibility/rules/rule-java-docs/index.mdx b/docs/extensibility/rules/rule-java-docs/index.mdx index be62d8a58e5d9..e3b57567af561 100644 --- a/docs/extensibility/rules/rule-java-docs/index.mdx +++ b/docs/extensibility/rules/rule-java-docs/index.mdx @@ -6,7 +6,7 @@ sidebar_label: Java Docs sidebar_position: 6 sidebar_class_name: ruleJavaDocs keywords: ['rules', 'java', 'docs'] -description: Documentation for rule development in IdentityNow. +description: Documentation for rule development in SailPoint Identity Security. slug: /extensibility/rules/java-docs tags: ['Rules', 'Java', 'Docs'] --- diff --git a/docs/extensibility/transforms/guides/lifecycle-state-transforms.md b/docs/extensibility/transforms/guides/lifecycle-state-transforms.md index 3ce0867d6fd95..752b1f882fb3f 100644 --- a/docs/extensibility/transforms/guides/lifecycle-state-transforms.md +++ b/docs/extensibility/transforms/guides/lifecycle-state-transforms.md @@ -15,7 +15,7 @@ tags: ['Transforms', 'Guides', 'Lifecycle'] In this guide, you will walk through a lifecycle state transform that requires you to nest multiple transforms together to achieve your desired result. -A lifecycle state is a status an identity can be in, such as `active`, `inactive` and `terminated`, for example. You can then use this lifecycle state in SailPoint Human Fabric to determine an identity's access. +A lifecycle state is a status an identity can be in, such as `active`, `inactive` and `terminated`, for example. You can then use this lifecycle state in SailPoint Identity Security to determine an identity's access. ## Determine lifecycle state from end date attribute diff --git a/docs/extensibility/transforms/guides/provisioning-policy-transform.md b/docs/extensibility/transforms/guides/provisioning-policy-transform.md index a5cb2635629a4..86f4b260666ff 100644 --- a/docs/extensibility/transforms/guides/provisioning-policy-transform.md +++ b/docs/extensibility/transforms/guides/provisioning-policy-transform.md @@ -13,7 +13,7 @@ tags: ['Transforms', 'Guides', 'Provisioning', 'Policies'] ## Overview -In this guide, you will learn how to use [SailPoint Human Fabric's Transforms](/docs/api/transforms) in a provisioning policy for a source. This can be useful if you need to hide the attribute in your identity attribute list but still need the attribute during provisioning. +In this guide, you will learn how to use [SailPoint Identity Security's Transforms](/docs/api/transforms) in a provisioning policy for a source. This can be useful if you need to hide the attribute in your identity attribute list but still need the attribute during provisioning. ## Create provisioning policy diff --git a/docs/extensibility/transforms/guides/temporary-password.md b/docs/extensibility/transforms/guides/temporary-password.md index 6dfc42a520f74..945344aed0662 100644 --- a/docs/extensibility/transforms/guides/temporary-password.md +++ b/docs/extensibility/transforms/guides/temporary-password.md @@ -580,7 +580,7 @@ curl --location --request POST 'https://{tenant}.api.identitynow.com/v3/transfor Once you have created the transform successfully, you can apply the new transform and preview what the password will look like for each user. -Log in to your SailPoint Human Fabric tenant and go to **Admin** > **Identities** > **Identity Profiles**. Select the name of the profile you created earlier, Transform Example. Select the **Mappings** tab, scroll to the bottom and select **Add New Attribute**. Name the attribute `Temporary Password`. To save the new mappings, you must fill out the id, email, first name and last name mappings. +Log in to your SailPoint Identity Security tenant and go to **Admin** > **Identities** > **Identity Profiles**. Select the name of the profile you created earlier, Transform Example. Select the **Mappings** tab, scroll to the bottom and select **Add New Attribute**. Name the attribute `Temporary Password`. To save the new mappings, you must fill out the id, email, first name and last name mappings. ![Attribute Mapping](./img/temporary_password_attribute_mapping.png) diff --git a/docs/extensibility/transforms/guides/your-first-transform.md b/docs/extensibility/transforms/guides/your-first-transform.md index 2b408aed25a7d..6daa12d89e42b 100644 --- a/docs/extensibility/transforms/guides/your-first-transform.md +++ b/docs/extensibility/transforms/guides/your-first-transform.md @@ -13,9 +13,9 @@ tags: ['Transforms', 'Guides', 'First'] ## Overview -In this guide, you will learn how to use [SailPoint Human Fabric's Transform REST APIs](/docs/api/transforms) to do the following: +In this guide, you will learn how to use [SailPoint Identity Security's Transform REST APIs](/docs/api/transforms) to do the following: -- [List Transforms in Your SailPoint Human Fabric Tenant](#list-transforms-in-your-sailpoint-human-fabric-tenant) +- [List Transforms in Your SailPoint Identity Security Tenant](#list-transforms-in-your-sailpoint-identity-security-tenant) - [Create a Transform](#create-a-transform) - [Get Transform by ID](#get-transform-by-id) - [Update a Transform](#update-a-transform) @@ -23,7 +23,7 @@ In this guide, you will learn how to use [SailPoint Human Fabric's Transform RES -## List transforms in your SailPoint Human Fabric tenant +## List transforms in your SailPoint Identity Security tenant To call the APIs for transforms, you need a personal access token and your tenant's name to provide with the request. For more information about how to get a personal access token, see [Personal Access Tokens](../../../api/authentication.md#generate-a-personal-access-token). For more information about how to get the name of your tenant, see [Finding Your Organization Tenant Name](../../../api/getting-started.md#find-your-tenant-name). @@ -120,7 +120,7 @@ curl --location --request POST 'https://{tenant}.api.identitynow.com/v3/transfor } ``` -Once you have created the transform, you can find it in SailPoint Human Fabric by going to **Admin** > **Identities** > **Identity Profiles** > (An Identity Profile) > **Mappings** (tab). +Once you have created the transform, you can find it in SailPoint Identity Security by going to **Admin** > **Identities** > **Identity Profiles** > (An Identity Profile) > **Mappings** (tab). ![Mappings Tab](./img/mappings_tab.png) diff --git a/docs/extensibility/transforms/index.md b/docs/extensibility/transforms/index.md index a5f073242483c..c4cebd6eb4c8b 100644 --- a/docs/extensibility/transforms/index.md +++ b/docs/extensibility/transforms/index.md @@ -28,17 +28,17 @@ flowchart LR
-Because there is no code to write, an administrator can configure these by using a JSON object structure and uploading them into SailPoint Human Fabric using [SailPoint Human Fabric's Transform REST APIs](/docs/api/transforms). +Because there is no code to write, an administrator can configure these by using a JSON object structure and uploading them into SailPoint Identity Security using the [Transform REST APIs](/docs/api/transforms). :::info -Sometimes transforms are referred to as Seaspray, the codename for transforms. SailPoint Human Fabric Transforms and Seaspray are essentially the same. +Sometimes transforms are referred to as Seaspray, the codename for transforms. SailPoint Identity Security Transforms and Seaspray are essentially the same. ::: ## How transforms work -Transforms typically have an input(s) and output(s). The way the transformation occurs mainly depends on the type of transform. Refer to [Operations in SailPoint Human Fabric Transforms](./operations/index.md) for more information. +Transforms typically have an input(s) and output(s). The way the transformation occurs mainly depends on the type of transform. Refer to [Operations in SailPoint Identity Security Transforms](./operations/index.md) for more information. For example, a [Lower transform](./operations/lower.md) transforms any input text strings into lowercase versions as output. So if the input were `Foo`, the lowercase output of the transform would be `foo`: @@ -78,7 +78,7 @@ flowchart LR ### Complex nested transforms -For more complex use cases, a single transform may not be enough. It is possible to link several transforms together. SailPoint Human Fabric calls these 'nested' transforms because they are transform objects within other transform objects. +For more complex use cases, a single transform may not be enough. It is possible to link several transforms together. SailPoint Identity Security calls these 'nested' transforms because they are transform objects within other transform objects. An example of a nested transform would be using the previous [Concat transform](./operations/concatenation.md) and passing its output as an input to another [Lower transform](./operations/lower.md). If the inputs `Foo` and `Bar` were passed into the transforms, the ultimate output would be `foobar`, concatenated and in lowercase. @@ -129,7 +129,7 @@ Transforms are JSON objects. Prior to this, the transforms have been shown as fl There are three main components of a transform object: -1. `name` - This specifies the name of the transform. It refers to a transform in the SailPoint Human Fabric API or User Interface (UI). Only provide a name on the root-level transform. Nested transforms do not have names. +1. `name` - This specifies the name of the transform. It refers to a transform in the SailPoint Identity Security API or User Interface (UI). Only provide a name on the root-level transform. Nested transforms do not have names. 2. `type` - This specifies the transform type, which ultimately determines the transform's behavior. @@ -137,7 +137,7 @@ There are three main components of a transform object: :::caution -When uploading a transform to SailPoint Human Fabric it cannot exceed 400KB. +When uploading a transform to SailPoint Identity Security it cannot exceed 400KB. ::: @@ -174,7 +174,7 @@ The following variables are available to the Apache Velocity template engine whe ## Implicit vs explicit input -A special configuration attribute available to all transforms is input. If the input attribute is not specified, this is referred to as implicit input, and the system determines the input based on what is configured. If the input attribute is specified, then this is referred to as explicit input, and the system's input is ignored in favor of whatever the transform explicitly specifies. A good way to understand this concept is to walk through an example. Imagine that SailPoint Human Fabric has the following: +A special configuration attribute available to all transforms is input. If the input attribute is not specified, this is referred to as implicit input, and the system determines the input based on what is configured. If the input attribute is specified, then this is referred to as explicit input, and the system's input is ignored in favor of whatever the transform explicitly specifies. A good way to understand this concept is to walk through an example. Imagine that SailPoint Identity Security has the following: - An account on Source 1 with department set to `Services`. - An account on Source 2 with department set to `Engineering`. @@ -243,13 +243,13 @@ These transforms are configured separately from the transforms applied via the i #### Configuration -These can be configured in SailPoint Human Fabric by going to **Admin** > **Sources** > (A Source) > **Accounts** (tab) > **Create Account**. +These can be configured in SailPoint Identity Security by going to **Admin** > **Sources** > (A Source) > **Accounts** (tab) > **Create Account**. The available options on this page are constructed as transforms behind the scenes. For example, the identity attribute mapping choice is saved as an [identity attribute transform](./operations/identity-attribute.md) definition within the saved create profile. -These can also be configured with SailPoint Human Fabric REST APIs. You can define any kind of transform you want for any field in the create profile policy, to calculate account attributes in ways beyond what the UI offers. See [Transforms in Provisioning Policies](./guides/provisioning-policy-transform.md). +These can also be configured with SailPoint Identity Security REST APIs. You can define any kind of transform you want for any field in the create profile policy, to calculate account attributes in ways beyond what the UI offers. See [Transforms in Provisioning Policies](./guides/provisioning-policy-transform.md). -For more information on the SailPoint Human Fabric REST API endpoints used to managed transform objects in APIs, refer to [SailPoint Human Fabric Transform REST APIs](/docs/api/transforms). +For more information on the SailPoint Identity Security REST API endpoints used to managed transform objects in APIs, refer to [Transform REST APIs](/docs/api/transforms). :::tip @@ -293,9 +293,9 @@ To test a transform for account data, you must provision a new account on that s Sometimes it can be difficult to decide when to implement a transform and when to implement a rule. Both transforms and rules can calculate values for identity or account attributes. -Despite their functional similarity, transforms and rules have very different implementations. Transforms are JSON-based configurations, editable with SailPoint Human Fabric's transform REST APIs. Rules are implemented with code (typically [BeanShell](https://github.com/beanshell/beanshell), a Java-like syntax), so they must follow the [SailPoint Human Fabric Rule Guidelines](https://community.sailpoint.com/docs/DOC-12122), and they require SailPoint to be reviewed and installed into the tenant. Rules, however, can do things that transforms cannot in some cases. +Despite their functional similarity, transforms and rules have very different implementations. Transforms are JSON-based configurations, editable with SailPoint Identity Security's transform REST APIs. Rules are implemented with code (typically [BeanShell](https://github.com/beanshell/beanshell), a Java-like syntax), so they must follow the [SailPoint Identity Security Rule Guidelines](https://community.sailpoint.com/docs/DOC-12122), and they require SailPoint to be reviewed and installed into the tenant. Rules, however, can do things that transforms cannot in some cases. -Because transforms have easier and more accessible implementations, they are generally recommended. With transforms, any SailPoint Human Fabric administrator can view, create, edit, and delete transforms directly with REST API without SailPoint involvement. +Because transforms have easier and more accessible implementations, they are generally recommended. With transforms, any SailPoint Identity Security administrator can view, create, edit, and delete transforms directly with REST API without SailPoint involvement. If something cannot be done with a transform, then consider using a rule. When you are transitioning from a transform to a rule, you must take special consideration when you decide where the rule executes. @@ -303,6 +303,6 @@ If something cannot be done with a transform, then consider using a rule. When y - If you are calculating account attributes (during provisioning), you can use [Attribute Generator rules](https://community.sailpoint.com/docs/DOC-12645) instead of account transforms. -- All rules you build must follow the [SailPoint Human Fabric Rule Guidelines](https://community.sailpoint.com/docs/DOC-12122). +- All rules you build must follow the [SailPoint Identity Security Rule Guidelines](https://community.sailpoint.com/docs/DOC-12122). If you use a rule, make note of it for administrative purposes. The best practice is to check in these types of artifacts into some sort of version control (e.g., GitHub, et. Al.) for records. diff --git a/docs/extensibility/transforms/operations/account-attribute.md b/docs/extensibility/transforms/operations/account-attribute.md index 0e5bca2301a4b..7d9d46ae45b10 100644 --- a/docs/extensibility/transforms/operations/account-attribute.md +++ b/docs/extensibility/transforms/operations/account-attribute.md @@ -16,8 +16,8 @@ Use the account attribute transform to look up an account for a particular sourc :::note Other Considerations -- If there are multiple accounts, then SailPoint Human Fabric by default takes the value from the oldest account (based on the account created date). You can configure this behavior by specifying `accountSortAttribute` and `accountSortDescending` attributes. -- If there are multiple accounts and the oldest account has a null attribute value, by default SailPoint Human Fabric moves to the next account that can have a value (if there are any). You can override this behavior with the `accountReturnFirstLink` property. +- If there are multiple accounts, then SailPoint Identity Security by default takes the value from the oldest account (based on the account created date). You can configure this behavior by specifying `accountSortAttribute` and `accountSortDescending` attributes. +- If there are multiple accounts and the oldest account has a null attribute value, by default SailPoint Identity Security moves to the next account that can have a value (if there are any). You can override this behavior with the `accountReturnFirstLink` property. - You can filter the multiple accounts returned based on the data they contain so that you can target specific accounts. This is often used to target accounts that are "active" instead of those that are not. ::: diff --git a/docs/extensibility/transforms/operations/replace.md b/docs/extensibility/transforms/operations/replace.md index 66a64e1aff473..21449a2c703a3 100644 --- a/docs/extensibility/transforms/operations/replace.md +++ b/docs/extensibility/transforms/operations/replace.md @@ -22,7 +22,7 @@ The replace transform takes a `regex` attribute as an argument to identify which { "attributes": { "regex": "IIQ", - "replacement": "SailPoint Human Fabric" + "replacement": "SailPoint Identity Security" }, "type": "replace", "name": "Replace Transform" @@ -76,11 +76,11 @@ The `attributes` object contains the replacement configuration. ## Examples -This transform makes a simple word replacement, exchanging "IIQ" for "SailPoint Human Fabric". +This transform makes a simple word replacement, exchanging "IIQ" for "SailPoint Identity Security". ```bash Input: "Working with IIQ is fun" -Output: "Working with SailPoint Human Fabric is fun" +Output: "Working with SailPoint Identity Security is fun" ``` **Transform request body**: @@ -89,7 +89,7 @@ Output: "Working with SailPoint Human Fabric is fun" { "attributes": { "regex": "IIQ", - "replacement": "SailPoint Human Fabric" + "replacement": "SailPoint Identity Security" }, "type": "replace", "name": "Replace Transform" diff --git a/docs/extensibility/transforms/operations/static.md b/docs/extensibility/transforms/operations/static.md index 2d3aa94037ee6..721217ab3385c 100644 --- a/docs/extensibility/transforms/operations/static.md +++ b/docs/extensibility/transforms/operations/static.md @@ -17,7 +17,7 @@ Use the static transform to return a fixed string value, or more commonly, to ev :::note Other Considerations - When you are using static transforms within the create profile for a source, you can enter the value directly in the input field if the user selects Static as the attribute type. -- Because SailPoint Human Fabric supports the ability to order attributes in a create profile, you can use the Velocity template of an attribute higher in the list to generate a static value for an attribute that is lower in the list. For example, if you wanted to generate an email address based on a display name, you would need to do the follwing: +- Because SailPoint Identity Security supports the ability to order attributes in a create profile, you can use the Velocity template of an attribute higher in the list to generate a static value for an attribute that is lower in the list. For example, if you wanted to generate an email address based on a display name, you would need to do the follwing: - Move the "displayName" attribute higher in the list so that it is created before the email address. - In the "mail" attribute, select Static for the attribute type. In the Static Value field, enter `$displayName@yourdomain.com`. diff --git a/docs/extensibility/transforms/operations/username-generator.md b/docs/extensibility/transforms/operations/username-generator.md index b1cdac1637fc3..3aa84ece69121 100644 --- a/docs/extensibility/transforms/operations/username-generator.md +++ b/docs/extensibility/transforms/operations/username-generator.md @@ -25,7 +25,7 @@ Use the username generator transform to specify logic to use when it derives a u The username generator transform is intended for use as a configuration within the account create profile for a source. Thus, this transform's structure is more extensive than a typical Seaspray implementation -- it must be assigned to a create profile attribute (designated by `name`) and provide certain uniqueness check attributes such as `cloudMaxSize`, `cloudMaxUniqueChecks`, and `cloudRequired`. -The `cloudMaxSize` attribute denotes the maximum length of generated data allowable as a result of the generator logic. The transform truncates any characters over the `cloudMaxSize`. The `cloudMaxUniqueChecks` attribute determines the maximum number of iterations the generator must attempt before failing to generate a value. The `cloudRequired` attribute is an internal flag required for the SailPoint Human Fabric platform - leave it as `true`. +The `cloudMaxSize` attribute denotes the maximum length of generated data allowable as a result of the generator logic. The transform truncates any characters over the `cloudMaxSize`. The `cloudMaxUniqueChecks` attribute determines the maximum number of iterations the generator must attempt before failing to generate a value. The `cloudRequired` attribute is an internal flag required for the SailPoint Identity Security platform - leave it as `true`. Provide the username generator transform itself in the create profile attribute entry's `transform` parameter. @@ -128,9 +128,9 @@ The `attributes` object contains the username generation configuration. #### Optional - **sourceCheck** `boolean` _(optional)_ - Whether the generator checks only the SailPoint Human Fabric database or queries the target system directly. + Whether the generator checks only the SailPoint Identity Security database or queries the target system directly. - `true` - Check the target system directly (only if the system supports `getObject`). For systems that lack the ability to query for single account objects, the generator ignores this setting and defaults to `false`. The generator only checks the attribute identified in the account schema as the `accountID`. - - `false` - Check only the SailPoint Human Fabric database (default). The generator only checks the `accountID`. + - `false` - Check only the SailPoint Identity Security database (default). The generator only checks the `accountID`. #### Optional (dynamic variables) diff --git a/docs/extensibility/transforms/out-of-the-box-operations/index.md b/docs/extensibility/transforms/out-of-the-box-operations/index.md index a646b8074da4b..737b970760ffe 100644 --- a/docs/extensibility/transforms/out-of-the-box-operations/index.md +++ b/docs/extensibility/transforms/out-of-the-box-operations/index.md @@ -10,7 +10,7 @@ slug: /extensibility/transforms/ootb tags: ['Transforms', 'Transform Operations'] --- -SailPoint Human Fabric ships out of the box with a number of primitive transforms. The following sections describe the transforms. +SailPoint Identity Security ships out of the box with a number of primitive transforms. The following sections describe the transforms. ```mdx-code-block import DocCardList from '@theme/DocCardList'; diff --git a/docs/guides.md b/docs/guides.md index 6f486ec12b381..e2967f2d1819f 100644 --- a/docs/guides.md +++ b/docs/guides.md @@ -7,14 +7,14 @@ sidebar_key: isc-guides sidebar_position: 1 sidebar_class_name: guides keywords: ['guides'] -description: SHF guides. +description: SailPoint Identity Security guides. slug: /guides tags: ['guides'] --- ## Overview -SailPoint Human Fabric (SHF) has all sorts of potential specific solutions you can implement as long as you know how. These specific solutions may either not fall into one of the extensibility, connectivity, tools, or reporting categories, or they may fall into multiple categories. Read these guides to learn how to implement these specific solutions. +SailPoint Identity Security has all sorts of potential specific solutions you can implement as long as you know how. These specific solutions may either not fall into one of the extensibility, connectivity, tools, or reporting categories, or they may fall into multiple categories. Read these guides to learn how to implement these specific solutions. ```mdx-code-block import DocCardList from '@theme/DocCardList'; @@ -25,6 +25,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about these SHF 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 SailPoint Identity Security topics and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/docs/guides/audit-events-reference.md b/docs/guides/audit-events-reference.md index 22ac49c4e5679..5afe7d931a3f8 100644 --- a/docs/guides/audit-events-reference.md +++ b/docs/guides/audit-events-reference.md @@ -6,14 +6,14 @@ sidebar_label: Audit Events Reference sidebar_position: 4 sidebar_class_name: auditEventsReference keywords: ['audit', 'events', 'search', 'reference', 'event types'] -description: Complete reference of all audit event action names and types supported by the SHF Search API. +description: Complete reference of all audit event action names and types supported by the SailPoint Identity Security Search API. slug: /guides/audit-events-reference tags: ['Search', 'Audit', 'Events', 'Reference'] --- ## Overview -This page lists every audit event supported by the SailPoint Human Fabric Search API. +This page lists every audit event supported by the SailPoint Identity Security Search API. The **Search Field** column tells you which field to use in your query: diff --git a/docs/guides/disable-access-profile-requests.md b/docs/guides/disable-access-profile-requests.md index a7bd437fe783a..43aff1357ce3e 100644 --- a/docs/guides/disable-access-profile-requests.md +++ b/docs/guides/disable-access-profile-requests.md @@ -13,7 +13,7 @@ tags: ['AccessProfileRequestManagement'] ## Overview -In SailPoint Human Fabric, [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 SailPoint Human Fabric [Request Center](https://documentation.sailpoint.com/saas/user-help/requests/request_center.html), where all access profiles are listed. +In SailPoint Identity Security, [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 SailPoint Identity Security [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/patch-access-profile-v-1) to mark the individual access profile as non-requestable. @@ -21,7 +21,7 @@ You may have many access profiles that you want to disable requests for, and you ## Disable requests for individual access profiles with the UI -Follow these steps to use the SailPoint Human Fabric UI to individually disable requests for all access profiles that aren't currently associated with applications: +Follow these steps to use the SailPoint Identity Security UI to individually disable requests for all access profiles that aren't currently associated with applications: 1. Identify the access profiles that are associated with applications configured for access requests. Create a list of these associated access profiles. diff --git a/docs/guides/ip-address-allow-list.md b/docs/guides/ip-address-allow-list.md index 5dd76437ffae1..fb43982e81561 100644 --- a/docs/guides/ip-address-allow-list.md +++ b/docs/guides/ip-address-allow-list.md @@ -21,13 +21,13 @@ In order to create an IP Address Allow list, you need to know what region your t ### Finding your tenant using the admin console -Go to the admin console in SailPoint Human Fabric and find the 'Org Details' section. You will find your tenant's host region there: +Go to the admin console in SailPoint Identity Security and find the 'Org Details' section. You will find your tenant's host region there: ![img](./img/idn-console.PNG) -### Finding your tenant programatically using the IP address returned by SailPoint Human Fabric +### Finding your tenant programatically using the IP address returned by SailPoint Identity Security If you can't access the admin console or you want to dynamically find the region through code, follow these steps to find it: @@ -35,13 +35,13 @@ If you can't access the admin console or you want to dynamically find the region ![img](./img/postman1.PNG) -2. After a succesful call to SailPoint Human Fabric, hover over the globe icon in the response window in postman to get the IP address: +2. After a succesful call to SailPoint Identity Security, hover over the globe icon in the response window in postman to get the IP address: ![img](./img/postman2.PNG) 3. Download the [IP Address ranges from AWS](https://ip-ranges.amazonaws.com/ip-ranges.json) -4. Compare the IP address found when calling SailPoint Human Fabric to the list provided by AWS to determine where your tenant is hosted. You can run a simple Python script to easily find what region the IP address belongs to: +4. Compare the IP address found when calling SailPoint Identity Security to the list provided by AWS to determine where your tenant is hosted. You can run a simple Python script to easily find what region the IP address belongs to: ```python from ipaddress import ip_network, ip_address @@ -76,7 +76,7 @@ The URL used to find your range of allow list URLs can be constructed using the https://files.accessiq.sailpoint.com/network/REGION/FILENAME ``` -Where REGION is the region of your SailPoint Human Fabric Tenant and FILENAME is one of the three following: +Where REGION is the region of your SailPoint Identity Security Tenant and FILENAME is one of the three following: ``` source_ips.yaml @@ -102,7 +102,7 @@ which will result in a file similar to the following: - '54.243.179.37/32' ``` -These IP Address ranges can now be used as an allow list to permit any call from your SailPoint Human Fabric tenant to access your internal network. +These IP Address ranges can now be used as an allow list to permit any call from your SailPoint Identity Security tenant to access your internal network. ## Limitations diff --git a/docs/guides/searching-audit-events.md b/docs/guides/searching-audit-events.md index cdfda7dfebb99..36906bec400db 100644 --- a/docs/guides/searching-audit-events.md +++ b/docs/guides/searching-audit-events.md @@ -6,14 +6,14 @@ sidebar_label: Searching Audit Events sidebar_position: 3 sidebar_class_name: searchingAuditEvents keywords: ['audit', 'events', 'search', 'search api', 'security', 'compliance'] -description: Use the Search API to query audit events in SailPoint Human Fabric. +description: Use the Search API to query audit events in SailPoint Identity Security. slug: /guides/searching-audit-events tags: ['Search', 'Audit', 'Events', 'Security', 'Compliance'] --- ## Overview -SailPoint Human Fabric (SHF) records a wide range of audit events whenever actions are taken in the platform — user logins, role changes, access requests, workflow executions, and much more. These events are indexed in real time and can be queried through the [Search API](https://developer.sailpoint.com/docs/api/search-post-v-1). +SailPoint Identity Security records a wide range of audit events whenever actions are taken in the platform — user logins, role changes, access requests, workflow executions, and much more. These events are indexed in real time and can be queried through the [Search API](https://developer.sailpoint.com/docs/api/search-post-v-1). This guide explains how to build useful search queries and what the key fields in an event response mean. For a complete listing of every supported event name and its type, see the [Audit Events Reference](./audit-events-reference). @@ -21,7 +21,7 @@ This guide explains how to build useful search queries and what the key fields i Use `POST /search/v1` with `"indices": ["events"]` to query audit events. For full details on request and response formats, authentication, and rate limits, see the [Search API reference](https://developer.sailpoint.com/docs/api/search-post-v-1). -To try requests interactively, use the [SailPoint Postman workspace](https://www.postman.com/sailpoint/workspace/identitynow) — the **SailPoint Human Fabric APIs** collection includes the Search endpoint with pre-configured authentication. See [Postman Collections](https://developer.sailpoint.com/docs/api/postman-collections) for setup instructions. +To try requests interactively, use the [SailPoint Postman workspace](https://www.postman.com/sailpoint/workspace/identitynow) — the **SailPoint Identity Security APIs** collection includes the Search endpoint with pre-configured authentication. See [Postman Collections](https://developer.sailpoint.com/docs/api/postman-collections) for setup instructions. ### Key response fields diff --git a/docs/index.md b/docs/index.md index c1d26c5fa32da..12f09e6dc8e03 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,27 +1,27 @@ --- id: docs -title: SailPoint Human Fabric +title: SailPoint Identity Security pagination_label: Docs sidebar_label: Docs sidebar_position: 1 sidebar_class_name: docs keywords: ['docs'] -description: The SailPoint Human Fabric Developer Documentation. +description: The SailPoint Identity Security Developer Documentation. slug: / tags: ['docs'] --- ## Overview -:::caution Looking for IdentityNow or Identity Security Cloud? +:::caution Looking for Identity Security Cloud? -You're in the right place. This platform was previously named IdentityNow, then Identity Security Cloud (ISC). It is now SailPoint Human Fabric (SHF). The product is the same — only the name has changed. +You're in the right place. Identity Security Cloud is now SailPoint Identity Security. SailPoint Identity Security includes SailPoint Human Fabric, for human identities, and SailPoint Agentic Fabric, for AI agent security. ::: -SailPoint Human Fabric (SHF) is a unified, multi-tenant identity governance and security platform. SHF provides organizations with the ability to ensure that their users, known as identities in SHF, have secure access to different data sources, and it makes identity access management fast and easy. +SailPoint Identity Security is a unified, multi-tenant identity governance and security platform. SailPoint Identity Security provides organizations with the ability to ensure that their users, known as identities, have secure access to different data sources, and it makes identity access management fast and easy. -The SHF platform out of the box will often meet all your identity governance and security needs, but it's possible that it won't. The beauty of SHF is that even if it doesn't quite meet all your needs, you can extend the platform's functionality and build custom solutions that do! +SailPoint Identity Security out of the box will often meet all your identity governance and security needs, but it's possible that it won't. The beauty of the platform is that even if it doesn't quite meet all your needs, you can extend the platform's functionality and build custom solutions that do! The SailPoint Developer Documentation provides developers with all the information they need to extend their platforms' functionality and build their desired solutions. The developer documentation is written for developers of all experience levels, from nontechnical users exploring what's possible to advanced developers who live and breathe code. @@ -29,7 +29,7 @@ Check out the developer documentation and see what's possible! :::info Are you a partner? -The developer documentation is written for customers and partners who already have access to SHF. If you're interested in becoming a partner, go [here](https://www.sailpoint.com/partners/become-partner/). +The developer documentation is written for customers and partners who already have access to SailPoint Identity Security. If you're interested in becoming a partner, go [here](https://www.sailpoint.com/partners/become-partner/). ::: @@ -44,6 +44,6 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about SHF 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 SailPoint Identity Security and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/docs/reporting.md b/docs/reporting.md index 01e75f0049903..43177245aa73d 100644 --- a/docs/reporting.md +++ b/docs/reporting.md @@ -6,14 +6,14 @@ sidebar_label: Reporting sidebar_position: 1 sidebar_class_name: reporting keywords: ['reporting'] -description: Collect data reports from SHF. +description: Collect data reports from SailPoint Identity Security. slug: /reporting tags: ['reporting'] --- ## Overview -Data reporting refers to the process of collecting and presenting data in a structured format that makes the data accessible and easy to understand, which facilitates an organization's data-driven decisions. SailPoint Human Fabric (SHF) provides different data reporting options you can use to extract data from your tenant and make it presentable. +Data reporting refers to the process of collecting and presenting data in a structured format that makes the data accessible and easy to understand, which facilitates an organization's data-driven decisions. SailPoint Identity Security provides different data reporting options you can use to extract data from your tenant and make it presentable. ```mdx-code-block import DocCardList from '@theme/DocCardList'; @@ -24,6 +24,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about SHF 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 SailPoint Identity Security 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). diff --git a/docs/reporting/access-intelligence-center/ciem-er-diagram.md b/docs/reporting/access-intelligence-center/ciem-er-diagram.md index 1e204b7e76ce6..f86740cd00371 100644 --- a/docs/reporting/access-intelligence-center/ciem-er-diagram.md +++ b/docs/reporting/access-intelligence-center/ciem-er-diagram.md @@ -20,7 +20,7 @@ import MermaidViewer from '@site/src/components/MermaidViewer'; -## SailPoint Human Fabric Documentation +## SailPoint Identity Security Documentation For information on how to use AIC in your environment, see the documentation [here](https://documentation.sailpoint.com/saas/help/ai/access_insights/access_intelligence.html) diff --git a/docs/reporting/secure-data-share/_category_.json b/docs/reporting/secure-data-share/_category_.json index 59aa246d9596c..db3cc1e06c443 100644 --- a/docs/reporting/secure-data-share/_category_.json +++ b/docs/reporting/secure-data-share/_category_.json @@ -1,5 +1,5 @@ { "customProps": { - "description": "Securely share SHF data with Snowflake." + "description": "Securely share SailPoint Identity Security data with Snowflake." } } diff --git a/docs/reporting/secure-data-share/identity-data-dictionary.md b/docs/reporting/secure-data-share/identity-data-dictionary.md index 780264d73e109..cb6cfb0e91fc2 100644 --- a/docs/reporting/secure-data-share/identity-data-dictionary.md +++ b/docs/reporting/secure-data-share/identity-data-dictionary.md @@ -153,7 +153,7 @@ Use the table of contents on the right-hand side of the page to jump directly to | --- | --- | --- | --- | | TENANT_ID | text | | Unique Id for an Organization tenant | | ID | text | | Unique Id for the Access Profile | -| NAME | text | | Name of the object in SHF | +| NAME | text | | Name of the object in SailPoint Identity Security | | DISPLAY_NAME | text | | Human-readable display name of the object | | DESCRIPTION | text | | Description of the object | | CREATED_DATE | datetime | | date when the object was created | @@ -174,14 +174,14 @@ Use the table of contents on the right-hand side of the page to jump directly to | --- | --- | --- | --- | | TENANT_ID | text | | Unique Id for an Organization tenant | | ID | text | | Unique Id for the Access Profile | -| NAME | text | | Name of the object in SHF | +| NAME | text | | Name of the object in SailPoint Identity Security | | CREATED_DATE | datetime | | date when the object was created | | UPDATED_DATE | datetime | | date when the object was modified | | DELETED_DATE | datetime | | date when the object was deleted | | TARGET_ID | text | | Identity ID whose access is getting updated | | REQUESTER_ID | text | | Identity ID who raised this access request | | END_DATE | datetime | | date when the access request was completed | -| EXECUTION_STATUS | text | | Execution status at SHF Ex: Completed, Terminated etc. | +| EXECUTION_STATUS | text | | Execution status at SailPoint Identity Security Ex: Completed, Terminated etc. | | COMPLETION_STATUS | text | | Completion status Ex: Success, Failure etc. | | PRIORITY | text | | one of low, Normal and high | | TYPE | text | | type of access item or Identity items requested | @@ -196,7 +196,7 @@ Contains certification data sourced from **Certs 1.0**. | --- | --- | --- | --- | | TENANT_ID | text | | Unique Id for an Organization tenant | | ID | text | | Unique Id for the Certification | -| NAME | text | | Name of the object in SHF | +| NAME | text | | Name of the object in SailPoint Identity Security | | CREATED_DATE | datetime | | date when the object was created | | UPDATED_DATE | datetime | | date when the object was modified | | DELETED_DATE | datetime | | date when the object was deleted | @@ -271,7 +271,7 @@ Contains certification data sourced from **Certs 2.0**. | --- | --- | --- | --- | | TENANT_ID | text | | Unique Id for an Organization tenant | | ID | text | | Unique Id for the Role | -| NAME | text | | Name of the object in SHF | +| NAME | text | | Name of the object in SailPoint Identity Security | | CREATED_DATE | datetime | | date when the object was created | | UPDATED_DATE | datetime | | date when the object was modified | | DELETED_DATE | datetime | | date when the object was deleted | @@ -331,7 +331,7 @@ Contains certification item data sourced from **Certs 1.0**. | TYPE | text | | Type of certification item Ex: Bundle, Exception, Account Etc. | | SUB_TYPE | text | | Associated Sub_type for each of the type | | COMPLETED_DATE | datetime | | time the access item certification was completed | -| DECISION_DATE | datetime | | time the decision was submitted on SHF | +| DECISION_DATE | datetime | | time the decision was submitted on SailPoint Identity Security | | APPROVED | number | | Whether the item was approved(1) or rejected(0) | | STATUS | text | | Status of the certification item | | DECISION | text | | Decision taken by reviewer on the access item Ex: Approved, Mitigated, remediated etc. | diff --git a/docs/reporting/secure-data-share/identity-er-diagram.md b/docs/reporting/secure-data-share/identity-er-diagram.md index 16a01cf869250..a934085a91088 100644 --- a/docs/reporting/secure-data-share/identity-er-diagram.md +++ b/docs/reporting/secure-data-share/identity-er-diagram.md @@ -111,7 +111,7 @@ import MermaidViewer from '@site/src/components/MermaidViewer'; ACCESS_PROFILE { text TENANT_ID "Unique Id for an Organization tenant" text ID "Unique Id for the Access Profile" - text NAME "Name of the object in SHF" + text NAME "Name of the object in SailPoint Identity Security" text DISPLAY_NAME "Human-readable display name of the object" text DESCRIPTION "Description of the object" datetime CREATED_DATE "date when the object was created" @@ -128,14 +128,14 @@ import MermaidViewer from '@site/src/components/MermaidViewer'; ACCESS_REQUEST { text TENANT_ID "Unique Id for an Organization tenant" text ID "Unique Id for the Access Profile" - text NAME "Name of the object in SHF" + text NAME "Name of the object in SailPoint Identity Security" datetime CREATED_DATE "date when the object was created" datetime UPDATED_DATE "date when the object was modified" datetime DELETED_DATE "date when the object was deleted" text TARGET_ID "Identity ID whose access is getting updated" text REQUESTER_ID "Identity ID who raised this access request" datetime END_DATE "date when the access request was completed" - text EXECUTION_STATUS "Execution status at SHF Ex: Completed, Terminated etc." + text EXECUTION_STATUS "Execution status at SailPoint Identity Security Ex: Completed, Terminated etc." text COMPLETION_STATUS "Completion status Ex: Success, Failure etc." text PRIORITY "one of low, Normal and high" text TYPE " type of access item or Identity items requested" @@ -144,7 +144,7 @@ import MermaidViewer from '@site/src/components/MermaidViewer'; CERTIFICATION { text TENANT_ID "Unique Id for an Organization tenant" text ID "Unique Id for the Certification" - text NAME "Name of the object in SHF" + text NAME "Name of the object in SailPoint Identity Security" datetime CREATED_DATE "date when the object was created" datetime UPDATED_DATE "date when the object was modified" datetime DELETED_DATE "date when the object was deleted" @@ -187,7 +187,7 @@ import MermaidViewer from '@site/src/components/MermaidViewer'; ROLE { text TENANT_ID "Unique Id for an Organization tenant" text ID "Unique Id for the Role" - text NAME "Name of the object in SHF" + text NAME "Name of the object in SailPoint Identity Security" datetime CREATED_DATE "date when the object was created" datetime UPDATED_DATE "date when the object was modified" datetime DELETED_DATE "date when the object was deleted" @@ -237,7 +237,7 @@ import MermaidViewer from '@site/src/components/MermaidViewer'; text TYPE "Type of certification item Ex: Bundle, Exception, Account Etc." text SUB_TYPE "Assocaited Sub_type for each of the type" datetime COMPLETED_DATE "time the access item certification was completed" - datetime DECISION_DATE "time the decision was submitted on SHF" + datetime DECISION_DATE "time the decision was submitted on SailPoint Identity Security" number APPROVED "Whether the item was approved(1) or rejected(0)" text STATUS "Status of the certification item" text DECISION "Decision taken by reviewer on the access item Ex: Approved, Mitigated, remediated etc." diff --git a/docs/reporting/secure-data-share/index.md b/docs/reporting/secure-data-share/index.md index 0166fc43b1198..5b38b3ed9576b 100644 --- a/docs/reporting/secure-data-share/index.md +++ b/docs/reporting/secure-data-share/index.md @@ -6,7 +6,7 @@ sidebar_label: Secure Data Share sidebar_position: 6 sidebar_class_name: secureDataShare keywords: ['data listing', 'data share', 'secure data sharing'] -description: Share SHF data with Snowflake. +description: Share SailPoint Identity Security data with Snowflake. slug: /reporting/secure-data-share tags: ['SecureDataShare'] hide_table_of_contents: true @@ -25,7 +25,7 @@ Secure Data Share (SDS) makes your SailPoint identity data available directly in ## Requirements -Secure Data Share is an add-on for SailPoint Human Fabric. Please contact your sales representative to discuss your SDS options. You must also have an AWS, Azure, or GCP Snowflake account so that SailPoint can synchronize your tenant data with your Snowflake instance. +Secure Data Share is an add-on for SailPoint Identity Security. Please contact your sales representative to discuss your SDS options. You must also have an AWS, Azure, or GCP Snowflake account so that SailPoint can synchronize your tenant data with your Snowflake instance. ## Data synchronization SLA @@ -44,6 +44,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where 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). diff --git a/docs/tools.md b/docs/tools.md index 609e8fe78ded1..c2a51a5c80c57 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -6,14 +6,14 @@ sidebar_label: Tools sidebar_position: 1 sidebar_class_name: tools keywords: ['tools'] -description: SHF developer tools. +description: SailPoint Identity Security developer tools. slug: /tools tags: ['tools'] --- ## Overview -The SailPoint Developer Relations Team has built some useful tools that improve the experience for developers building on the SailPoint Human Fabric (SHF) platform. These tools make it easier for developers to leverage the SHF APIs, extensibility options, and connectivity. +The SailPoint Developer Relations Team has built some useful tools that improve the experience for developers building on the SailPoint Identity Security platform. These tools make it easier for developers to leverage the SailPoint Identity Security APIs, extensibility options, and connectivity. ```mdx-code-block import DocCardList from '@theme/DocCardList'; @@ -24,6 +24,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about SHF 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 SailPoint Identity Security tools and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/docs/tools/cli/Templates/search.md b/docs/tools/cli/Templates/search.md index 2c2db36385a8b..3b8d8b92a0da5 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 [SailPoint Human Fabric 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/search-post-v-1), 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 [SailPoint Identity Security 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/search-post-v-1), 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 3d3b60a6e982a..f2b3c127ee573 100644 --- a/docs/tools/cli/Templates/spconfig.md +++ b/docs/tools/cli/Templates/spconfig.md @@ -11,7 +11,7 @@ slug: /tools/cli/templates/spconfig tags: ['CLI'] --- -Use SPConfig templates to perform complex import and export operations with SailPoint Human Fabric (SHF) configurations. +Use SPConfig templates to perform complex import and export operations with SailPoint Identity Security configurations. This is an example of a template file with one SPConfig template populated: diff --git a/docs/tools/cli/_category_.json b/docs/tools/cli/_category_.json index 3ffcdb61fc657..2cb4cb98e1cd9 100644 --- a/docs/tools/cli/_category_.json +++ b/docs/tools/cli/_category_.json @@ -1,5 +1,5 @@ { "customProps": { - "description": "Terminal based tool for interaction with SHF." + "description": "Terminal based tool for interaction with SailPoint Identity Security." } } diff --git a/docs/tools/cli/api.md b/docs/tools/cli/api.md index 06b2f45af3096..d68753c88abcd 100644 --- a/docs/tools/cli/api.md +++ b/docs/tools/cli/api.md @@ -115,7 +115,7 @@ sail api put /v2025/transforms --file-body ./updated-transform.json ## Delete requests -Use this command to remove resources from SailPoint Human Fabric. +Use this command to remove resources from SailPoint Identity Security. Run the following command to remove a transform from your tenant: diff --git a/docs/tools/cli/connectors.md b/docs/tools/cli/connectors.md index cc828df990260..49cfbf184cea0 100644 --- a/docs/tools/cli/connectors.md +++ b/docs/tools/cli/connectors.md @@ -15,7 +15,7 @@ tags: ['CLI'] Learn how to use the CLI to create, manage, and test SaaS connectors in this guide. -You can use SaaS connectors to serve as bridges between your SailPoint Human Fabric (SHF) tenant and other source systems without the use of a Virtual Appliance (VA). For more information about the SaaS connectors, refer to the [SaaS Connectivity](/docs/connectivity/saas-connectivity) guide. +You can use SaaS connectors to serve as bridges between your SailPoint Identity Security tenant and other source systems without the use of a Virtual Appliance (VA). For more information about the SaaS connectors, refer to the [SaaS Connectivity](/docs/connectivity/saas-connectivity) guide. The `connectors` command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create, manage, and test SaaS connectors within your tenant. @@ -46,7 +46,7 @@ This command creates a folder named `connectorProjectName` in your working direc ### Create connector -To create a connector entry in your SHF tenant, run this command: +To create a connector entry in your SailPoint Identity Security tenant, run this command: ```shell sail conn create [connectorAlias] @@ -56,7 +56,7 @@ This command registers your connector and gives it a unique ID. For more informa ### Upload connector -To upload a connector to your SHF tenant, run `npm run pack-zip` in the project directory to package the connector into a zip file. Then run this command: +To upload a connector to your SailPoint Identity Security tenant, run `npm run pack-zip` in the project directory to package the connector into a zip file. Then run this command: ```shell sail conn upload -c [connectorID | connectorAlias] -f connector.zip @@ -80,7 +80,7 @@ The entitlement commands require an additional flag (`-t [entitlementType]`), li sail conn invoke entitlement-list -t [entitlementType] -c [connectorID | connectorAlias] -p [config.json] -v [version] ``` -For more information about invoking commands, refer to the [Test your connector in SailPoint Human Fabric](/docs/connectivity/saas-connectivity/test-build-deploy#test-your-connector-in-sailpoint-human-fabric) section of the SaaS Connectivity documentation. +For more information about invoking commands, refer to the [Test your connector in SailPoint Identity Security](/docs/connectivity/saas-connectivity/test-build-deploy#test-your-connector-in-sailpoint-identity-security) section of the SaaS Connectivity documentation. ### List connectors @@ -120,7 +120,7 @@ sail conn delete -c [connectorID] ### Manage tags -You can use tags to create multiple instances of your connector that can be used in SHF. The `latest` tag is created by default and is the primary instance, typically used for production purposes. Tags are similar to branches in a version control system, like git or CVS. You can create a tag for actively developing the connector, or for any other purpose you want. +You can use tags to create multiple instances of your connector that can be used in SailPoint Identity Security. The `latest` tag is created by default and is the primary instance, typically used for production purposes. Tags are similar to branches in a version control system, like git or CVS. You can create a tag for actively developing the connector, or for any other purpose you want. A common pattern is to create a `development` tag on a connector from a specific version, like the latest version. @@ -134,7 +134,7 @@ As the connector is developed and the version number increases, update the `deve sail conn tags update -c [connectorID | connectorAlias] -n [tagName] -v [version] ``` -You can test the connector in SHF by selecting the connector instance with the `development` tag. The CLI will use the version you point to with the update command. +You can test the connector in SailPoint Identity Security by selecting the connector instance with the `development` tag. The CLI will use the version you point to with the update command. To see a connector's tags and the versions they point to, run this command: diff --git a/docs/tools/cli/index.md b/docs/tools/cli/index.md index af1a3cf3c1ac6..1e64198c8ef6e 100644 --- a/docs/tools/cli/index.md +++ b/docs/tools/cli/index.md @@ -6,16 +6,16 @@ sidebar_label: CLI sidebar_position: 1 sidebar_class_name: cli keywords: ['cli'] -description: Terminal-based tool for interaction with SHF. +description: Terminal-based tool for interaction with SailPoint Identity Security. slug: /tools/cli tags: ['CLI'] --- ## Start using the CLI -The SailPoint CLI is a terminal-based tool you can use to to interact with your SailPoint Human Fabric (SHF) tenant. The CLI provides a text-based environment you can use to run operations known as "commands" to interact with your tenant however you want. +The SailPoint CLI is a terminal-based tool you can use to to interact with your SailPoint Identity Security tenant. The CLI provides a text-based environment you can use to run operations known as "commands" to interact with your tenant however you want. -You can use the CLI to perform many functions you would have otherwise used Postman or custom scripts to perform before. For example, you can use the CLI to call the SailPoint APIs to do whatever you want in your SHF tenant, and you can do all this directly on the command line, with minimal setup. +You can use the CLI to perform many functions you would have otherwise used Postman or custom scripts to perform before. For example, you can use the CLI to call the SailPoint APIs to do whatever you want in your SailPoint Identity Security tenant, and you can do all this directly on the command line, with minimal setup.
@@ -119,9 +119,9 @@ sudo yum localinstall /path/to/rpm/package/sail_x.x.x_linux_amd64.rpm ## Configuration -To configure the CLI to connect and authenticate to your SHF tenant, you must do the following: +To configure the CLI to connect and authenticate to your SailPoint Identity Security tenant, you must do the following: -- Find your tenant name or tenant URL. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The CLI will use this value to connect to your SHF instance. +- Find your tenant name or tenant URL. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The CLI will use this value to connect to your SailPoint Identity Security instance. - Choose an authentication method: - OAuth | Sign in through your browser. You do not need to create credentials first. - PAT | Create a personal access token (PAT). Make sure to note the "Client ID" and "Client Secret." The CLI needs this information to authenticate successfully. To learn how to create a PAT, refer to [Personal Access Tokens](/docs/api/authentication#generate-a-personal-access-token). @@ -141,8 +141,8 @@ The CLI asks for your tenant name or URL. You can enter either of these: From this value, the CLI creates two URLs: -- The Tenant URL - The web URL used to access your SailPoint Human Fabric tenant (ex. https://tenant.identitynow.com), this is used during the OAuth process. -- The API URL - The API URL used to access your SailPoint Human Fabric tenant (ex. https://tenant.api.identitynow.com), this is used for the api calls made by certain commands. +- The Tenant URL - The web URL used to access your SailPoint Identity Security tenant (ex. https://tenant.identitynow.com), this is used during the OAuth process. +- The API URL - The API URL used to access your SailPoint Identity Security tenant (ex. https://tenant.api.identitynow.com), this is used for the api calls made by certain commands. The CLI then checks the API URL with your tenant. If the check passes, the CLI skips the URL confirmation prompts: @@ -167,7 +167,7 @@ The CLI runs the authorization code flow with PKCE, and it exchanges the code wi 1. The CLI opens your browser and prints a confirmation code, such as `Ab3d-9Kx1`. -2. You sign in to Identity Security Cloud. +2. You sign in to SailPoint Identity Security. 3. The page at `https://developer.sailpoint.com/sailapps` shows the same confirmation code and a one-time code that starts with `sp1.`. Make sure that both confirmation codes match. @@ -242,9 +242,9 @@ Run the `sail` command for an overview of available commands and flags. You can These commands are available: - `connectors`: This command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create and manage SaaS connectors within your tenant. For more information about the `connectors` command, refer to the CLI [Connectors guide](/docs/tools/cli/connectors). -- `search`: Run this command to access SHF search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/docs/tools/cli/search). +- `search`: Run this command to access SailPoint Identity Security search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/docs/tools/cli/search). - `set`: Run this command to configure your CLI settings. For more information about the `set` command, refer to the CLI [Set guide](/docs/tools/cli/set). -- `spconfig`: Run this command to access SHF SP Config functionality. For more information about the `spconfig` command, refer to the CLI [SPConfig guide](/docs/tools/cli/spconfig). +- `spconfig`: Run this command to access SailPoint Identity Security SP Config functionality. For more information about the `spconfig` command, refer to the CLI [SPConfig guide](/docs/tools/cli/spconfig). - `transform`: This command is a CLI interface that makes it easy to create, manage, and test transforms. For more information about the `transform` command, refer to the CLI [Transforms guide](/docs/tools/cli/transforms). - `va`: Run this command to access VAs connected to your tenant. For more information about the `va` command, refer to the CLI [VA guide](/docs/tools/cli/va). - `cluster`: Run this command to access VA clusters connected to your tenant. For more information about the `cluster` command, refer to the CLI [Clusters guide](/docs/tools/cli/cluster). diff --git a/docs/tools/cli/reassign.md b/docs/tools/cli/reassign.md index 603337223453a..b3fd14c1f0190 100644 --- a/docs/tools/cli/reassign.md +++ b/docs/tools/cli/reassign.md @@ -6,12 +6,12 @@ sidebar_label: Reassign sidebar_position: 10 sidebar_class_name: cli-reassign keywords: ['cli', 'cli reassign', 'reassign'] -description: Learn how to use the CLI to reassign the owner on objects in SailPoint Human Fabric. +description: Learn how to use the CLI to reassign the owner on objects in SailPoint Identity Security. slug: /tools/cli/reassign tags: ['CLI'] --- -Learn how to use the SailPoint CLI to reassign the owner on objects in SailPoint Human Fabric. +Learn how to use the SailPoint CLI to reassign the owner on objects in SailPoint Identity Security. The `reassign` command makes it easy to reassign ownership for the following supported object types: diff --git a/docs/tools/cli/sanitize.md b/docs/tools/cli/sanitize.md index e657d145675f7..d02f401b05238 100644 --- a/docs/tools/cli/sanitize.md +++ b/docs/tools/cli/sanitize.md @@ -15,7 +15,7 @@ tags: ['CLI'] Learn how to use the CLI to sanitize your HAR files in this guide. -When you're troubleshooting issues you encounter using SailPoint Human Fabric, some of the most helpful data can be contained in a HAR file collected from your browser's API calls made while replicating the issue. +When you're troubleshooting issues you encounter using SailPoint Identity Security, some of the most helpful data can be contained in a HAR file collected from your browser's API calls made while replicating the issue. The problem lies in the amount of information, specifically sensitive information that the HAR file contains, due to the nature of the data it's capturing. The CLI is very useful for this. You can use the CLI to sanitize the HAR file, which removes sensitive information but still still leaves the file in a useful state for troubleshooting the issue. @@ -27,7 +27,7 @@ The existing support guide for collecting and sanitizing the HAR file [can be fo ### Functionality -The sanitize command sanitizes a HAR file of sensitive data. It only removes access tokens matching the SailPoint Human Fabric format and origin urls similar to the examples below: +The sanitize command sanitizes a HAR file of sensitive data. It only removes access tokens matching the SailPoint Identity Security format and origin urls similar to the examples below: Access Token diff --git a/docs/tools/cli/search.md b/docs/tools/cli/search.md index 69950c7dd5944..c55a014933d69 100644 --- a/docs/tools/cli/search.md +++ b/docs/tools/cli/search.md @@ -6,18 +6,18 @@ sidebar_label: Search sidebar_position: 3 sidebar_class_name: cli keywords: ['cli', 'search'] -description: Learn how to use the CLI to search your SHF tenant in this guide. +description: Learn how to use the CLI to search your SailPoint Identity Security tenant in this guide. slug: /tools/cli/search tags: ['CLI'] --- -Learn how to use the CLI to search your SHF tenant in this guide. +Learn how to use the CLI to search your SailPoint Identity Security tenant in this guide. -In SailPoint Human Fabric (SHF), you can search across all the sources connected to your tenant and return virtually any information you have access to. The `search` command allows you to access SHF search functionality within the CLI. For more information about search in SHF, refer to [Search](../../api/search). +In SailPoint Identity Security, you can search across all the sources connected to your tenant and return virtually any information you have access to. The `search` command allows you to access SailPoint Identity Security search functionality within the CLI. For more information about search in SailPoint Identity Security, refer to [Search](../../api/search). -In SailPoint Human Fabric, you can search all the sources connected to your tenant and return virtually any information you have access to. To learn more about search in SailPoint Human Fabric, refer to [Search](https://documentation.sailpoint.com/saas/help/search/index.html). +In SailPoint Identity Security, you can search all the sources connected to your tenant and return virtually any information you have access to. To learn more about search in SailPoint Identity Security, refer to [Search](https://documentation.sailpoint.com/saas/help/search/index.html). -The `search` command makes it easy to search in SailPoint Human Fabric with the SailPoint CLI. Read this guide to learn how to use the `query` and `template` commands to search SailPoint Human Fabric with the CLI. +The `search` command makes it easy to search in SailPoint Identity Security with the SailPoint CLI. Read this guide to learn how to use the `query` and `template` commands to search SailPoint Identity Security with the CLI. - [Query](#query) - [Command](#command) @@ -32,11 +32,11 @@ The `search` command makes it easy to search in SailPoint Human Fabric with the ## Query -Search queries in SailPoint Human Fabric are flexible - they can be very broad or very narrow, and you can further narrow your results by using SailPoint Human Fabric's specific syntax to structure your queries. To learn about structuring search queries, refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html). +Search queries in SailPoint Identity Security are flexible - they can be very broad or very narrow, and you can further narrow your results by using the platform's specific syntax to structure your queries. To learn about structuring search queries, refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html). -The `query` command allows you to search SailPoint Human Fabric for a query you specify. +The `query` command allows you to search SailPoint Identity Security for a query you specify. -To use the `query` command to search SailPoint Human Fabric, you must understand how to format your search queries. +To use the `query` command to search SailPoint Identity Security, you must understand how to format your search queries. The basic format of a query is "field:term", so an example `query` command would like this: @@ -114,7 +114,7 @@ sail search query "name:a*" --indices identities --folderPath ./local/folder/pat For more detailed search queries, you can provide a predefined template instead of constructing the whole query every time. This allows you to run very detailed search queries quickly and easily. -The `template` command allows you to use predefined templates to search SailPoint Human Fabric. +The `template` command allows you to use predefined templates to search SailPoint Identity Security. ### Command @@ -124,7 +124,7 @@ This example shows the essential `template` command structure: sail search template all-provisioning-events-90-days ``` -The specified template file will give the CLI all the information it needs to perform its search in SailPoint Human Fabric. +The specified template file will give the CLI all the information it needs to perform its search in SailPoint Identity Security. ### Flags diff --git a/docs/tools/cli/spconfig.md b/docs/tools/cli/spconfig.md index c1a172facfb09..2c538cd8088d5 100644 --- a/docs/tools/cli/spconfig.md +++ b/docs/tools/cli/spconfig.md @@ -15,7 +15,7 @@ tags: ['CLI'] Learn how to use the CLI to import and export configurations. -You can use the [SP Config APIs](/docs/api/list-sp-config-objects-v-1) to import configurations into SHF and export them out. +You can use the [SP Config APIs](/docs/api/list-sp-config-objects-v-1) to import configurations into SailPoint Identity Security and export them out. With the `spconfig` command, you can access the same functionality. @@ -38,9 +38,9 @@ To perform SPConfig operations, you can run these commands: ### Download -You can use the `download` command to download import and export job results from SHF. The `download` command is specified differently for **Linux/Mac** and **Windows**, respectively. +You can use the `download` command to download import and export job results from SailPoint Identity Security. The `download` command is specified differently for **Linux/Mac** and **Windows**, respectively. -To download import and export job results from SHF on **Linux/Mac**, run this command: +To download import and export job results from SailPoint Identity Security on **Linux/Mac**, run this command: ```shell sail spconfig download \ @@ -48,7 +48,7 @@ sail spconfig download \ --export {export job ID} ``` -To download import and export job results from SHF on **Windows**, run this command: +To download import and export job results from SailPoint Identity Security on **Windows**, run this command: ```shell sail spconfig download \ @@ -66,7 +66,7 @@ You can add these flags to the `download` command: ### Import -To begin an import task in SHF, run this command: +To begin an import task in SailPoint Identity Security, run this command: ```shell sail spconfig import \ @@ -83,7 +83,7 @@ You can add these flags to the `import` command: ### Export -To begin an export task in SHF, run this command: +To begin an export task in SailPoint Identity Security, run this command: ```shell sail spconfig export \ @@ -104,7 +104,7 @@ You can add these flags to the `export` command: ### Status -To check the status of import and export jobs in SHF, run this command: +To check the status of import and export jobs in SailPoint Identity Security, run this command: ```shell sail spconfig status --import {import job ID to check} --export {export job ID to check} @@ -119,7 +119,7 @@ You can add these flags to the `status` command: ### Template -To begin exporting a template from SHF, run this command: +To begin exporting a template from SailPoint Identity Security, run this command: ```shell sail spconfig template diff --git a/docs/tools/cli/transforms.md b/docs/tools/cli/transforms.md index 8cb51334cc3f1..742497096e3e7 100644 --- a/docs/tools/cli/transforms.md +++ b/docs/tools/cli/transforms.md @@ -13,7 +13,7 @@ tags: ['CLI'] Learn about the CLI commands you can use to create, manage, and test transforms in this guide. -In SailPoint Human Fabric (SHF), you can use transforms to manipulate attribute data without writing any code. For more information about transforms, refer to [Transforms](/docs/extensibility/transforms). +In SailPoint Identity Security, you can use transforms to manipulate attribute data without writing any code. For more information about transforms, refer to [Transforms](/docs/extensibility/transforms). With the `transforms` command, it's it easy to create, manage, and test transforms in the CLI. @@ -71,7 +71,7 @@ To update a transform from a `json` file, run the following command. Use the `-f sail transform update -f transform.json ``` -A common workflow is to first download the transforms, then make edits to the transform file, and then use the update command to save those edits in SHF. +A common workflow is to first download the transforms, then make edits to the transform file, and then use the update command to save those edits in SailPoint Identity Security. ## Delete transform diff --git a/docs/tools/cli/va.md b/docs/tools/cli/va.md index 9d04ec6a7a506..5f548a9b57902 100644 --- a/docs/tools/cli/va.md +++ b/docs/tools/cli/va.md @@ -13,7 +13,7 @@ tags: ['CLI'] Learn about the CLI commands you can use to interact with VAs in this guide. -A virtual appliance (VA) is a Linux-based virtual machine that connects to your sources and applications in SHF by using APIs, connectors, and other integrations SailPoint has made available. +A virtual appliance (VA) is a Linux-based virtual machine that connects to your sources and applications in SailPoint Identity Security by using APIs, connectors, and other integrations SailPoint has made available. For more information about VAs, refer to the [Virtual Appliance Reference Guide](https://community.sailpoint.com/t5/IdentityNow-Connectors/Virtual-Appliance-Reference-Guide/ta-p/74641?_ga=2.265747530.43742715.1681135659-1245631791.1680185785&_gl=1*1bevvkq*_ga*MTI0NTYzMTc5MS4xNjgwMTg1Nzg1*_ga_SS72Z4HXJM*MTY4MTMwOTc1MC4yOS4xLjE2ODEzMDk5MzkuMjguMC4w). diff --git a/docs/tools/cli/workflow.md b/docs/tools/cli/workflow.md index b2b265b0eeca1..62d9f25e804a6 100644 --- a/docs/tools/cli/workflow.md +++ b/docs/tools/cli/workflow.md @@ -13,7 +13,7 @@ tags: ['CLI'] Learn how to use the SailPoint CLI to create, manage, and test workflows in this guide. -A workflow is a set of steps that are completed whenever a specific event occurs. Once that event triggers the workflow, the workflow performs the steps within SailPoint Human Fabric. +A workflow is a set of steps that are completed whenever a specific event occurs. Once that event triggers the workflow, the workflow performs the steps within SailPoint Identity Security. The `workflow` command makes it easy to create, manage, and test workflows from within the SailPoint CLI. To learn more about workflows, refer to [Workflows](https://documentation.sailpoint.com/saas/help/workflows/). diff --git a/docs/tools/colab/getting-started-with-rules.md b/docs/tools/colab/getting-started-with-rules.md index 662eac1e9c987..e195bb8b8c01f 100644 --- a/docs/tools/colab/getting-started-with-rules.md +++ b/docs/tools/colab/getting-started-with-rules.md @@ -4,19 +4,19 @@ title: Getting Started with Rules in CoLab pagination_label: Getting Started with Rules sidebar_label: Rules Guide sidebar_position: 11 -keywords: ['CoLab', 'Rules', 'SHF', 'Rule Development Kit'] -description: Learn how to use CoLab cloud and connector rules in SailPoint Human Fabric. +keywords: ['CoLab', 'Rules', 'SailPoint Identity Security', 'Rule Development Kit'] +description: Learn how to use CoLab cloud and connector rules in SailPoint Identity Security. slug: /tools/colab/getting-started-with-rules tags: ['CoLab'] --- -Use this category to view and download SailPoint Human Fabric (SHF) rules built by the community. +Use this category to view and download SailPoint Identity Security rules built by the community. :::warning -Update all rule inputs to match your SailPoint Human Fabric environment **before** uploading. +Update all rule inputs to match your SailPoint Identity Security environment **before** uploading. ::: -There are two types of rules in SHF: cloud rules and connector rules. The setup steps are slightly different. +There are two types of rules in SailPoint Identity Security: cloud rules and connector rules. The setup steps are slightly different. ## Cloud rules @@ -28,7 +28,7 @@ Follow these steps to download and use a cloud rule: 4. Review the rule documentation and replace required inputs to match your environment. 5. Test your rule logic with the Rule Development Kit. 6. Run the Rule Validator to validate syntax and usage. -7. Submit the cloud rule for upload to SailPoint Human Fabric. +7. Submit the cloud rule for upload to SailPoint Identity Security. ## Connector rules diff --git a/docs/tools/colab/getting-started-with-saas-connectors.md b/docs/tools/colab/getting-started-with-saas-connectors.md index ae16eca6a6686..48c47a2ec063e 100644 --- a/docs/tools/colab/getting-started-with-saas-connectors.md +++ b/docs/tools/colab/getting-started-with-saas-connectors.md @@ -10,7 +10,7 @@ slug: /tools/colab/getting-started-with-saas-connectors tags: ['CoLab'] --- -Use this guide to view and download SailPoint Human Fabric (SHF) SaaS Connectors built by the community. +Use this guide to view and download SailPoint Identity Security SaaS Connectors built by the community. ## Download the connector @@ -29,7 +29,7 @@ sail conn create "my-connector-name" sail conn upload -c "my-connector-name" -f path/to/your/download.zip ``` -Once the connector is uploaded, you can start using it in SailPoint Human Fabric. +Once the connector is uploaded, you can start using it in SailPoint Identity Security. ## Use the connector @@ -40,7 +40,7 @@ To use the connector you uploaded: 3. Select **Create New** and choose the connector. :::note -The connector name in SHF is **not** the name from `sail conn create`; it is the name set by the connector author. +The connector name in SailPoint Identity Security is **not** the name from `sail conn create`; it is the name set by the connector author. ::: 4. Select **Configure** and follow the instructions provided by the connector author. diff --git a/docs/tools/colab/getting-started-with-transforms.md b/docs/tools/colab/getting-started-with-transforms.md index 19eda250dff1c..bc403d4a91c08 100644 --- a/docs/tools/colab/getting-started-with-transforms.md +++ b/docs/tools/colab/getting-started-with-transforms.md @@ -4,16 +4,16 @@ title: Getting Started with Transforms in CoLab pagination_label: Getting Started with Transforms sidebar_label: Transforms Guide sidebar_position: 12 -keywords: ['CoLab', 'Transforms', 'SHF'] +keywords: ['CoLab', 'Transforms', 'SailPoint Identity Security'] description: Learn how to download, update, test, and upload CoLab transforms. slug: /tools/colab/getting-started-with-transforms tags: ['CoLab'] --- -Use this category to view and download SailPoint Human Fabric (SHF) transforms built by the community. +Use this category to view and download SailPoint Identity Security transforms built by the community. :::warning -You must update transform inputs to match your SailPoint Human Fabric environment **before** uploading. +You must update transform inputs to match your SailPoint Identity Security environment **before** uploading. ::: Follow these steps to download and use a transform: diff --git a/docs/tools/colab/getting-started-with-workflows.md b/docs/tools/colab/getting-started-with-workflows.md index 3e9a2d02a8de4..26ffb02c2bce4 100644 --- a/docs/tools/colab/getting-started-with-workflows.md +++ b/docs/tools/colab/getting-started-with-workflows.md @@ -4,13 +4,13 @@ title: Getting Started with Workflows in CoLab pagination_label: Getting Started with Workflows sidebar_label: Workflows Guide sidebar_position: 10 -keywords: ['CoLab', 'Workflows', 'SHF'] -description: Learn how to download and import CoLab workflows into SailPoint Human Fabric. +keywords: ['CoLab', 'Workflows', 'SailPoint Identity Security'] +description: Learn how to download and import CoLab workflows into SailPoint Identity Security. slug: /tools/colab/getting-started-with-workflows tags: ['CoLab'] --- -Use this category to view and download SailPoint Human Fabric (SHF) workflows built by the community. +Use this category to view and download SailPoint Identity Security workflows built by the community. Follow these steps to download a workflow from CoLab and start using it: diff --git a/docs/tools/escaping-tool-formatter/index.md b/docs/tools/escaping-tool-formatter/index.md index f1f9258be6f0b..7cc696756b25f 100644 --- a/docs/tools/escaping-tool-formatter/index.md +++ b/docs/tools/escaping-tool-formatter/index.md @@ -13,9 +13,9 @@ tags: ['tools'] ## Overview -The **Escaping Tool Formatter** (also known as the **Java/.NET String Escaper**) is a SailPoint-maintained tool that escapes and unescapes Java code so you can move rules between your editor and the SHF APIs without leaving the Developer Community. +The **Escaping Tool Formatter** (also known as the **Java/.NET String Escaper**) is a SailPoint-maintained tool that escapes and unescapes Java code so you can move rules between your editor and the SailPoint Identity Security APIs without leaving the Developer Community. -Rules in SailPoint Human Fabric (SHF) are typically written in Java (BeanShell). When you upload a rule through the API, the rule's source has to be embedded inside a JSON payload as a single string value. JSON strings can't contain raw line breaks, tabs, or unescaped quotation marks, so the code must first be **escaped** into a valid string. When you want to read or edit a rule you've pulled back down, you need to reverse the process and **unescape** it into readable code. +Rules in SailPoint Identity Security are typically written in Java (BeanShell). When you upload a rule through the API, the rule's source has to be embedded inside a JSON payload as a single string value. JSON strings can't contain raw line breaks, tabs, or unescaped quotation marks, so the code must first be **escaped** into a valid string. When you want to read or edit a rule you've pulled back down, you need to reverse the process and **unescape** it into readable code. This tool handles both directions for you, so you no longer need to rely on a third-party website to format your rules. @@ -23,12 +23,12 @@ This tool handles both directions for you, so you no longer need to rely on a th ## When to use it -- **Escape** your Java rule before uploading it in a JSON request body (for example, when creating or updating a rule through the [SHF APIs](/docs/api)). +- **Escape** your Java rule before uploading it in a JSON request body (for example, when creating or updating a rule through the [SailPoint Identity Security APIs](/docs/api)). - **Unescape** a rule you've retrieved from the API so you can read, review, or edit it as normal Java. - Format code for other tasks that require escaped strings, such as building custom rule reports or assembling large datasets for email attachments. :::tip Already using the VS Code extension? -The [SHF VS Code extension](https://marketplace.visualstudio.com/items?itemName=yannick-beot-sp.vscode-sailpoint-identitynow) escapes and unescapes rules automatically. Right-click a rule, choose **Edit Script**, make your changes, and save — the extension handles the formatting for you. The Escaping Tool Formatter is handy when you're working outside of VS Code or want a quick, one-off conversion. +The [SailPoint Identity Security VS Code extension](https://marketplace.visualstudio.com/items?itemName=yannick-beot-sp.vscode-sailpoint-identitynow) escapes and unescapes rules automatically. Right-click a rule, choose **Edit Script**, make your changes, and save — the extension handles the formatting for you. The Escaping Tool Formatter is handy when you're working outside of VS Code or want a quick, one-off conversion. ::: ## How to use it diff --git a/docs/tools/json-path-evaluator/index.md b/docs/tools/json-path-evaluator/index.md index 4b6f5690d2ba6..8bee10e07bf3d 100644 --- a/docs/tools/json-path-evaluator/index.md +++ b/docs/tools/json-path-evaluator/index.md @@ -6,7 +6,7 @@ sidebar_label: JSON Path Evaluator sidebar_position: 5 sidebar_class_name: tools keywords: ['tools', 'json', 'jsonpath', 'evaluator', 'workflows', 'event triggers'] -description: Test and validate JSONPath expressions for SHF workflows and event triggers. +description: Test and validate JSONPath expressions for SailPoint Identity Security workflows and event triggers. slug: /tools/json-path-evaluator tags: ['tools'] --- @@ -15,12 +15,12 @@ tags: ['tools'] The **JSON Path Evaluator** is a SailPoint-maintained tool that lets you test [JSONPath](https://goessner.net/articles/JsonPath/) expressions against a JSON document and see the matching results instantly. It gives you a seamless way to validate your expressions without relying on a third-party website. -JSONPath is used throughout SailPoint Human Fabric (SHF) to pull values out of JSON data. Two of the most common places you'll write JSONPath are: +JSONPath is used throughout SailPoint Identity Security to pull values out of JSON data. Two of the most common places you'll write JSONPath are: - **Workflows** — to reference data from a trigger or from earlier steps. - **[Event trigger filters](/docs/extensibility/event-triggers/filtering-events)** — to decide whether a trigger event should be delivered to your subscription. -Because these two features use different underlying JSONPath engines, an expression that works in one won't always behave the same in the other. The evaluator lets you choose which implementation to test against so you can validate your expression in the same way SHF will evaluate it. +Because these two features use different underlying JSONPath engines, an expression that works in one won't always behave the same in the other. The evaluator lets you choose which implementation to test against so you can validate your expression in the same way SailPoint Identity Security will evaluate it. [**Launch the JSON Path Evaluator →**](/tools/json-path-evaluator) diff --git a/docs/tools/rule-development-kit/index.md b/docs/tools/rule-development-kit/index.md index fd47df002ee39..4a90d21e48ea2 100644 --- a/docs/tools/rule-development-kit/index.md +++ b/docs/tools/rule-development-kit/index.md @@ -64,7 +64,7 @@ src/ - **`src/main/java/`** Use this folder to develop your rules before putting them into the rule XML format. Import objects as needed from `sailpoint.*` -- **`src/main/resources/rules/`** Use this folder to store your rules in the XML format you would expect to upload to SailPoint Human Fabric (SHF). +- **`src/main/resources/rules/`** Use this folder to store your rules in the XML format you would expect to upload to SailPoint Identity Security. - **`src/test/java/sailpoint/`** Use this folder for test classes to test your rules. @@ -88,7 +88,7 @@ The rule development kit provides you with intellisense when writing rules, you ## Create your new rule -To get syntax highlighting and the features from the IDE, this guide shows how to write the rule in native Java and move it over to the XML format needed when you're storing it in SailPoint Human Fabric (SHF). +To get syntax highlighting and the features from the IDE, this guide shows how to write the rule in native Java and move it over to the XML format needed when you're storing it in SailPoint Identity Security. This guide will walk through an example of how to duplicate writing the 'Username Generator' rule that ships with the RDK. @@ -531,7 +531,7 @@ Interpreter i = new Interpreter(); ### Mock the objects and return the mocked data -Anywhere your rule uses data from SHF, you will need to mock out those objects. In the 'Username Generator' example, the objects used are `IdnRuleUtil`, `Application`, and `Identity`. +Anywhere your rule uses data from SailPoint Identity Security, you will need to mock out those objects. In the 'Username Generator' example, the objects used are `IdnRuleUtil`, `Application`, and `Identity`. ```java IdnRuleUtil idn = mock(); diff --git a/docs/tools/sdk/angular/error-handling.md b/docs/tools/sdk/angular/error-handling.md index cc97ff77edecc..09adc5ad0830d 100644 --- a/docs/tools/sdk/angular/error-handling.md +++ b/docs/tools/sdk/angular/error-handling.md @@ -35,7 +35,7 @@ this.api.listTransformsV1({filters: 'id eq'}).subscribe({ | Field | Description | | --- | --- | | `status` | The HTTP status code, for example 400. | -| `error` | The parsed response body. An ISC error body holds `detailCode`, `trackingId`, `messages`, and `causes`. | +| `error` | The parsed response body. A SailPoint Identity Security error body holds `detailCode`, `trackingId`, `messages`, and `causes`. | | `headers` | The response headers. | | `url` | The URL of the failed request. | | `message` | A summary string that Angular builds for logging. | @@ -66,9 +66,11 @@ this.api The example recovers from a 400 response and re-raises every other error. Return `of([])` for every status code to make the request never fail. -## Read the error message from ISC + -The ISC APIs return a structured body on an error. Read `error.error.messages` to get the text: +## Read the error message from SailPoint Identity Security + +The SailPoint Identity Security APIs return a structured body on an error. Read `error.error.messages` to get the text: ```typescript error: (error: HttpErrorResponse) => { @@ -79,6 +81,6 @@ error: (error: HttpErrorResponse) => { }, ``` -`trackingId` identifies the failed request inside ISC. Include that value in a support case. +`trackingId` identifies the failed request inside SailPoint Identity Security. Include that value in a support case. For retry behavior on a 401, a 429, or a 5xx response, refer to [Retries](./retries.md). diff --git a/docs/tools/sdk/angular/getting-started.md b/docs/tools/sdk/angular/getting-started.md index eb7e5cff01b9f..3890e83ddb0ef 100644 --- a/docs/tools/sdk/angular/getting-started.md +++ b/docs/tools/sdk/angular/getting-started.md @@ -11,7 +11,7 @@ slug: /tools/sdk/angular/getting-started tags: ['SDK'] --- -Once your SDK is installed and configured, you can start calling the ISC APIs. To learn how to install and configure the Angular SDK, refer to [Installation and Configuration](./index.mdx). +Once your SDK is installed and configured, you can start calling the SailPoint Identity Security APIs. To learn how to install and configure the Angular SDK, refer to [Installation and Configuration](./index.mdx). This guide walks through some examples. diff --git a/docs/tools/sdk/angular/index.mdx b/docs/tools/sdk/angular/index.mdx index a4f834e5de20d..2db428b79f5bc 100644 --- a/docs/tools/sdk/angular/index.mdx +++ b/docs/tools/sdk/angular/index.mdx @@ -6,14 +6,14 @@ sidebar_label: Angular sidebar_position: 5 sidebar_class_name: angularsdk keywords: ['angular', 'typescript', 'sdk'] -description: Easy ISC development in Angular. +description: Easy SailPoint Identity Security development in Angular. slug: /tools/sdk/angular tags: ['SDK'] --- ## Overview -The Angular SDK is an Angular library for the Identity Security Cloud (ISC) APIs. Learn how to install and configure it in this guide. +The Angular SDK is an Angular library for the SailPoint Identity Security APIs. Learn how to install and configure it in this guide. Every API resource is an injectable Angular service, and every service method returns an RxJS `Observable`. The SDK also installs an HTTP interceptor that adds the base URL, attaches the access token, and retries failed requests for you. @@ -25,9 +25,9 @@ You need the following to use the Angular SDK: - **Angular 15 or later**. The SDK registers itself with the `provideSailPoint()` function, which uses the standalone provider APIs that Angular added in version 15. -- Your tenant name in ISC. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK uses this tenant name to build the base URL of your ISC instance. +- Your tenant name in SailPoint Identity Security. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK uses this tenant name to build the base URL of your SailPoint Identity Security instance. -- Credentials for your tenant. The SDK accepts either a personal access token (PAT) or an OAuth2 client ID and client secret. To learn how to create a PAT in ISC, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). +- Credentials for your tenant. The SDK accepts either a personal access token (PAT) or an OAuth2 client ID and client secret. To learn how to create a PAT in SailPoint Identity Security, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). :::warning A browser application cannot keep a secret. Anything you ship to the browser is readable by anyone who loads the page. Use a client secret only in a trusted context, such as a local development build or a SailPoint plugin. For a production web application, obtain a short-lived token from your own backend. Pass that token to the SDK with the `accessToken` function. Refer to [Provide a token per request](#provide-a-token-per-request). @@ -172,7 +172,7 @@ Before you contribute, you must sign our [CLA](https://cla-assistant.io/sailpoin ## 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, 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 SailPoint Identity Security platform and improve experiences across your organization. Use this guide to get started, and if you have questions, reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss. ## Getting started diff --git a/docs/tools/sdk/angular/search.md b/docs/tools/sdk/angular/search.md index 6ac1ddd8ef45b..94527ac792559 100644 --- a/docs/tools/sdk/angular/search.md +++ b/docs/tools/sdk/angular/search.md @@ -11,7 +11,7 @@ slug: /tools/sdk/angular/search tags: ['SDK'] --- -`SearchService` calls the ISC [search endpoint](/docs/api/search-post-v-1). Copy this component into your Angular project to try it out: +`SearchService` calls the SailPoint Identity Security [search endpoint](/docs/api/search-post-v-1). Copy this component into your Angular project to try it out: ```typescript title="src/app/search.component.ts" import {Component, inject} from '@angular/core'; diff --git a/docs/tools/sdk/go/index.mdx b/docs/tools/sdk/go/index.mdx index 9881afc90203e..7510320bf4560 100644 --- a/docs/tools/sdk/go/index.mdx +++ b/docs/tools/sdk/go/index.mdx @@ -6,12 +6,12 @@ sidebar_label: Golang sidebar_position: 2 sidebar_class_name: gosdk keywords: ['go', 'golang', 'sdk'] -description: Easy SHF development in Golang SDK. +description: Easy SailPoint Identity Security development in Golang SDK. slug: /tools/sdk/go tags: ['SDK', 'Software Development Kit'] --- -Read this guide to learn how to use the Go SDK. The Go SDK has some pre-built code examples you can use to learn how to build tools that can interact with IdentityNow. +Read this guide to learn how to use the Go SDK. The Go SDK has some pre-built code examples you can use to learn how to build tools that can interact with SailPoint Identity Security. ## Requirements @@ -19,9 +19,9 @@ You need the following to use the Go SDK: - Golang version 1.18 or above. You can download it [here](https://go.dev/dl/). You can use `go version` to check your version. -- Your tenant name in IdentityNow. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your SailPoint Human Fabric instance. +- Your tenant name in SailPoint Identity Security. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your SailPoint Identity Security instance. -- A PAT with a client secret and ID. To learn how to create one in SHF, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. +- A PAT with a client secret and ID. To learn how to create one in SailPoint Identity Security, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. ## Setup @@ -203,7 +203,7 @@ Before you contribute, you must sign our [CLA](https://cla-assistant.io/sailpoin ## Discuss -You can use this SDK to build new tools that extend your SHF 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 SailPoint Identity Security 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! ## Getting started diff --git a/docs/tools/sdk/go/search.md b/docs/tools/sdk/go/search.md index bb87a4c079172..717c17057d12d 100644 --- a/docs/tools/sdk/go/search.md +++ b/docs/tools/sdk/go/search.md @@ -11,7 +11,7 @@ slug: /tools/sdk/go/search tags: ['SDK', 'Software Development Kit'] --- -To try using the SHF [search functionality](/docs/api/search-post-v-1) along with pagination, create a file in your project called `sdk.go` with the following content: +To try using the SailPoint Identity Security [search functionality](/docs/api/search-post-v-1) along with pagination, create a file in your project called `sdk.go` with the following content: ```go package main diff --git a/docs/tools/sdk/index.md b/docs/tools/sdk/index.md index fdaf9aaba7b52..41d2585cff477 100644 --- a/docs/tools/sdk/index.md +++ b/docs/tools/sdk/index.md @@ -6,14 +6,14 @@ sidebar_label: SDKs sidebar_position: 2 sidebar_class_name: sdk keywords: ['sdk'] -description: Easy SHF development in your preferred coding language. +description: Easy SailPoint Identity Security development in your preferred coding language. slug: /tools/sdk tags: ['SDK'] --- ## Overview -The SailPoint software development kits (SDKs) make it easier for developers to leverage the SailPoint Human Fabric (SHF) APIs, extensibility options, and connectivity while they build with their preferred coding languages. +The SailPoint software development kits (SDKs) make it easier for developers to leverage the SailPoint Identity Security APIs, extensibility options, and connectivity while they build with their preferred coding languages. ```mdx-code-block import DocCardList from '@theme/DocCardList'; @@ -24,6 +24,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about the SHF 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 SailPoint Identity Security SDKs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6). diff --git a/docs/tools/sdk/powershell/index.mdx b/docs/tools/sdk/powershell/index.mdx index 4c0981c7360c1..8d5719f66bf33 100644 --- a/docs/tools/sdk/powershell/index.mdx +++ b/docs/tools/sdk/powershell/index.mdx @@ -6,12 +6,12 @@ sidebar_label: PowerShell sidebar_position: 3 sidebar_class_name: powershellsdk keywords: ['powershell', 'sdk'] -description: Easy SHF development in PowerShell. +description: Easy SailPoint Identity Security development in PowerShell. slug: /tools/sdk/powershell tags: ['SDK'] --- -Read this guide to learn how to use the PowerShell SDK. The PowerShell SDK has some pre-built code examples you can use to learn how to build tools that can interact with IdentityNow. +Read this guide to learn how to use the PowerShell SDK. The PowerShell SDK has some pre-built code examples you can use to learn how to build tools that can interact with SailPoint Identity Security. ## Requirements @@ -19,9 +19,9 @@ You need the following to use the PowerShell SDK: - PowerShell 6.2 or greater. To learn how to install, refer to [Installing PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4). -- Your tenant name in IdentityNow. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your SailPoint Human Fabric instance. +- Your tenant name in SailPoint Identity Security. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your SailPoint Identity Security instance. -- A PAT with a client secret and ID. To learn how to create one in SHF, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. +- A PAT with a client secret and ID. To learn how to create one in SailPoint Identity Security, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. ## Setup @@ -207,7 +207,7 @@ Before you contribute, you must sign our [CLA](https://cla-assistant.io/sailpoin ## Discuss -You can use this SDK to build new tools that extend your SHF 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 SailPoint Identity Security 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! ## Getting started diff --git a/docs/tools/sdk/powershell/search.md b/docs/tools/sdk/powershell/search.md index 48e26ece45c70..3c254c213e7f9 100644 --- a/docs/tools/sdk/powershell/search.md +++ b/docs/tools/sdk/powershell/search.md @@ -11,7 +11,7 @@ slug: /tools/sdk/powershell/search tags: ['SDK'] --- -The PowerShell SDK provides you access to SailPoint Human Fabric's [Search](https://documentation.sailpoint.com/saas/help/search/index.html) functionality. +The PowerShell SDK provides you access to SailPoint Identity Security's [Search](https://documentation.sailpoint.com/saas/help/search/index.html) functionality. Here is an example search you can copy into your PowerShell instance to try it out: @@ -79,7 +79,7 @@ try { } ``` -This example searches your SailPoint Human Fabric tenant for all identities and sorts them by their `displayName` in descending order. The search returns a maximum of 150000 records (the `Limit`) and 5000 records per page (the `Increment`). +This example searches your SailPoint Identity Security tenant for all identities and sorts them by their `displayName` in descending order. The search returns a maximum of 150000 records (the `Limit`) and 5000 records per page (the `Increment`). To paginate the search results, you can specify these parameters: diff --git a/docs/tools/sdk/python/getting-started.md b/docs/tools/sdk/python/getting-started.md index 2fab8445ebf78..82f20c9dcb7f0 100644 --- a/docs/tools/sdk/python/getting-started.md +++ b/docs/tools/sdk/python/getting-started.md @@ -15,7 +15,7 @@ Once your SDK is installed and configured, you can start accessing the SDK's dif ## List transforms -One of the most useful functionalities of the Python SDK is the ability to easily access all the [SailPoint Human Fabric APIs](/docs/api) and implement them in your project. +One of the most useful functionalities of the Python SDK is the ability to easily access all the [SailPoint Identity Security APIs](/docs/api) and implement them in your project. The SDK is organized by API resource rather than by API version. Each API class (for example, `TransformsApi`) is imported directly from the top-level `sailpoint` package, and each method is suffixed with the version of the endpoint it calls (for example, `list_transforms_v1` calls the `v1` version of the List Transforms endpoint). This lets a single SDK access every version of every endpoint without having to import a separate version package. diff --git a/docs/tools/sdk/python/index.mdx b/docs/tools/sdk/python/index.mdx index c8979eb7d4db8..73b1e6e08b7e6 100644 --- a/docs/tools/sdk/python/index.mdx +++ b/docs/tools/sdk/python/index.mdx @@ -11,7 +11,7 @@ slug: /tools/sdk/python tags: ['SDK', 'Software Development Kit'] --- -Read this guide to learn how to use the Python SDK. The Python SDK has some pre-built code examples you can use to learn how to build tools that can interact with SailPoint Human Fabric. +Read this guide to learn how to use the Python SDK. The Python SDK has some pre-built code examples you can use to learn how to build tools that can interact with SailPoint Identity Security. ## Requirements @@ -19,9 +19,9 @@ You need the following to use the Python SDK: - Python version 3.7 or above. You can download it [here](https://www.python.org/downloads/). You can use `python --version` to check your version. -- Your tenant name in SailPoint Human Fabric. To learn how to find it, refer to [Getting Started](/docs/api/getting-started.md#find-your-tenant-name). The SDK will use this tenant name to connect to your SailPoint Human Fabric instance. +- Your tenant name in SailPoint Identity Security. To learn how to find it, refer to [Getting Started](/docs/api/getting-started.md#find-your-tenant-name). The SDK will use this tenant name to connect to your SailPoint Identity Security instance. -- A PAT with a client secret and ID. To learn how to create one in SailPoint Human Fabric, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. +- A PAT with a client secret and ID. To learn how to create one in SailPoint Identity Security, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. ## Setup @@ -200,7 +200,7 @@ Before you contribute, you must sign our [CLA](https://cla-assistant.io/sailpoin ## Discuss -You can use this SDK to build new tools that extend your SailPoint Human Fabric 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 SailPoint Identity Security 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! ## Getting started diff --git a/docs/tools/sdk/python/search.md b/docs/tools/sdk/python/search.md index 40ab25e8f2e36..ab808751343e4 100644 --- a/docs/tools/sdk/python/search.md +++ b/docs/tools/sdk/python/search.md @@ -11,7 +11,7 @@ slug: /tools/sdk/python/search tags: ['SDK'] --- -One of the most useful functionalities you can access with the Python SDK is SailPoint Human Fabric's [search functionality](/docs/api/search-post-v-1). +One of the most useful functionalities you can access with the Python SDK is SailPoint Identity Security's [search functionality](/docs/api/search-post-v-1). Here is an example of how you can implement Search, along with pagination. Copy this code into your "sdk.py" file to try it out: diff --git a/docs/tools/sdk/typescript/index.mdx b/docs/tools/sdk/typescript/index.mdx index be71085327b18..edb336f1912f0 100644 --- a/docs/tools/sdk/typescript/index.mdx +++ b/docs/tools/sdk/typescript/index.mdx @@ -6,7 +6,7 @@ sidebar_label: TypeScript sidebar_position: 4 sidebar_class_name: typescriptsdk keywords: ['tsc', 'typescript', 'sdk'] -description: Easy SHF development in TypeScript. +description: Easy SailPoint Identity Security development in TypeScript. slug: /tools/sdk/typescript tags: ['SDK'] --- @@ -27,9 +27,9 @@ You need the following to use the TypeScript SDK: npm install -g typescript ``` -- Your tenant name in SHF. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your SHF instance. +- Your tenant name in SailPoint Identity Security. To learn how to find it, refer to [Getting Started](/docs/api/getting-started#find-your-tenant-name). The SDK will use this tenant name to connect to your SailPoint Identity Security instance. -- A PAT with a client secret and ID. To learn how to create one in SHF, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. +- A PAT with a client secret and ID. To learn how to create one in SailPoint Identity Security, refer to [Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html#generating-a-personal-access-token). The SDK will use this PAT to authenticate with the SailPoint APIs. ## Setup @@ -243,7 +243,7 @@ Before you contribute, you must sign our [CLA](https://cla-assistant.io/sailpoin ## Discuss -You can use this SDK to build new tools that extend your SHF 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 SailPoint Identity Security 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! ## Getting started diff --git a/docs/tools/sdk/typescript/search.md b/docs/tools/sdk/typescript/search.md index 614a0a426920b..e276739566264 100644 --- a/docs/tools/sdk/typescript/search.md +++ b/docs/tools/sdk/typescript/search.md @@ -11,7 +11,7 @@ slug: /tools/sdk/typescript/search tags: ['SDK'] --- -To try using the SHF [search functionality](/docs/api/search-post-v-1) along with pagination, copy this code into your "index.ts" file: +To try using the SailPoint Identity Security [search functionality](/docs/api/search-post-v-1) along with pagination, copy this code into your "index.ts" file: ```typescript import {Configuration, SearchApi, Paginator} from 'sailpoint-api-client'; diff --git a/docs/tools/ui-development-kit/accounts-list.mdx b/docs/tools/ui-development-kit/accounts-list.mdx index 779ce231b4eaa..2e49085a4a28e 100644 --- a/docs/tools/ui-development-kit/accounts-list.mdx +++ b/docs/tools/ui-development-kit/accounts-list.mdx @@ -1011,6 +1011,6 @@ To learn more about handling errors in your UI, refer to [Error Handling](./erro ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about the SHF 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 SailPoint Identity Security 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 diff --git a/docs/tools/ui-development-kit/components.md b/docs/tools/ui-development-kit/components.md index 70b754d9d7211..e566bf13ac863 100644 --- a/docs/tools/ui-development-kit/components.md +++ b/docs/tools/ui-development-kit/components.md @@ -17,9 +17,9 @@ The new UI Development Kit is ALSO the Community Toolbox! You can download the T ## Overview -The SailPoint UI Development Kit is a project you can use to develop custom user interfaces that interact with SailPoint Human Fabric (SHF). +The SailPoint UI Development Kit is a project you can use to develop custom user interfaces that interact with SailPoint Identity Security. -The UI Development Kit provides you with a framework you can use to build your own applications or processes on the SHF platform. +The UI Development Kit provides you with a framework you can use to build your own applications or processes on the SailPoint Identity Security platform. This document provides an overview of the main components in the UI Development Kit. diff --git a/docs/tools/ui-development-kit/error-handling.md b/docs/tools/ui-development-kit/error-handling.md index 6bd0e6bd58fae..35459daf7a555 100644 --- a/docs/tools/ui-development-kit/error-handling.md +++ b/docs/tools/ui-development-kit/error-handling.md @@ -63,6 +63,6 @@ When running the built app locally, you can retrieve details logging from the ap ## Discuss -The most valuable resource for SHF developers is the SailPoint Developer Community itself, where SHF users and experts all over the world come together to ask questions and provide solutions. +The most valuable resource for SailPoint Identity Security developers is the SailPoint Developer Community itself, where users and experts all over the world come together to ask questions and provide solutions. -To learn more about the SHF 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 SailPoint Identity Security 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). diff --git a/docs/tools/ui-development-kit/getting-started.mdx b/docs/tools/ui-development-kit/getting-started.mdx index 5f15b07edf45f..42f2cd3b7663a 100644 --- a/docs/tools/ui-development-kit/getting-started.mdx +++ b/docs/tools/ui-development-kit/getting-started.mdx @@ -37,12 +37,12 @@ To create a brand new environment, select the "Create new environment" option in You will be prompted to enter the following information: - **Environment name**: The user friendly name of the environment you want to create. -- **Tenant name**: The name of your SailPoint Human Fabric tenant. This is used to connect to your SHF instance. -- **Tenant URL**: The web URL used to access your SailPoint Human Fabric tenant (ex. https://tenant.identitynow.com). This is used during the OAuth process. -- **API URL**: The API URL used to access your SailPoint Human Fabric tenant (ex. https://tenant.api.identitynow.com). This is used for the API calls made by certain commands. +- **Tenant name**: The name of your SailPoint Identity Security tenant. This is used to connect to your SailPoint Identity Security instance. +- **Tenant URL**: The web URL used to access your SailPoint Identity Security tenant (ex. https://tenant.identitynow.com). This is used during the OAuth process. +- **API URL**: The API URL used to access your SailPoint Identity Security tenant (ex. https://tenant.api.identitynow.com). This is used for the API calls made by certain commands. - **Authentication method**: The authentication method you want to use for this environment. You can choose between OAuth and Personal Access Token (PAT). -- **Client ID**: The client ID of your PAT. This is used to authenticate your requests to the SailPoint Human Fabric API. -- **Client Secret**: The client secret of your PAT. This is used to authenticate your requests to the SailPoint Human Fabric API. +- **Client ID**: The client ID of your PAT. This is used to authenticate your requests to the SailPoint Identity Security API. +- **Client Secret**: The client secret of your PAT. This is used to authenticate your requests to the SailPoint Identity Security API. ## Enable shared components from the component selector @@ -69,6 +69,6 @@ To create a new component, you can use the `npm run generate:component -`link` registers your running dev server with the plugin instance as a **per-developer override**. It binds your dev server port to your own identity, so ISC loads your local code only for you — it does not affect the deployed plugin or other developers. +## Step 5: Load your local code in SailPoint Identity Security with `link` + +`link` registers your running dev server with the plugin instance as a **per-developer override**. It binds your dev server port to your own identity, so SailPoint Identity Security loads your local code only for you — it does not affect the deployed plugin or other developers. ```bash sail ui-plugins link @@ -142,33 +144,33 @@ sail ui-plugins link ```text Plugin test-plugin linked to port 4200 -To load your local plugin in ISC navigate to: +To load your local plugin in SailPoint Identity Security navigate to: https:///ui/plugin/033b32b5-280f-4d78-a856-05c2a34d15d1?spPluginDev=test-plugin ``` -Open the printed URL in your browser. ISC's plugin renderer verifies the override and, if you are authorized, loads your local code live in the tenant with a **Local Dev** badge. Because your dev server is still running, changes you make locally appear when you refresh. +Open the printed URL in your browser. SailPoint Identity Security's plugin renderer verifies the override and, if you are authorized, loads your local code live in the tenant with a **Local Dev** badge. Because your dev server is still running, changes you make locally appear when you refresh. -![The starter plugin loaded inside ISC with the Local Dev badge](./img/link-local-dev-badge.png) +![The starter plugin loaded inside SailPoint Identity Security with the Local Dev badge](./img/link-local-dev-badge.png) :::caution Can't reach your local plugin server? -If ISC shows a "Can't reach your local plugin server" page, your dev server either isn't running or is serving over a self-signed certificate your browser hasn't accepted yet. +If SailPoint Identity Security shows a "Can't reach your local plugin server" page, your dev server either isn't running or is serving over a self-signed certificate your browser hasn't accepted yet. -![The ISC error shown when the local plugin server can't be reached](./img/link-cant-reach-local-server.png) +![The SailPoint Identity Security error shown when the local plugin server can't be reached](./img/link-cant-reach-local-server.png) Make sure `npm run start` is running, then open the dev server address (for example, `https://localhost:4200`) in a new browser tab and accept the certificate warning — the browser will flag it as **Not Secure**, which is expected for local development. ![Accepting the self-signed certificate warning for the local dev server](./img/link-accept-self-signed-cert.png) -Once the certificate is accepted, return to the ISC tab and select **Retry**. +Once the certificate is accepted, return to the SailPoint Identity Security tab and select **Retry**. -If ISC still cannot load your plugin, read the next note about the Chrome local network permission. +If SailPoint Identity Security still cannot load your plugin, read the next note about the Chrome local network permission. ::: :::caution Chrome blocked the local network -Chrome can block ISC from reaching `localhost` even when your dev server runs and you already accepted the certificate. The browser console shows an error like this one: +Chrome can block SailPoint Identity Security from reaching `localhost` even when your dev server runs and you already accepted the certificate. The browser console shows an error like this one: ```text Access to fetch at 'https://localhost:4200/' from origin 'https://.identitynow.com' has been blocked by CORS policy: Permission was denied for this request to access the `loopback` address space. @@ -180,19 +182,19 @@ Chrome asks for permission the first time a page connects to the local network. 2. Search for your tenant domain, for example `identitynow.com`, then select it. 3. Set **Local Network** to **Allow**. 4. Set **Apps on Device** to **Allow**. -5. Reload the ISC plugin page. +5. Reload the SailPoint Identity Security plugin page. Other browsers can apply similar restrictions to loopback addresses. If your browser is not Chrome, look for a local network or private network permission for your tenant domain. ::: -The port is resolved in this order: the `--port` flag, then `build.port` from the manifest, then the default (`4200`). To point ISC at a different port, pass `--port`: +The port is resolved in this order: the `--port` flag, then `build.port` from the manifest, then the default (`4200`). To point SailPoint Identity Security at a different port, pass `--port`: ```bash sail ui-plugins link --port 4300 ``` -When you are done developing locally, remove the override so ISC goes back to serving the deployed plugin: +When you are done developing locally, remove the override so SailPoint Identity Security goes back to serving the deployed plugin: ```bash sail ui-plugins unlink @@ -230,9 +232,9 @@ The plugin can be viewed at: https:///ui/plugin/033b32b5-280f-4d78-a856-05c2a34d15d1 ``` -The uploaded assets become the plugin instance's **active asset bundle**, hosted immutably behind the CDN. Open the printed URL to see the deployed plugin — note that it renders without the **Local Dev** badge, because ISC is now serving the uploaded assets rather than your local dev server. +The uploaded assets become the plugin instance's **active asset bundle**, hosted immutably behind the CDN. Open the printed URL to see the deployed plugin — note that it renders without the **Local Dev** badge, because SailPoint Identity Security is now serving the uploaded assets rather than your local dev server. -![The deployed plugin rendered in ISC, served from the uploaded asset bundle](./img/upload-deployed-plugin.png) +![The deployed plugin rendered in SailPoint Identity Security, served from the uploaded asset bundle](./img/upload-deployed-plugin.png) :::caution Build before you upload @@ -254,7 +256,7 @@ The workspace `alias` is the deterministic lookup key for the plugin instance, s ## Step 7: Add the plugin to the nav bar -After you upload the plugin, users can open it only from its URL. A nav bar item gives the plugin a permanent place in ISC, next to the standard menus. +After you upload the plugin, users can open it only from its URL. A nav bar item gives the plugin a permanent place in SailPoint Identity Security, next to the standard menus. 1. In your tenant, go to **Admin → Global → System Settings → Customize Navbar**. 2. Open **Custom Item**, and select the **Enabled** checkbox. @@ -272,7 +274,7 @@ After you upload the plugin, users can open it only from its URL. A nav bar item 9. Click **Save**. -Refresh your tenant. The nav bar shows the **Test Plugin** menu, and the menu contains **Test Plugin Page**. Click the item to open your plugin inside ISC. +Refresh your tenant. The nav bar shows the **Test Plugin** menu, and the menu contains **Test Plugin Page**. Click the item to open your plugin inside SailPoint Identity Security. ## Manage your plugins diff --git a/docusaurus.config.minified.ts b/docusaurus.config.minified.ts index d4f980a250793..af27df45dc7fa 100644 --- a/docusaurus.config.minified.ts +++ b/docusaurus.config.minified.ts @@ -1,12 +1,12 @@ -// Minified Docusaurus config — builds only docs/api/v* (SHF API) for faster iteration in PRs. +// Minified Docusaurus config — builds only docs/api/v* (SailPoint Identity Security API) for faster iteration in PRs. // Run with: npm run start-minified or npm run build-minified // // Key differences from the main config: // - onBrokenLinks/onBrokenMarkdownLinks set to 'warn' (api docs may link to non-api pages) -// - Uses sidebars.minified.ts (SHF API sidebars only) +// - Uses sidebars.minified.ts (SailPoint Identity Security API sidebars only) // - Docs plugin excludes all non-API directories // - Plugins imported from plugins.ts with iiq-api, nerm-api, GTM, and redirects filtered out -// - Simplified navbar with only SHF API-spec link +// - Simplified navbar with only SailPoint Identity Security API-spec link import { ThemeConfig } from '@docusaurus/preset-classic'; import { Config } from '@docusaurus/types'; @@ -17,7 +17,7 @@ import allPlugins from './plugins'; const lightCodeTheme = themes.github; const darkCodeTheme = themes.dracula; -// Exclude plugins that are not needed for the SHF API-only minified build. +// Exclude plugins that are not needed for the SailPoint Identity Security API-only minified build. const EXCLUDED_PLUGIN_NAMES = new Set([ '@docusaurus/plugin-google-tag-manager', '@docusaurus/plugin-client-redirects', @@ -98,7 +98,7 @@ const config: Config = { 'api/iiq/**', 'api/nerm/**', // Community policy pages use the communityPoliciesSidebar, which is - // not part of the SHF API-only minified build. + // not part of the SailPoint Identity Security API-only minified build. 'ai-policy.md', 'ambassador-agreement.md', 'ambassador-code-of-conduct.md', @@ -150,7 +150,7 @@ const config: Config = { label: 'API specifications', position: 'left', items: [ - { label: 'SailPoint Human Fabric', to: '/docs/api' }, + { label: 'SailPoint Identity Security', to: '/docs/api' }, ], }, { diff --git a/footer.ts b/footer.ts index 19fd88aaf0fd6..204ec88bf4a37 100644 --- a/footer.ts +++ b/footer.ts @@ -2,7 +2,7 @@ const footerConfig = { style: 'light', links: [ { - title: 'SailPoint Human Fabric', + title: 'SailPoint Identity Security', items: [ { label: 'Your first API call', to: 'docs/api/getting-started' }, { label: 'Build a transform', to: 'docs/extensibility/transforms/guides/your-first-transform' }, diff --git a/navbar.ts b/navbar.ts index 6a67859fffc19..6e9c56967bb81 100644 --- a/navbar.ts +++ b/navbar.ts @@ -12,8 +12,8 @@ const navbarConfig = { position: 'left', groups: [ { - label: 'SailPoint Human Fabric', - description: 'Guides and references for building on SHF.', + label: 'SailPoint Identity Security', + description: 'Guides and references for building on the platform.', items: [ { label: 'Overview', to: '/docs' }, { label: 'Extensibility', to: '/docs/extensibility' }, @@ -39,14 +39,14 @@ const navbarConfig = { position: 'left', groups: [ { - label: 'SailPoint Human Fabric', + label: 'SailPoint Identity Security', description: 'API specifications and getting-started essentials.', items: [ { label: 'Getting Started', to: '/docs/api/getting-started' }, { label: 'Authentication', to: '/docs/api/authentication' }, { label: 'Authorization', to: '/docs/api/authorization' }, { label: 'Postman Collections', to: '/docs/api/postman-collections' }, - { label: 'SHF API Specifications', to: '/docs/api' }, + { label: 'SailPoint Identity Security API Specifications', to: '/docs/api' }, { label: 'NERM API Specifications', to: '/docs/api/nerm/v1' }, { label: 'Legacy Specifications', to: '/apis/legacy' }, diff --git a/plugins.ts b/plugins.ts index ad19839fe31d2..feab7f43f9e42 100644 --- a/plugins.ts +++ b/plugins.ts @@ -31,7 +31,7 @@ const pluginConfig = [ '@writechoice/docusaurus-plugin-llms-txt', { description: - 'Documentation, API references, SDKs, and guides for building on SailPoint Identity Security Cloud, IdentityIQ, and Non-Employee Risk Management.', + 'Documentation, API references, SDKs, and guides for building on SailPoint Identity Security, IdentityIQ, and Non-Employee Risk Management.', }, ], [ diff --git a/scripts/generate-legacy-api-docs.sh b/scripts/generate-legacy-api-docs.sh index fd4c4d1ed7532..6104d982d15bc 100755 --- a/scripts/generate-legacy-api-docs.sh +++ b/scripts/generate-legacy-api-docs.sh @@ -66,11 +66,11 @@ bundle() { echo " Done: sailpoint-api-${key}-light.html + sailpoint-api-${key}-dark.html" } -bundle "beta" "SailPoint ISC API (Beta)" -bundle "v3" "SailPoint ISC API (V3)" -bundle "v2024" "SailPoint ISC API (V2024)" -bundle "v2025" "SailPoint ISC API (V2025)" -bundle "v2026" "SailPoint ISC API (V2026)" +bundle "beta" "SailPoint Identity Security API (Beta)" +bundle "v3" "SailPoint Identity Security API (V3)" +bundle "v2024" "SailPoint Identity Security API (V2024)" +bundle "v2025" "SailPoint Identity Security API (V2025)" +bundle "v2026" "SailPoint Identity Security API (V2026)" echo "" echo "All legacy API docs generated in $OUT_DIR" diff --git a/sidebars.minified.ts b/sidebars.minified.ts index bced5b3ddeacb..028715349aee0 100644 --- a/sidebars.minified.ts +++ b/sidebars.minified.ts @@ -1,9 +1,9 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; -// Minified sidebar config — only includes SHF API sidebars. +// Minified sidebar config — only includes SailPoint Identity Security API sidebars. // openApiSidebar, iiqSideBar, iiqApiSideBar, nermSideBar, and nerm_2025_sidebar -// are intentionally omitted to keep the minified build focused on SHF API docs only. +// are intentionally omitted to keep the minified build focused on SailPoint Identity Security API docs only. const sidebars: SidebarsConfig = { isc_api_sidebar: [ { @@ -45,7 +45,7 @@ const sidebars: SidebarsConfig = { type: 'generated-index', title: 'SailPoint APIs', description: - 'Use these APIs to interact with the SailPoint Human Fabric 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 SailPoint Identity Security 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.', slug: '/api', }, items: require('./docs/api/sidebar.ts'), diff --git a/sidebars.ts b/sidebars.ts index 13dfb4e715ad4..6d0fda90b48ae 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -234,7 +234,7 @@ const sidebars: SidebarsConfig = { type: 'generated-index', title: 'API Specifications', description: - 'Use these APIs to interact with the SailPoint Human Fabric 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 SailPoint Identity Security 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.', slug: '/api', }, items: require('./docs/api/sidebar.ts'), diff --git a/src/components/blog/BlogCards/index.tsx b/src/components/blog/BlogCards/index.tsx index 47644cb3d56f4..9c00516b7e5c9 100644 --- a/src/components/blog/BlogCards/index.tsx +++ b/src/components/blog/BlogCards/index.tsx @@ -5,7 +5,7 @@ import NewtonsCradle from '../../newtonsCradle'; import { discourseBaseURL, developerWebsiteDomain, - SHF_PRODUCT_TAG, + PRODUCT_TAG, } from '../../../util/util'; import { getBlogPosts, getUserTitle } from '../../../services/DiscourseService'; @@ -38,7 +38,7 @@ const BlogCards: React.FC = ({ filterCallback, limit, featured } const [loadingCards, setLoadingCards] = useState(true); const getPosts = async () => { - let filters = filterCallback ?? [SHF_PRODUCT_TAG]; + let filters = filterCallback ?? [PRODUCT_TAG]; if (featured) filters = ['featured']; const data = await getBlogPosts(filters); diff --git a/src/components/blog/BlogSidebar/index.tsx b/src/components/blog/BlogSidebar/index.tsx index a6b5929440e1c..9f6e42aa70ca9 100644 --- a/src/components/blog/BlogSidebar/index.tsx +++ b/src/components/blog/BlogSidebar/index.tsx @@ -1,7 +1,7 @@ import React, { useState, useEffect } from 'react'; import styles from './styles.module.css'; import { getTags } from '../../../services/DiscourseService'; -import { SHF_PRODUCT_TAG } from '../../../util/util'; +import { PRODUCT_TAG } from '../../../util/util'; // Define props interface interface BlogSidebarProps { @@ -16,7 +16,7 @@ const BlogSidebar: React.FC = ({ filterCallback, defaultValue const handleChange = () => { setIsChecked(!isChecked); - const value = isChecked ? SHF_PRODUCT_TAG : 'Identityiq'; + const value = isChecked ? PRODUCT_TAG : 'Identityiq'; filterCallback(value); }; @@ -51,7 +51,7 @@ const BlogSidebar: React.FC = ({ filterCallback, defaultValue />
diff --git a/src/components/blog/BlogSidebar/styles.module.css b/src/components/blog/BlogSidebar/styles.module.css index 368c33ea7accb..b7c22c8ae43d8 100644 --- a/src/components/blog/BlogSidebar/styles.module.css +++ b/src/components/blog/BlogSidebar/styles.module.css @@ -187,7 +187,7 @@ top: 0; bottom: 0; width: 50%; - background-color: #cc27b0; /* Default color for "SailPoint Human Fabric" */ + background-color: #cc27b0; /* Default color for "SailPoint Identity Security" */ border-radius: 25px; transition: transform 0.25s ease, @@ -206,7 +206,7 @@ text-align: center; z-index: 1; transition: color 0.25s; - color: white; /* "SailPoint Human Fabric" highlighted */ + color: white; /* "SailPoint Identity Security" highlighted */ } .toggleCheckbox:not(:checked) + .toggleLabel .toggleTextRight { @@ -230,7 +230,7 @@ text-align: center; z-index: 1; transition: color 0.25s; - color: #415364; /* "SailPoint Human Fabric" not highlighted */ + color: #415364; /* "SailPoint Identity Security" not highlighted */ } @media only screen and (max-width: 550px) { diff --git a/src/components/homepage/DiscussCard/index.tsx b/src/components/homepage/DiscussCard/index.tsx index b46e31fe8435d..e6a753c66b68e 100644 --- a/src/components/homepage/DiscussCard/index.tsx +++ b/src/components/homepage/DiscussCard/index.tsx @@ -17,40 +17,33 @@ interface DiscussCardProps { } const DiscussCard: React.FC = ({ link, title, tags, views, liked, solution }) => { - let solved = ( - Discussion - ); - let linkText =
Join the Discussion
; - - if (solution) { - solved = ; - linkText =
View the Solution
; - } - return (
- - - - Liked - {solved} +
+ +
+ {solution && ( + + )} + + Liked + {liked} + + + + {views} + +
+
+
{title}
-
{views}
-
{liked}
- {linkText}
{tags?.slice(0, 3).map((tag) => ( @@ -59,6 +52,19 @@ const DiscussCard: React.FC = ({ link, title, tags, views, lik
))}
+ +
+
+ {solution ? 'View the Solution' : 'Join the Discussion'} +
+ +
); diff --git a/src/components/homepage/DiscussCard/styles.module.css b/src/components/homepage/DiscussCard/styles.module.css index ed3ad40541daa..a6628f79ca399 100644 --- a/src/components/homepage/DiscussCard/styles.module.css +++ b/src/components/homepage/DiscussCard/styles.module.css @@ -1,8 +1,11 @@ /* Getting Started Card */ .card { position: relative; + display: flex; + flex-direction: column; margin-top: 20px; height: 300px; + padding: 22px; /* UI Properties */ opacity: 1; transition: all 0.3s; @@ -28,100 +31,61 @@ box-shadow: var(--dev-card-selected); } -.cardText { - position: absolute; - margin: 22px; - font-size: 16px; - font-weight: 500; - min-width: 170px; - top: 35px; - left: 0; -} - -.linkText { - position: absolute; - margin: 15px 45px 15px 25px; - font-size: 18px; - font-weight: 700; - bottom: 22px; - left: -19; - color: var(--ifm-color-primary); -} - -.linkSolvedText { - position: absolute; - margin: 15px 45px; - font-size: 18px; - font-weight: 700; - bottom: 22px; - left: -19px; - color: var(--ifm-color-primary); +.cardHeader { + display: flex; + align-items: center; + justify-content: space-between; + gap: 12px; } .cardIcon { - position: absolute; - margin: 20px; - top: 20px; - left: 0; width: 20px; } -.cardArrow { - position: absolute; - margin: 20px; - bottom: 20px; - right: 0; - width: 20px; +.cardStats { + display: flex; + align-items: center; + gap: 14px; + font-size: 15px; + white-space: nowrap; } -.cardViews { - position: absolute; - margin: 15px; - right: 0px; - top: 0; - width: 30px; +.cardStat { + display: inline-flex; + align-items: center; + gap: 5px; } -.cardLikes { - position: absolute; - margin: 15px; - right: 45px; - top: 0; - width: 30px; +.cardLiked { + width: 18px; } -.cardSolved { - position: absolute; - margin: 0px; - right: 132px; - top: 18px; - width: 20px; - color: var(--ifm-color-primary); +.cardEye { + width: 18px; } -.cardDiscuss { - display: none; - position: absolute; - margin: 0px; - left: 12px; - bottom: 57px; - width: 28px; +.cardSolved { + color: var(--ifm-color-primary); } -.cardEye { - position: absolute; - margin: 20px; - right: 28px; - top: -3px; - width: 22px; +/* Long titles stop after four lines so they never push into the tags. */ +.cardText { + display: -webkit-box; + margin-top: 14px; + overflow: hidden; + font-size: 16px; + font-weight: 500; + line-height: 1.6; + -webkit-box-orient: vertical; + -webkit-line-clamp: 4; } -.cardLiked { - position: absolute; - margin: 16px; - right: 75px; - top: 0; - width: 22px; +.tags { + display: flex; + flex-direction: column; + gap: 3px; + margin-top: auto; + padding-top: 12px; } .tag { @@ -130,15 +94,21 @@ color: var(--dev-secondary-text); } -.tags { - grid-gap: 3px; - bottom: 50px; - display: grid; - position: absolute; - padding: -4%; - margin-top: 5%; - margin-bottom: 6%; - margin-left: 8%; +.cardFooter { + display: flex; + align-items: center; + justify-content: space-between; + margin-top: 14px; +} + +.linkText { + font-size: 18px; + font-weight: 700; + color: var(--ifm-color-primary); +} + +.cardArrow { + width: 20px; } .idn { diff --git a/src/components/homepage/HomepageCard/index.tsx b/src/components/homepage/HomepageCard/index.tsx index 07508534dab19..9d17613a6ea17 100644 --- a/src/components/homepage/HomepageCard/index.tsx +++ b/src/components/homepage/HomepageCard/index.tsx @@ -9,14 +9,11 @@ export interface HomepageCardProps { link: string; title: string; image?: string; - product: 'shf' | 'iiq'; } -const HomepageCard: React.FC = ({ link, title, image, product }) => { - const productStyles = product === 'shf' ? styles.shf : styles.iiq; - +const HomepageCard: React.FC = ({ link, title, image }) => { return ( - +
{image && ( = ({ link, title, image, product }} /> )} -
{product}
{title}
{image && (
diff --git a/src/components/homepage/HomepageTrainingGuides/index.tsx b/src/components/homepage/HomepageTrainingGuides/index.tsx index 4ae3da0ffc908..5fd76cbdaccbc 100644 --- a/src/components/homepage/HomepageTrainingGuides/index.tsx +++ b/src/components/homepage/HomepageTrainingGuides/index.tsx @@ -3,10 +3,8 @@ import clsx from 'clsx'; import styles from './styles.module.css'; import Link from '@docusaurus/Link'; import HomepageCard from '../HomepageCard'; -import { HomepageCardProps } from '../HomepageCard'; interface TrainingGuide { - product: HomepageCardProps['product']; link: string; title: string; image: string; @@ -15,27 +13,23 @@ interface TrainingGuide { const trainingGuides: TrainingGuide[] = [ { - product: 'shf', link: '/docs/api/getting-started', title: 'Make your first API call', image: '/homepage/cloud-data.svg', }, { - product: 'shf', link: '/docs/extensibility/transforms/guides/your-first-transform', title: 'Build a Transform', image: '/homepage/process.svg', }, { - product: 'shf', link: '/docs/connectivity/saas-connectivity', title: 'Build a SaaS Connector', image: '/homepage/connectivity.svg', }, { - product: 'iiq', link: 'https://documentation.sailpoint.com/identityiq/help/plugins/develop_plugins/index.html', - title: 'Build an IIQ Plugin', + title: 'Build an IdentityIQ Plugin', image: '/homepage/puzzle.svg', isThemedImage: true, }, @@ -48,7 +42,6 @@ const HomepageTrainingGuides: React.FC = () => { {trainingGuides.map((guide, index) => ( = ({ filterCallback, const uppercaseText = (text: string): string => { switch (text) { + case 'sailpoint-identity-security': case 'sailpoint-human-fabric': case 'identity-security-cloud': - return 'SailPoint Human Fabric'; + return 'SailPoint Identity Security'; case 'identitynow': return 'IdentityNow'; case 'identityiq': diff --git a/src/components/video-library/VideoSidebar/index.tsx b/src/components/video-library/VideoSidebar/index.tsx index fddb0be9fdc69..bac4febf71f33 100644 --- a/src/components/video-library/VideoSidebar/index.tsx +++ b/src/components/video-library/VideoSidebar/index.tsx @@ -1,7 +1,7 @@ import React, { useState, useEffect } from 'react'; import styles from './styles.module.css'; import { getTags } from '../../../services/DiscourseService'; -import { canonicalProductTag, SHF_PRODUCT_TAG } from '../../../util/util'; +import { canonicalProductTag, PRODUCT_TAG } from '../../../util/util'; // Define the props interface interface MarketplaceSidebarProps { @@ -88,9 +88,10 @@ const VideoSidebar: React.FC = ({ filterCallback }) => 'developer-days': 'Developer Days', 'product-demo': 'Product Demo', // Product tags carry no label of their own, so they used to render as - // raw slugs. Both product slugs share one label. - [SHF_PRODUCT_TAG]: 'SailPoint Human Fabric', - 'identity-security-cloud': 'SailPoint Human Fabric', + // raw slugs. Every product slug shares one label. + [PRODUCT_TAG]: 'SailPoint Identity Security', + 'sailpoint-human-fabric': 'SailPoint Identity Security', + 'identity-security-cloud': 'SailPoint Identity Security', identityiq: 'IdentityIQ', }; diff --git a/src/css/custom.css b/src/css/custom.css index 3014f706e358b..1b59d2447b189 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -994,8 +994,8 @@ html.hack-day-track [class*='codeBlockLines'] * { } /* * Legacy heading anchors kept alive across the Identity Security Cloud -> - * SailPoint Human Fabric rename. The heading now generates its own - * brand-correct id, and an empty sits just above it so + * SailPoint Human Fabric -> SailPoint Identity Security renames. The heading + * now generates its own brand-correct id, and an empty sits just above it so * pre-rename deep links still land. Docusaurus only applies its sticky-navbar * scroll offset to real headings, so mirror it here or the old links scroll * the target underneath the fixed navbar. diff --git a/src/pages/ambassadors.tsx b/src/pages/ambassadors.tsx index 301de28a50d0a..ddf8c4036ca7d 100644 --- a/src/pages/ambassadors.tsx +++ b/src/pages/ambassadors.tsx @@ -9,7 +9,7 @@ const benefits = [ { title: 'Tenant access', description: - 'Ambassadors receive an unconfigured SailPoint Human Fabric test tenant. Expert Ambassadors receive a preconfigured tenant.', + 'Ambassadors receive an unconfigured SailPoint Identity Security test tenant. Expert Ambassadors receive a preconfigured tenant.', }, { title: 'Forum badge & recognition', diff --git a/src/pages/apis/legacy.tsx b/src/pages/apis/legacy.tsx index 58f110ccc15cd..1d0c8a2409668 100644 --- a/src/pages/apis/legacy.tsx +++ b/src/pages/apis/legacy.tsx @@ -19,22 +19,22 @@ const API_VERSIONS: ApiVersion[] = [ { key: 'v3', label: 'V3', - description: 'V3 API — stable, versioned SHF API collection.', + description: 'V3 API — stable, versioned SailPoint Identity Security API collection.', }, { key: 'v2024', label: 'V2024', - description: '2024 release of the SHF API collection.', + description: '2024 release of the SailPoint Identity Security API collection.', }, { key: 'v2025', label: 'V2025', - description: '2025 release of the SHF API collection.', + description: '2025 release of the SailPoint Identity Security API collection.', }, { key: 'v2026', label: 'V2026', - description: '2026 release of the SHF API collection.', + description: '2026 release of the SailPoint Identity Security API collection.', }, ]; @@ -52,7 +52,7 @@ function LegacyViewer({ activeKey }: { activeKey: string }) {