mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 04:19:34 +00:00
Update to powershell SDK docs: 13593177491
This commit is contained in:
developer-relations-sp
@@ -635,8 +635,8 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull*
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType**
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt*
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name**
|
||||
|
||||
### Return type
|
||||
[**Account[]**](../models/account)
|
||||
@@ -661,8 +661,8 @@ $DetailLevel = "SLIM" # String | This value determines whether the API provides
|
||||
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional)
|
||||
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
|
||||
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional)
|
||||
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional)
|
||||
|
||||
# Accounts List
|
||||
|
||||
|
||||
@@ -28,22 +28,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile
|
||||
[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile
|
||||
[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile
|
||||
[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile
|
||||
[**Remove-BetaIdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles
|
||||
[**Export-BetaIdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles
|
||||
[**Get-BetaDefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config
|
||||
[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Gets a single Identity Profile
|
||||
[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile
|
||||
[**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles
|
||||
[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List
|
||||
[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
|
||||
[**Show-BetaGenerateIdentityPreview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
|
||||
[**Sync-BetaIdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
|
||||
[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile
|
||||
[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile
|
||||
|
||||
|
||||
## create-identity-profile
|
||||
This creates an Identity Profile.
|
||||
|
||||
Create an identity profile.
|
||||
A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-profile)
|
||||
@@ -59,7 +58,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
201 | The created Identity Profile | IdentityProfile
|
||||
201 | Created identity profile | IdentityProfile
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -122,7 +121,7 @@ $IdentityProfile = @"{
|
||||
"id" : "id12345"
|
||||
}"@
|
||||
|
||||
# Create an Identity Profile
|
||||
# Create Identity Profile
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
|
||||
@@ -138,20 +137,16 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-identity-profile
|
||||
This deletes an Identity Profile based on ID.
|
||||
|
||||
Delete an identity profile by ID.
|
||||
On success, this endpoint will return a reference to the bulk delete task result.
|
||||
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
|
||||
The following rights are required to access this endpoint: idn:identity-profile:delete
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profile)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | IdentityProfileId | **String** | True | The Identity Profile ID.
|
||||
Path | IdentityProfileId | **String** | True | Identity profile ID.
|
||||
|
||||
### Return type
|
||||
[**TaskResultSimplified**](../models/task-result-simplified)
|
||||
@@ -173,9 +168,9 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID.
|
||||
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
|
||||
|
||||
# Delete an Identity Profile
|
||||
# Delete Identity Profile
|
||||
|
||||
try {
|
||||
Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
|
||||
@@ -345,8 +340,7 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-identity-profile
|
||||
This returns a single Identity Profile based on ID.
|
||||
|
||||
Get a single identity profile by ID.
|
||||
A token with ORG_ADMIN or API authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-profile)
|
||||
@@ -354,7 +348,7 @@ A token with ORG_ADMIN or API authority is required to call this API.
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | IdentityProfileId | **String** | True | The Identity Profile ID
|
||||
Path | IdentityProfileId | **String** | True | Identity profile ID.
|
||||
|
||||
### Return type
|
||||
[**IdentityProfile**](../models/identity-profile)
|
||||
@@ -362,7 +356,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | An Identity Profile object | IdentityProfile
|
||||
200 | Identity profile object. | IdentityProfile
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -376,9 +370,9 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID
|
||||
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
|
||||
|
||||
# Gets a single Identity Profile
|
||||
# Get Identity Profile
|
||||
|
||||
try {
|
||||
Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
|
||||
@@ -501,7 +495,7 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-identity-profiles
|
||||
This returns a list of Identity Profiles based on the specified query parameters.
|
||||
Get a list of identity profiles, based on the specified query parameters.
|
||||
A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-profiles)
|
||||
@@ -512,7 +506,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne*
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne*
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name**
|
||||
|
||||
### Return type
|
||||
@@ -521,7 +515,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of identityProfiles. | IdentityProfile[]
|
||||
200 | List of identity profiles. | IdentityProfile[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -537,10 +531,10 @@ Code | Description | Data Type
|
||||
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional)
|
||||
$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional)
|
||||
$Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional)
|
||||
|
||||
# Identity Profiles List
|
||||
# List Identity Profiles
|
||||
|
||||
try {
|
||||
Get-BetaIdentityProfiles
|
||||
@@ -680,13 +674,10 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-identity-profile
|
||||
This updates the specified Identity Profile.
|
||||
|
||||
Update the specified identity profile with this PATCH request.
|
||||
A token with ORG_ADMIN authority is required to call this API to update the Identity Profile.
|
||||
|
||||
Some fields of the Schema cannot be updated. These fields are listed below:
|
||||
These fields cannot be updated:
|
||||
* id
|
||||
* name
|
||||
* created
|
||||
* modified
|
||||
* identityCount
|
||||
@@ -698,8 +689,8 @@ Some fields of the Schema cannot be updated. These fields are listed below:
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | IdentityProfileId | **String** | True | The Identity Profile ID
|
||||
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
Path | IdentityProfileId | **String** | True | Identity profile ID.
|
||||
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
### Return type
|
||||
[**IdentityProfile**](../models/identity-profile)
|
||||
@@ -707,7 +698,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | The updated Identity Profile. | IdentityProfile
|
||||
200 | Updated identity profile. | IdentityProfile
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -721,15 +712,15 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID
|
||||
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
|
||||
$JsonPatchOperation = @"{
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
|
||||
# Update the Identity Profile
|
||||
# Update Identity Profile
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
||||
|
||||
@@ -253,9 +253,7 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## create-non-employee-source
|
||||
This request will create a non-employee source.
|
||||
Request will require the following security scope:
|
||||
'idn:nesr:create'
|
||||
Create a non-employee source.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source)
|
||||
|
||||
@@ -1377,18 +1375,20 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-non-employee-sources
|
||||
This gets a list of non-employee sources.
|
||||
Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter:
|
||||
1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`.
|
||||
2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-sources)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user.
|
||||
Query | NonEmployeeCount | **Boolean** | True | The flag to determine whether return a non-employee count associate with source.
|
||||
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user.
|
||||
Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source.
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId**
|
||||
|
||||
### Return type
|
||||
@@ -1397,7 +1397,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of non-employee sources objects. | NonEmployeeSourceWithNECount[]
|
||||
200 | List of non-employee source objects. | NonEmployeeSourceWithNECount[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -1410,20 +1410,20 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user.
|
||||
$NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with source.
|
||||
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional)
|
||||
$NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false)
|
||||
$Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional)
|
||||
|
||||
# List Non-Employee Sources
|
||||
|
||||
try {
|
||||
Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount
|
||||
Get-BetaNonEmployeeSources
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
|
||||
# Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
|
||||
$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
|
||||
-Count 10
|
||||
```
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdenti
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Enabled** | **Boolean** | If the profile or mapping is enabled | [optional] [default to $true]
|
||||
**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $true]
|
||||
**AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1', 'BetaIdent
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false]
|
||||
**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false]
|
||||
**AttributeTransforms** | [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIde
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IdentityAttributeName** | **String** | Name of the identity attribute | [optional]
|
||||
**IdentityAttributeName** | **String** | Identity attribute's name. | [optional]
|
||||
**TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaId
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional]
|
||||
**IdentityAttributeName** | **String** | Identity attribute's name. | [optional]
|
||||
**TransformDefinition** | [**TransformDefinition1**](transform-definition1) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'B
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**TaskResultId** | **String** | The id of the task result | [optional]
|
||||
**ReportName** | **String** | The name of the report | [optional]
|
||||
**TaskResultId** | **String** | Task result ID. | [optional]
|
||||
**ReportName** | **String** | Report name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', '
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**TaskResultId** | **String** | The id of the task result. | [optional]
|
||||
**ReportName** | **String** | The name of the report. | [optional]
|
||||
**TaskResultId** | **String** | Task result ID. | [optional]
|
||||
**ReportName** | **String** | Report name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -20,15 +20,15 @@ Name | Type | Description | Notes
|
||||
**Name** | **String** | Name of the Object | [required]
|
||||
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
|
||||
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
|
||||
**Description** | **String** | The description of the Identity Profile. | [optional]
|
||||
**Description** | **String** | Identity profile's description. | [optional]
|
||||
**Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional]
|
||||
**Priority** | **Int64** | The priority for an Identity Profile. | [optional]
|
||||
**Priority** | **Int64** | Identity profile's priority. | [optional]
|
||||
**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required]
|
||||
**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made | [optional] [default to $false]
|
||||
**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional]
|
||||
**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false]
|
||||
**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional]
|
||||
**IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional]
|
||||
**IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional]
|
||||
**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $true]
|
||||
**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $true]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -20,15 +20,15 @@ Name | Type | Description | Notes
|
||||
**Name** | **String** | Name of the Object | [required]
|
||||
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
|
||||
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
|
||||
**Description** | **String** | The description of the Identity Profile. | [optional]
|
||||
**Description** | **String** | Identity profile's description. | [optional]
|
||||
**Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional]
|
||||
**Priority** | **Int64** | The priority for an Identity Profile. | [optional]
|
||||
**Priority** | **Int64** | Identity profile's priority. | [optional]
|
||||
**AuthoritativeSource** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required]
|
||||
**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false]
|
||||
**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional]
|
||||
**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false]
|
||||
**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional]
|
||||
**IdentityAttributeConfig** | [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional]
|
||||
**IdentityExceptionReportReference** | [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional]
|
||||
**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false]
|
||||
**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSou
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [optional]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional]
|
||||
**Id** | **String** | Authoritative source's ID. | [optional]
|
||||
**Name** | **String** | Authoritative source's name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [optional]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional]
|
||||
**Id** | **String** | Authoritative source's ID. | [optional]
|
||||
**Name** | **String** | Authoritative source's name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIden
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [optional]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional]
|
||||
**Id** | **String** | Owner's ID. | [optional]
|
||||
**Name** | **String** | Owner's name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR
|
||||
-ApprovalStatus null `
|
||||
-Comment approved `
|
||||
-CompletionDate 2020-03-24T11:11:41.139-05:00 `
|
||||
-StartDate Mon Mar 23 20:00:00 EDT 2020 `
|
||||
-EndDate Wed Mar 24 20:00:00 EDT 2021 `
|
||||
-StartDate Tue Mar 24 00:00:00 UTC 2020 `
|
||||
-EndDate Thu Mar 25 00:00:00 UTC 2021 `
|
||||
-Modified 2020-03-24T11:11:41.139-05:00 `
|
||||
-Created 2020-03-24T11:11:41.139-05:00
|
||||
```
|
||||
|
||||
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
|
||||
**AccountManagers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional]
|
||||
**Modified** | **System.DateTime** | When the request was last modified. | [optional]
|
||||
**Created** | **System.DateTime** | When the request was created. | [optional]
|
||||
**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional]
|
||||
**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'null' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
|
||||
$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
|
||||
-Count 10.45
|
||||
```
|
||||
|
||||
|
||||
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
||||
**ObjectType** | **String** | The object type this configuration is for. | [optional]
|
||||
**ReferenceExtractors** | **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional]
|
||||
**SignatureRequired** | **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false]
|
||||
**AlwaysResolveById** | **Boolean** | Whether this object type has to be resolved always by ID | [optional] [default to $false]
|
||||
**LegacyObject** | **Boolean** | Whether this is a legacy object | [optional] [default to $false]
|
||||
**OnePerTenant** | **Boolean** | Whether there is only one object of this type | [optional] [default to $false]
|
||||
**Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false]
|
||||
@@ -31,6 +32,7 @@ Name | Type | Description | Notes
|
||||
$SpConfigObject = Initialize-PSSailpoint.BetaSpConfigObject -ObjectType TRIGGER_SUBSCRIPTION `
|
||||
-ReferenceExtractors [$.owner] `
|
||||
-SignatureRequired false `
|
||||
-AlwaysResolveById true `
|
||||
-LegacyObject false `
|
||||
-OnePerTenant false `
|
||||
-Exportable true `
|
||||
|
||||
@@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule']
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional]
|
||||
**Value** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional]
|
||||
**Mode** | **[]String** | Draft modes to which this rule will apply | [optional]
|
||||
**Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional]
|
||||
**Modes** | **[]String** | Draft modes to which this rule will apply | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
```powershell
|
||||
$SpConfigRule = Initialize-PSSailpoint.BetaSpConfigRule -Path $.enabled `
|
||||
-Value null `
|
||||
-Mode [RESTORE, PROMOTE]
|
||||
-Modes [RESTORE, PROMOTE]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
id: beta-sp-config-rule-value
|
||||
title: SpConfigRuleValue
|
||||
pagination_label: SpConfigRuleValue
|
||||
sidebar_label: SpConfigRuleValue
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRuleValue', 'BetaSpConfigRuleValue']
|
||||
slug: /tools/sdk/powershell/beta/models/sp-config-rule-value
|
||||
tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRuleValue']
|
||||
---
|
||||
|
||||
|
||||
# SpConfigRuleValue
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$SpConfigRuleValue = Initialize-PSSailpoint.BetaSpConfigRuleValue
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$SpConfigRuleValue | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformD
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **String** | The type of the transform definition. | [optional]
|
||||
**Type** | **String** | Transform definition type. | [optional]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransform
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **String** | The type of the transform definition. | [optional]
|
||||
**Type** | **String** | Transform definition type. | [optional]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
|
||||
**RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional]
|
||||
**StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional]
|
||||
**CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional]
|
||||
**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional]
|
||||
**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
Reference in New Issue
Block a user