LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
bdb088c15d658724ba159ccb8208ead957056c7a
developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md
developer-relations-sp bdb088c15d Update to powershell SDK docs: 13122455471
2025-02-03 20:42:04 +00:00

92 KiB
Raw Blame History

id: non-employee-lifecycle-management title: NonEmployeeLifecycleManagement pagination_label: NonEmployeeLifecycleManagement sidebar_label: NonEmployeeLifecycleManagement sidebar_class_name: powershellsdk keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeLifecycleManagement', 'NonEmployeeLifecycleManagement'] slug: /tools/sdk/powershell/v3/methods/non-employee-lifecycle-management tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'NonEmployeeLifecycleManagement']

NonEmployeeLifecycleManagement

Use this API to implement non-employee lifecycle management functionality. With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. This allows organizations to provide secure access to non-employees and control that access.

The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. Organizations can have a maximum of 50 non-employee sources.

By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following:

  • SailPoint is not responsible for storing sensitive data. You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud.

  • You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts.

To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source.

To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. They must then specify 'Non-Employee' in the 'Source Type' field. Refer to Creating a Non-Employee Source for more details about how to create non-employee sources.

To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to.

Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. Refer to Adding Accounts for more details about how to add accounts to non-employee sources.

Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities.

Refer to Managing Non-Employee Sources and Accounts for more information about non-employee lifecycle management.

All URIs are relative to https://sailpoint.api.identitynow.com/v3

Method HTTP request Description
Approve-NonEmployeeRequest POST /non-employee-approvals/{id}/approve Approve a Non-Employee Request
New-NonEmployeeRecord POST /non-employee-records Create Non-Employee Record
New-NonEmployeeRequest POST /non-employee-requests Create Non-Employee Request
New-NonEmployeeSource POST /non-employee-sources Create Non-Employee Source
New-NonEmployeeSourceSchemaAttributes POST /non-employee-sources/{sourceId}/schema-attributes Create a new Schema Attribute for Non-Employee Source
Remove-NonEmployeeRecord DELETE /non-employee-records/{id} Delete Non-Employee Record
Remove-NonEmployeeRecordsInBulk POST /non-employee-records/bulk-delete Delete Multiple Non-Employee Records
Remove-NonEmployeeRequest DELETE /non-employee-requests/{id} Delete Non-Employee Request
Remove-NonEmployeeSchemaAttribute DELETE /non-employee-sources/{sourceId}/schema-attributes/{attributeId} Delete a Schema Attribute for Non-Employee Source
Remove-NonEmployeeSource DELETE /non-employee-sources/{sourceId} Delete Non-Employee Source
Remove-NonEmployeeSourceSchemaAttributes DELETE /non-employee-sources/{sourceId}/schema-attributes Delete all custom schema attributes for Non-Employee Source
Export-NonEmployeeRecords GET /non-employee-sources/{id}/non-employees/download Exports Non-Employee Records to CSV
Export-NonEmployeeSourceSchemaTemplate GET /non-employee-sources/{id}/schema-attributes-template/download Exports Source Schema Template
Get-NonEmployeeApproval GET /non-employee-approvals/{id} Get a non-employee approval item detail
Get-NonEmployeeApprovalSummary GET /non-employee-approvals/summary/{requested-for} Get Summary of Non-Employee Approval Requests
Get-NonEmployeeBulkUploadStatus GET /non-employee-sources/{id}/non-employee-bulk-upload/status Obtain the status of bulk upload on the source
Get-NonEmployeeRecord GET /non-employee-records/{id} Get a Non-Employee Record
Get-NonEmployeeRequest GET /non-employee-requests/{id} Get a Non-Employee Request
Get-NonEmployeeRequestSummary GET /non-employee-requests/summary/{requested-for} Get Summary of Non-Employee Requests
Get-NonEmployeeSchemaAttribute GET /non-employee-sources/{sourceId}/schema-attributes/{attributeId} Get Schema Attribute Non-Employee Source
Get-NonEmployeeSource GET /non-employee-sources/{sourceId} Get a Non-Employee Source
Get-NonEmployeeSourceSchemaAttributes GET /non-employee-sources/{sourceId}/schema-attributes List Schema Attributes Non-Employee Source
Import-NonEmployeeRecordsInBulk POST /non-employee-sources/{id}/non-employee-bulk-upload Imports, or Updates, Non-Employee Records
Get-NonEmployeeApprovals GET /non-employee-approvals Get List of Non-Employee Approval Requests
Get-NonEmployeeRecords GET /non-employee-records List Non-Employee Records
Get-NonEmployeeRequests GET /non-employee-requests List Non-Employee Requests
Get-NonEmployeeSources GET /non-employee-sources List Non-Employee Sources
Update-NonEmployeeRecord PATCH /non-employee-records/{id} Patch Non-Employee Record
Update-NonEmployeeSchemaAttribute PATCH /non-employee-sources/{sourceId}/schema-attributes/{attributeId} Patch a Schema Attribute for Non-Employee Source
Update-NonEmployeeSource PATCH /non-employee-sources/{sourceId} Patch a Non-Employee Source
Deny-NonEmployeeRequest POST /non-employee-approvals/{id}/reject Reject a Non-Employee Request
Update-NonEmployeeRecord 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.

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-Employee approval item id (UUID)
Body NonEmployeeApprovalDecision NonEmployeeApprovalDecision True

