mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
adding index.md files for powershell sdk docs
This commit is contained in:
22
docs/tools/sdk/powershell/Reference/Beta/Index.md
Normal file
22
docs/tools/sdk/powershell/Reference/Beta/Index.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
id: beta
|
||||
title: Beta
|
||||
pagination_label: Beta
|
||||
sidebar_label: Beta
|
||||
sidebar_position: 2
|
||||
sidebar_class_name: beta
|
||||
keywords: ['beta', 'PowerShell']
|
||||
description: PowerShell SDK reference Beta.
|
||||
slug: /tools/powershell/reference/beta
|
||||
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.
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||
```
|
||||
30
docs/tools/sdk/powershell/Reference/Beta/Methods/index.md
Normal file
30
docs/tools/sdk/powershell/Reference/Beta/Methods/index.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
id: methods
|
||||
title: Methods
|
||||
pagination_label: Methods
|
||||
sidebar_label: Methods
|
||||
sidebar_position: 3
|
||||
sidebar_class_name: methods
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'methods']
|
||||
slug: /tools/sdk/powershell/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.
|
||||
|
||||
## Key Features
|
||||
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
||||
- Parameters: Describes the required input parameters, including their data types.
|
||||
- Response Format: Details the expected return format or structure.
|
||||
- Error Scenarios: Outlines potential errors or issues that may arise during method execution.
|
||||
- Example: Provides a sample of how the method is used in the API.
|
||||
|
||||
## Available Methods
|
||||
Below you'll find a list of the core methods available in the PowerShell SDK for **beta** endpoints:
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||
```
|
||||
19
docs/tools/sdk/powershell/Reference/Beta/Models/index.md
Normal file
19
docs/tools/sdk/powershell/Reference/Beta/Models/index.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
id: models
|
||||
title: Models
|
||||
pagination_label: Models
|
||||
sidebar_label: Models
|
||||
sidebar_position: 3
|
||||
sidebar_class_name: models
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'models']
|
||||
slug: /tools/sdk/powershell/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.
|
||||
|
||||
|
||||
## Key Features
|
||||
- Attributes: Describes 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).
|
||||
- Example: Provides a sample of how the model is used in the API.
|
||||
22
docs/tools/sdk/powershell/Reference/V2024/Index.md
Normal file
22
docs/tools/sdk/powershell/Reference/V2024/Index.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
id: v2024
|
||||
title: V2024
|
||||
pagination_label: V2024
|
||||
sidebar_label: V2024
|
||||
sidebar_position: 2
|
||||
sidebar_class_name: v2024
|
||||
keywords: ['v2024', 'PowerShell']
|
||||
description: PowerShell SDK reference V2024.
|
||||
slug: /tools/powershell/reference/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.
|
||||
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||
```
|
||||
29
docs/tools/sdk/powershell/Reference/V2024/Methods/index.md
Normal file
29
docs/tools/sdk/powershell/Reference/V2024/Methods/index.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
id: methods
|
||||
title: Methods
|
||||
pagination_label: Methods
|
||||
sidebar_label: Methods
|
||||
sidebar_position: 3
|
||||
sidebar_class_name: methods
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'methods']
|
||||
slug: /tools/sdk/powershell/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.
|
||||
|
||||
## Key Features
|
||||
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
||||
- Parameters: Describes the required input parameters, including their data types.
|
||||
- Response Format: Details the expected return format or structure.
|
||||
- Error Scenarios: Outlines potential errors or issues that may arise during method execution.
|
||||
|
||||
## Available Methods
|
||||
Below you'll find a list of the core methods available in the PowerShell SDK for **v2024** endpoints:
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||
```
|
||||
19
docs/tools/sdk/powershell/Reference/V2024/Models/index.md
Normal file
19
docs/tools/sdk/powershell/Reference/V2024/Models/index.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
id: models
|
||||
title: Models
|
||||
pagination_label: Models
|
||||
sidebar_label: Models
|
||||
sidebar_position: 3
|
||||
sidebar_class_name: models
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'models']
|
||||
slug: /tools/sdk/powershell/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.
|
||||
|
||||
|
||||
## Key Features
|
||||
- Attributes: Describes 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).
|
||||
- Example: Provides a sample of how the model is used in the API.
|
||||
21
docs/tools/sdk/powershell/Reference/V3/Index.md
Normal file
21
docs/tools/sdk/powershell/Reference/V3/Index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
id: v3
|
||||
title: V3
|
||||
pagination_label: V3
|
||||
sidebar_label: V3
|
||||
sidebar_position: 2
|
||||
sidebar_class_name: v3
|
||||
keywords: ['v3', 'PowerShell']
|
||||
description: PowerShell SDK reference V3.
|
||||
slug: /tools/powershell/reference/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.
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||
```
|
||||
29
docs/tools/sdk/powershell/Reference/V3/Methods/index.md
Normal file
29
docs/tools/sdk/powershell/Reference/V3/Methods/index.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
id: methods
|
||||
title: Methods
|
||||
pagination_label: Methods
|
||||
sidebar_label: Methods
|
||||
sidebar_position: 3
|
||||
sidebar_class_name: methods
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'methods']
|
||||
slug: /tools/sdk/powershell/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.
|
||||
|
||||
## Key Features
|
||||
- Purpose & Overview: Explains the purpose of the method and its role in the API.
|
||||
- Parameters: Describes the required input parameters, including their data types.
|
||||
- Response Format: Details the expected return format or structure.
|
||||
- Error Scenarios: Outlines potential errors or issues that may arise during method execution.
|
||||
|
||||
## Available Methods
|
||||
Below you'll find a list of the core methods available in the PowerShell SDK for **v3** endpoints:
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||
```
|
||||
19
docs/tools/sdk/powershell/Reference/V3/Models/index.md
Normal file
19
docs/tools/sdk/powershell/Reference/V3/Models/index.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
id: models
|
||||
title: Models
|
||||
pagination_label: Models
|
||||
sidebar_label: Models
|
||||
sidebar_position: 3
|
||||
sidebar_class_name: models
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'models']
|
||||
slug: /tools/sdk/powershell/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.
|
||||
|
||||
|
||||
## Key Features
|
||||
- Attributes: Describes 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).
|
||||
- Example: Provides a sample of how the model is used in the API.
|
||||
33
docs/tools/sdk/powershell/Reference/index.md
Normal file
33
docs/tools/sdk/powershell/Reference/index.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: reference
|
||||
title: PowerShell SDK Reference
|
||||
pagination_label: Reference
|
||||
sidebar_label: Reference
|
||||
sidebar_position: 1
|
||||
sidebar_class_name: reference
|
||||
keywords: ['reference']
|
||||
description: PowerShell SDK reference.
|
||||
slug: /tools/powershell/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.
|
||||
|
||||
### 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 Model Definitions](/docs/tools/sdk/powershell/beta/models)** – Descriptions of objects and data structures used in the SDK.
|
||||
- **[V3 Method Reference](/docs/tools/sdk/powershell/v3/methods)** – A list of available 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.
|
||||
- **[V2024 Method Reference](/docs/tools/sdk/powershell/v3/methods)** – A list of available 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.
|
||||
- **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.
|
||||
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||
```
|
||||
Reference in New Issue
Block a user