LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13123805130

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 22:09:17 +00:00
parent bdb088c15d
commit 3e9d359da1
2608 changed files with 14669 additions and 14876 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/tools/sdk/powershell/Reference/V3/Models/Role.md
View File

@@ -16,24 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'Role', 'Role']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional]
**Name** | **String** | The human-readable display name of the Role | [required]
**Created** | Pointer to **System.DateTime** | Date the Role was created | [optional] [readonly]
**Modified** | Pointer to **System.DateTime** | Date the Role was last modified. | [optional] [readonly]
**Description** | Pointer to **String** | A human-readable description of the Role | [optional]
**Owner** | [**OwnerReference**](owner-reference) | | [required]
**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional]
**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional]
**Membership** | Pointer to [**RoleMembershipSelector**](role-membership-selector) | | [optional]
**LegacyMembershipInfo** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional]
**Enabled** | Pointer to **Boolean** | Whether the Role is enabled or not. | [optional] [default to $false]
**Requestable** | Pointer to **Boolean** | Whether the Role can be the target of access requests. | [optional] [default to $false]
**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional]
**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional]
**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Role is assigned. | [optional]
**Dimensional** | Pointer to **Boolean** | Whether the Role is dimensional. | [optional] [default to $false]
**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional]
**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional]
**Id** | **String** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional]
**Name** | **String** | The human-readable display name of the Role | [required]
**Created** | **System.DateTime** | Date the Role was created | [optional] [readonly]
**Modified** | **System.DateTime** | Date the Role was last modified. | [optional] [readonly]
**Description** | **String** | A human-readable description of the Role | [optional]
**Owner** | [**OwnerReference**](owner-reference) | | [required]
**AccessProfiles** | [**[]AccessProfileRef**](access-profile-ref) | | [optional]
**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | | [optional]
**Membership** | [**RoleMembershipSelector**](role-membership-selector) | | [optional]
**LegacyMembershipInfo** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional]
**Enabled** | **Boolean** | Whether the Role is enabled or not. | [optional] [default to $false]
**Requestable** | **Boolean** | Whether the Role can be the target of access requests. | [optional] [default to $false]
**AccessRequestConfig** | [**RequestabilityForRole**](requestability-for-role) | | [optional]
**RevocationRequestConfig** | [**RevocabilityForRole**](revocability-for-role) | | [optional]
**Segments** | **[]String** | List of IDs of segments, if any, to which this Role is assigned. | [optional]
**Dimensional** | **Boolean** | Whether the Role is dimensional. | [optional] [default to $false]
**DimensionRefs** | [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional]
**AccessModelMetadata** | [**AttributeDTOList**](attribute-dto-list) | | [optional]
## Examples