LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-06 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ee77cd5e3653839fc53b3b66a4eb22765bd3d45e
developer.sailpoint.com/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md
developer-relations-sp 22efb17a6f Update PowerShell SDK docs: 16199476247
2025-07-10 15:36:19 +00:00

98 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
beta-non-employee-lifecycle-management NonEmployeeLifecycleManagement NonEmployeeLifecycleManagement NonEmployeeLifecycleManagement powershellsdk
powershell
PowerShell
sdk
NonEmployeeLifecycleManagement
BetaNonEmployeeLifecycleManagement
/tools/sdk/powershell/beta/methods/non-employee-lifecycle-management
SDK
Software Development Kit
NonEmployeeLifecycleManagement
BetaNonEmployeeLifecycleManagement

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/beta

Method HTTP request Description
Approve-BetaNonEmployeeRequest POST /non-employee-approvals/{id}/approve Approve a non-employee request
New-BetaNonEmployeeRecord POST /non-employee-records Create non-employee record
New-BetaNonEmployeeRequest POST /non-employee-requests Create non-employee request
New-BetaNonEmployeeSource POST /non-employee-sources Create non-employee source
New-BetaNonEmployeeSourceSchemaAttributes POST /non-employee-sources/{sourceId}/schema-attributes Create non-employee source schema attribute
Remove-BetaNonEmployeeRecord DELETE /non-employee-records/{id} Delete non-employee record
Remove-BetaNonEmployeeRecordInBulk POST /non-employee-records/bulk-delete Delete multiple non-employee records
Remove-BetaNonEmployeeRequest DELETE /non-employee-requests/{id} Delete non-employee request
Remove-BetaNonEmployeeSchemaAttribute DELETE /non-employee-sources/{sourceId}/schema-attributes/{attributeId} Delete non-employee source's schema attribute
Remove-BetaNonEmployeeSource DELETE /non-employee-sources/{sourceId} Delete non-employee source
Remove-BetaNonEmployeeSourceSchemaAttributes DELETE /non-employee-sources/{sourceId}/schema-attributes Delete all custom schema attributes
Get-BetaNonEmployeeApproval GET /non-employee-approvals/{id} A non-employee approval item detail
Get-BetaNonEmployeeApprovalSummary GET /non-employee-approvals/summary/{requested-for} Summary of non-employee approval requests
Get-BetaNonEmployeeBulkUploadStatus GET /non-employee-sources/{id}/non-employee-bulk-upload/status Bulk upload status on source
Get-BetaNonEmployeeExportRecords GET /non-employee-sources/{id}/non-employees/download Exports non-employee records to csv
Get-BetaNonEmployeeExportSourceSchemaTemplate GET /non-employee-sources/{id}/schema-attributes-template/download Exports source schema template
Get-BetaNonEmployeeRecord GET /non-employee-records/{id} Get a non-employee record
Get-BetaNonEmployeeRequest GET /non-employee-requests/{id} Get a non-employee request
Get-BetaNonEmployeeRequestSummary GET /non-employee-requests/summary/{requested-for} Get summary of non-employee requests
Get-BetaNonEmployeeSchemaAttribute GET /non-employee-sources/{sourceId}/schema-attributes/{attributeId} Get schema attribute non-employee source
Get-BetaNonEmployeeSource GET /non-employee-sources/{sourceId} Get a non-employee source
Get-BetaNonEmployeeSourceSchemaAttributes GET /non-employee-sources/{sourceId}/schema-attributes List schema attributes non-employee source
Import-BetaNonEmployeeRecordsInBulk POST /non-employee-sources/{id}/non-employee-bulk-upload Imports, or updates, non-employee records
Get-BetaNonEmployeeApproval GET /non-employee-approvals List of non-employee approval requests
Get-BetaNonEmployeeRecords GET /non-employee-records List non-employee records
Get-BetaNonEmployeeRequests GET /non-employee-requests List non-employee requests
Get-BetaNonEmployeeSources GET /non-employee-sources List non-employee sources
Update-BetaNonEmployeeRecord PATCH /non-employee-records/{id} Patch non-employee record
Update-BetaNonEmployeeSchemaAttribute PATCH /non-employee-sources/{sourceId}/schema-attributes/{attributeId} Patch non-employee source's schema attribute
Update-BetaNonEmployeeSource PATCH /non-employee-sources/{sourceId} Patch a non-employee source
Send-BetaNonEmployeeRecord PUT /non-employee-records/{id} Update non-employee record
Deny-BetaNonEmployeeRequest POST /non-employee-approvals/{id}/reject Reject a non-employee request

