This commit is contained in:
con-docs
2025-02-07 13:08:53 -06:00
parent f79d201b73
commit edace75dde
10 changed files with 38 additions and 36 deletions

View File

@@ -11,7 +11,7 @@ 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.
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
import DocCardList from '@theme/DocCardList';

View File

@@ -10,16 +10,17 @@ 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.
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
- 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.
- 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
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
import DocCardList from '@theme/DocCardList';

View File

@@ -10,10 +10,10 @@ 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.
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
- 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.
- Attributes: Describe each attribute, including its name, data type, and whether it's required.
- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits.
- Example: Provides a sample of how the API uses the model.