Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/ai-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:**
Expand Down Expand Up @@ -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
Expand All @@ -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**
Expand Down Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions docs/api/api-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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). -->
6 changes: 3 additions & 3 deletions docs/api/api-versioning-migration.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
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']
---

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

Expand Down
8 changes: 4 additions & 4 deletions docs/api/api-versioning-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down
Loading
Loading