IdentitiesService

Use this API to implement identity functionality. With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes.

Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes.

An identity has a variety of attributes, such as an account name, an email address, a job title, and more. These identity attributes can be correlated with different attributes on different sources. For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes.

In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity.

Refer to Synchronizing Attributes for more information about synchronizing attributes.

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

Method	HTTP request	Description
delete-identity-v1	DELETE `/identities/v1/{id}`	Delete identity
get-identity-ownership-details-v1	GET `/identities/v1/{identityId}/ownership`	Get ownership details
get-identity-v1	GET `/identities/v1/{id}`	Identity details
get-role-assignment-v1	GET `/identities/v1/{identityId}/role-assignments/{assignmentId}`	Role assignment details
get-role-assignments-v1	GET `/identities/v1/{identityId}/role-assignments`	List role assignments
list-entitlements-by-identity-v1	GET `/entitlements/v1/identities/{id}/entitlements`	List of entitlements by identity.
list-identities-v1	GET `/identities/v1`	List identities
reset-identity-v1	POST `/identities/v1/{id}/reset`	Reset an identity
send-identity-verification-account-token-v1	POST `/identities/v1/{id}/verification/account/send`	Send password reset email
start-identities-invite-v1	POST `/identities/v1/invite`	Invite identities to register
start-identity-processing-v1	POST `/identities/v1/process`	Process a list of identityids
synchronize-attributes-for-identity-v1	POST `/identities/v1/{identityId}/synchronize-attributes`	Attribute synchronization for single identity.

delete-identity-v1

Delete identity The API returns successful response if the requested identity was deleted.

API Spec

Parameters

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

Name	Type	Description	Notes
id	`string`	Identity 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 { IdentitiesService } from '@sailpoint/angular-sdk/identities';

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

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

[Back to top]

get-identity-ownership-details-v1

Get ownership details Use this API to return an identity's owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the Search API. When you search for identities, the returned identities have a property, owns, that contains a more comprehensive list of identity's owned objects.

API Spec

Parameters

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

Name	Type	Description	Notes
identityId	`string`	Identity ID.	[default to undefined]

Return type

