Skip to main content

RightSetDTO

A RightSetDTO represents a collection of rights that assigned to capability or scope, enabling them to possess specific rights to access corresponding APIs.

Properties

NameTypeDescriptionNotes
idstrThe unique identifier of the RightSet.[optional]
namestrThe human-readable name of the RightSet.[optional]
descriptionstrA human-readable description of the RightSet.[optional]
categorystrThe category of the RightSet.[optional]
rights[]strRight is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet.[optional]
right_set_ids[]strList of unique identifiers for related RightSets, current RightSet contains rights from these RightSets.[optional]
ui_assignable_child_right_set_ids[]strList of unique identifiers for UI-assignable child RightSets, used to build UI components.[optional]
ui_assignableboolIndicates whether the RightSet is UI-assignable.[optional] [default to False]
translated_namestrThe translated name of the RightSet.[optional]
translated_descriptionstrThe translated description of the RightSet.[optional]
parent_idstrThe unique identifier of the parent RightSet for UI Assignable RightSet.[optional]
}

Example

from sailpoint.v2025.models.right_set_dto import RightSetDTO

right_set_dto = RightSetDTO(
id='idn:ui-right-set-example',
name='Right Set Name',
description='This is a description of the RightSet.',
category='identity',
rights=[idn:ui-right-set-example:read, idn:ui-right-set-example:write],
right_set_ids=[idn:ui-right-set-example-update, idn:ui-right-set-example-delete],
ui_assignable_child_right_set_ids=[idn:ui-right-set-example-detail, idn:ui-right-set-example-management],
ui_assignable=True,
translated_name='Translated Right Set Name',
translated_description='This is a translated description of the RightSet.',
parent_id='idn:ui-parent-example'
)

[Back to top]