Skip to main content
GET
Get

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow. Request an access token from the token endpoint and send it as Authorization: Bearer <token>.

Path Parameters

id
string
required

Global id of the resource instance.

Response

The resource instance.

An Oleria ResourceInstance object represents an application-specific instance of a resource controlled by the application's access control system (e.g. repositories in GitHub, files in Google Drive)

id
string
required

An identifier (unique to the integrated application) for a ResourceInstance object represented in the Oleria system. Oleria converts these identifiers to global ids so they can be unique in the context of the global system graph. It is important for this identifier to be based on an underlying persistent and reusable application or identity provider id so connections to the object are robust to metadata changes and other relevant operations

Example:

"repo:R_kgDOLL0doQ (GitHub based on repository node identifier), 1BUxdX4M-H7X8GKRgTjprJS8fjY_Ij1giE82lQlny2kc (Google Drive based on file id)"

isDeleted
boolean
required

Has this resource instance been deleted? A deleted resource instance may still be represented in the Oleria composite graph of an application's identity security

Example:

false

name
string
required

The name of the resource instance

Minimum string length: 1
Example:

"oleria"

objectMetadata
object
required

The ObjectMetadata structure defines metadata that applies to every object and relationship, and is usually managed by the system that receives the data

prohibitInheritedLabels
boolean
required

Inherited labels e.g. container -> contained are not allowed on this resource instance. Only directly assigned labels are honored

Example:

false

prohibitInheritedPermissions
boolean
required

Inherited permissions e.g. container -> contained are not allowed on this resource instance. Only direct permissions are honored

Example:

true

resourceClass
string
required

The unique application-specific type of the ResourceInstance which connects it to a particular ResourceClass via the ResourceClass.name field

Example:

"repo"

globalId
string
required
oleriaObjectMetadata
object
required

object metadata supersets object metadata with platform enrichment provenance — the enrichment version and the time the record was generated

contentHashesOrFingerprints
string[]

Exposes hashes or fingerprints of the content represented by this ResourceInstance

createdBy
string

An identifier (unique to integrated application) for an Account object represented in the Oleria system. Oleria converts these identifiers to global ids so they can be unique in the context of the global system graph. It is important for this identifier to be based on an underlying persistent and reusable application or identity provider id so connections to the object are robust to metadata changes and other relevant operations

Example:

"user:U_kgDOB7P6Rg (GitHub based on node identifier), 838439349399 (Google Workspace based on user id), user:wiz-inc-4db1c46901 (GitHub based on app slug)"

createdByFederation
object

Federation information used when specifying an EntityIdentifier

createdDate
string<date-time>

The date the resource instance was created

labels
object[]
lastModifiedBy
string

An identifier (unique to integrated application) for an Account object represented in the Oleria system. Oleria converts these identifiers to global ids so they can be unique in the context of the global system graph. It is important for this identifier to be based on an underlying persistent and reusable application or identity provider id so connections to the object are robust to metadata changes and other relevant operations

Example:

"user:U_kgDOB7P6Rg (GitHub based on node identifier), 838439349399 (Google Workspace based on user id), user:wiz-inc-4db1c46901 (GitHub based on app slug)"

lastModifiedByFederation
object

Federation information used when specifying an EntityIdentifier

lastModifiedDate
string<date-time>

The date the resource instance was last modified

Example:

"2024-05-02T03:17:34.948Z"

objectDirectoryContainerFederation
object

Federation information used when specifying an EntityIdentifier

objectDirectoryContainerId
string

An identifier (unique to the integrated application) for a ObjectDirectory object represented in the Oleria system. Oleria converts these identifiers to global ids so they can be unique in the context of the global system graph. It is important for this identifier to be based on an underlying persistent and reusable application or identity provider id so connections to the object are robust to metadata changes and other relevant operations

Example:

"repo:R_kgDOLL0doQ (GitHub based on repository node identifier), 1BUxdX4M-H7X8GKRgTjprJS8fjY_Ij1giE82lQlny2kc (Google Drive based on file id)"

pageUri
string<uri>

The URI of the resource instance entity

Example:

"/lightning/r/Opportunity/006Dn000007rkDYIAY/view, https://github.com/roanokedatasecurity/oleria"

secondaryResourceClasses
string[]
sourceTag
string

An application-specific tag representing the resource instance information data source

globalCreatedBy
string
globalLastModifiedBy
string
globalObjectDirectoryContainerId
string
enrichedDataClassifications
object[]
analyticsAccessFromApplicationAccountsCount
integer<int32> | null

Cached count of distinct accounts with access to this resource instance, including both application accounts and directory accounts. Values above 1000 may be approximate.

analyticsAccessFromRolesCount
integer<int32> | null

Cached count of roles with access to this resource instance. Values above 1000 may be approximate.

analyticsAccessFromUserGroupsCount
integer<int32> | null

Cached count of user groups with access to this resource instance.

analyticsChildResourceInstanceCount
integer<int64> | null

Cached count of directly nested child resource instances.

analyticsContainedDataSensitivityLabels
string[]

Distinct data-sensitivity labels found across this resource instance's descendants (excluding itself).

analyticsContainedSensitiveResourceInstancesCount
integer<int64> | null

Cached count of sensitive resource instances among this resource instance's descendants (excluding itself).

analyticsDaysSinceLastActivity
integer<int32> | null

Days since the most recent activity directly observed on this resource instance.

analyticsEffectiveDaysSinceLastActivity
integer<int32> | null

Days since the most recent activity across this resource instance and all of its descendants.

analyticsEffectiveLastActivityDate
string<date-time> | null

Most recent activity across this resource instance and all of its descendants.

analyticsIsAnonymouslyShared
boolean | null

Whether this resource instance is shared via an anonymous or public link.

analyticsIsExternallyShared
boolean | null

Whether this resource instance is shared with parties external to the organization.

analyticsLastActivityDate
string<date-time> | null

Most recent activity directly observed on this resource instance.

analyticsMaximumRolledUpLastActivityDate
string<date-time> | null

Most recent activity across this resource instance's descendants (excluding itself).

analyticsMinimumRolledUpDaysSinceLastActivity
integer<int32> | null

Days since the most recent activity across this resource instance's descendants (excluding itself).

analyticsOwners
string[]

Names of the accounts, roles, or user groups determined to own this resource instance, derived from access topology.

Cached count of shared links pointing to this resource instance.

sorPrimaryStewardEmail
string