Observable<IdentityOwnershipAssociationDetails>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

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

  getIdentityOwnershipDetailsV1(): void {
    const identityId: string = ; // Identity ID.
    this.api.getIdentityOwnershipDetailsV1({ identityId: identityId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-identity-v1

Identity details This API returns a single identity using the Identity ID.

API Spec

Parameters

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

Name	Type	Description	Notes
id	`string`	Identity Id	[default to undefined]

Return type

Observable<Identity>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

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

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

[Back to top]

get-role-assignment-v1

Role assignment details

API Spec

Parameters

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

Name	Type	Description	Notes
identityId	`string`	Identity Id	[default to undefined]
assignmentId	`string`	Assignment Id	[default to undefined]

Return type

Observable<RoleAssignmentDto>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

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

  getRoleAssignmentV1(): void {
    const identityId: string = ; // Identity Id
    const assignmentId: string = ; // Assignment Id
    this.api.getRoleAssignmentV1({ identityId: identityId, assignmentId: assignmentId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-role-assignments-v1

List role assignments This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id.

API Spec

Parameters

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

Name	Type	Description	Notes
identityId	`string`	Identity Id to get the role assignments for	[default to undefined]
roleId	`string`	Role Id to filter the role assignments with	[optional] [default to undefined]
roleName	`string`	Role name to filter the role assignments with	[optional] [default to undefined]

Return type

Observable<Array<GetRoleAssignmentsV1200ResponseInner>>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

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

  getRoleAssignmentsV1(): void {
    const identityId: string = ; // Identity Id to get the role assignments for
    const roleId: string = ; // Role Id to filter the role assignments with (optional)
    const roleName: string = ; // Role name to filter the role assignments with (optional)
    this.api.getRoleAssignmentsV1({ identityId: identityId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-entitlements-by-identity-v1

List of entitlements by identity. The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API.

API Spec

Parameters

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

Name	Type	Description	Notes
id	`string`	Identity Id	[default to undefined]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
offset	`number`	Offset 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]
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=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]

Return type

Observable<Array<IdentityEntitlements>>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

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

  listEntitlementsByIdentityV1(): void {
    const id: string = ; // Identity Id
    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)
    this.api.listEntitlementsByIdentityV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-identities-v1

List identities This API returns a list of identities.

API Spec

Parameters

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

Name	Type	Description	Notes
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: eq, sw alias: eq, sw firstname: eq, sw lastname: eq, sw email: eq, sw cloudStatus: eq processingState: eq correlated: eq protected: eq	[optional] [default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, alias, cloudStatus	[optional] [default to undefined]
defaultFilter	`'CORRELATED_ONLY'	'NONE'`	Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter.
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=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
offset	`number`	Offset 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]

Return type

Observable<Array<Identity>>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

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

  listIdentitiesV1(): void {
    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:  **id**: *eq, in*  **name**: *eq, sw*  **alias**: *eq, sw*  **firstname**: *eq, sw*  **lastname**: *eq, sw*  **email**: *eq, sw*  **cloudStatus**: *eq*  **processingState**: *eq*  **correlated**: *eq*  **protected**: *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: **name, alias, cloudStatus** (optional)
    const defaultFilter: string = ; // Adds additional filter to filters query parameter.  CORRELATED_ONLY adds correlated&#x3D;true and returns only identities that are correlated.  NONE does not add any and returns all identities that satisfy filters query parameter. (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 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)
    this.api.listIdentitiesV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

reset-identity-v1

Reset an identity Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.

API Spec

Parameters

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

Name	Type	Description	Notes
id	`string`	Identity 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 { IdentitiesService } from '@sailpoint/angular-sdk/identities';

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

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

[Back to top]

send-identity-verification-account-token-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Send password reset email This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.

API Spec

Parameters

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

Name	Type	Description	Notes
id	`string`	Identity ID	[default to undefined]
sendAccountVerificationRequest	`SendAccountVerificationRequest`
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

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 { IdentitiesService } from '@sailpoint/angular-sdk/identities';
import { SendAccountVerificationRequest } from '@sailpoint/angular-sdk/identities';

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

  sendIdentityVerificationAccountTokenV1(): void {
    const id: string = ; // Identity ID
    const sendAccountVerificationRequest: SendAccountVerificationRequest = ; // 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.sendIdentityVerificationAccountTokenV1({ id: id, sendAccountVerificationRequest: sendAccountVerificationRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

start-identities-invite-v1

experimental

Invite identities to register This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.

This task will send an invitation email only for unregistered identities.

The executed task status can be checked by Task Management > Get task status by ID.

API Spec

Parameters

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

Name	Type	Description	Notes
inviteIdentitiesRequest	`InviteIdentitiesRequest`
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<TaskStatus>

HTTP request headers

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

Example

import { Component, inject } from '@angular/core';
import { IdentitiesService } from '@sailpoint/angular-sdk/identities';
import { InviteIdentitiesRequest } from '@sailpoint/angular-sdk/identities';

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

  startIdentitiesInviteV1(): void {
    const inviteIdentitiesRequest: InviteIdentitiesRequest = ; // 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.startIdentitiesInviteV1({ inviteIdentitiesRequest: inviteIdentitiesRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

start-identity-processing-v1

experimental

Process a list of identityids This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of event-based processing and scheduled processing that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized.

This endpoint will perform the following tasks:

Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change).
Evaluate role assignments, leading to assignment of new roles and removal of existing roles.
Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health).
Recalculate manager relationships.
Potentially clean-up identity processing errors, assuming the error has been resolved.

API Spec

Parameters

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

Name	Type	Description	Notes
processIdentitiesRequest	`ProcessIdentitiesRequest`
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<TaskResultResponse>

HTTP request headers

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

Example

import { Component, inject } from '@angular/core';
import { IdentitiesService } from '@sailpoint/angular-sdk/identities';
import { ProcessIdentitiesRequest } from '@sailpoint/angular-sdk/identities';

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

  startIdentityProcessingV1(): void {
    const processIdentitiesRequest: ProcessIdentitiesRequest = ; // 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.startIdentityProcessingV1({ processIdentitiesRequest: processIdentitiesRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

synchronize-attributes-for-identity-v1

experimental

Attribute synchronization for single identity. This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity.

API Spec

Parameters

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

Name	Type	Description	Notes
identityId	`string`	The Identity id	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<IdentitySyncJob>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

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

  synchronizeAttributesForIdentityV1(): void {
    const identityId: string = ; // The Identity id
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.synchronizeAttributesForIdentityV1({ identityId: identityId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-identity-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-identity-ownership-details-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-identity-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-role-assignment-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-role-assignments-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-entitlements-by-identity-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-identities-v1​

Parameters​

Return type​

HTTP request headers​

Example​

reset-identity-v1​

Parameters​

Return type​

HTTP request headers​

Example​

send-identity-verification-account-token-v1​

Parameters​

Return type​

HTTP request headers​

Example​

start-identities-invite-v1​

Parameters​

Return type​

HTTP request headers​

Example​

start-identity-processing-v1​

Parameters​

Return type​

HTTP request headers​

Example​

synchronize-attributes-for-identity-v1​

Parameters​

Return type​

HTTP request headers​

Example​

delete-identity-v1

Parameters

Return type

HTTP request headers

Example

get-identity-ownership-details-v1

Parameters

Return type

HTTP request headers

Example

get-identity-v1

Parameters

Return type

HTTP request headers

Example

get-role-assignment-v1

Parameters

Return type

HTTP request headers

Example

get-role-assignments-v1

Parameters

Return type

HTTP request headers

Example

list-entitlements-by-identity-v1

Parameters

Return type

HTTP request headers

Example

list-identities-v1

Parameters

Return type

HTTP request headers

Example

reset-identity-v1

Parameters

Return type

HTTP request headers

Example

send-identity-verification-account-token-v1

Parameters

Return type

HTTP request headers

Example

start-identities-invite-v1

Parameters

Return type

HTTP request headers

Example

start-identity-processing-v1

Parameters

Return type

HTTP request headers

Example

synchronize-attributes-for-identity-v1

Parameters

Return type

HTTP request headers

Example