Return type

NonEmployeeApprovalItem

Responses

Code Description Data Type
200 Non-Employee approval item object. NonEmployeeApprovalItem
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID)
$NonEmployeeApprovalDecision = @"{
  "comment" : "Approved by manager"
}"@

# Approve a Non-Employee Request

try {
    $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
    Approve-NonEmployeeRequest-Id $Id -NonEmployeeApprovalDecision $Result
    
    # Below is a request that includes all optional parameters
    # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision  
} 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

Parameters

Param Type Name Data Type Required Description
Body NonEmployeeRequestBody NonEmployeeRequestBody True Non-Employee record creation request body.

Return type

NonEmployeeRecord

Responses

Code Description Data Type
200 Created non-employee record. NonEmployeeRecord
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$NonEmployeeRequestBody = @"{
  "sourceId" : "2c91808568c529c60168cca6f90c1313",
  "firstName" : "William",
  "lastName" : "Smith",
  "manager" : "jane.doe",
  "data" : {
    "description" : "Auditing"
  },
  "accountName" : "william.smith",
  "phone" : "5125555555",
  "endDate" : "2021-03-25T00:00:00-05:00",
  "email" : "william.smith@example.com",
  "startDate" : "2020-03-24T00:00:00-05:00"
}"@

# Create Non-Employee Record

try {
    $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
    New-NonEmployeeRecord-NonEmployeeRequestBody $Result
    
    # Below is a request that includes all optional parameters
    # New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody  
} 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.

Parameters

Param Type Name Data Type Required Description
Body NonEmployeeRequestBody NonEmployeeRequestBody True Non-Employee creation request body

Return type

NonEmployeeRequest

Responses

Code Description Data Type
200 Non-Employee request creation object NonEmployeeRequest
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$NonEmployeeRequestBody = @"{
  "sourceId" : "2c91808568c529c60168cca6f90c1313",
  "firstName" : "William",
  "lastName" : "Smith",
  "manager" : "jane.doe",
  "data" : {
    "description" : "Auditing"
  },
  "accountName" : "william.smith",
  "phone" : "5125555555",
  "endDate" : "2021-03-25T00:00:00-05:00",
  "email" : "william.smith@example.com",
  "startDate" : "2020-03-24T00:00:00-05:00"
}"@

# Create Non-Employee Request

try {
    $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
    New-NonEmployeeRequest-NonEmployeeRequestBody $Result
    
    # Below is a request that includes all optional parameters
    # New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody  
} 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

Parameters

Param Type Name Data Type Required Description
Body NonEmployeeSourceRequestBody NonEmployeeSourceRequestBody True Non-Employee source creation request body.

Return type

NonEmployeeSourceWithCloudExternalId

Responses

