LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md
View File

@@ -81,9 +81,12 @@ Method | HTTP request | Description
[**Deny-NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request
[**Update-NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record
## approve-non-employee-request
Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -118,20 +121,23 @@ $NonEmployeeApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
# Below is a request that includes all optional parameters
# Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision
# Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-record
This request will create a non-employee record.
Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -175,19 +181,22 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-NonEmployeeRecord -NonEmployeeRequestBody $Result
New-NonEmployeeRecord -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody
# New-NonEmployeeRecord -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-request
This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -231,19 +240,22 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-NonEmployeeRequest -NonEmployeeRequestBody $Result
New-NonEmployeeRequest -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody
# New-NonEmployeeRequest -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-source
This request will create a non-employee source. Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -299,20 +311,23 @@ $NonEmployeeSourceRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result
New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody
# New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-source-schema-attributes
This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response.
Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -352,20 +367,23 @@ $NonEmployeeSchemaAttributeBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody
# New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-record
This request will delete a non-employee record.
Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -405,9 +423,12 @@ try {
}
```
[[Back to top]](#)
## delete-non-employee-records-in-bulk
This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-records-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -438,20 +459,23 @@ $DeleteNonEmployeeRecordsInBulkRequest = @""@
try {
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest
Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
# Below is a request that includes all optional parameters
# Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest
# Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-request
This request will delete a non-employee request.
Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -492,11 +516,14 @@ try {
}
```
[[Back to top]](#)
## delete-non-employee-schema-attribute
This end-point deletes a specific schema attribute for a non-employee source.
Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -528,7 +555,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete a Schema Attribute for Non-Employee Source
try {
Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -538,9 +565,12 @@ try {
}
```
[[Back to top]](#)
## delete-non-employee-source
This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -580,9 +610,12 @@ try {
}
```
[[Back to top]](#)
## delete-non-employee-source-schema-attributes
This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -622,9 +655,12 @@ try {
}
```
[[Back to top]](#)
## export-non-employee-records
This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-records)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -665,9 +701,12 @@ try {
}
```
[[Back to top]](#)
## export-non-employee-source-schema-template
This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-source-schema-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -708,12 +747,15 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-approval
Gets a non-employee approval item detail. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:read`, in which case they
can get any approval.
2. The user owns the requested approval.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -755,6 +797,7 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-approval-summary
This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -762,6 +805,8 @@ she may request a summary of all non-employee approval requests assigned to a pa
2. The current user is an approver, in which case "me" should be provided
as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -801,11 +846,14 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-bulk-upload-status
The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.
Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-bulk-upload-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -845,10 +893,13 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-record
This gets a non-employee record.
Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -888,6 +939,7 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-request
This gets a non-employee request.
There are two contextual uses for this endpoint:
@@ -895,6 +947,8 @@ There are two contextual uses for this endpoint:
can get the non-employee request for any user.
2. The user must be the owner of the non-employee request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -935,6 +989,7 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-request-summary
This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -942,6 +997,8 @@ she may request a summary of all non-employee approval requests assigned to a pa
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -981,9 +1038,12 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-schema-attribute
This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1015,7 +1075,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Get Schema Attribute Non-Employee Source
try {
Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -1025,6 +1085,7 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-source
This gets a non-employee source. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -1032,6 +1093,8 @@ she may request any source.
2. The current user is an account manager, in which case the user can only
request sources that they own.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1071,10 +1134,13 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-source-schema-attributes
This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.
Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1115,9 +1181,12 @@ try {
}
```
[[Back to top]](#)
## import-non-employee-records-in-bulk
This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/import-non-employee-records-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1150,7 +1219,7 @@ $Data = # System.IO.FileInfo |
# Imports, or Updates, Non-Employee Records
try {
Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
# Below is a request that includes all optional parameters
# Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
@@ -1160,6 +1229,7 @@ try {
}
```
[[Back to top]](#)
## list-non-employee-approvals
This gets a list of non-employee approval requests.
There are two contextual uses for this endpoint:
@@ -1167,6 +1237,8 @@ There are two contextual uses for this endpoint:
can list the approvals for any approver.
2. The user owns the requested approval.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1206,7 +1278,7 @@ $Sorters = "created" # String | Sort results using the standard syntax described
# Get List of Non-Employee Approval Requests
try {
Get-NonEmployeeApprovals
Get-NonEmployeeApprovals
# Below is a request that includes all optional parameters
# Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -1216,11 +1288,14 @@ try {
}
```
[[Back to top]](#)
## list-non-employee-records
This gets a list of non-employee records. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees.
2. The user is an account manager, in which case they can get a list of the non-employees that they manage.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-records)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1258,7 +1333,7 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re
# List Non-Employee Records
try {
Get-NonEmployeeRecords
Get-NonEmployeeRecords
# Below is a request that includes all optional parameters
# Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
@@ -1268,6 +1343,7 @@ try {
}
```
[[Back to top]](#)
## list-non-employee-requests
This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -1275,6 +1351,8 @@ she may request a list non-employee requests assigned to a particular account ma
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1324,6 +1402,7 @@ try {
}
```
[[Back to top]](#)
## list-non-employee-sources
This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -1331,6 +1410,8 @@ she may request a list sources assigned to a particular account manager by passi
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-sources)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1380,6 +1461,7 @@ try {
}
```
[[Back to top]](#)
## patch-non-employee-record
This request will patch a non-employee record. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:update`, in which case they
@@ -1387,6 +1469,8 @@ update all available fields.
2. The user is owner of the source, in this case they can only update the
end date.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1425,21 +1509,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-non-employee-schema-attribute
This end-point patches a specific schema attribute for a non-employee SourceId.
Requires role context of `idn:nesr:update`
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1480,19 +1567,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation
# Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-non-employee-source
patch a non-employee source. (partial update) <br/> Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1530,19 +1620,22 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation
# Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reject-non-employee-request
This endpoint will reject an approval item request and notify user. The current user must be the requested approver.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1577,16 +1670,17 @@ $NonEmployeeRejectApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
# Below is a request that includes all optional parameters
# Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision
# Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-non-employee-record
This request will update a non-employee record. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:update`, in which case they
@@ -1594,6 +1688,8 @@ update all available fields.
2. The user is owner of the source, in this case they can only update the
end date.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1640,10 +1736,10 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody
# Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord"
Write-Host $_.ErrorDetails