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 integrated application.

Response

The integrated application.

An Oleria IntegratedApplication represents a direct Oleria integration — the application's own AIR source application emits this object. It is the most authoritative source for deployment identity signals, including the Oleria-assigned globalDeploymentKey (translated from IntegratedApplication.key). Multiple Oleria IntegratedApplication nodes may exist for the same deployment in rare cases (e.g. multi-region integrations), but typically there is one per customer deployment. Connects to Oleria ApplicationDeployment via Oleria ApplicationReferencedBy.

authenticationRequirements
object
required

AuthenticationRequirements are used to specify authentication requirement configuration for Oleria integrated applications as described by their corresponding IntegratedApplication object

category
enum<string>
required

Categories of application that can be integrated with Oleria

Available options:
BusinessApplication,
CloudDataService,
CloudInfrastructure,
Collaboration,
Communications,
CRM,
CustomApplication,
DeveloperTool,
DirectoryService,
Finance,
HRIS,
IdentityProvider,
ITSM,
LogAnalytics,
Productivity,
Security,
Storage
id
string
required

An identifier for an IntegratedApplication object 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 id so connections to the object are robust to metadata changes and other relevant operations. For the IntegratedApplication object this can be based on the key field

Example:

"app:O_kgDOCfJllg (GitHub)"

key
string
required

The unique application-specific key that maps to a specific service instance integrated with Oleria. This key is used to prevent instance collision when adding integrations to the system

Example:

"O_kgDOCfJllg (GitHub)"

name
string
required

The name of application-specific service instance that has been integrated with Oleria e.g. GitHub organization, Salesforce instance, Google Workspace domain, Microsoft 365 tenant, etc. This is typically the unit of registration within the application of a customer's organization or enterprise and is associated with an IntegratedApplicationKey.

Minimum string length: 1
Example:

"roanokedatasecurity"

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

globalAuthenticationRequirements
object
required

AuthenticationRequirements are used to specify authentication requirement configuration for Oleria integrated applications as described by their corresponding IntegratedApplication object

globalDeploymentKey
string
required

Translated from IntegratedApplication.key. Oleria-assigned stable deployment identifier. Used as the primary key for deployment resolution (resolution priority 1).

globalId
string
required

Opaque platform-assigned identifier for this integrated application node.

oleriaObjectMetadata
object
required

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

labels
object[]
supportedFederatedRelationships
enum<string>[]

An array of relationship types supported for federated connections e.g. EntityAssignedAccessToObject or IdentityAccountMemberOfUserGroup. If federated connections are supported, then Oleria will use data in the edges emitted by the source application to do composite graph connections for the relevant source entities

The enumerated list of all Oleria relationships used to describe and manage the connections among Oleria objects. Furthermore, these connections amongst objects complete the definiton of an Oleria composite graph used to represent a customer's full (potentally cross-application) identity security. The definition of each relationship describes its usage and the description includes a "GraphNotation:" which gives a normative way of describing the relationship using the connected ObjectTypes, abstract Relationship, and potential field matching.

Available options:
AccountCanImpersonateAccount,
AccountMemberOfRole,
AccountMemberOfUserGroup,
ApplicationAccountCanImpersonateApplicationAccount,
ApplicationAccountMemberOfRole,
ApplicationAccountMemberOfUserGroup,
AssignedApplicationHasAccountRole,
DepartmentContainsDepartment,
EmployeeManagesEmployee,
EmployeeServingInDepartment,
EnrollmentViaAuthenticator,
EntityAssignedAccessToObject,
EntityCanImpersonateEntity,
EntityManagedViaObject,
IdentityAccountAssignedAccessToAssignedApplication,
IdentityAccountCanImpersonateIdentityAccount,
IdentityAccountMemberOfRole,
IdentityAccountMemberOfUserGroup,
IntegratedApplicationHasAccountRole,
IntegratedApplicationRegisteredWithDirectoryProvider,
ObjectHasExtension,
ObjectDirectoryContainsObject,
PermissionSetAccessToResourceInstance,
PersonIsEmployee,
ResourceClassHasResourceInstance,
ResourceInstanceContainsResourceInstance,
RoleAccessToResourceClass,
RoleAssignedAccessToAssignedApplication,
RoleHasPermissionSet,
RoleMemberOfRole,
UserGroupAssignedAccessToAssignedApplication,
UserGroupAssignedAccessToResourceInstance,
UserGroupMemberOfRole,
UserGroupMemberOfUserGroup,
UserGroupSyncsWithUserGroup
unsupportedTypes
object

Declares object and relationship types that this integration does not support despite its declared schema profile. Omitted when the integration fully satisfies its declared profile contract. See UnsupportedTypeSet for semantics.

vendorName
string

Name of the vendor for the enterprise application or identity provider product

Example:

"Microsoft"

enrichedResolvedDeploymentId
string

Global ID of the Oleria ApplicationDeployment this node resolved to. Denormalized cache of the Oleria ApplicationReferencedBy edge, which is authoritative; set by the deployment resolution pipeline after matching.