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

Update PowerShell SDK docs: 15781241582

Browse Source
This commit is contained in:
developer-relations-sp
2025-06-20 14:31:01 +00:00
parent cc95222670
commit 83c944f2cb
50 changed files with 1841 additions and 383 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md
View File

@@ -273,8 +273,9 @@ if you submit duplicate access requests in quick succession or submit an access
It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can
be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also
use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting
an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request.
These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API.
an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has,
without changing the account details or end date information from the existing assignment,
the API will cancel the request as a duplicate.
There are two types of access request:
@@ -283,17 +284,19 @@ __GRANT_ACCESS__
* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options.
* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.
* Roles, access profiles and entitlements can be requested.
* You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time.
* If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time.
* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.
* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source.
__REVOKE_ACCESS__
* Can only be requested for a single identity at a time.
* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning.
* Does not support self request. Only manager can request to revoke access for their directly managed employees.
* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements.
* If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time.
* Roles, access profiles, and entitlements can be requested for revocation.
* Revoke requests for entitlements are limited to 1 entitlement per access request currently.
* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone.
* You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time.
* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. These fields should be used within the 'requestedItems' section for the revoke requests.
* Usage of 'requestedForWithRequestedItems' field is not supported for revoke requests.

72
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md
View File

@@ -46,9 +46,6 @@ Method | HTTP request | Description
## delete-identity
:::warning 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.
:::
The API returns successful response if the requested identity was deleted.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity)
@@ -57,7 +54,6 @@ The API returns successful response if the requested identity was deleted.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Identity Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
(empty response body)
@@ -80,15 +76,14 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete identity
try {
Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
Remove-V2024Identity -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Remove-V2024Identity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity"
Write-Host $_.ErrorDetails
@@ -97,9 +92,6 @@ try {
[[Back to top]](#)
## get-identity
:::warning 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.
:::
This API returns a single identity using the Identity ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity)
@@ -108,7 +100,6 @@ This API returns a single identity using the Identity ID.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Identity Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**Identity**](../models/identity)
@@ -131,15 +122,14 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Identity details
try {
Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
Get-V2024Identity -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Get-V2024Identity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity"
Write-Host $_.ErrorDetails
@@ -148,9 +138,6 @@ try {
[[Back to top]](#)
## get-identity-ownership-details
:::warning 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.
:::
Use this API to return an identity's owned objects that will cause problems for deleting the identity.
Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity.
For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects.
@@ -161,7 +148,6 @@ For a full list of objects owned by an identity, use the [Search API](https://de
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityId | **String** | True | Identity ID.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details)
@@ -184,15 +170,14 @@ Code | Description | Data Type
### Example
```powershell
$IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get ownership details
try {
Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails"
Write-Host $_.ErrorDetails
@@ -201,9 +186,6 @@ try {
[[Back to top]](#)
## get-role-assignment
:::warning 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.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignment)
@@ -213,7 +195,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityId | **String** | True | Identity Id
Path | AssignmentId | **String** | True | Assignment Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**RoleAssignmentDto**](../models/role-assignment-dto)
@@ -237,15 +218,14 @@ Code | Description | Data Type
```powershell
$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Role assignment details
try {
Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental
Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId
# Below is a request that includes all optional parameters
# Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment"
Write-Host $_.ErrorDetails
@@ -254,9 +234,6 @@ try {
[[Back to top]](#)
## get-role-assignments
:::warning 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.
:::
This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignments)
@@ -265,7 +242,6 @@ This returns either a list of Role Assignments when querying with either a Role
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityId | **String** | True | Identity Id to get the role assignments for
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | RoleId | **String** | (optional) | Role Id to filter the role assignments with
Query | RoleName | **String** | (optional) | Role name to filter the role assignments with
@@ -290,17 +266,16 @@ Code | Description | Data Type
### Example
```powershell
$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional)
$RoleName = "Engineer" # String | Role name to filter the role assignments with (optional)
# List role assignments
try {
Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
Get-V2024RoleAssignments -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName
# Get-V2024RoleAssignments -IdentityId $IdentityId -RoleId $RoleId -RoleName $RoleName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments"
Write-Host $_.ErrorDetails
@@ -309,9 +284,6 @@ try {
[[Back to top]](#)
## list-identities
:::warning 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.
:::
This API returns a list of identities.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identities)
@@ -319,7 +291,6 @@ This API returns a list of identities.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Filters | **String** | (optional) | 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: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq*
Query | Sorters | **String** | (optional) | 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, alias, cloudStatus**
Query | DefaultFilter | **String** | (optional) (default to "CORRELATED_ONLY") | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter.
@@ -346,7 +317,6 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Filters = 'id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false' # 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: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional)
$Sorters = "name,-cloudStatus" # 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, alias, cloudStatus** (optional)
$DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY")
@@ -357,10 +327,10 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List identities
try {
Get-V2024Identities -XSailPointExperimental $XSailPointExperimental
Get-V2024Identities
# Below is a request that includes all optional parameters
# Get-V2024Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset
# Get-V2024Identities -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities"
Write-Host $_.ErrorDetails
@@ -369,9 +339,6 @@ try {
[[Back to top]](#)
## reset-identity
:::warning 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.
:::
Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-identity)
@@ -380,7 +347,6 @@ Use this endpoint to reset a user's identity if they have forgotten their authen
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityId | **String** | True | Identity Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
(empty response body)
@@ -403,15 +369,14 @@ Code | Description | Data Type
### Example
```powershell
$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Reset an identity
try {
Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
Reset-V2024Identity -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Reset-V2024Identity -IdentityId $IdentityId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity"
Write-Host $_.ErrorDetails
@@ -478,9 +443,6 @@ try {
[[Back to top]](#)
## start-identities-invite
:::warning 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.
:::
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
This task will send an invitation email only for unregistered identities.
@@ -493,7 +455,6 @@ The executed task status can be checked by Task Management > [Get task status by
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | InviteIdentitiesRequest | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True |
### Return type
@@ -516,7 +477,6 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$InviteIdentitiesRequest = @"{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
@@ -526,10 +486,10 @@ $InviteIdentitiesRequest = @"{
try {
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
Start-V2024IdentitiesInvite -InviteIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
# Start-V2024IdentitiesInvite -InviteIdentitiesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite"
Write-Host $_.ErrorDetails

54
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md
View File

@@ -26,9 +26,6 @@ Method | HTTP request | Description
## create-identity-attribute
:::warning 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.
:::
Use this API to create a new identity attribute.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-attribute)
@@ -36,7 +33,6 @@ Use this API to create a new identity attribute.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True |
### Return type
@@ -59,7 +55,6 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentityAttribute = @"{
"standard" : false,
"system" : false,
@@ -87,10 +82,10 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result
New-V2024IdentityAttribute -IdentityAttribute $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result
# New-V2024IdentityAttribute -IdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
@@ -99,9 +94,6 @@ try {
[[Back to top]](#)
## delete-identity-attribute
:::warning 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.
:::
This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attribute)
@@ -110,7 +102,6 @@ This deletes an identity attribute with the given name. The `system` and `stand
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Name | **String** | True | The attribute's technical name.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
(empty response body)
@@ -133,15 +124,14 @@ Code | Description | Data Type
### Example
```powershell
$Name = "displayName" # String | The attribute's technical name.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete identity attribute
try {
Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
Remove-V2024IdentityAttribute -Name $Name
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
# Remove-V2024IdentityAttribute -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
@@ -150,9 +140,6 @@ try {
[[Back to top]](#)
## delete-identity-attributes-in-bulk
:::warning 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.
:::
Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attributes-in-bulk)
@@ -160,7 +147,6 @@ Use this API to bulk delete identity attributes for a given set of names. Attrib
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | IdentityAttributeNames | [**IdentityAttributeNames**](../models/identity-attribute-names) | True |
### Return type
@@ -183,7 +169,6 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentityAttributeNames = @"{
"ids" : [ "name", "displayName" ]
}"@
@@ -192,10 +177,10 @@ $IdentityAttributeNames = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result
Remove-V2024IdentityAttributesInBulk -IdentityAttributeNames $Result
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result
# Remove-V2024IdentityAttributesInBulk -IdentityAttributeNames $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk"
Write-Host $_.ErrorDetails
@@ -204,9 +189,6 @@ try {
[[Back to top]](#)
## get-identity-attribute
:::warning 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.
:::
This gets an identity attribute for a given technical name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-attribute)
@@ -215,7 +197,6 @@ This gets an identity attribute for a given technical name.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Name | **String** | True | The attribute's technical name.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**IdentityAttribute**](../models/identity-attribute)
@@ -238,15 +219,14 @@ Code | Description | Data Type
### Example
```powershell
$Name = "displayName" # String | The attribute's technical name.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get identity attribute
try {
Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityAttribute -Name $Name
# Below is a request that includes all optional parameters
# Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
# Get-V2024IdentityAttribute -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
@@ -255,9 +235,6 @@ try {
[[Back to top]](#)
## list-identity-attributes
:::warning 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.
:::
Use this API to get a collection of identity attributes.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-attributes)
@@ -265,7 +242,6 @@ Use this API to get a collection of identity attributes.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | IncludeSystem | **Boolean** | (optional) (default to $false) | Include 'system' attributes in the response.
Query | IncludeSilent | **Boolean** | (optional) (default to $false) | Include 'silent' attributes in the response.
Query | SearchableOnly | **Boolean** | (optional) (default to $false) | Include only 'searchable' attributes in the response.
@@ -290,7 +266,6 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false)
$IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false)
$SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false)
@@ -299,10 +274,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List identity attributes
try {
Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityAttributes
# Below is a request that includes all optional parameters
# Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count
# Get-V2024IdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes"
Write-Host $_.ErrorDetails
@@ -311,9 +286,6 @@ try {
[[Back to top]](#)
## put-identity-attribute
:::warning 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.
:::
This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-identity-attribute)
@@ -322,7 +294,6 @@ This updates an existing identity attribute. Making an attribute searchable req
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Name | **String** | True | The attribute's technical name.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True |
### Return type
@@ -346,7 +317,6 @@ Code | Description | Data Type
### Example
```powershell
$Name = "displayName" # String | The attribute's technical name.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentityAttribute = @"{
"standard" : false,
"system" : false,
@@ -374,10 +344,10 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result
Send-V2024IdentityAttribute -Name $Name -IdentityAttribute $Result
# Below is a request that includes all optional parameters
# Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result
# Send-V2024IdentityAttribute -Name $Name -IdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountMappingsApi.md
View File

@@ -20,7 +20,7 @@ Method | HTTP request | Description
[**New-V2024MachineAccountMappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create machine account mappings
[**Remove-V2024MachineAccountMappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete source's machine account mappings
[**Get-V2024MachineAccountMappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine account mapping for source
[**Set-V2024MachineAccountMappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update source's machine account mappings
[**Set-V2024MachineAccountMappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update Source's Machine Account Mappings
## create-machine-account-mappings
@@ -243,7 +243,7 @@ $AttributeMappings = @"{
}
}"@
# Update source's machine account mappings
# Update Source's Machine Account Mappings
try {
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings

6
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md
View File

@@ -33,7 +33,7 @@ Any authenticated token can call this endpoint to see their requestable access i
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | IdentityId | **String** | (optional) | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
Query | Types | [**[]RequestableObjectType**](../models/requestable-object-type) | (optional) | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
Query | Types | **[]String** | (optional) | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
Query | Term | **String** | (optional) | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
Query | Statuses | [**[]RequestableObjectRequestStatus**](../models/requestable-object-request-status) | (optional) | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
@@ -62,9 +62,9 @@ Code | Description | Data Type
### Example
```powershell
$IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional)
$Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional)
$Types = "ACCESS_PROFILE" # String[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional)
$Types = @"ROLE,ACCESS_PROFILE"@ # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional)
$Types = @"ACCESS_PROFILE,ROLE"@ # String[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional)
$Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional)
$Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional)

83
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md
View File

@@ -102,6 +102,7 @@ Method | HTTP request | Description
[**Import-V2024Accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account aggregation
[**Import-V2024AccountsSchema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template
[**Import-V2024ConnectorFile**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
[**Import-V2024Entitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement aggregation
[**Import-V2024EntitlementsSchema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template
[**Import-V2024UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts
[**Get-V2024ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
@@ -534,9 +535,6 @@ try {
[[Back to top]](#)
## delete-native-change-detection-config
:::warning 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.
:::
Deletes the native change detection configuration for the source specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-native-change-detection-config)
@@ -545,7 +543,6 @@ Deletes the native change detection configuration for the source specified by th
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The source id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
(empty response body)
@@ -568,15 +565,14 @@ Code | Description | Data Type
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete native change detection configuration
try {
Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
Remove-V2024NativeChangeDetectionConfig -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
# Remove-V2024NativeChangeDetectionConfig -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig"
Write-Host $_.ErrorDetails
@@ -919,9 +915,6 @@ try {
[[Back to top]](#)
## get-native-change-detection-config
:::warning 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.
:::
This API returns the existing native change detection configuration for a source specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-native-change-detection-config)
@@ -930,7 +923,6 @@ This API returns the existing native change detection configuration for a source
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The source id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**NativeChangeDetectionConfig**](../models/native-change-detection-config)
@@ -953,15 +945,14 @@ Code | Description | Data Type
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Native change detection configuration
try {
Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
Get-V2024NativeChangeDetectionConfig -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
# Get-V2024NativeChangeDetectionConfig -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig"
Write-Host $_.ErrorDetails
@@ -1664,6 +1655,61 @@ try {
```
[[Back to top]](#)
## import-entitlements
:::warning 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.
:::
Starts an entitlement aggregation on the specified source.
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
You will also need to set the Content-Type header to `multipart/form-data`.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | SourceId | **String** | True | Source Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
| File | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type
[**LoadEntitlementTask**](../models/load-entitlement-task)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
202 | Aggregate Entitlements Task | LoadEntitlementTask
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### Example
```powershell
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Entitlement aggregation
try {
Import-V2024Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Import-V2024Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Entitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-entitlements-schema
This API uploads a source schema template file to configure a source's entitlement attributes.
@@ -1991,9 +2037,6 @@ try {
[[Back to top]](#)
## put-native-change-detection-config
:::warning 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.
:::
Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-native-change-detection-config)
@@ -2002,7 +2045,6 @@ Replaces the native change detection configuration for the source specified by t
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The source id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | NativeChangeDetectionConfig | [**NativeChangeDetectionConfig**](../models/native-change-detection-config) | True |
### Return type
@@ -2026,7 +2068,6 @@ Code | Description | Data Type
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$NativeChangeDetectionConfig = @"{
"selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ],
"operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ],
@@ -2040,10 +2081,10 @@ $NativeChangeDetectionConfig = @"{
try {
$Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig
Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result
Send-V2024NativeChangeDetectionConfig -Id $Id -NativeChangeDetectionConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result
# Send-V2024NativeChangeDetectionConfig -Id $Id -NativeChangeDetectionConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig"
Write-Host $_.ErrorDetails

1
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md
View File

@@ -287,6 +287,7 @@ Code | Description | Data Type
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required]
**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
**RemoveDate** | **System.DateTime** | The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. | [optional]
**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional]
**NativeIdentity** | **String** | The unique identifier for an account on the identity, designated as the account ID attribute in the source's account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional]

35
docs/tools/sdk/powershell/Reference/V2024/Models/ImportEntitlementsRequest.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-import-entitlements-request
title: ImportEntitlementsRequest
pagination_label: ImportEntitlementsRequest
sidebar_label: ImportEntitlementsRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ImportEntitlementsRequest', 'V2024ImportEntitlementsRequest']
slug: /tools/sdk/powershell/v2024/models/import-entitlements-request
tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsRequest', 'V2024ImportEntitlementsRequest']
---
# ImportEntitlementsRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**File** | **System.IO.FileInfo** | The CSV file containing the source entitlements to aggregate. | [optional]
## Examples
- Prepare the resource
```powershell
$ImportEntitlementsRequest = Initialize-V2024ImportEntitlementsRequest -File null
```
- Convert the resource to JSON
```powershell
$ImportEntitlementsRequest | ConvertTo-JSON
```
[[Back to top]](#)

2
docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required]
**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
**RemoveDate** | **System.DateTime** | The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. | [optional]
**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional]
## Examples