Skip to content
Open
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
2 changes: 1 addition & 1 deletion docs/ai-policy.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: ai-policy
title: AI Usage Policy
description: Guidelines for the responsible use of AI tools in the SailPoint Developer Community.
description: Guidelines for the responsible use of AI tools in SailPoint developer community spaces.
slug: ai-policy
unlisted: true
custom_edit_url: null
Expand Down
27 changes: 15 additions & 12 deletions docs/api/api-specifications.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,34 @@
<!-- ---
---
id: api-specifications
title: API Specifications
pagination_label: API Specifications
sidebar_label: API Specifications
sidebar_position: 1
sidebar_class_name: apiSpecifications
keywords: ['api', 'specifications']
description: Identity Security Cloud API specifications.
slug: /api/api-specifications
description: SailPoint API specifications.
slug: /api
tags: ['API Specifications']
---

## Overview

The Identity Security Cloud (ISC) APIs provide developers with a way to interact with the ISC platform and extend it. Developers can leverage these APIs to customize their platform experiences and build new solutions and integrations that meet their needs.
SailPoint API specifications help developers automate identity workflows, extend product behavior, and build integrations with SailPoint platforms.

Choose the API family that matches the product or service you are building against.

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.
| API family | Use it for |
| --- | --- |
| [Identity Security Cloud APIs](/docs/api/v2026) | Automating and extending Identity Security Cloud. |
| [IdentityIQ APIs](/docs/api/iiq) | Working with IdentityIQ SCIM APIs. |
| [NERM APIs](/docs/api/nerm/v1) | Working with Non-employee Risk Management APIs. |

```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
## Getting started

<DocCardList items={useCurrentSidebarCategory().items}/>
```
If you are new to SailPoint APIs, start with [your first Identity Security Cloud API call](/docs/api/getting-started) to learn authentication, tenant URLs, and basic request structure.

## Discuss

The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions.
The developer forum is the best place to ask API questions, share examples, and learn from other SailPoint developers.

