LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
611622805c0271a0751e1d340302f3c0e6af116c
developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md
darrell-thobe-sp c69a78b807 adding powershell sdk docs back
2025-01-28 13:29:29 -05:00

10 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
v2024-search-document SearchDocument SearchDocument SearchDocument powershellsdk
powershell
PowerShell
sdk
SearchDocument
V2024SearchDocument
/tools/sdk/powershell/v2024/models/search-document
SDK
Software Development Kit
SearchDocument
V2024SearchDocument

SearchDocument

Properties

Name Type Description Notes
Id String The unique ID of the referenced object. [required]
Name String The human readable name of the referenced object. [required]
Description Pointer to String Access item's description. [optional]
Created Pointer to System.DateTime ISO-8601 date-time referring to the time when the object was created. [optional]
Modified Pointer to System.DateTime ISO-8601 date-time referring to the time when the object was last modified. [optional]
Synced Pointer to System.DateTime ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the synced time and the time when the updated data is actually available in the search API. [optional]
Enabled Pointer to Boolean Indicates whether the access item is currently enabled. [optional] [default to $false]
Requestable Pointer to Boolean Indicates whether the access item can be requested. [optional] [default to $true]
RequestCommentsRequired Pointer to Boolean Indicates whether comments are required for requests to access the item. [optional] [default to $false]
Owner Pointer to BaseAccessAllOfOwner [optional]
Type DocumentType [required]
Source Pointer to IdentityDocumentAllOfSource [optional]
Entitlements Pointer to []BaseEntitlement Entitlements included with the role. [optional]
EntitlementCount Pointer to Int32 Number of entitlements included with the role. [optional]
Tags Pointer to []String Tags that have been applied to the object. [optional]
Action Pointer to String Name of the event as it's displayed in audit reports. [optional]
Stage Pointer to String Activity's current stage. [optional]
Origin Pointer to String Activity's origin. [optional]
Status Pointer to String Identity's status in SailPoint. [optional]
Requester Pointer to AccountSource [optional]
Recipient Pointer to AccountSource [optional]
TrackingNumber Pointer to String ID of the group of events. [optional]
Errors Pointer to []String Errors provided by the source while completing account actions. [optional]
Warnings Pointer to []String Warnings provided by the source while completing account actions. [optional]
Approvals Pointer to []Approval1 Approvals performed on an item during activity. [optional]
OriginalRequests Pointer to []OriginalRequest Original actions that triggered all individual source actions related to the account action. [optional]
ExpansionItems Pointer to []ExpansionItem Controls that translated the attribute requests into actual provisioning actions on the source. [optional]
AccountRequests Pointer to []AccountRequest Account data for each individual source action triggered by the original requests. [optional]
Sources Pointer to String Sources involved in the account activity. [optional]
DisplayName Pointer to String Identity's display name. [optional]
Segments Pointer to []BaseSegment Segments with the role. [optional]
SegmentCount Pointer to Int32 Number of segments with the role. [optional]
CloudGoverned Pointer to Boolean Indicates whether the entitlement is cloud governed. [optional] [default to $false]
Privileged Pointer to Boolean Indicates whether the entitlement is privileged. [optional] [default to $false]
IdentityCount Pointer to Int32 Number of identities who have access to the entitlement. [optional]
Type Pointer to String Event type. Refer to Event Types for a list of event types and their meanings. [optional]
Actor Pointer to String Name of the actor that generated the event. [optional]
Target Pointer to String Name of the target, or recipient, of the event. [optional]
Stack Pointer to String The event's stack. [optional]
IpAddress Pointer to String Target system's IP address. [optional]
Details Pointer to String ID of event's details. [optional]
Attributes Pointer to [map[string]AnyType]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 Map or dictionary of key/value pairs. [optional]
Objects Pointer to []String Objects the event is happening to. [optional]
Operation Pointer to String Operation, or action, performed during the event. [optional]
TechnicalName Pointer to String Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. [optional]
FirstName Pointer to String Identity's first name. [optional]
LastName Pointer to String Identity's last name. [optional]
Email Pointer to String Identity's primary email address. [optional]
Phone Pointer to String Identity's phone number. [optional]
Inactive Pointer to Boolean Indicates whether the identity is inactive. [optional] [default to $false]
Protected Pointer to Boolean Indicates whether the identity is protected. [optional] [default to $false]
EmployeeNumber Pointer to String Identity's employee number. [optional]
Manager Pointer to IdentityDocumentAllOfManager [optional]
IsManager Pointer to Boolean Indicates whether the identity is a manager of other identities. [optional]
IdentityProfile Pointer to IdentityDocumentAllOfIdentityProfile [optional]
ProcessingState Pointer to String Identity's processing state. [optional]
ProcessingDetails Pointer to ProcessingDetails [optional]
Accounts Pointer to []BaseAccount List of accounts associated with the identity. [optional]
AccountCount Pointer to Int32 Number of accounts associated with the identity. [optional]
Apps Pointer to []App List of applications the identity has access to. [optional]
AppCount Pointer to Int32 Number of applications the identity has access to. [optional]
Access Pointer to []IdentityAccess List of access items assigned to the identity. [optional]
AccessCount Pointer to Int32 Number of access items assigned to the identity. [optional]
RoleCount Pointer to Int32 Number of roles assigned to the identity. [optional]
AccessProfileCount Pointer to Int32 Number of access profiles included with the role. [optional]
Owns Pointer to []Owns Access items the identity owns. [optional]
OwnsCount Pointer to Int32 Number of access items the identity owns. [optional]
AccessProfiles Pointer to []BaseAccessProfile Access profiles included with the role. [optional]