Code Description Data Type
200 Created non-employee source. NonEmployeeSourceWithCloudExternalId
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$NonEmployeeSourceRequestBody = @"{
  "owner" : {
    "id" : "2c91808570313110017040b06f344ec9"
  },
  "managementWorkgroup" : "123299",
  "accountManagers" : [ {
    "id" : "2c91808570313110017040b06f344ec9"
  }, {
    "id" : "2c91808570313110017040b06f344ec9"
  }, {
    "id" : "2c91808570313110017040b06f344ec9"
  }, {
    "id" : "2c91808570313110017040b06f344ec9"
  }, {
    "id" : "2c91808570313110017040b06f344ec9"
  } ],
  "name" : "Retail",
  "description" : "Source description",
  "approvers" : [ {
    "id" : "2c91808570313110017040b06f344ec9"
  }, {
    "id" : "2c91808570313110017040b06f344ec9"
  }, {
    "id" : "2c91808570313110017040b06f344ec9"
  } ]
}"@

# Create Non-Employee Source

try {
    $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
    New-NonEmployeeSource-NonEmployeeSourceRequestBody $Result
    
    # Below is a request that includes all optional parameters
    # New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody  
} 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

Parameters

Param Type Name Data Type Required Description
Path SourceId String True The Source id
Body NonEmployeeSchemaAttributeBody NonEmployeeSchemaAttributeBody True

Return type

NonEmployeeSchemaAttribute

Responses

Code Description Data Type
200 Schema Attribute created. NonEmployeeSchemaAttribute
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
$NonEmployeeSchemaAttributeBody = @"{
  "helpText" : "The unique identifier for the account",
  "label" : "Account Name",
  "placeholder" : "Enter a unique user name for this account.",
  "type" : "TEXT",
  "technicalName" : "account.name",
  "required" : true
}"@

# Create a new Schema Attribute for Non-Employee Source

try {
    $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
    New-NonEmployeeSourceSchemaAttributes-SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
    
    # Below is a request that includes all optional parameters
    # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody  
} 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

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-Employee record id (UUID)

Return type

(empty response body)

Responses

Code Description Data Type
204 No content - indicates the request was successful but there is no content to be returned in the response.
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID)

# Delete Non-Employee Record

try {
    Remove-NonEmployeeRecord-Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-NonEmployeeRecord -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord"
    Write-Host $_.ErrorDetails
}