To learn more about the ISC APIs and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/tags/c/isc/6/apis). -->
To discuss API topics, visit the [SailPoint Developer Forum](https://developer.sailpoint.com/discuss/tags/c/isc/6/apis).
6 changes: 4 additions & 2 deletions docs/connectivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ tags: ['connectivity']

Connectivity refers to Identity Security Cloud's (ISC) 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.

This section is primarily guide-oriented. Use it when you need to build, configure, or extend source connectivity. For API endpoint syntax, use the [API specifications](/docs/api).

```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
Expand All @@ -24,6 +26,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

## Discuss

The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions.
The developer forum is a valuable resource for ISC developers, where users and experts come together to ask questions and provide solutions.

To learn more about ISC connectivity and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6).
To learn more about ISC connectivity and discuss it with other SailPoint developers, go to the [SailPoint Developer Forum](https://developer.sailpoint.com/discuss/c/isc/6).
12 changes: 10 additions & 2 deletions docs/extensibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ tags: ['extensibility']

The Identity Security Cloud (ISC) 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.

## Start here

Extensibility content includes both tutorials and reference material:

- Use [transform guides](/docs/extensibility/transforms/guides) and [rule guides](/docs/extensibility/rules/guides) when you want a step-by-step implementation path.
- Use [transform operations](/docs/extensibility/transforms/operations), [cloud executed rules](/docs/extensibility/rules/cloud-rules), and [connector executed rules](/docs/extensibility/rules/connector-rules) when you need reference details for a specific capability.
- Use [API specifications](/docs/api) when you need endpoint syntax, authentication details, and request/response shapes.

```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
Expand All @@ -24,6 +32,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

## Discuss

The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions.
The developer forum is a valuable resource for ISC developers, where users and experts come together to ask questions and provide solutions.

To learn more about ISC extensibility and discuss the different extensibility options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6).
To learn more about ISC extensibility and discuss the different extensibility options with other SailPoint developers, go to the [SailPoint Developer Forum](https://developer.sailpoint.com/discuss/c/isc/6).
2 changes: 1 addition & 1 deletion docs/extensibility/rules/connector-rules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ requestEndPoint.getBody().put(\"jsonBody\",requestXML); \n }\n
- `sourceVersion` - String indicating the rule's version. Typically, this is the same as `version`.
- `sourceCode` - Object housing the actual source code that makes the rule work.
- `version` - String indicating the rule's version. Typically, this is the same as `sourceVersion`.
- `script` - Rule’s code the connector runs. This must be an escaped string. For help with formatting, use an escaping tool like [Escaping Tool Formatter.](/tools/escaping-tool-formatter)
- `script` - Rule’s code the connector runs. This must be an escaped string. For help with formatting, use an escaping tool like [Java/.NET string escaper.](/tools/escaping-tool-formatter)

## Attaching connector-related Rules to sources

Expand Down
6 changes: 3 additions & 3 deletions docs/extensibility/rules/guides/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: guides
title: Rule guides
pagination_label: Guides
sidebar_label: Guides
title: Rule Guides
pagination_label: Rule Guides
sidebar_label: Rule Guides
sidebar_key: rules-guides
sidebar_position: 1
sidebar_class_name: Rules
Expand Down
11 changes: 5 additions & 6 deletions docs/extensibility/transforms/guides/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
---
id: guides
title: Guides
pagination_label: Guides
sidebar_label: Guides
title: Transform Guides
pagination_label: Transform Guides
sidebar_label: Transform Guides
sidebar_position: 1
sidebar_key: transform-guides
sidebar_class_name: transforms
keywords: ['transforms', 'guides']
description: Transform Guides
description: Transform guides.
slug: /extensibility/transforms/guides
tags: ['Transforms', 'Guides']
---

# Transform guides

Not sure how to use transforms yet? Read these guides to see how you can use transforms and learn how to get started!

```mdx-code-block
Expand Down
11 changes: 10 additions & 1 deletion docs/extensibility/transforms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ customProps:

In SailPoint's cloud services, transforms allow you to manipulate attribute values while aggregating from or provisioning to a source. This guide provides a reference to help you understand the purpose, configuration, and usage of transforms.

## Start here

Transforms include both tutorials and reference material:

- Start with [Your first transform](/docs/extensibility/transforms/guides/your-first-transform) if you are new to transforms and want a guided implementation.
- Use [Transform guides](/docs/extensibility/transforms/guides) for task-focused tutorials, including provisioning policy and lifecycle state examples.
- Use [Transform operations](/docs/extensibility/transforms/operations) when you need reference details for a specific transform type.
- Use [Out of the box transforms](/docs/extensibility/transforms/ootb) to review preset transform behavior.

## What are transforms

Transforms are configurable objects that define easy ways to manipulate attribute data without requiring you to write code. Transforms are configurable building blocks with sets of inputs and outputs:
Expand Down Expand Up @@ -281,7 +290,7 @@ To test a transform for account data, you must provision a new account on that s

- **JSON Editor** - Because transforms are JSON objects, it is recommended that you use a good JSON editor. Atom, Sublime Text, and Microsoft Code work well because they have JSON formatting and plugins that can do JSON validation, completion, formatting, and folding. This is very useful for large complex JSON objects.

- **Leverage Examples** - Many implementations use similar sets of transforms, and a lot of common solutions can be found in examples. Feel free to share your own transform examples on the [Developer Community forum](https://developer.sailpoint.com/discuss)!
- **Leverage Examples** - Many implementations use similar sets of transforms, and a lot of common solutions can be found in examples. Feel free to share your own transform examples on the [SailPoint Developer Forum](https://developer.sailpoint.com/discuss)!

- **Same Problem, Multiple Solutions** - There can be multiple ways to solve the same problem, but use the solution that makes the most sense to your implementation and is easiest to administer and understand.

Expand Down
7 changes: 4 additions & 3 deletions docs/extensibility/transforms/operations/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
id: operations
title: Operations
pagination_label: Operations
sidebar_label: Operations
title: Transform Operations
pagination_label: Transform Operations
sidebar_label: Transform Operations
sidebar_position: 2
sidebar_class_name: operations
keywords: ['transforms', 'operations']
description: A list of transform operations.
Expand Down
6 changes: 3 additions & 3 deletions docs/extensibility/transforms/operations/reference.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: reference
title: Reference
pagination_label: Reference
sidebar_label: Reference
title: Reference Transform
pagination_label: Reference Transform
sidebar_label: Reference Transform
sidebar_class_name: reference
sidebar_key: transforms-reference
keywords: ['transforms', 'operations', 'reference']
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
id: ootb-transforms
title: Out of the box transforms
pagination_label: Out of the Box Transforms
sidebar_label: OOTB Transforms
title: Out-of-the-box transforms
pagination_label: Out-of-the-box transforms
sidebar_label: Out-of-the-box transforms
sidebar_position: 3
sidebar_class_name: operations
keywords: ['transforms', 'operations']
description: A list of out of the box transforms.
Expand Down
21 changes: 14 additions & 7 deletions docs/guides.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
---
id: guides
title: Guides
pagination_label: Guides
sidebar_label: Guides
title: Solution guides
pagination_label: Solution guides
sidebar_label: Solution guides
sidebar_key: isc-guides
sidebar_position: 1
sidebar_class_name: guides
keywords: ['guides']
description: ISC guides.
description: Cross-cutting ISC solution guides.
slug: /guides
tags: ['guides']
---

## Overview

Identity Security Cloud (ISC) 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.
Identity Security Cloud (ISC) has all sorts of specific solutions you can implement as long as you know how. This section is for cross-cutting solution guides: tasks that span multiple areas of the platform or do not fit cleanly under Extensibility, Connectivity, Tools, or Reporting.

If you are looking for a domain-specific tutorial, start in that domain instead:

- [Transform guides](/docs/extensibility/transforms/guides) for transform tutorials.
- [Rule guides](/docs/extensibility/rules/guides) for rule tutorials.
- [Developer tools](/docs/tools) for installation, setup, and local development workflows.
- [API specifications](/docs/api) for endpoint reference documentation.

```mdx-code-block
import DocCardList from '@theme/DocCardList';
Expand All @@ -25,6 +32,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

## Discuss

The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions.
The developer forum is a valuable resource for ISC developers, where users and experts come together to ask questions and provide solutions.

To learn more about these ISC topics and discuss them with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6).
To learn more about these ISC topics and discuss them with other SailPoint developers, go to the [SailPoint Developer Forum](https://developer.sailpoint.com/discuss/c/isc/6).
2 changes: 1 addition & 1 deletion docs/iiq/plugin-developer-guide/chapter-1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Overview
sidebar_position: 1
sidebar_class_name: plugin_developer_guide_overview
keywords: ['plugin']
description: IdentityIQ Plugin Developer Guide Overview
description: IdentityIQ plugin developer guide overview
slug: /iiq/plugin-developer-guide/overview
tags: ['plugin', 'guide', 'identityiq']
---
Expand Down
14 changes: 10 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: docs
title: Identity Security Cloud
pagination_label: Docs
sidebar_label: Docs
pagination_label: Identity Security Cloud
sidebar_label: Identity Security Cloud
sidebar_position: 1
sidebar_class_name: docs
keywords: ['docs']
Expand All @@ -27,6 +27,12 @@ The SailPoint Developer Documentation provides developers with all the informati

Check out the developer documentation and see what's possible!

## Choose the right type of content

- **Reference documentation** explains the available APIs, transform operations, rule types, SDK methods, and product behaviors. Use it when you already know what you need to build and need exact syntax or capabilities.
- **Getting started content** helps you install tools, configure authentication, and make your first working request or local project.
- **Guides and tutorials** walk through opinionated implementation paths. Domain-specific guides live with their domain, such as [transform guides](/docs/extensibility/transforms/guides) and [rule guides](/docs/extensibility/rules/guides). The [solution guides](/docs/guides) section is reserved for tasks that span multiple domains or do not fit one product area cleanly.

:::info Are you a partner?

The developer documentation is written for customers and partners who already have access to ISC. If you're interested in becoming a partner, go [here](https://www.sailpoint.com/partners/become-partner/).
Expand All @@ -44,6 +50,6 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

## Discuss

The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions.
The developer forum is a valuable resource for ISC developers, where users and experts come together to ask questions and provide solutions.

To learn more about ISC and discuss it with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6).
To learn more about ISC and discuss it with other SailPoint developers, go to the [SailPoint Developer Forum](https://developer.sailpoint.com/discuss/c/isc/6).
8 changes: 4 additions & 4 deletions docs/plugin-developer-guide.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
id: plugin-developer-guide
title: Plugin Developer Guide
pagination_label: Plugin Developer Guide
sidebar_label: Plugin Developer Guide
title: IdentityIQ plugin developer guide
pagination_label: IdentityIQ plugin developer guide
sidebar_label: IdentityIQ plugin developer guide
sidebar_position: 1
sidebar_class_name: plugin_developer_guide
keywords: ['plugin']
description: IdentityIQ Plugin Developer Guide.
description: IdentityIQ plugin developer guide.
slug: /iiq/plugin-developer-guide
tags: ['plugin', 'guide', 'identityiq']
---
Expand Down
6 changes: 4 additions & 2 deletions docs/reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ tags: ['reporting']

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. Identity Security Cloud (ISC) provides different data reporting options you can use to extract data from your tenant and make it presentable.

This section is primarily guide-oriented. Use it when you need to configure reporting workflows or understand reporting options. For API endpoint syntax, use the [API specifications](/docs/api).

```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
Expand All @@ -24,6 +26,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

## Discuss

The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions.
The developer forum is a valuable resource for ISC developers, where users and experts come together to ask questions and provide solutions.

To learn more about ISC data reporting and discuss the different options with SailPoint Developer Community members, go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/discuss/c/isc/6).
To learn more about ISC data reporting and discuss the different options with other SailPoint developers, go to the [SailPoint Developer Forum](https://developer.sailpoint.com/discuss/c/isc/6).
2 changes: 1 addition & 1 deletion docs/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ const sidebars = {
type: 'generated-index',
title: 'IdentityIQ API',
description:
"These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.",
"These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. We encourage you to join the SailPoint Developer Forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.",
slug: '/api/iiq',
},
// @ts-ignore
Expand Down
Loading
Loading