Skip to main content

NonEmployeeLifecycleManagementService

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.

Every method returns an Observable. All request paths are relative to the baseUrl you pass to provideSailPoint().

MethodHTTP requestDescription
approve-non-employee-request-v1POST /non-employee-approvals/v1/{id}/approveApprove a non-employee request
create-non-employee-record-v1POST /non-employee-records/v1Create non-employee record
create-non-employee-request-v1POST /non-employee-requests/v1Create non-employee request
create-non-employee-source-schema-attributes-v1POST /non-employee-sources/v1/{sourceId}/schema-attributesCreate a new schema attribute for non-employee source
create-non-employee-source-v1POST /non-employee-sources/v1Create non-employee source
delete-non-employee-record-v1DELETE /non-employee-records/v1/{id}Delete non-employee record
delete-non-employee-records-in-bulk-v1POST /non-employee-records/v1/bulk-deleteDelete multiple non-employee records
delete-non-employee-request-v1DELETE /non-employee-requests/v1/{id}Delete non-employee request
delete-non-employee-schema-attribute-v1DELETE /non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}Delete a schema attribute for non-employee source
delete-non-employee-source-schema-attributes-v1DELETE /non-employee-sources/v1/{sourceId}/schema-attributesDelete all custom schema attributes for non-employee source
delete-non-employee-source-v1DELETE /non-employee-sources/v1/{sourceId}Delete non-employee source
export-non-employee-records-v1GET /non-employee-sources/v1/{id}/non-employees/downloadExports non-employee records to csv
export-non-employee-source-schema-template-v1GET /non-employee-sources/v1/{id}/schema-attributes-template/downloadExports source schema template
get-non-employee-approval-summary-v1GET /non-employee-approvals/v1/summary/{requestedFor}Get summary of non-employee approval requests
get-non-employee-approval-v1GET /non-employee-approvals/v1/{id}Get a non-employee approval item detail
get-non-employee-bulk-upload-status-v1GET /non-employee-sources/v1/{id}/non-employee-bulk-upload/statusObtain the status of bulk upload on the source
get-non-employee-record-v1GET /non-employee-records/v1/{id}Get a non-employee record
get-non-employee-request-summary-v1GET /non-employee-requests/v1/summary/{requestedFor}Get summary of non-employee requests
get-non-employee-request-v1GET /non-employee-requests/v1/{id}Get a non-employee request
get-non-employee-schema-attribute-v1GET /non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}Get schema attribute non-employee source
get-non-employee-source-schema-attributes-v1GET /non-employee-sources/v1/{sourceId}/schema-attributesList schema attributes non-employee source
get-non-employee-source-v1GET /non-employee-sources/v1/{sourceId}Get a non-employee source
import-non-employee-records-in-bulk-v1POST /non-employee-sources/v1/{id}/non-employee-bulk-uploadImports, or updates, non-employee records
list-non-employee-approvals-v1GET /non-employee-approvals/v1Get list of non-employee approval requests
list-non-employee-records-v1GET /non-employee-records/v1List non-employee records
list-non-employee-requests-v1GET /non-employee-requests/v1List non-employee requests
list-non-employee-sources-v1GET /non-employee-sources/v1List non-employee sources
patch-non-employee-record-v1PATCH /non-employee-records/v1/{id}Patch non-employee record
patch-non-employee-schema-attribute-v1PATCH /non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}Patch a schema attribute for non-employee source
patch-non-employee-source-v1PATCH /non-employee-sources/v1/{sourceId}Patch a non-employee source
reject-non-employee-request-v1POST /non-employee-approvals/v1/{id}/rejectReject a non-employee request
update-non-employee-record-v1PUT /non-employee-records/v1/{id}Update non-employee record

approve-non-employee-request-v1​

Approve a non-employee request Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ApproveNonEmployeeRequestV1RequestParams.

NameTypeDescriptionNotes
idstringNon-Employee approval item id (UUID)[default to undefined]
nonEmployeeApprovalDecisionNonEmployeeApprovalDecision

Return type​

