/** * Identity Security Cloud API - Custom User Levels * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface AuthUserLevelsIdentityCount */ export interface AuthUserLevelsIdentityCount { /** * The unique identifier of the user level. * @type {string} * @memberof AuthUserLevelsIdentityCount */ 'id'?: string; /** * Number of identities having this user level. * @type {number} * @memberof AuthUserLevelsIdentityCount */ 'count'?: number; } /** * * @export * @interface AuthUserSlimResponse */ export interface AuthUserSlimResponse { /** * Identity ID. * @type {string} * @memberof AuthUserSlimResponse */ 'id'?: string; /** * Identity unique identifier. * @type {string} * @memberof AuthUserSlimResponse */ 'uid'?: string; /** * Identity alias. * @type {string} * @memberof AuthUserSlimResponse */ 'alias'?: string; /** * Identity name in display format. * @type {string} * @memberof AuthUserSlimResponse */ 'displayName'?: string; } /** * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. * @export * @enum {string} */ export declare const DtoType: { readonly AccountCorrelationConfig: "ACCOUNT_CORRELATION_CONFIG"; readonly AccessProfile: "ACCESS_PROFILE"; readonly AccessRequestApproval: "ACCESS_REQUEST_APPROVAL"; readonly Account: "ACCOUNT"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly CampaignFilter: "CAMPAIGN_FILTER"; readonly Certification: "CERTIFICATION"; readonly Cluster: "CLUSTER"; readonly ConnectorSchema: "CONNECTOR_SCHEMA"; readonly Entitlement: "ENTITLEMENT"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; readonly Identity: "IDENTITY"; readonly IdentityProfile: "IDENTITY_PROFILE"; readonly IdentityRequest: "IDENTITY_REQUEST"; readonly MachineIdentity: "MACHINE_IDENTITY"; readonly LifecycleState: "LIFECYCLE_STATE"; readonly PasswordPolicy: "PASSWORD_POLICY"; readonly Role: "ROLE"; readonly Rule: "RULE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; readonly Tag: "TAG"; readonly TagCategory: "TAG_CATEGORY"; readonly TaskResult: "TASK_RESULT"; readonly ReportResult: "REPORT_RESULT"; readonly SodViolation: "SOD_VIOLATION"; readonly AccountActivity: "ACCOUNT_ACTIVITY"; readonly Workgroup: "WORKGROUP"; }; export type DtoType = typeof DtoType[keyof typeof DtoType]; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * A HierarchicalRightSet * @export * @interface HierarchicalRightSet */ export interface HierarchicalRightSet { /** * The unique identifier of the RightSet. * @type {string} * @memberof HierarchicalRightSet */ 'id'?: string; /** * The human-readable name of the RightSet. * @type {string} * @memberof HierarchicalRightSet */ 'name'?: string; /** * A human-readable description of the RightSet. * @type {string} * @memberof HierarchicalRightSet */ 'description'?: string | null; /** * The category of the RightSet. * @type {string} * @memberof HierarchicalRightSet */ 'category'?: string; /** * * @type {NestedConfig} * @memberof HierarchicalRightSet */ 'nestedConfig'?: NestedConfig; /** * List of child HierarchicalRightSets. * @type {Array} * @memberof HierarchicalRightSet */ 'children'?: Array; } /** * The manager for the identity. * @export * @interface IdentityReference */ export interface IdentityReference { /** * * @type {DtoType} * @memberof IdentityReference */ 'type'?: DtoType; /** * Identity id * @type {string} * @memberof IdentityReference */ 'id'?: string; /** * Human-readable display name of identity. * @type {string} * @memberof IdentityReference */ 'name'?: string; } /** * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatch */ export interface JsonPatch { /** * Operations to be applied * @type {Array} * @memberof JsonPatch */ 'operations'?: Array; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListUserLevelsV1401Response */ export interface ListUserLevelsV1401Response { /** * A message describing the error * @type {any} * @memberof ListUserLevelsV1401Response */ 'error'?: any; } /** * * @export * @interface ListUserLevelsV1429Response */ export interface ListUserLevelsV1429Response { /** * A message describing the error * @type {any} * @memberof ListUserLevelsV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * A NestedConfig * @export * @interface NestedConfig */ export interface NestedConfig { /** * The unique identifier of the ancestor RightSet. * @type {string} * @memberof NestedConfig */ 'ancestorId'?: string; /** * The depth level of the configuration. * @type {number} * @memberof NestedConfig */ 'depth'?: number; /** * The unique identifier of the parent RightSet. * @type {string} * @memberof NestedConfig */ 'parentId'?: string | null; /** * List of unique identifiers for child configurations. * @type {Array} * @memberof NestedConfig */ 'childrenIds'?: Array; } /** * Details about a public identity * @export * @interface PublicIdentity */ export interface PublicIdentity { /** * Identity id * @type {string} * @memberof PublicIdentity */ 'id'?: string; /** * Human-readable display name of identity. * @type {string} * @memberof PublicIdentity */ 'name'?: string; /** * Alternate unique identifier for the identity. * @type {string} * @memberof PublicIdentity */ 'alias'?: string; /** * Email address of identity. * @type {string} * @memberof PublicIdentity */ 'email'?: string | null; /** * The lifecycle status for the identity * @type {string} * @memberof PublicIdentity */ 'status'?: string | null; /** * The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. * @type {string} * @memberof PublicIdentity */ 'identityState'?: PublicIdentityIdentityStateEnum | null; /** * * @type {IdentityReference} * @memberof PublicIdentity */ 'manager'?: IdentityReference | null; /** * The public identity attributes of the identity * @type {Array} * @memberof PublicIdentity */ 'attributes'?: Array; } export declare const PublicIdentityIdentityStateEnum: { readonly Active: "ACTIVE"; readonly InactiveShortTerm: "INACTIVE_SHORT_TERM"; readonly InactiveLongTerm: "INACTIVE_LONG_TERM"; }; export type PublicIdentityIdentityStateEnum = typeof PublicIdentityIdentityStateEnum[keyof typeof PublicIdentityIdentityStateEnum]; /** * * @export * @interface PublicIdentityAttributesInner */ export interface PublicIdentityAttributesInner { /** * The attribute key * @type {string} * @memberof PublicIdentityAttributesInner */ 'key'?: string; /** * Human-readable display name of the attribute * @type {string} * @memberof PublicIdentityAttributesInner */ 'name'?: string; /** * The attribute value * @type {string} * @memberof PublicIdentityAttributesInner */ 'value'?: string | null; } /** * A RightSetDTO represents a collection of rights that assigned to capability or scope, enabling them to possess specific rights to access corresponding APIs. * @export * @interface RightSetDTO */ export interface RightSetDTO { /** * The unique identifier of the RightSet. * @type {string} * @memberof RightSetDTO */ 'id'?: string; /** * The human-readable name of the RightSet. * @type {string} * @memberof RightSetDTO */ 'name'?: string; /** * A human-readable description of the RightSet. * @type {string} * @memberof RightSetDTO */ 'description'?: string; /** * The category of the RightSet. * @type {string} * @memberof RightSetDTO */ 'category'?: string; /** * Right is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet. * @type {Array} * @memberof RightSetDTO */ 'rights'?: Array; /** * List of unique identifiers for related RightSets, current RightSet contains rights from these RightSets. * @type {Array} * @memberof RightSetDTO */ 'rightSetIds'?: Array; /** * List of unique identifiers for UI-assignable child RightSets, used to build UI components. * @type {Array} * @memberof RightSetDTO */ 'uiAssignableChildRightSetIds'?: Array; /** * Indicates whether the RightSet is UI-assignable. * @type {boolean} * @memberof RightSetDTO */ 'uiAssignable'?: boolean; /** * The translated name of the RightSet. * @type {string} * @memberof RightSetDTO */ 'translatedName'?: string; /** * The translated description of the RightSet. * @type {string} * @memberof RightSetDTO */ 'translatedDescription'?: string | null; /** * The unique identifier of the parent RightSet for UI Assignable RightSet. * @type {string} * @memberof RightSetDTO */ 'parentId'?: string | null; } /** * It represents a summary of a user level publish operation, including its metadata and status. * @export * @interface UserLevelPublishSummary */ export interface UserLevelPublishSummary { /** * The unique identifier of the UserLevel. * @type {string} * @memberof UserLevelPublishSummary */ 'userLevelId'?: string; /** * Indicates whether the API call triggered a publish operation. * @type {boolean} * @memberof UserLevelPublishSummary */ 'publish'?: boolean; /** * The status of the UserLevel publish operation. * @type {string} * @memberof UserLevelPublishSummary */ 'status'?: string; /** * The last modification timestamp of the UserLevel. * @type {string} * @memberof UserLevelPublishSummary */ 'modified'?: string; } /** * Payload containing details for creating a custom user level. * @export * @interface UserLevelRequest */ export interface UserLevelRequest { /** * The name of the user level. * @type {string} * @memberof UserLevelRequest */ 'name': string; /** * A brief description of the user level. * @type {string} * @memberof UserLevelRequest */ 'description': string; /** * * @type {PublicIdentity} * @memberof UserLevelRequest */ 'owner': PublicIdentity; /** * A list of rights associated with the user level. * @type {Array} * @memberof UserLevelRequest */ 'rightSets'?: Array; } /** * It represents a summary of a user level, including its metadata, attributes, and associated properties. * @export * @interface UserLevelSummaryDTO */ export interface UserLevelSummaryDTO { /** * The unique identifier of the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'id'?: string; /** * The human-readable name of the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'name'?: string; /** * A human-readable description of the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'description'?: string | null; /** * The legacy group associated with the UserLevel, used for backward compatibility for the UserLevel id. * @type {string} * @memberof UserLevelSummaryDTO */ 'legacyGroup'?: string | null; /** * List of RightSets associated with the UserLevel. * @type {Array} * @memberof UserLevelSummaryDTO */ 'rightSets'?: Array; /** * Indicates whether the UserLevel is custom. * @type {boolean} * @memberof UserLevelSummaryDTO */ 'custom'?: boolean; /** * Indicates whether the UserLevel is admin-assignable. * @type {boolean} * @memberof UserLevelSummaryDTO */ 'adminAssignable'?: boolean; /** * The translated name of the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'translatedName'?: string | null; /** * The translated grant message for the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'translatedGrant'?: string | null; /** * The translated remove message for the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'translatedRemove'?: string | null; /** * * @type {PublicIdentity} * @memberof UserLevelSummaryDTO */ 'owner'?: PublicIdentity; /** * The status of the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'status'?: UserLevelSummaryDTOStatusEnum; /** * The creation timestamp of the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'created'?: string; /** * The last modification timestamp of the UserLevel. * @type {string} * @memberof UserLevelSummaryDTO */ 'modified'?: string; /** * The count of associated identities for the UserLevel. * @type {number} * @memberof UserLevelSummaryDTO */ 'associatedIdentitiesCount'?: number | null; } export declare const UserLevelSummaryDTOStatusEnum: { readonly Active: "ACTIVE"; readonly Draft: "DRAFT"; }; export type UserLevelSummaryDTOStatusEnum = typeof UserLevelSummaryDTOStatusEnum[keyof typeof UserLevelSummaryDTOStatusEnum]; /** * CustomUserLevelsApi - axios parameter creator * @export */ export declare const CustomUserLevelsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new custom user level for the tenant. * @summary Create a custom user level * @param {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. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCustomUserLevelV1: (userLevelRequest: UserLevelRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Deletes a specific user level by its ID. * @summary Delete a user level * @param {string} id The unique identifier of the user level. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserLevelV1: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Fetches the details of a specific user level by its ID. * @summary Retrieve a user level * @param {string} id The unique identifier of the user level. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserLevelV1: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves a list of authorization assignable right sets for the tenant. * @summary List all uiAssignable right sets * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {string} [filters] 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* * @param {string} [sorters] 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** * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAllAuthorizationRightSetsV1: (xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * List of identities associated with a user level. * @summary List user level identities * @param {string} id The unique identifier of the user level. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. * @param {string} [sorters] 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** * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listUserLevelIdentitiesV1: (id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves a list of user levels for the tenant. * @summary List user levels * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {ListUserLevelsV1DetailLevelEnum} [detailLevel] Specifies the level of detail for the user levels. * @param {string} [filters] 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* * @param {string} [sorters] 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** * @param {number} [limit] 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. * @param {number} [offset] 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listUserLevelsV1: (xSailPointExperimental?: string, detailLevel?: ListUserLevelsV1DetailLevelEnum, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Publishes a custom user level for the tenant, making it active and available. * @summary Publish a custom user level * @param {string} id The unique identifier of the user level to publish. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ publishCustomUserLevelV1: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * List of user levels along with the number of identities associated to it. * @summary Count user levels identities * @param {Array} requestBody List of user level ids. Max 50 identifiers can be passed in a single request. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ showUserLevelCountsV1: (requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Updates the details of a specific user level using JSON Patch. * @summary Update a user level * @param {string} id The unique identifier of the user level. * @param {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. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateUserLevelV1: (id: string, jsonPatch: JsonPatch, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * CustomUserLevelsApi - functional programming interface * @export */ export declare const CustomUserLevelsApiFp: (configuration?: Configuration) => { /** * Creates a new custom user level for the tenant. * @summary Create a custom user level * @param {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. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCustomUserLevelV1(userLevelRequest: UserLevelRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a specific user level by its ID. * @summary Delete a user level * @param {string} id The unique identifier of the user level. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserLevelV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches the details of a specific user level by its ID. * @summary Retrieve a user level * @param {string} id The unique identifier of the user level. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserLevelV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a list of authorization assignable right sets for the tenant. * @summary List all uiAssignable right sets * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {string} [filters] 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* * @param {string} [sorters] 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** * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAllAuthorizationRightSetsV1(xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * List of identities associated with a user level. * @summary List user level identities * @param {string} id The unique identifier of the user level. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. * @param {string} [sorters] 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** * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listUserLevelIdentitiesV1(id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Retrieves a list of user levels for the tenant. * @summary List user levels * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {ListUserLevelsV1DetailLevelEnum} [detailLevel] Specifies the level of detail for the user levels. * @param {string} [filters] 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* * @param {string} [sorters] 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** * @param {number} [limit] 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. * @param {number} [offset] 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listUserLevelsV1(xSailPointExperimental?: string, detailLevel?: ListUserLevelsV1DetailLevelEnum, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Publishes a custom user level for the tenant, making it active and available. * @summary Publish a custom user level * @param {string} id The unique identifier of the user level to publish. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ publishCustomUserLevelV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List of user levels along with the number of identities associated to it. * @summary Count user levels identities * @param {Array} requestBody List of user level ids. Max 50 identifiers can be passed in a single request. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ showUserLevelCountsV1(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Updates the details of a specific user level using JSON Patch. * @summary Update a user level * @param {string} id The unique identifier of the user level. * @param {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. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateUserLevelV1(id: string, jsonPatch: JsonPatch, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CustomUserLevelsApi - factory interface * @export */ export declare const CustomUserLevelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new custom user level for the tenant. * @summary Create a custom user level * @param {CustomUserLevelsApiCreateCustomUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCustomUserLevelV1(requestParameters: CustomUserLevelsApiCreateCustomUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a specific user level by its ID. * @summary Delete a user level * @param {CustomUserLevelsApiDeleteUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserLevelV1(requestParameters: CustomUserLevelsApiDeleteUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches the details of a specific user level by its ID. * @summary Retrieve a user level * @param {CustomUserLevelsApiGetUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserLevelV1(requestParameters: CustomUserLevelsApiGetUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a list of authorization assignable right sets for the tenant. * @summary List all uiAssignable right sets * @param {CustomUserLevelsApiListAllAuthorizationRightSetsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAllAuthorizationRightSetsV1(requestParameters?: CustomUserLevelsApiListAllAuthorizationRightSetsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * List of identities associated with a user level. * @summary List user level identities * @param {CustomUserLevelsApiListUserLevelIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listUserLevelIdentitiesV1(requestParameters: CustomUserLevelsApiListUserLevelIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieves a list of user levels for the tenant. * @summary List user levels * @param {CustomUserLevelsApiListUserLevelsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listUserLevelsV1(requestParameters?: CustomUserLevelsApiListUserLevelsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Publishes a custom user level for the tenant, making it active and available. * @summary Publish a custom user level * @param {CustomUserLevelsApiPublishCustomUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ publishCustomUserLevelV1(requestParameters: CustomUserLevelsApiPublishCustomUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * List of user levels along with the number of identities associated to it. * @summary Count user levels identities * @param {CustomUserLevelsApiShowUserLevelCountsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ showUserLevelCountsV1(requestParameters: CustomUserLevelsApiShowUserLevelCountsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Updates the details of a specific user level using JSON Patch. * @summary Update a user level * @param {CustomUserLevelsApiUpdateUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateUserLevelV1(requestParameters: CustomUserLevelsApiUpdateUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createCustomUserLevelV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiCreateCustomUserLevelV1Request */ export interface CustomUserLevelsApiCreateCustomUserLevelV1Request { /** * 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. * @type {UserLevelRequest} * @memberof CustomUserLevelsApiCreateCustomUserLevelV1 */ readonly userLevelRequest: UserLevelRequest; /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiCreateCustomUserLevelV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for deleteUserLevelV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiDeleteUserLevelV1Request */ export interface CustomUserLevelsApiDeleteUserLevelV1Request { /** * The unique identifier of the user level. * @type {string} * @memberof CustomUserLevelsApiDeleteUserLevelV1 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiDeleteUserLevelV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getUserLevelV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiGetUserLevelV1Request */ export interface CustomUserLevelsApiGetUserLevelV1Request { /** * The unique identifier of the user level. * @type {string} * @memberof CustomUserLevelsApiGetUserLevelV1 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiGetUserLevelV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for listAllAuthorizationRightSetsV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiListAllAuthorizationRightSetsV1Request */ export interface CustomUserLevelsApiListAllAuthorizationRightSetsV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiListAllAuthorizationRightSetsV1 */ readonly xSailPointExperimental?: 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* * @type {string} * @memberof CustomUserLevelsApiListAllAuthorizationRightSetsV1 */ readonly filters?: 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** * @type {string} * @memberof CustomUserLevelsApiListAllAuthorizationRightSetsV1 */ readonly sorters?: string; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof CustomUserLevelsApiListAllAuthorizationRightSetsV1 */ readonly limit?: 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. * @type {number} * @memberof CustomUserLevelsApiListAllAuthorizationRightSetsV1 */ readonly offset?: number; } /** * Request parameters for listUserLevelIdentitiesV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiListUserLevelIdentitiesV1Request */ export interface CustomUserLevelsApiListUserLevelIdentitiesV1Request { /** * The unique identifier of the user level. * @type {string} * @memberof CustomUserLevelsApiListUserLevelIdentitiesV1 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiListUserLevelIdentitiesV1 */ readonly xSailPointExperimental?: string; /** * If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. * @type {boolean} * @memberof CustomUserLevelsApiListUserLevelIdentitiesV1 */ readonly count?: boolean; /** * 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** * @type {string} * @memberof CustomUserLevelsApiListUserLevelIdentitiesV1 */ readonly sorters?: string; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof CustomUserLevelsApiListUserLevelIdentitiesV1 */ readonly limit?: 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. * @type {number} * @memberof CustomUserLevelsApiListUserLevelIdentitiesV1 */ readonly offset?: number; } /** * Request parameters for listUserLevelsV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiListUserLevelsV1Request */ export interface CustomUserLevelsApiListUserLevelsV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiListUserLevelsV1 */ readonly xSailPointExperimental?: string; /** * Specifies the level of detail for the user levels. * @type {'FULL' | 'SLIM'} * @memberof CustomUserLevelsApiListUserLevelsV1 */ readonly detailLevel?: ListUserLevelsV1DetailLevelEnum; /** * 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* * @type {string} * @memberof CustomUserLevelsApiListUserLevelsV1 */ readonly filters?: 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** * @type {string} * @memberof CustomUserLevelsApiListUserLevelsV1 */ readonly sorters?: string; /** * 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. * @type {number} * @memberof CustomUserLevelsApiListUserLevelsV1 */ readonly limit?: 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. * @type {number} * @memberof CustomUserLevelsApiListUserLevelsV1 */ readonly offset?: number; } /** * Request parameters for publishCustomUserLevelV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiPublishCustomUserLevelV1Request */ export interface CustomUserLevelsApiPublishCustomUserLevelV1Request { /** * The unique identifier of the user level to publish. * @type {string} * @memberof CustomUserLevelsApiPublishCustomUserLevelV1 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiPublishCustomUserLevelV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for showUserLevelCountsV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiShowUserLevelCountsV1Request */ export interface CustomUserLevelsApiShowUserLevelCountsV1Request { /** * List of user level ids. Max 50 identifiers can be passed in a single request. * @type {Array} * @memberof CustomUserLevelsApiShowUserLevelCountsV1 */ readonly requestBody: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiShowUserLevelCountsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for updateUserLevelV1 operation in CustomUserLevelsApi. * @export * @interface CustomUserLevelsApiUpdateUserLevelV1Request */ export interface CustomUserLevelsApiUpdateUserLevelV1Request { /** * The unique identifier of the user level. * @type {string} * @memberof CustomUserLevelsApiUpdateUserLevelV1 */ readonly id: string; /** * 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. * @type {JsonPatch} * @memberof CustomUserLevelsApiUpdateUserLevelV1 */ readonly jsonPatch: JsonPatch; /** * Use this header to enable this experimental API. * @type {string} * @memberof CustomUserLevelsApiUpdateUserLevelV1 */ readonly xSailPointExperimental?: string; } /** * CustomUserLevelsApi - object-oriented interface * @export * @class CustomUserLevelsApi * @extends {BaseAPI} */ export declare class CustomUserLevelsApi extends BaseAPI { /** * Creates a new custom user level for the tenant. * @summary Create a custom user level * @param {CustomUserLevelsApiCreateCustomUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ createCustomUserLevelV1(requestParameters: CustomUserLevelsApiCreateCustomUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Deletes a specific user level by its ID. * @summary Delete a user level * @param {CustomUserLevelsApiDeleteUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ deleteUserLevelV1(requestParameters: CustomUserLevelsApiDeleteUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Fetches the details of a specific user level by its ID. * @summary Retrieve a user level * @param {CustomUserLevelsApiGetUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ getUserLevelV1(requestParameters: CustomUserLevelsApiGetUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves a list of authorization assignable right sets for the tenant. * @summary List all uiAssignable right sets * @param {CustomUserLevelsApiListAllAuthorizationRightSetsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ listAllAuthorizationRightSetsV1(requestParameters?: CustomUserLevelsApiListAllAuthorizationRightSetsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * List of identities associated with a user level. * @summary List user level identities * @param {CustomUserLevelsApiListUserLevelIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ listUserLevelIdentitiesV1(requestParameters: CustomUserLevelsApiListUserLevelIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves a list of user levels for the tenant. * @summary List user levels * @param {CustomUserLevelsApiListUserLevelsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ listUserLevelsV1(requestParameters?: CustomUserLevelsApiListUserLevelsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Publishes a custom user level for the tenant, making it active and available. * @summary Publish a custom user level * @param {CustomUserLevelsApiPublishCustomUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ publishCustomUserLevelV1(requestParameters: CustomUserLevelsApiPublishCustomUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * List of user levels along with the number of identities associated to it. * @summary Count user levels identities * @param {CustomUserLevelsApiShowUserLevelCountsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ showUserLevelCountsV1(requestParameters: CustomUserLevelsApiShowUserLevelCountsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Updates the details of a specific user level using JSON Patch. * @summary Update a user level * @param {CustomUserLevelsApiUpdateUserLevelV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomUserLevelsApi */ updateUserLevelV1(requestParameters: CustomUserLevelsApiUpdateUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ListUserLevelsV1DetailLevelEnum: { readonly Full: "FULL"; readonly Slim: "SLIM"; }; export type ListUserLevelsV1DetailLevelEnum = typeof ListUserLevelsV1DetailLevelEnum[keyof typeof ListUserLevelsV1DetailLevelEnum];