CustomUserLevelsService

Use this API to implement custom user level functionality. With this functionality in place, administrators can create custom user levels and configure them for use throughout Identity Security Cloud.

Custom user levels allow administrators to create custom user levels that can be used to control access to Identity Security Cloud features and APIs.

Refer to User Levels for more information about User Levels.

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

Method	HTTP request	Description
create-custom-user-level-v1	POST /authorization/v1/custom-user-levels	Create a custom user level
delete-user-level-v1	DELETE /authorization/v1/custom-user-levels/{id}	Delete a user level
get-user-level-v1	GET /authorization/v1/custom-user-levels/{id}	Retrieve a user level
list-all-authorization-right-sets-v1	GET /authorization/v1/authorization-assignable-right-sets	List all uiAssignable right sets
list-user-level-identities-v1	GET /authorization/v1/user-levels/{id}/identities	List user level identities
list-user-levels-v1	GET /authorization/v1/custom-user-levels	List user levels
publish-custom-user-level-v1	POST /authorization/v1/custom-user-levels/{id}/publish	Publish a custom user level
show-user-level-counts-v1	POST /authorization/v1/user-levels/get-identity-count	Count user levels identities
update-user-level-v1	PATCH /authorization/v1/custom-user-levels/{id}	Update a user level

create-custom-user-level-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 a custom user level Creates a new custom user level for the tenant.

API Spec

Parameters

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

Name	Type	Description	Notes
userLevelRequest	UserLevelRequest	Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case.
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<UserLevelSummaryDTO>

HTTP request headers

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

Example

import { Component, inject } from '@angular/core';
import { CustomUserLevelsService } from '@sailpoint/angular-sdk/custom_user_levels';
import { UserLevelRequest } from '@sailpoint/angular-sdk/custom_user_levels';

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

  createCustomUserLevelV1(): void {
    const userLevelRequest: UserLevelRequest = ; // Payload containing the details of the user level to be created.   - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned.   - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.createCustomUserLevelV1({ userLevelRequest: userLevelRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-user-level-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.

Delete a user level Deletes a specific user level by its ID.

API Spec

Parameters

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

Name	Type	Description	Notes
id	string	The unique identifier of the user level.	[default to undefined]
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: Not defined
• Accept: application/json

Example

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

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

  deleteUserLevelV1(): void {
    const id: string = ; // The unique identifier of the user level.
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.deleteUserLevelV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-user-level-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.

Retrieve a user level Fetches the details of a specific user level by its ID.

API Spec

Parameters

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

Name	Type	Description	Notes
id	string	The unique identifier of the user level.	[default to undefined]
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<UserLevelSummaryDTO>

HTTP request headers

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

Example

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

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

  getUserLevelV1(): void {
    const id: string = ; // The unique identifier of the user level.
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.getUserLevelV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-all-authorization-right-sets-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.

List all uiAssignable right sets Retrieves a list of authorization assignable right sets for the tenant.

API Spec

Parameters

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

Name	Type	Description	Notes
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: category: 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: id, name, category	[optional] [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]

Return type

Observable<Array<HierarchicalRightSet>>

HTTP request headers

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

Example

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

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

  listAllAuthorizationRightSetsV1(): void {
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (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:  **category**: *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: **id, name, category** (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.listAllAuthorizationRightSetsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-user-level-identities-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.

List user level identities List of identities associated with a user level.

API Spec

Parameters

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

Name	Type	Description	Notes
id	string	The unique identifier of the user level.	[default to undefined]
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']
count	boolean	If true, X-Total-Count header with the the total number of identities for this user level will be included in the response.	[optional] [default to false]
sorters	string	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName	[optional] [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]

Return type

Observable<Array<AuthUserSlimResponse>>

HTTP request headers

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

Example

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

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

  listUserLevelIdentitiesV1(): void {
    const id: string = ; // The unique identifier of the user level.
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    const count: boolean = ; // If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. (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: **displayName** (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.listUserLevelIdentitiesV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-user-levels-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.

List user levels Retrieves a list of user levels for the tenant.

API Spec

Parameters

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

Name	Type	Description	Notes
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']
detailLevel	`'FULL'	'SLIM'`	Specifies the level of detail for the user levels.
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: co owner: co status: eq description: co	[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, created, description, status, owner	[optional] [default to undefined]
limit	number	Note that for this API the maximum value for limit is 50. See V3 API Standard Collection Parameters for more information.	[optional] [default to 50]
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<UserLevelSummaryDTO>>

HTTP request headers

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

Example

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

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

  listUserLevelsV1(): void {
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    const detailLevel: string = ; // Specifies the level of detail for the user levels. (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:  **name**: *co*    **owner**: *co*    **status**: *eq*  **description**: *co* (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, description, status, owner** (optional)
    const limit: number = ; // Note that for this API the maximum value for limit is 50. 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.listUserLevelsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

publish-custom-user-level-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.

Publish a custom user level Publishes a custom user level for the tenant, making it active and available.

API Spec

Parameters

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

Name	Type	Description	Notes
id	string	The unique identifier of the user level to publish.	[default to undefined]
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<UserLevelPublishSummary>

HTTP request headers

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

Example

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

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

  publishCustomUserLevelV1(): void {
    const id: string = ; // The unique identifier of the user level to publish.
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.publishCustomUserLevelV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

show-user-level-counts-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.

Count user levels identities List of user levels along with the number of identities associated to it.

API Spec

Parameters

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

Name	Type	Description	Notes
requestBody	Array<string>	List of user level ids. Max 50 identifiers can be passed in a single request.
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<Array<AuthUserLevelsIdentityCount>>

HTTP request headers

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

Example

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

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

  showUserLevelCountsV1(): void {
    const requestBody: Array<string> = ; // List of user level ids. Max 50 identifiers can be passed in a single request.
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.showUserLevelCountsV1({ requestBody: requestBody }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-user-level-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.

Update a user level Updates the details of a specific user level using JSON Patch.

API Spec

Parameters

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

Name	Type	Description	Notes
id	string	The unique identifier of the user level.	[default to undefined]
jsonPatch	JsonPatch	JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case.
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<UserLevelSummaryDTO>

HTTP request headers

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

Example

import { Component, inject } from '@angular/core';
import { CustomUserLevelsService } from '@sailpoint/angular-sdk/custom_user_levels';
import { JsonPatch } from '@sailpoint/angular-sdk/custom_user_levels';

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

  updateUserLevelV1(): void {
    const id: string = ; // The unique identifier of the user level.
    const jsonPatch: JsonPatch = ; // JSON Patch payload for updating the user level.   - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned.   - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.updateUserLevelV1({ id: id, jsonPatch: jsonPatch }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]