[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

Parameters

Param Type Name Data Type Required Description
Body DeleteNonEmployeeRecordsInBulkRequest DeleteNonEmployeeRecordsInBulkRequest True Non-Employee bulk delete request body.

Return type

(empty response body)

Responses

Code Description Data Type
204 No content - indicates the request was successful but there is no content to be returned in the response.
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$DeleteNonEmployeeRecordsInBulkRequest = @""@

# Delete Multiple Non-Employee Records

try {
    $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest
    Remove-NonEmployeeRecordsInBulk-DeleteNonEmployeeRecordsInBulkRequest $Result
    
    # Below is a request that includes all optional parameters
    # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest  
} 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

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-Employee request id in the UUID format

Return type

(empty response body)

Responses

Code Description Data Type
204 No content - indicates the request was successful but there is no content to be returned in the response.
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format

# Delete Non-Employee Request

try {
    Remove-NonEmployeeRequest-Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-NonEmployeeRequest -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest"
    Write-Host $_.ErrorDetails
}

[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

Parameters

Param Type Name Data Type Required Description
Path AttributeId String True The Schema Attribute Id (UUID)
Path SourceId String True The Source id

Return type

(empty response body)

Responses

Code Description Data Type
204 No content - indicates the request was successful but there is no content to be returned in the response.
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id

# Delete a Schema Attribute for Non-Employee Source

try {
    Remove-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId 
    
    # Below is a request that includes all optional parameters
    # Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-non-employee-source

This request will delete a non-employee source. Requires role context of idn:nesr:delete.

Parameters

Param Type Name Data Type Required Description
Path SourceId String True Source Id

Return type

(empty response body)

Responses

Code Description Data Type
204 No content - indicates the request was successful but there is no content to be returned in the response.
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id

# Delete Non-Employee Source

try {
    Remove-NonEmployeeSource-SourceId $SourceId 
    
    # Below is a request that includes all optional parameters
    # Remove-NonEmployeeSource -SourceId $SourceId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource"
    Write-Host $_.ErrorDetails
}

[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

Parameters

Param Type Name Data Type Required Description
Path SourceId String True The Source id

Return type

(empty response body)

Responses

Code Description Data Type
204 No content - indicates the request was successful but there is no content to be returned in the response.
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id

# Delete all custom schema attributes for Non-Employee Source

try {
    Remove-NonEmployeeSourceSchemaAttributes-SourceId $SourceId 
    
    # Below is a request that includes all optional parameters
    # Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes"
    Write-Host $_.ErrorDetails
}

[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

Parameters

Param Type Name Data Type Required Description
Path Id String True Source Id (UUID)

Return type

(empty response body)

Responses

Code Description Data Type
200 Exported CSV
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/csv, application/json

Example

$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)

# Exports Non-Employee Records to CSV

try {
    Export-NonEmployeeRecords-Id $Id 
    
    # Below is a request that includes all optional parameters
    # Export-NonEmployeeRecords -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords"
    Write-Host $_.ErrorDetails
}

[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

Parameters

Param Type Name Data Type Required Description
Path Id String True Source Id (UUID)

Return type

(empty response body)

Responses

Code Description Data Type
200 Exported Source Schema Template
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/csv, application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID)

# Exports Source Schema Template

try {
    Export-NonEmployeeSourceSchemaTemplate-Id $Id 
    
    # Below is a request that includes all optional parameters
    # Export-NonEmployeeSourceSchemaTemplate -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate"
    Write-Host $_.ErrorDetails
}

[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.

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-Employee approval item id (UUID)
Query IncludeDetail Boolean (optional) The object nonEmployeeRequest will not be included detail when set to false. Default value is true

Return type

NonEmployeeApprovalItemDetail

Responses

Code Description Data Type
200 Non-Employee approval item object. NonEmployeeApprovalItemDetail
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID)
$IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional)

# Get a non-employee approval item detail

try {
    Get-NonEmployeeApproval-Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval"
    Write-Host $_.ErrorDetails
}

[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 she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id.
  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.

Parameters

Param Type Name Data Type Required Description
Path RequestedFor String True The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.

Return type

NonEmployeeApprovalSummary

Responses

Code Description Data Type
200 summary of non-employee approval requests NonEmployeeApprovalSummary
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.

# Get Summary of Non-Employee Approval Requests

try {
    Get-NonEmployeeApprovalSummary-RequestedFor $RequestedFor 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary"
    Write-Host $_.ErrorDetails
}

[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

Parameters

Param Type Name Data Type Required Description
Path Id String True Source ID (UUID)

Return type

NonEmployeeBulkUploadStatus

Responses

Code Description Data Type
200 Status of the newest bulk-upload job, if any. NonEmployeeBulkUploadStatus
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID)

# Obtain the status of bulk upload on the source

try {
    Get-NonEmployeeBulkUploadStatus-Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeBulkUploadStatus -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-non-employee-record

This gets a non-employee record. Requires role context of idn:nesr:read

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-Employee record id (UUID)

Return type

NonEmployeeRecord

Responses

Code Description Data Type
200 Non-Employee record object NonEmployeeRecord
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID)

# Get a Non-Employee Record

try {
    Get-NonEmployeeRecord-Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeRecord -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-non-employee-request

This gets a non-employee request. There are two contextual uses for this endpoint:

  1. The user has the role context of idn:nesr:read, in this case the user can get the non-employee request for any user.
  2. The user must be the owner of the non-employee request.

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-Employee request id (UUID)

Return type

NonEmployeeRequest

Responses

Code Description Data Type
200 Non-Employee request object. NonEmployeeRequest
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID)

# Get a Non-Employee Request

try {
    Get-NonEmployeeRequest-Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeRequest -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest"
    Write-Host $_.ErrorDetails
}

[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 she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id.
  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.

Parameters

Param Type Name Data Type Required Description
Path RequestedFor String True The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.

Return type

NonEmployeeRequestSummary

Responses

Code Description Data Type
200 Non-Employee request summary object. NonEmployeeRequestSummary
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.

# Get Summary of Non-Employee Requests

try {
    Get-NonEmployeeRequestSummary-RequestedFor $RequestedFor 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary"
    Write-Host $_.ErrorDetails
}

[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.

Parameters

Param Type Name Data Type Required Description
Path AttributeId String True The Schema Attribute Id (UUID)
Path SourceId String True The Source id

Return type

NonEmployeeSchemaAttribute

Responses

Code Description Data Type
200 The Schema Attribute NonEmployeeSchemaAttribute
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id

# Get Schema Attribute Non-Employee Source

try {
    Get-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute"
    Write-Host $_.ErrorDetails
}

[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 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.

Parameters

Param Type Name Data Type Required Description
Path SourceId String True Source Id

Return type

NonEmployeeSource

Responses

Code Description Data Type
200 Non-Employee source object. NonEmployeeSource
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id

# Get a Non-Employee Source

try {
    Get-NonEmployeeSource-SourceId $SourceId 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeSource -SourceId $SourceId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource"
    Write-Host $_.ErrorDetails
}

[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.

Parameters

Param Type Name Data Type Required Description
Path SourceId String True The Source id

Return type

NonEmployeeSchemaAttribute[]

Responses

Code Description Data Type
200 A list of Schema Attributes NonEmployeeSchemaAttribute[]
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id

# List Schema Attributes Non-Employee Source

try {
    Get-NonEmployeeSourceSchemaAttributes-SourceId $SourceId 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes"
    Write-Host $_.ErrorDetails
}

[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

Parameters

Param Type Name Data Type Required Description
Path Id String True Source Id (UUID)
Data System.IO.FileInfo True

Return type

NonEmployeeBulkUploadJob

Responses

Code Description Data Type
202 The CSV was accepted to be bulk inserted now or at a later time. NonEmployeeBulkUploadJob
400 Client Error - Returned if the request body is invalid. The response body will contain the list of specific errors with one on each line. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

Example

$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
$Data =  # System.IO.FileInfo | 

# Imports, or Updates, Non-Employee Records

try {
    Import-NonEmployeeRecordsInBulk-Id $Id -Data $Data 
    
    # Below is a request that includes all optional parameters
    # Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-non-employee-approvals

This gets a list of non-employee approval requests. There are two contextual uses for this endpoint:

  1. The user has the role context of idn:nesr:read, in which case they can list the approvals for any approver.
  2. The user owns the requested approval.

Parameters

Param Type Name Data Type Required Description
Query RequestedFor String (optional) The identity for whom the request was made. me indicates the current user.
Query Limit Int32 (optional) (default to 250) Max number of results to return. See V3 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 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 for more information.
Query Filters String (optional) Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: approvalStatus: eq
Query Sorters String (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: created, modified

Return type

NonEmployeeApprovalItem[]

Responses

Code Description Data Type
200 List of approval items. NonEmployeeApprovalItem[]
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional)
$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 = 'approvalStatus eq "Pending"' # 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:  **approvalStatus**: *eq* (optional)
$Sorters = "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: **created, modified** (optional)

# Get List of Non-Employee Approval Requests

try {
    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  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals"
    Write-Host $_.ErrorDetails
}

[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.

Parameters

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 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 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 for more information.
Query Sorters String (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified
Query Filters String (optional) Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: sourceId: eq

Return type

NonEmployeeRecord[]

Responses

Code Description Data Type
200 Non-Employee record objects NonEmployeeRecord[]
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$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)
$Sorters = "accountName,sourceId" # 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional)
$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # 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:  **sourceId**: *eq* (optional)

# List Non-Employee Records

try {
    Get-NonEmployeeRecords
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords"
    Write-Host $_.ErrorDetails
}

[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 she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.
  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.

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 Limit Int32 (optional) (default to 250) Max number of results to return. See V3 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 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 for more information.
Query Sorters String (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate
Query Filters String (optional) Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: sourceId: eq

Return type

NonEmployeeRequest[]

Responses

Code Description Data Type
200 List of non-employee request objects. NonEmployeeRequest[]
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user.
$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)
$Sorters = "created,approvalStatus" # 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional)
$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # 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:  **sourceId**: *eq*  (optional)

# List Non-Employee Requests

try {
    Get-NonEmployeeRequests-RequestedFor $RequestedFor 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests"
    Write-Host $_.ErrorDetails
}

[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 she may request a list sources assigned to a particular account manager by passing in that manager's id.
  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.

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 Limit Int32 (optional) (default to 250) Max number of results to return. See V3 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 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 for more information.
Query NonEmployeeCount Boolean (optional) The flag to determine whether return a non-employee count associate with source.
Query Sorters String (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, created, sourceId

Return type

NonEmployeeSourceWithNECount[]

Responses

Code Description Data Type
200 List of non-employee sources 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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user.
$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)
$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional)
$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-NonEmployeeSources-RequestedFor $RequestedFor 
    
    # Below is a request that includes all optional parameters
    # Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources"
    Write-Host $_.ErrorDetails
}

[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 update all available fields.
  2. The user is owner of the source, in this case they can only update the end date.

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-employee record id (UUID)
Body JsonPatchOperation []JsonPatchOperation True A list of non-employee update operations according to the JSON Patch standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.

Return type

NonEmployeeRecord

Responses

Code Description Data Type
200 A patched non-employee record. NonEmployeeRecord
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID)
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
 

# Patch Non-Employee Record

try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-NonEmployeeRecord-Id $Id -JsonPatchOperation $Result
    
    # Below is a request that includes all optional parameters
    # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation  
} 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

Parameters

Param Type Name Data Type Required Description
Path AttributeId String True The Schema Attribute Id (UUID)
Path SourceId String True The Source id
Body JsonPatchOperation []JsonPatchOperation True A list of schema attribute update operations according to the JSON Patch standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.

Return type

NonEmployeeSchemaAttribute

Responses

Code Description Data Type
200 The Schema Attribute was successfully patched. NonEmployeeSchemaAttribute
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

Example

$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
 

# Patch a Schema Attribute for Non-Employee Source

try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    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  
} 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)
Patchable field: name, description, approvers, accountManagers Requires role context of idn:nesr:update.

Parameters

Param Type Name Data Type Required Description
Path SourceId String True Source Id
Body JsonPatchOperation []JsonPatchOperation True A list of non-employee source update operations according to the JSON Patch standard.

Return type

NonEmployeeSource

Responses

Code Description Data Type
200 A patched non-employee source object. NonEmployeeSource
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

Example

$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
 

# Patch a Non-Employee Source

try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-NonEmployeeSource-SourceId $SourceId -JsonPatchOperation $Result
    
    # Below is a request that includes all optional parameters
    # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation  
} 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.

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-Employee approval item id (UUID)
Body NonEmployeeRejectApprovalDecision NonEmployeeRejectApprovalDecision True

Return type

NonEmployeeApprovalItem

Responses

Code Description Data Type
200 Non-Employee approval item object. NonEmployeeApprovalItem
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID)
$NonEmployeeRejectApprovalDecision = @"{
  "comment" : "approved"
}"@

# Reject a Non-Employee Request

try {
    $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
    Deny-NonEmployeeRequest-Id $Id -NonEmployeeRejectApprovalDecision $Result
    
    # Below is a request that includes all optional parameters
    # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision  
} 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 update all available fields.
  2. The user is owner of the source, in this case they can only update the end date.

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-employee record id (UUID)
Body NonEmployeeRequestBody NonEmployeeRequestBody True Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.

Return type

NonEmployeeRecord

Responses

Code Description Data Type
200 An updated non-employee record. NonEmployeeRecord
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. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID)
$NonEmployeeRequestBody = @"{
  "sourceId" : "2c91808568c529c60168cca6f90c1313",
  "firstName" : "William",
  "lastName" : "Smith",
  "manager" : "jane.doe",
  "data" : {
    "description" : "Auditing"
  },
  "accountName" : "william.smith",
  "phone" : "5125555555",
  "endDate" : "2021-03-25T00:00:00-05:00",
  "email" : "william.smith@example.com",
  "startDate" : "2020-03-24T00:00:00-05:00"
}"@

# Update Non-Employee Record

try {
    $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
    Update-NonEmployeeRecord-Id $Id -NonEmployeeRequestBody $Result
    
    # Below is a request that includes all optional parameters
    # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord"
    Write-Host $_.ErrorDetails
}

[Back to top]