Skip to main content

Identity Details

GET 

/identities/:id

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.

Request

Path Parameters

    id stringrequired

    Identity Id

    Example: ef38f94347e94562b5bb8424a56397d8

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

An identity object

Schema

    id string

    System-generated unique ID of the identity

    name stringrequired

    The identity's name is equivalent to its Display Name attribute.

    created date-time

    Creation date of the identity

    modified date-time

    Last modification date of the identity

    alias string

    The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema.

    emailAddress stringnullable

    The email address of the identity

    processingState stringnullable

    Possible values: [ERROR, OK, null]

    The processing state of the identity

    identityStatus string

    Possible values: [UNREGISTERED, REGISTERED, PENDING, WARNING, DISABLED, ACTIVE, DEACTIVATED, TERMINATED, ERROR, LOCKED]

    The identity's status in the system

    managerRef

    object

    nullable

    Identity's manager

    type string

    Possible values: [IDENTITY]

    DTO type of identity's manager

    id string

    ID of identity's manager

    name string

    Human-readable display name of identity's manager

    isManager boolean

    Whether this identity is a manager of another identity

    lastRefresh date-time

    The last time the identity was refreshed by the system

    attributes object

    A map with the identity attributes for the identity

    lifecycleState

    object

    Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually

    stateName stringrequired

    The name of the lifecycle state

    manuallyUpdated booleanrequired

    Whether the lifecycle state has been manually or automatically set

Loading...