Gets the list of identity access items at a given date filterd by item type

GET 
/historical-identities/:id/snapshots/:date/access-items

This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read'

Request

Path Parameters

id stringrequired
The identity id
Example: 8c190e6787aa4ed9a90bd9d5344523fb
date stringrequired
The specified date
Example: 2007-03-01T13:00:00Z

Query Parameters

type string
The access item type
Example: account

Responses

200

The identity object.

application/json

Schema

Schema

• Array [
oneOf

AccessItemAccessProfileResponse

accessType string

the access item type. accessProfile in this case

id string

the access item id

name string

the access profile name

sourceName string

the name of the source

sourceId string

the id of the source

description string

the description for the access profile

displayName string

the display name of the identity

entitlementCount string

the number of entitlements the access profile will create

appDisplayName string

the name of app

AccessItemAccountResponse

accessType string

the access item type. account in this case

id string

the access item id

nativeIdentity string

the native identifier used to uniquely identify an acccount

sourceName string

the name of the source

sourceId string

the id of the source

entitlementCount string

the number of entitlements the account will create

displayName string

the display name of the identity

AccessItemAppResponse

accessType string

the access item type. entitlement in this case

id string

the access item id

displayName string

the access profile display name

sourceName string

the associated source name if it exists

AccessItemEntitlementResponse

accessType string

the access item type. entitlement in this case

id string

the access item id

attribute string

the entitlement attribute

value string

the associated value

entitlementType string

the type of entitlement

sourceName string

the name of the source

sourceId string

the id of the source

description string

the description for the entitlment

displayName string

the display name of the identity

AccessItemRoleResponse

accessType string

the access item type. role in this case

id string

the access item id

displayName string

the role display name

description string

the description for the role

sourceName string

the associated source name if it exists

• ]

Example (from schema)

[
  {},
  {},
  {},
  {},
  {}
]

Access Item AccessProfile Response

[
  {
    "type": "accessProfile",
    "id": "2c918087763e69d901763e72e97f006f",
    "name": "sample",
    "sourceName": "DataScienceDataset",
    "sourceId": "2793o32dwd",
    "description": "AccessProfile - Workday/Citizenship access",
    "displayName": "Dr. Arden Rogahn MD",
    "entitlementCount": 12,
    "appDisplayName": "AppName"
  }
]

Access Item Account Response

[
  {
    "type": "account",
    "id": "2c918087763e69d901763e72e97f006f",
    "nativeIdentity": "dr.arden.ogahn.d",
    "sourceName": "DataScienceDataset",
    "sourceId": "2793o32dwd",
    "entitlementCount": 12,
    "displayName": "Dr. Arden Rogahn MD"
  }
]

Access Item App Response

[
  {
    "type": "app",
    "id": "2c918087763e69d901763e72e97f006f",
    "name": "appName"
  }
]

Access Item Entitlement Response

[
  {
    "type": "entitlement",
    "id": "2c918087763e69d901763e72e97f006f",
    "attribute": "groups",
    "value": "Upward mobility access",
    "entitlementType": "entitlement",
    "sourceName": "DataScienceDataset",
    "sourceId": "2793o32dwd",
    "description": "Entitlement - Workday/Citizenship access",
    "displayName": "Dr. Arden Rogahn MD"
  }
]

Access Item Role Response

[
  {
    "type": "role",
    "id": "2c918087763e69d901763e72e97f006f",
    "name": "sample",
    "description": "Role - Workday/Citizenship access"
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

404

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...