Skip to main content

Get a Document by ID

Fetches a single document from the specified index, using the specified document ID.

Path Parameters
  • index string required

    The index from which to fetch the specified document.

    The currently supported index names are: accessprofiles, accountactivities, accounts, aggregations, entitlements, events, identities, and roles.

    Example: accounts
  • id string required

    ID of the requested document.

    Example: 2c91808568c529c60168cca6f90c1313
Responses

The requested document.


Schema
    oneOf

  • id string
  • name string
  • _type string

    Possible values: [accessprofile, accountactivity, account, aggregation, entitlement, event, identity, role]

    Enum representing the currently supported document types.

    Additional values may be added in the future without notice.

  • description string

    The description of the access item

  • created date-time

    A date-time in ISO-8601 format

  • modified date-time

    A date-time in ISO-8601 format

  • synced date-time

    A date-time in ISO-8601 format

  • enabled boolean
  • requestable boolean

    Indicates if the access can be requested

  • requestCommentsRequired boolean

    Indicates if comments are required when requesting access

  • owner object
  • id string
  • name string
  • type string

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY]

    An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

  • email string

    The email of the identity

  • source object
  • id string
  • name string
  • entitlements object[]
  • id string
  • name string
  • description string

    A description of the entitlement

  • attribute string

    The name of the entitlement attribute

  • value string

    The value of the entitlement

  • entitlementCount integer
  • tags string[]
Loading...