Skip to main content

IdentityDocument

Identity

Properties

NameTypeDescriptionNotes
idstrThe unique ID of the referenced object.[required]
namestrThe human readable name of the referenced object.[required]
display_namestrIdentity's display name.[optional]
first_namestrIdentity's first name.[optional]
last_namestrIdentity's last name.[optional]
emailstrIdentity's primary email address.[optional]
createddatetimeISO-8601 date-time referring to the time when the object was created.[optional]
modifieddatetimeISO-8601 date-time referring to the time when the object was last modified.[optional]
phonestrIdentity's phone number.[optional]
syncedstrISO-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]
inactiveboolIndicates whether the identity is inactive.[optional] [default to False]
protectedboolIndicates whether the identity is protected.[optional] [default to False]
statusstrIdentity's status in SailPoint.[optional]
employee_numberstrIdentity's employee number.[optional]
managerIdentityDocumentAllOfManager[optional]
is_managerboolIndicates whether the identity is a manager of other identities.[optional]
identity_profileIdentityDocumentAllOfIdentityProfile[optional]
sourceIdentityDocumentAllOfSource[optional]
attributesmap[string]objectMap or dictionary of key/value pairs.[optional]
disabledboolIndicates whether the identity is disabled.[optional] [default to False]
lockedboolIndicates whether the identity is locked.[optional] [default to False]
processing_statestrIdentity's processing state.[optional]
processing_detailsProcessingDetails[optional]
accounts[]BaseAccountList of accounts associated with the identity.[optional]
account_countintNumber of accounts associated with the identity.[optional]
apps[]AppList of applications the identity has access to.[optional]
app_countintNumber of applications the identity has access to.[optional]
access[]IdentityAccessList of access items assigned to the identity.[optional]
access_countintNumber of access items assigned to the identity.[optional]
entitlement_countintNumber of entitlements assigned to the identity.[optional]
role_countintNumber of roles assigned to the identity.[optional]
access_profile_countintNumber of access profiles assigned to the identity.[optional]
owns[]OwnsAccess items the identity owns.[optional]
owns_countintNumber of access items the identity owns.[optional]
tags[]strTags that have been applied to the object.[optional]
tags_countintNumber of tags on the identity.[optional]
visible_segments[]strList of segments that the identity is in.[optional]
visible_segment_countintNumber of segments the identity is in.[optional]
}

Example

from sailpoint.v2024.models.identity_document import IdentityDocument

identity_document = IdentityDocument(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='Carol.Adams',
first_name='Carol',
last_name='Adams',
email='[email protected]',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
phone='+1 440-527-3672',
synced='',
inactive=False,
protected=False,
status='UNREGISTERED',
employee_number='1a2a3d4e',
manager=sailpoint.v2024.models.identity_document_all_of_manager.IdentityDocument_allOf_manager(
id = '2c9180867dfe694b017e208e27c05799',
name = 'Amanda.Ross',
display_name = 'Amanda.Ross', ),
is_manager=False,
identity_profile=sailpoint.v2024.models.identity_document_all_of_identity_profile.IdentityDocument_allOf_identityProfile(
id = '3bc8ad26b8664945866b31339d1ff7d2',
name = 'HR Employees', ),
source=sailpoint.v2024.models.identity_document_all_of_source.IdentityDocument_allOf_source(
id = '2c91808b6e9e6fb8016eec1a2b6f7b5f',
name = 'ODS-HR-Employees', ),
attributes={country=US, firstname=Carol, cloudStatus=UNREGISTERED},
disabled=False,
locked=False,
processing_state='ERROR',
processing_details=sailpoint.v2024.models.processing_details.ProcessingDetails(
date = '2018-06-25T20:22:28.104Z',
stage = 'In Process',
retry_count = 0,
stack_trace = '<stack trace>',
message = '<message>', ),
accounts=[
null
],
account_count=3,
apps=[
null
],
app_count=2,
access=[
null
],
access_count=5,
entitlement_count=10,
role_count=1,
access_profile_count=1,
owns=[
sailpoint.v2024.models.owns.Owns(
sources = [
sailpoint.v2024.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', )
],
entitlements = [
sailpoint.v2024.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', )
],
access_profiles = [

],
roles = [

],
apps = [

],
governance_groups = [

],
fallback_approver = False, )
],
owns_count=5,
tags=[TAG_1, TAG_2],
tags_count=56,
visible_segments=[All Employees],
visible_segment_count=1
)

[Back to top]