Observable<NonEmployeeApprovalItem>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { NonEmployeeApprovalDecision } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  approveNonEmployeeRequestV1(): void {
    const id: string = ; // Non-Employee approval item id (UUID)
    const nonEmployeeApprovalDecision: NonEmployeeApprovalDecision = ; // 
    this.api.approveNonEmployeeRequestV1({ id: id, nonEmployeeApprovalDecision: nonEmployeeApprovalDecision }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

create-non-employee-record-v1​

Create non-employee record This request will create a non-employee record. Requires role context of idn:nesr:create

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is CreateNonEmployeeRecordV1RequestParams.

NameTypeDescriptionNotes
nonEmployeeRequestBodyNonEmployeeRequestBodyNon-Employee record creation request body.

Return type​

Observable<NonEmployeeRecord>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { NonEmployeeRequestBody } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  createNonEmployeeRecordV1(): void {
    const nonEmployeeRequestBody: NonEmployeeRequestBody = ; // Non-Employee record creation request body.
    this.api.createNonEmployeeRecordV1({ nonEmployeeRequestBody: nonEmployeeRequestBody }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

create-non-employee-request-v1​

Create non-employee request This request will create a non-employee request and notify the approver. Requires role context of idn:nesr:create or the user must own the source.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is CreateNonEmployeeRequestV1RequestParams.

NameTypeDescriptionNotes
nonEmployeeRequestBodyNonEmployeeRequestBodyNon-Employee creation request body

Return type​

Observable<NonEmployeeRequest>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { NonEmployeeRequestBody } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  createNonEmployeeRequestV1(): void {
    const nonEmployeeRequestBody: NonEmployeeRequestBody = ; // Non-Employee creation request body
    this.api.createNonEmployeeRequestV1({ nonEmployeeRequestBody: nonEmployeeRequestBody }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

create-non-employee-source-schema-attributes-v1​

Create a new schema attribute for non-employee source This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. Requires role context of idn:nesr:create

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is CreateNonEmployeeSourceSchemaAttributesV1RequestParams.

NameTypeDescriptionNotes
sourceIdstringThe Source id[default to undefined]
nonEmployeeSchemaAttributeBodyNonEmployeeSchemaAttributeBody

Return type​

Observable<NonEmployeeSchemaAttribute>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { NonEmployeeSchemaAttributeBody } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  createNonEmployeeSourceSchemaAttributesV1(): void {
    const sourceId: string = ; // The Source id
    const nonEmployeeSchemaAttributeBody: NonEmployeeSchemaAttributeBody = ; // 
    this.api.createNonEmployeeSourceSchemaAttributesV1({ sourceId: sourceId, nonEmployeeSchemaAttributeBody: nonEmployeeSchemaAttributeBody }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

create-non-employee-source-v1​

Create non-employee source Create a non-employee source.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is CreateNonEmployeeSourceV1RequestParams.

NameTypeDescriptionNotes
nonEmployeeSourceRequestBodyNonEmployeeSourceRequestBodyNon-Employee source creation request body.

Return type​

Observable<NonEmployeeSourceWithCloudExternalId>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { NonEmployeeSourceRequestBody } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  createNonEmployeeSourceV1(): void {
    const nonEmployeeSourceRequestBody: NonEmployeeSourceRequestBody = ; // Non-Employee source creation request body.
    this.api.createNonEmployeeSourceV1({ nonEmployeeSourceRequestBody: nonEmployeeSourceRequestBody }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-non-employee-record-v1​

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

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is DeleteNonEmployeeRecordV1RequestParams.

NameTypeDescriptionNotes
idstringNon-Employee record id (UUID)[default to undefined]

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  deleteNonEmployeeRecordV1(): void {
    const id: string = ; // Non-Employee record id (UUID)
    this.api.deleteNonEmployeeRecordV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-non-employee-records-in-bulk-v1​

Delete multiple non-employee records This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of idn:nesr:delete

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is DeleteNonEmployeeRecordsInBulkV1RequestParams.

NameTypeDescriptionNotes
deleteNonEmployeeRecordsInBulkV1RequestDeleteNonEmployeeRecordsInBulkV1RequestNon-Employee bulk delete request body.

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { DeleteNonEmployeeRecordsInBulkV1Request } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  deleteNonEmployeeRecordsInBulkV1(): void {
    const deleteNonEmployeeRecordsInBulkV1Request: DeleteNonEmployeeRecordsInBulkV1Request = ; // Non-Employee bulk delete request body.
    this.api.deleteNonEmployeeRecordsInBulkV1({ deleteNonEmployeeRecordsInBulkV1Request: deleteNonEmployeeRecordsInBulkV1Request }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-non-employee-request-v1​

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

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is DeleteNonEmployeeRequestV1RequestParams.

NameTypeDescriptionNotes
idstringNon-Employee request id in the UUID format[default to undefined]

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  deleteNonEmployeeRequestV1(): void {
    const id: string = ; // Non-Employee request id in the UUID format
    this.api.deleteNonEmployeeRequestV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-non-employee-schema-attribute-v1​

Delete a schema attribute for non-employee source This end-point deletes a specific schema attribute for a non-employee source. Requires role context of idn:nesr:delete

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is DeleteNonEmployeeSchemaAttributeV1RequestParams.

NameTypeDescriptionNotes
attributeIdstringThe Schema Attribute Id (UUID)[default to undefined]
sourceIdstringThe Source id[default to undefined]

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  deleteNonEmployeeSchemaAttributeV1(): void {
    const attributeId: string = ; // The Schema Attribute Id (UUID)
    const sourceId: string = ; // The Source id
    this.api.deleteNonEmployeeSchemaAttributeV1({ attributeId: attributeId, sourceId: sourceId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-non-employee-source-schema-attributes-v1​

Delete all custom schema attributes for non-employee source This end-point deletes all custom schema attributes for a non-employee source. Requires role context of idn:nesr:delete

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is DeleteNonEmployeeSourceSchemaAttributesV1RequestParams.

NameTypeDescriptionNotes
sourceIdstringThe Source id[default to undefined]

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  deleteNonEmployeeSourceSchemaAttributesV1(): void {
    const sourceId: string = ; // The Source id
    this.api.deleteNonEmployeeSourceSchemaAttributesV1({ sourceId: sourceId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-non-employee-source-v1​

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

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is DeleteNonEmployeeSourceV1RequestParams.

NameTypeDescriptionNotes
sourceIdstringSource Id[default to undefined]

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  deleteNonEmployeeSourceV1(): void {
    const sourceId: string = ; // Source Id
    this.api.deleteNonEmployeeSourceV1({ sourceId: sourceId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

export-non-employee-records-v1​

Exports non-employee records to csv This requests a CSV download for all non-employees from a provided source. Requires role context of idn:nesr:read

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ExportNonEmployeeRecordsV1RequestParams.

NameTypeDescriptionNotes
idstringSource Id (UUID)[default to undefined]

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  exportNonEmployeeRecordsV1(): void {
    const id: string = ; // Source Id (UUID)
    this.api.exportNonEmployeeRecordsV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

export-non-employee-source-schema-template-v1​

Exports source schema template This requests a download for the Source Schema Template for a provided source. Requires role context of idn:nesr:read

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ExportNonEmployeeSourceSchemaTemplateV1RequestParams.

NameTypeDescriptionNotes
idstringSource Id (UUID)[default to undefined]

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  exportNonEmployeeSourceSchemaTemplateV1(): void {
    const id: string = ; // Source Id (UUID)
    this.api.exportNonEmployeeSourceSchemaTemplateV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-approval-summary-v1​

Get summary of non-employee approval requests 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.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeApprovalSummaryV1RequestParams.

NameTypeDescriptionNotes
requestedForstringThe identity (UUID) of the approver for whom for whom the summary is being retrieved. Use &quot;me&quot; instead to indicate the current user.[default to undefined]

Return type​

Observable<NonEmployeeApprovalSummary>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeApprovalSummaryV1(): void {
    const requestedFor: string = ; // The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \&quot;me\&quot; instead to indicate the current user.
    this.api.getNonEmployeeApprovalSummaryV1({ requestedFor: requestedFor }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-approval-v1​

Get a non-employee approval item detail Gets a non-employee approval item detail. There are two contextual uses for this endpoint:

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

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeApprovalV1RequestParams.

NameTypeDescriptionNotes
idstringNon-Employee approval item id (UUID)[default to undefined]
includeDetailbooleanThe object nonEmployeeRequest will not be included detail when set to false. Default value is true[optional] [default to undefined]

Return type​

Observable<NonEmployeeApprovalItemDetail>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeApprovalV1(): void {
    const id: string = ; // Non-Employee approval item id (UUID)
    const includeDetail: boolean = ; // The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional)
    this.api.getNonEmployeeApprovalV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-bulk-upload-status-v1​

Obtain the status of bulk upload on the source The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of idn:nesr:read

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeBulkUploadStatusV1RequestParams.

NameTypeDescriptionNotes
idstringSource ID (UUID)[default to undefined]

Return type​

Observable<NonEmployeeBulkUploadStatus>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeBulkUploadStatusV1(): void {
    const id: string = ; // Source ID (UUID)
    this.api.getNonEmployeeBulkUploadStatusV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-record-v1​

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

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeRecordV1RequestParams.

NameTypeDescriptionNotes
idstringNon-Employee record id (UUID)[default to undefined]

Return type​

Observable<NonEmployeeRecord>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeRecordV1(): void {
    const id: string = ; // Non-Employee record id (UUID)
    this.api.getNonEmployeeRecordV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-request-summary-v1​

Get summary of non-employee requests 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.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeRequestSummaryV1RequestParams.

NameTypeDescriptionNotes
requestedForstringThe identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use &quot;me&quot; instead to indicate the current user.[default to undefined]

Return type​

Observable<NonEmployeeRequestSummary>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeRequestSummaryV1(): void {
    const requestedFor: string = ; // The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \&quot;me\&quot; instead to indicate the current user.
    this.api.getNonEmployeeRequestSummaryV1({ requestedFor: requestedFor }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-request-v1​

Get a 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.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeRequestV1RequestParams.

NameTypeDescriptionNotes
idstringNon-Employee request id (UUID)[default to undefined]

Return type​

Observable<NonEmployeeRequest>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeRequestV1(): void {
    const id: string = ; // Non-Employee request id (UUID)
    this.api.getNonEmployeeRequestV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-schema-attribute-v1​

Get schema attribute non-employee source This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of idn:nesr:read or the user must be an account manager of the source.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeSchemaAttributeV1RequestParams.

NameTypeDescriptionNotes
attributeIdstringThe Schema Attribute Id (UUID)[default to undefined]
sourceIdstringThe Source id[default to undefined]

Return type​

Observable<NonEmployeeSchemaAttribute>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeSchemaAttributeV1(): void {
    const attributeId: string = ; // The Schema Attribute Id (UUID)
    const sourceId: string = ; // The Source id
    this.api.getNonEmployeeSchemaAttributeV1({ attributeId: attributeId, sourceId: sourceId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-source-schema-attributes-v1​

List schema attributes non-employee source This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of idn:nesr:read or the user must be an account manager of the source.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeSourceSchemaAttributesV1RequestParams.

NameTypeDescriptionNotes
sourceIdstringThe Source id[default to undefined]

Return type​

Observable<Array<NonEmployeeSchemaAttribute>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeSourceSchemaAttributesV1(): void {
    const sourceId: string = ; // The Source id
    this.api.getNonEmployeeSourceSchemaAttributesV1({ sourceId: sourceId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-non-employee-source-v1​

Get a 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.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetNonEmployeeSourceV1RequestParams.

NameTypeDescriptionNotes
sourceIdstringSource Id[default to undefined]

Return type​

Observable<NonEmployeeSource>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  getNonEmployeeSourceV1(): void {
    const sourceId: string = ; // Source Id
    this.api.getNonEmployeeSourceV1({ sourceId: sourceId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

import-non-employee-records-in-bulk-v1​

Imports, or updates, non-employee records This post will import, or update, Non-Employee records found in the CSV. Requires role context of idn:nesr:create

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ImportNonEmployeeRecordsInBulkV1RequestParams.

NameTypeDescriptionNotes
idstringSource Id (UUID)[default to undefined]
dataBlob[default to undefined]

Return type​

Observable<NonEmployeeBulkUploadJob>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  importNonEmployeeRecordsInBulkV1(): void {
    const id: string = ; // Source Id (UUID)
    const data: Blob = ; // 
    this.api.importNonEmployeeRecordsInBulkV1({ id: id, data: data }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-non-employee-approvals-v1​

Get list of non-employee approval requests 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.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ListNonEmployeeApprovalsV1RequestParams.

NameTypeDescriptionNotes
requestedForstringThe identity for whom the request was made. me indicates the current user.[optional] [default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.[optional] [default to 0]
countbooleanIf 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.[optional] [default to false]
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: approvalStatus: eq[optional] [default to undefined]
sortersstringSort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: created, modified[optional] [default to undefined]

Return type​

Observable<Array<NonEmployeeApprovalItem>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  listNonEmployeeApprovalsV1(): void {
    const requestedFor: string = ; // The identity for whom the request was made. *me* indicates the current user. (optional)
    const limit: number = ; // 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)
    const offset: number = ; // 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)
    const count: 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&#x3D;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)
    const filters: 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)
    const sorters: 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)
    this.api.listNonEmployeeApprovalsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-non-employee-records-v1​

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

  1. The user has the role context of idn:nesr:read, in which case they can get a list of all of the non-employees.
  2. The user is an account manager, in which case they can get a list of the non-employees that they manage.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ListNonEmployeeRecordsV1RequestParams.

NameTypeDescriptionNotes
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.[optional] [default to 0]
countbooleanIf 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.[optional] [default to false]
sortersstringSort 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[optional] [default to undefined]
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: sourceId: eq[optional] [default to undefined]

Return type​

Observable<Array<NonEmployeeRecord>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  listNonEmployeeRecordsV1(): void {
    const limit: number = ; // 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)
    const offset: number = ; // 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)
    const count: 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&#x3D;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)
    const sorters: 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)
    const filters: 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)
    this.api.listNonEmployeeRecordsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-non-employee-requests-v1​

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.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ListNonEmployeeRequestsV1RequestParams.

NameTypeDescriptionNotes
requestedForstringThe identity for whom the request was made. me indicates the current user.[default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.[optional] [default to 0]
countbooleanIf 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.[optional] [default to false]
sortersstringSort 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[optional] [default to undefined]
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: sourceId: eq[optional] [default to undefined]

Return type​

Observable<Array<NonEmployeeRequest>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  listNonEmployeeRequestsV1(): void {
    const requestedFor: string = ; // The identity for whom the request was made. *me* indicates the current user.
    const limit: number = ; // 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)
    const offset: number = ; // 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)
    const count: 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&#x3D;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)
    const sorters: 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)
    const filters: 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)
    this.api.listNonEmployeeRequestsV1({ requestedFor: requestedFor }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-non-employee-sources-v1​

List non-employee sources Get a list of non-employee sources. There are two contextual uses for the requested-for path parameter:

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

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ListNonEmployeeSourcesV1RequestParams.

NameTypeDescriptionNotes
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.[optional] [default to 0]
countbooleanIf 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.[optional] [default to false]
requestedForstringIdentity the request was made for. Use &#39;me&#39; to indicate the current user.[optional] [default to undefined]
nonEmployeeCountbooleanFlag that determines whether the API will return a non-employee count associated with the source.[optional] [default to false]
sortersstringSort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, created, sourceId[optional] [default to undefined]

Return type​

Observable<Array<NonEmployeeSourceWithNECount>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  listNonEmployeeSourcesV1(): void {
    const limit: number = ; // 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)
    const offset: number = ; // 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)
    const count: 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&#x3D;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)
    const requestedFor: string = ; // Identity the request was made for. Use \&#39;me\&#39; to indicate the current user. (optional)
    const nonEmployeeCount: boolean = ; // Flag that determines whether the API will return a non-employee count associated with the source. (optional)
    const sorters: 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)
    this.api.listNonEmployeeSourcesV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

patch-non-employee-record-v1​

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.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is PatchNonEmployeeRecordV1RequestParams.

NameTypeDescriptionNotes
idstringNon-employee record id (UUID)[default to undefined]
jsonPatchOperationArray<JsonPatchOperation>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​

Observable<NonEmployeeRecord>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { JsonPatchOperation } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  patchNonEmployeeRecordV1(): void {
    const id: string = ; // Non-employee record id (UUID)
    const jsonPatchOperation: Array<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.
    this.api.patchNonEmployeeRecordV1({ id: id, jsonPatchOperation: jsonPatchOperation }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

patch-non-employee-schema-attribute-v1​

Patch a schema attribute for non-employee source This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of idn:nesr:update

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is PatchNonEmployeeSchemaAttributeV1RequestParams.

NameTypeDescriptionNotes
attributeIdstringThe Schema Attribute Id (UUID)[default to undefined]
sourceIdstringThe Source id[default to undefined]
jsonPatchOperationArray<JsonPatchOperation>A list of schema attribute update operations according to the JSON Patch standard. The following properties are allowed for update &#39;:&#39; &#39;label&#39;, &#39;helpText&#39;, &#39;placeholder&#39;, &#39;required&#39;.

Return type​

Observable<NonEmployeeSchemaAttribute>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { JsonPatchOperation } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  patchNonEmployeeSchemaAttributeV1(): void {
    const attributeId: string = ; // The Schema Attribute Id (UUID)
    const sourceId: string = ; // The Source id
    const jsonPatchOperation: Array<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 \&#39;:\&#39; \&#39;label\&#39;, \&#39;helpText\&#39;, \&#39;placeholder\&#39;, \&#39;required\&#39;.
    this.api.patchNonEmployeeSchemaAttributeV1({ attributeId: attributeId, sourceId: sourceId, jsonPatchOperation: jsonPatchOperation }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

patch-non-employee-source-v1​

Patch a non-employee source patch a non-employee source. (partial update)
Patchable field: name, description, approvers, accountManagers Requires role context of idn:nesr:update.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is PatchNonEmployeeSourceV1RequestParams.

NameTypeDescriptionNotes
sourceIdstringSource Id[default to undefined]
jsonPatchOperationArray<JsonPatchOperation>A list of non-employee source update operations according to the JSON Patch standard.

Return type​

Observable<NonEmployeeSource>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { JsonPatchOperation } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  patchNonEmployeeSourceV1(): void {
    const sourceId: string = ; // Source Id
    const jsonPatchOperation: Array<JsonPatchOperation> = ; // A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
    this.api.patchNonEmployeeSourceV1({ sourceId: sourceId, jsonPatchOperation: jsonPatchOperation }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

reject-non-employee-request-v1​

Reject a non-employee request This endpoint will reject an approval item request and notify user. The current user must be the requested approver.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is RejectNonEmployeeRequestV1RequestParams.

NameTypeDescriptionNotes
idstringNon-Employee approval item id (UUID)[default to undefined]
nonEmployeeRejectApprovalDecisionNonEmployeeRejectApprovalDecision

Return type​

Observable<NonEmployeeApprovalItem>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { NonEmployeeRejectApprovalDecision } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  rejectNonEmployeeRequestV1(): void {
    const id: string = ; // Non-Employee approval item id (UUID)
    const nonEmployeeRejectApprovalDecision: NonEmployeeRejectApprovalDecision = ; // 
    this.api.rejectNonEmployeeRequestV1({ id: id, nonEmployeeRejectApprovalDecision: nonEmployeeRejectApprovalDecision }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-non-employee-record-v1​

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.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateNonEmployeeRecordV1RequestParams.

NameTypeDescriptionNotes
idstringNon-employee record id (UUID)[default to undefined]
nonEmployeeRequestBodyNonEmployeeRequestBodyNon-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​

Observable<NonEmployeeRecord>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { NonEmployeeLifecycleManagementService } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';
import { NonEmployeeRequestBody } from '@sailpoint/angular-sdk/non_employee_lifecycle_management';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(NonEmployeeLifecycleManagementService);

  updateNonEmployeeRecordV1(): void {
    const id: string = ; // Non-employee record id (UUID)
    const nonEmployeeRequestBody: NonEmployeeRequestBody = ; // 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.
    this.api.updateNonEmployeeRecordV1({ id: id, nonEmployeeRequestBody: nonEmployeeRequestBody }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]