approve-non-employee-request

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Approves a non-employee approval request and notifies the next approver.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee approval item id (UUID)
$NonEmployeeApprovalDecision = @"{
  "comment" : "comment"
}"@

# Approve a non-employee request

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

[Back to top]

create-non-employee-record

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will create a non-employee record. Request will require the following security scope: 'idn:nesr:create'

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-non-employee-request

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will create a non-employee request and notify the approver

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-non-employee-source

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Create a non-employee source.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-non-employee-source-schema-attributes

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: 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.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$SourceId = "2c91808b6ef1d43e016efba0ce470904" # 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 non-employee source schema attribute

try {
    $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
    New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-non-employee-record

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will delete a non-employee record.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

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

# Delete non-employee record

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

[Back to top]

delete-non-employee-record-in-bulk

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will delete multiple non-employee records based on the non-employee ids provided. Request will require the following scope: 'idn:nesr:delete'

API Spec

Parameters

Param Type Name Data Type Required Description
Body DeleteNonEmployeeRecordInBulkRequest DeleteNonEmployeeRecordInBulkRequest 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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$DeleteNonEmployeeRecordInBulkRequest = @""@

# Delete multiple non-employee records

try {
    $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest
    Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result 
    
    # Below is a request that includes all optional parameters
    # Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-non-employee-request

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will delete a non-employee request.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format

# Delete non-employee request

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

[Back to top]

delete-non-employee-schema-attribute

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This end-point deletes a specific schema attribute for a non-employee source.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

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

# Delete non-employee source's schema attribute

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

[Back to top]

delete-non-employee-source

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will delete a non-employee source.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

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

# Delete non-employee source

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

[Back to top]

delete-non-employee-source-schema-attributes

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This end-point deletes all custom schema attributes for a non-employee source.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id

# Delete all custom schema attributes

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

[Back to top]

get-non-employee-approval

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Approves a non-employee approval request and notifies the next approver.

API Spec

Parameters

Param Type Name Data Type Required Description
Path Id String True Non-Employee approval item id (UUID)
Query IncludeDetail String (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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID)
$IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional)

# A non-employee approval item detail

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

[Back to top]

get-non-employee-approval-summary

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the requested-for path parameter: 1. The current user is the Org Admin, 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.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.

# Summary of non-employee approval requests

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

[Back to top]

get-non-employee-bulk-upload-status

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

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

# Bulk upload status on source

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

[Back to top]

get-non-employee-export-records

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This requests a CSV download for all non-employees from a provided source.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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 = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID)

# Exports non-employee records to csv

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

[Back to top]

get-non-employee-export-source-schema-template

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This requests a download for the Source Schema Template for a provided source. Request will require the following security scope: idn:nesr:read'

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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 = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID)

# Exports source schema template

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

[Back to top]

get-non-employee-record

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This gets a non-employee record.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

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

# Get a non-employee record

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

[Back to top]

get-non-employee-request

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This gets a non-employee request.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID)

# Get a non-employee request

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

[Back to top]