Examples

  • Prepare the resource
$SearchDocument = Initialize-PSSailpoint.V2024SearchDocument  -Id 2c91808568c529c60168cca6f90c1313 `
 -Name John Doe `
 -Description The admin role `
 -Created 2018-06-25T20:22:28.104Z `
 -Modified 2018-06-25T20:22:28.104Z `
 -Synced 2018-06-25T20:22:33.104Z `
 -Enabled true `
 -Requestable true `
 -RequestCommentsRequired false `
 -Owner null `
 -Type null `
 -Source null `
 -Entitlements null `
 -EntitlementCount 3 `
 -Tags [TAG_1, TAG_2] `
 -Action update `
 -Stage Completed `
 -Origin null `
 -Status UNREGISTERED `
 -Requester null `
 -Recipient null `
 -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 `
 -Errors null `
 -Warnings null `
 -Approvals null `
 -OriginalRequests null `
 -ExpansionItems null `
 -AccountRequests null `
 -Sources smartsheet-test, airtable-v4, IdentityNow `
 -DisplayName Carol.Adams `
 -Segments null `
 -SegmentCount 1 `
 -CloudGoverned false `
 -Privileged false `
 -IdentityCount 3 `
 -Type SYSTEM_CONFIG `
 -Actor System `
 -Target Carol.Adams `
 -Stack tpe `
 -IpAddress 52.52.97.85 `
 -Details 73b65dfbed1842548c207432a18c84b0 `
 -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} `
 -Objects null `
 -Operation REQUEST `
 -TechnicalName AUTHENTICATION_REQUEST_PASSED `
 -FirstName Carol `
 -LastName Adams `
 -Email Carol.Adams@sailpointdemo.com `
 -Phone +1 440-527-3672 `
 -Inactive false `
 -Protected false `
 -EmployeeNumber 1a2a3d4e `
 -Manager null `
 -IsManager false `
 -IdentityProfile null `
 -ProcessingState null `
 -ProcessingDetails null `
 -Accounts null `
 -AccountCount 3 `
 -Apps null `
 -AppCount 2 `
 -Access null `
 -AccessCount 5 `
 -RoleCount 1 `
 -AccessProfileCount 1 `
 -Owns null `
 -OwnsCount 5 `
 -AccessProfiles null
  • Convert the resource to JSON
$SearchDocument | ConvertTo-JSON

[Back to top]