mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
Edits
This commit is contained in:
@@ -12,7 +12,7 @@ tags: ['beta']
|
|||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Welcome to the PowerShell SDK documentation for API Version Beta. This guide provides an overview of both Methods and Models, helping you understand how to interact with the API effectively.
|
Welcome to the PowerShell SDK documentation for the Identity Security Cloud (ISC) Beta API. This reference guide provides an overview of both methods and models, which will help you understand how to interact with the API effectively.
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
import DocCardList from '@theme/DocCardList';
|
import DocCardList from '@theme/DocCardList';
|
||||||
|
|||||||
@@ -10,17 +10,17 @@ slug: /tools/sdk/powershell/beta/methods
|
|||||||
tags: ['SDK', 'Software Development Kit', 'beta', 'methods']
|
tags: ['SDK', 'Software Development Kit', 'beta', 'methods']
|
||||||
---
|
---
|
||||||
|
|
||||||
Method docs provide detailed information about each API operation (or method). They describe what the method does, its input parameters, expected return values, and any considerations to keep in mind when using it.
|
Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it.
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
||||||
- Parameters: Describes the required input parameters, including their data types.
|
- Parameters: Describe the required input parameters, including their data types.
|
||||||
- Response Format: Details the expected return format or structure.
|
- Response Format: Details the expected return format or structure.
|
||||||
- Error Scenarios: Outlines potential errors or issues that may arise during method execution.
|
- Error Scenarios: Outline potential errors or issues that may arise during method execution.
|
||||||
- Example: Provides a sample of how the method is used in the API.
|
- Example: Provides a sample of how the API uses the method.
|
||||||
|
|
||||||
## Available Methods
|
## Available Methods
|
||||||
Below you'll find a list of the core methods available in the PowerShell SDK for **beta** endpoints:
|
This is a list of the core methods available in the PowerShell SDK for **Beta** endpoints:
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
import DocCardList from '@theme/DocCardList';
|
import DocCardList from '@theme/DocCardList';
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ slug: /tools/sdk/powershell/beta/models
|
|||||||
tags: ['SDK', 'Software Development Kit', 'beta', 'models']
|
tags: ['SDK', 'Software Development Kit', 'beta', 'models']
|
||||||
---
|
---
|
||||||
|
|
||||||
The PowerShell SDK utilizes data models to structure and manage data within the API. These models provide essential details about the data, including its attributes, data types, and how these models relate to each other. Understanding these models is crucial for interacting with the API effectively.
|
The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
|
||||||
|
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
- Attributes: Describes each attribute, including its name, data type, and whether it's required.
|
- Attributes: Describe each attribute, including its name, data type, and whether it's required.
|
||||||
- Validation & Constraints: Highlights any rules or limitations for the attributes (e.g., formats or length limits).
|
- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits.
|
||||||
- Example: Provides a sample of how the model is used in the API.
|
- Example: Provides a sample of how the API uses the model.
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ slug: /tools/powershell/reference/v2024
|
|||||||
tags: ['v2024']
|
tags: ['v2024']
|
||||||
---
|
---
|
||||||
|
|
||||||
Welcome to the PowerShell SDK documentation for API Version V2024. This guide provides an overview of both Methods and Models, helping you understand how to interact with the API effectively.
|
Welcome to the PowerShell SDK documentation for the Identity Security Cloud (ISC) V2024 API. This reference guide provides an overview of both methods and models, which will help you understand how to interact with the API effectively.
|
||||||
|
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
|
|||||||
@@ -10,16 +10,17 @@ slug: /tools/sdk/powershell/v2024/methods
|
|||||||
tags: ['SDK', 'Software Development Kit', 'v2024', 'methods']
|
tags: ['SDK', 'Software Development Kit', 'v2024', 'methods']
|
||||||
---
|
---
|
||||||
|
|
||||||
Method docs provide detailed information about each API operation (or method). They describe what the method does, its input parameters, expected return values, and any considerations to keep in mind when using it.
|
Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it.
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
||||||
- Parameters: Describes the required input parameters, including their data types.
|
- Parameters: Describe the required input parameters, including their data types.
|
||||||
- Response Format: Details the expected return format or structure.
|
- Response Format: Details the expected return format or structure.
|
||||||
- Error Scenarios: Outlines potential errors or issues that may arise during method execution.
|
- Error Scenarios: Outline potential errors or issues that may arise during method execution.
|
||||||
|
- Example: Provides a sample of how the API uses the method.
|
||||||
|
|
||||||
## Available Methods
|
## Available Methods
|
||||||
Below you'll find a list of the core methods available in the PowerShell SDK for **v2024** endpoints:
|
This is a list of the core methods available in the PowerShell SDK for **V2024** endpoints:
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
import DocCardList from '@theme/DocCardList';
|
import DocCardList from '@theme/DocCardList';
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ slug: /tools/sdk/powershell/v2024/models
|
|||||||
tags: ['SDK', 'Software Development Kit', 'v2024', 'models']
|
tags: ['SDK', 'Software Development Kit', 'v2024', 'models']
|
||||||
---
|
---
|
||||||
|
|
||||||
The PowerShell SDK utilizes data models to structure and manage data within the API. These models provide essential details about the data, including its attributes, data types, and how these models relate to each other. Understanding these models is crucial for interacting with the API effectively.
|
The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
|
||||||
|
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
- Attributes: Describes each attribute, including its name, data type, and whether it's required.
|
- Attributes: Describe each attribute, including its name, data type, and whether it's required.
|
||||||
- Validation & Constraints: Highlights any rules or limitations for the attributes (e.g., formats or length limits).
|
- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits.
|
||||||
- Example: Provides a sample of how the model is used in the API.
|
- Example: Provides a sample of how the API uses the model.
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ slug: /tools/powershell/reference/v3
|
|||||||
tags: ['v3']
|
tags: ['v3']
|
||||||
---
|
---
|
||||||
|
|
||||||
Welcome to the PowerShell SDK documentation for API Version V3. This guide provides an overview of both Methods and Models, helping you understand how to interact with the API effectively.
|
Welcome to the PowerShell SDK documentation for the Identity Security Cloud (ISC) V3 API. This reference guide provides an overview of both methods and models, which will help you understand how to interact with the API effectively.
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
import DocCardList from '@theme/DocCardList';
|
import DocCardList from '@theme/DocCardList';
|
||||||
|
|||||||
@@ -10,16 +10,17 @@ slug: /tools/sdk/powershell/v3/methods
|
|||||||
tags: ['SDK', 'Software Development Kit', 'v3', 'methods']
|
tags: ['SDK', 'Software Development Kit', 'v3', 'methods']
|
||||||
---
|
---
|
||||||
|
|
||||||
Method docs provide detailed information about each API operation (or method). They describe what the method does, its input parameters, expected return values, and any considerations to keep in mind when using it.
|
Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it.
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
||||||
- Parameters: Describes the required input parameters, including their data types.
|
- Parameters: Describe the required input parameters, including their data types.
|
||||||
- Response Format: Details the expected return format or structure.
|
- Response Format: Details the expected return format or structure.
|
||||||
- Error Scenarios: Outlines potential errors or issues that may arise during method execution.
|
- Error Scenarios: Outline potential errors or issues that may arise during method execution.
|
||||||
|
- Example: Provides a sample of how the API uses the method.
|
||||||
|
|
||||||
## Available Methods
|
## Available Methods
|
||||||
Below you'll find a list of the core methods available in the PowerShell SDK for **v3** endpoints:
|
This is a list of the core methods available in the PowerShell SDK for **V3** endpoints:
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
import DocCardList from '@theme/DocCardList';
|
import DocCardList from '@theme/DocCardList';
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ slug: /tools/sdk/powershell/v3/models
|
|||||||
tags: ['SDK', 'Software Development Kit', 'v3', 'models']
|
tags: ['SDK', 'Software Development Kit', 'v3', 'models']
|
||||||
---
|
---
|
||||||
|
|
||||||
The PowerShell SDK utilizes data models to structure and manage data within the API. These models provide essential details about the data, including its attributes, data types, and how these models relate to each other. Understanding these models is crucial for interacting with the API effectively.
|
The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
|
||||||
|
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
- Attributes: Describes each attribute, including its name, data type, and whether it's required.
|
- Attributes: Describe each attribute, including its name, data type, and whether it's required.
|
||||||
- Validation & Constraints: Highlights any rules or limitations for the attributes (e.g., formats or length limits).
|
- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits.
|
||||||
- Example: Provides a sample of how the model is used in the API.
|
- Example: Provides a sample of how the API uses the model.
|
||||||
|
|||||||
@@ -11,18 +11,18 @@ slug: /tools/powershell/reference
|
|||||||
tags: ['Reference']
|
tags: ['Reference']
|
||||||
---
|
---
|
||||||
|
|
||||||
Welcome to the **PowerShell SDK Reference**. This section provides detailed documentation on how to use the SDK to interact with our API, including available methods and models for each api version. Whether you're automating workflows, managing resources, or integrating with other systems, this guide will help you effectively leverage the PowerShell SDK.
|
Welcome to the **PowerShell SDK Reference**. This reference guide provides detailed documentation about how to use the SDK to interact with the Identity Security Cloud (ISC) API, including available methods and models for each API version (Beta, V3, and V2024). Whether you're automating workflows, managing resources, or integrating with other systems, this reference guide will help you effectively leverage the PowerShell SDK.
|
||||||
|
|
||||||
### What You'll Find Here:
|
### What You'll Find Here:
|
||||||
- **[Beta Method Reference](/docs/tools/sdk/powershell/beta/methods)** – A list of available cmdlets, their parameters, and expected outputs.
|
- **[Beta Method Reference](/docs/tools/sdk/powershell/beta/methods)** – List of available Beta cmdlets, their parameters, and expected outputs.
|
||||||
- **[Beta Model Definitions](/docs/tools/sdk/powershell/beta/models)** – Descriptions of objects and data structures used in the SDK.
|
- **[Beta Model Definitions](/docs/tools/sdk/powershell/beta/models)** – Descriptions of Beta objects and data structures the SDK uses.
|
||||||
- **[V3 Method Reference](/docs/tools/sdk/powershell/v3/methods)** – A list of available cmdlets, their parameters, and expected outputs.
|
- **[V3 Method Reference](/docs/tools/sdk/powershell/v3/methods)** – List of available V3 cmdlets, their parameters, and expected outputs.
|
||||||
- **[V3 Model Definitions](/docs/tools/sdk/powershell/v3/models)** – Descriptions of objects and data structures used in the SDK.
|
- **[V3 Model Definitions](/docs/tools/sdk/powershell/v3/models)** – Descriptions of V3 objects and data structures the SDK uses.
|
||||||
- **[V2024 Method Reference](/docs/tools/sdk/powershell/v3/methods)** – A list of available cmdlets, their parameters, and expected outputs.
|
- **[V2024 Method Reference](/docs/tools/sdk/powershell/v3/methods)** – List of available V2024 cmdlets, their parameters, and expected outputs.
|
||||||
- **[V2024 Model Definitions](/docs/tools/sdk/powershell/v2024/models)** – Descriptions of objects and data structures used in the SDK.
|
- **[V2024 Model Definitions](/docs/tools/sdk/powershell/v2024/models)** – Descriptions of V2024 objects and data structures the SDK uses.
|
||||||
- **Usage Examples** – Practical PowerShell scripts demonstrating common tasks.
|
- **Usage Examples** – Practical PowerShell scripts demonstrating common tasks.
|
||||||
|
|
||||||
Use this reference as a companion while scripting and automating tasks. If you're new to the SDK, check out the [Installation & Setup](/docs/tools/sdk/powershell) guide before diving in.
|
Use this reference guide as a companion while scripting and automating tasks. If you're new to the SDK, check out [Installation & Setup](/docs/tools/sdk/powershell) before you get started.
|
||||||
|
|
||||||
|
|
||||||
```mdx-code-block
|
```mdx-code-block
|
||||||
|
|||||||
Reference in New Issue
Block a user