get-non-employee-request-summary

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will retrieve a summary of non-employee requests. There are two contextual uses for the requested-for path parameter: 1. The current user is the Org Admin, 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.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # 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-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor 
    
    # Below is a request that includes all optional parameters
    # Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-non-employee-schema-attribute

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This API gets a schema attribute by Id for the specified Non-Employee SourceId.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

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

# Get schema attribute non-employee source

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

[Back to top]

get-non-employee-source

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This gets a non-employee source.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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-BetaNonEmployeeSource -SourceId $SourceId 
    
    # Below is a request that includes all optional parameters
    # Get-BetaNonEmployeeSource -SourceId $SourceId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-non-employee-source-schema-attributes

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: 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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path SourceId String True The Source id
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.

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id
$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)

# List schema attributes non-employee source

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

[Back to top]

import-non-employee-records-in-bulk

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This post will import, or update, Non-Employee records found in the CSV. Request will need the following security scope: 'idn:nesr:create'

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data 
    
    # Below is a request that includes all optional parameters
    # Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-non-employee-approval

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This gets a list of non-employee approval requests.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # 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)

# List of non-employee approval requests

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

[Back to top]

list-non-employee-records

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This gets a list of non-employee records.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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-BetaNonEmployeeRecords 
    
    # Below is a request that includes all optional parameters
    # Get-BetaNonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-non-employee-requests

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This gets a list of non-employee requests.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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)
$Sorters = "approvalStatus,firstName" # 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-BetaNonEmployeeRequests -RequestedFor $RequestedFor 
    
    # Below is a request that includes all optional parameters
    # Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-non-employee-sources

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Get a list of non-employee sources. There are two contextual uses for the requested-for path parameter:

  1. If the user has the role context of idn:nesr:read, he or she may request a list sources assigned to a particular account manager by passing in that manager's id.
  2. If the current user is an account manager, the user should provide 'me' as the requested-for value. Doing so provide the user with a list of the sources he or she owns.

API Spec

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 RequestedFor String (optional) Identity the request was made for. Use 'me' to indicate the current user.
Query NonEmployeeCount Boolean (optional) (default to $false) Flag that determines whether the API will return a non-employee count associated with the source.
Query Sorters String (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, created, sourceId

Return type

NonEmployeeSourceWithNECount[]

Responses

Code Description Data Type
200 List of non-employee source objects. NonEmployeeSourceWithNECount[]
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
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. ListAccessModelMetadataAttribute429Response
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)
$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional)
$NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false)
$Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name, created, sourceId** (optional)

# List non-employee sources

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

[Back to top]

patch-non-employee-record

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will patch a non-employee record.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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 = "2c91808b6ef1d43e016efba0ce470904" # 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-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result 
    
    # Below is a request that includes all optional parameters
    # Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord"
    Write-Host $_.ErrorDetails
}

[Back to top]

patch-non-employee-schema-attribute

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This end-point patches a specific schema attribute for a non-employee SourceId.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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 = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID)
$SourceId = "2c91808b6ef1d43e016efba0ce470904" # 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 non-employee source's schema attribute

try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result 
    
    # Below is a request that includes all optional parameters
    # Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute"
    Write-Host $_.ErrorDetails
}

[Back to top]

patch-non-employee-source

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: patch a non-employee source. (Partial Update) Patchable field: name, description, approvers, accountManagers

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
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 = "2c91808b6ef1d43e016efba0ce470904" # 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-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result 
    
    # Below is a request that includes all optional parameters
    # Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-non-employee-record

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This request will update a non-employee record.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808b6ef1d43e016efba0ce470904" # 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
    Send-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result 
    
    # Below is a request that includes all optional parameters
    # Send-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNonEmployeeRecord"
    Write-Host $_.ErrorDetails
}

[Back to top]

reject-non-employee-request

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: This endpoint will reject an approval item request and notify user.

API Spec

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. ListAccessModelMetadataAttribute401Response
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. ListAccessModelMetadataAttribute429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

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

Example

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

# Reject a non-employee request

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

[Back to top]