IAICommonAccessService

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

Method	HTTP request	Description
create-common-access-v1	POST /common-access/v1	Create common access items
get-common-access-v1	GET /common-access/v1	Get a paginated list of common access
update-common-access-status-in-bulk-v1	POST /common-access/v1/update-status	Bulk update common access status

create-common-access-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.

Create common access items This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create

API Spec

Parameters

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

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

Return type

Observable<CommonAccessItemResponse>

HTTP request headers

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

Example

import { Component, inject } from '@angular/core';
import { IAICommonAccessService } from '@sailpoint/angular-sdk/iai_common_access';
import { CommonAccessItemRequest } from '@sailpoint/angular-sdk/iai_common_access';

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

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

[Back to top]

get-common-access-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.

Get a paginated list of common access This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read

API Spec

Parameters

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

Name	Type	Description	Notes
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]
limit	number	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
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]
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: status: eq, sw reviewedByUser eq access.id: eq, sw access.type: eq access.name: sw, eq access.description: sw, 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: access.name, status By default the common access items are sorted by name, ascending.	[optional] [default to undefined]
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<Array<CommonAccessResponse>>

HTTP request headers

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

Example

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

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

  getCommonAccessV1(): void {
    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 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 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](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:  **status**: *eq, sw*  **reviewedByUser** *eq*  **access.id**: *eq, sw*  **access.type**: *eq*  **access.name**: *sw, eq*  **access.description**: *sw, 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: **access.name, status**  By default the common access items are sorted by name, ascending. (optional)
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.getCommonAccessV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-common-access-status-in-bulk-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.

Bulk update common access status This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update

API Spec

Parameters

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

Name	Type	Description	Notes
commonAccessIDStatus	Array<CommonAccessIDStatus>	Confirm or deny in bulk the common access ids that are (or aren&#39;t) common access
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<object>

HTTP request headers

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

Example

import { Component, inject } from '@angular/core';
import { IAICommonAccessService } from '@sailpoint/angular-sdk/iai_common_access';
import { CommonAccessIDStatus } from '@sailpoint/angular-sdk/iai_common_access';

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

  updateCommonAccessStatusInBulkV1(): void {
    const commonAccessIDStatus: Array<CommonAccessIDStatus> = ; // Confirm or deny in bulk the common access ids that are (or aren\&#39;t) common access
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.updateCommonAccessStatusInBulkV1({ commonAccessIDStatus: commonAccessIDStatus }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]