> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oleria.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List

> Returns a page of managed-via relationships. Pass `pageToken` from the previous response's `nextPageToken` to fetch the next page. A page can be empty while the results are still being prepared. Keep requesting pages until the response has no `nextPageToken`. Requires the `https://devx.{environment}.oleria.io/read` scope.



## OpenAPI

````yaml /developer-docs/api-reference/oleria-public-api-1.0.0.yaml get /v1/entity-managed-via-object
openapi: 3.0.3
info:
  title: Oleria Public API
  version: 1.0.0
  description: >-
    REST API for Oleria's identity and access data. Each resource is a
    collection exposing list and get operations; responses return the complete
    object. Where Oleria can change what it reports, the change is a method on
    the same resource: disabling an account is `POST /v1/accounts/{id}/disable`,
    and membership is a sub-resource asserted with `PUT` and removed with
    `DELETE`. Those changes are applied in the source application
    asynchronously: each returns a job under `/v1/action-jobs` that reports the
    outcome for every target it affected, and whether Oleria's own data reflects
    it yet. Authenticate with OAuth 2.0 client credentials and send the access
    token as `Authorization: Bearer <token>`.
servers:
  - url: https://devx.{environment}.oleria.io
    description: Oleria API server.
    variables:
      environment:
        default: prod
        description: >-
          Your Oleria deployment, for example `acme` for
          `https://devx.acme.oleria.io`. Substitute it in the OAuth scope names
          as well, since OpenAPI applies a server variable to the URL only and
          the scopes are published with the placeholder still in them.
security: []
paths:
  /v1/entity-managed-via-object:
    get:
      tags:
        - Managed-via relationships
      summary: List
      description: >-
        Returns a page of managed-via relationships. Pass `pageToken` from the
        previous response's `nextPageToken` to fetch the next page. A page can
        be empty while the results are still being prepared. Keep requesting
        pages until the response has no `nextPageToken`. Requires the
        `https://devx.{environment}.oleria.io/read` scope.
      operationId: ListEntityManagedViaObject
      parameters:
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/applicationInstanceId'
      responses:
        '200':
          description: A page of managed-via relationships.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityManagedViaObjectList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - oauth2:
            - https://devx.{environment}.oleria.io/read
components:
  parameters:
    pageSize:
      name: pageSize
      in: query
      description: Maximum items per page.
      schema:
        type: integer
        format: int32
        default: 50
        minimum: 1
        maximum: 200
    pageToken:
      name: pageToken
      in: query
      description: >-
        Opaque page token from the previous response's `nextPageToken`. Omit it
        for the first page; pass it back exactly as received. Do not parse or
        construct it.
      schema:
        type: string
    applicationInstanceId:
      name: applicationInstanceId
      in: query
      description: >-
        Scope the list to a single application instance, identified by its id
        (UUID). An application instance is one connected integration in your
        tenant: a specific Okta, Workday, and so on. Omit it to list across all
        of your instances.
      schema:
        type: string
        format: uuid
  schemas:
    EntityManagedViaObjectList:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Oleria_EntityManagedViaObject'
        nextPageToken:
          type: string
          description: >-
            Opaque token for the next page; pass it back as `pageToken`. Present
            whenever more pages remain, including when this page is empty
            because the results are still being prepared, and absent only once
            the collection is fully returned. Do not parse or construct it.
    Oleria_EntityManagedViaObject:
      type: object
      description: >
        An Oleria EntityManagedViaObject relationship connects an entity (Oleria
        Account, Oleria Role,

        or Oleria UserGroup) to the Oleria ResourceInstance that also represents
        it in the graph, so that

        ownership and management of the entity can be expressed separately from
        the entity itself.

        Direction: entity to managed-via object. globalEntityId/Type identify
        the entity;

        globalManagedViaObjectId/Type identify the representing object.
      allOf:
        - $ref: '#/components/schemas/EntityManagedViaObject'
        - $ref: '#/components/schemas/Oleria_EntityManagedViaObjectGlobalIdentifiers'
        - required:
            - oleriaObjectMetadata
          type: object
          properties:
            oleriaObjectMetadata:
              $ref: '#/components/schemas/Oleria_ObjectMetadata'
    ErrorResponse:
      type: object
      description: >-
        Error envelope. `code` is a stable machine-readable identifier;
        `message` is human-readable.
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable, machine-readable error code (SCREAMING_SNAKE_CASE).
          example: NOT_FOUND
        details:
          type: object
          description: Optional free-form context for debugging.
          additionalProperties: true
        message:
          type: string
          description: Human-readable description of the error.
          example: No resource with the given id.
    EntityManagedViaObject:
      required:
        - entityId
        - entityType
        - id
        - managedViaObjectId
        - managedViaObjectType
        - objectMetadata
      type: object
      properties:
        entityId:
          $ref: '#/components/schemas/LocallyUniqueId'
        entityType:
          $ref: '#/components/schemas/ObjectType'
        federationSpecification:
          $ref: '#/components/schemas/FederatedRelationshipSpecification'
        id:
          $ref: '#/components/schemas/LocallyUniqueId'
        managedViaObjectId:
          $ref: '#/components/schemas/LocallyUniqueId'
        managedViaObjectType:
          $ref: '#/components/schemas/ObjectType'
        objectMetadata:
          $ref: '#/components/schemas/ObjectMetadata'
      description: >
        An EntityManagedViaObject relationship connects an
        [Account](#/components/schemas/Account),
        [Role](#/components/schemas/Role), or
        [UserGroup](#/components/schemas/UserGroup) to the
        [ResourceInstance](#/components/schemas/ResourceInstance) or
        [ObjectDirectory](#/components/schemas/ObjectDirectory) that also
        represents it in the graph. The
        [ResourceInstance](#/components/schemas/ResourceInstance) or
        [ObjectDirectory](#/components/schemas/ObjectDirectory) representation
        enables ownership and management permissions of the entity to be
        expressed in the graph separate from the entity itself which avoids
        potential loops in the graph
    Oleria_EntityManagedViaObjectGlobalIdentifiers:
      required:
        - globalEntityId
        - globalEntityType
        - globalId
        - globalManagedViaObjectId
        - globalManagedViaObjectType
      type: object
      properties:
        globalEntityId:
          type: string
          description: >
            Global ID of the entity that is owned or managed via the
            representing object. Valid values reference Oleria Account, Oleria
            Role, or Oleria UserGroup.
        globalEntityType:
          allOf:
            - $ref: '#/components/schemas/Oleria_ObjectType'
          description: >
            Object type of the entity. Expected values: Oleria Account, Oleria
            Role, Oleria UserGroup.
        globalId:
          type: string
          description: Opaque platform-assigned identifier for this relationship instance.
        globalManagedViaObjectId:
          type: string
          description: >
            Global ID of the object that represents the entity for ownership and
            management. References Oleria ResourceInstance.
        globalManagedViaObjectType:
          allOf:
            - $ref: '#/components/schemas/Oleria_ObjectType'
          description: >
            Object type of the representing object. Expected value: Oleria
            ResourceInstance.
      description: |
        Global identifiers composed on Oleria EntityManagedViaObject
    Oleria_ObjectMetadata:
      type: object
      properties:
        enrichmentVersion:
          type: string
        generatedTime:
          type: string
          format: date-time
      description: >
        object metadata supersets object metadata with platform enrichment
        provenance — the enrichment version and the time the record was
        generated
    LocallyUniqueId:
      minLength: 1
      type: string
      description: >
        An identifier (unique to the integrated or assigned application) of any
        object or entity represented in the Oleria system as well as any
        relationship or connection among entities when they are represented in
        Oleria. Oleria converts these identifiers to global ids so they can be
        unique in the context of the global system graph. The full list of
        Oleria objects or entities is defined by the object-type enumeration,
        and the full list of relationships or connections is defined by the
        relationship-type enumeration
    ObjectType:
      type: string
      description: >-
        The enumerated list of all Oleria objects used to describe and manage
        any customer application's identity security. The definition of each
        object describes its usage
      example: Account
      enum:
        - Account
        - AccountRole
        - Activity
        - AssignedApplication
        - Authenticator
        - AuthenticatorEnrollment
        - Department
        - DirectoryProvider
        - Employee
        - IntegratedApplication
        - None
        - ObjectDirectory
        - PermissionSet
        - Person
        - ResourceClass
        - ResourceInstance
        - RiskDefinition
        - RiskViolation
        - Role
        - UserGroup
    FederatedRelationshipSpecification:
      type: object
      required:
        - isFederated
      properties:
        connectionType:
          $ref: '#/components/schemas/FederatedRelationshipConnectionType'
        isFederated:
          type: boolean
        sourceAuthenticationKey:
          type: string
        targetAuthenticationKey:
          type: string
      description: >
        Used to specify if an emitted relationship is federated, and if so, how
        Oleria can connect the participating objects in a composite graph
    ObjectMetadata:
      required:
        - ApplicationInstanceId
        - GeneratedTime
      type: object
      properties:
        ApplicationInstanceId:
          type: string
        GeneratedTime:
          type: string
          format: date-time
        Profile:
          $ref: '#/components/schemas/SchemaProfile'
        ObjectOrRelationshipType:
          type: string
      description: >
        The _ObjectMetadata_ structure defines metadata that applies to every
        object and relationship, and is usually managed by the system that
        receives the data
    Oleria_ObjectType:
      type: string
      description: >
        The enumerated list of all Oleria objects used to describe and manage
        any customer's identity security. The definition of each object
        describes its usage  
      example: Oleria_IntegratedApplication
      enum:
        - Oleria_Account
        - Oleria_AccountRole
        - Oleria_Activity
        - Oleria_Application
        - Oleria_ApplicationDeployment
        - Oleria_AssignedApplication
        - Oleria_Authenticator
        - Oleria_AuthenticatorEnrollment
        - Oleria_Department
        - Oleria_DirectoryProvider
        - Oleria_DiscoveredApplication
        - Oleria_Employee
        - Oleria_IntegratedApplication
        - Oleria_ObjectDirectory
        - Oleria_Person
        - Oleria_ResourceClass
        - Oleria_ResourceInstance
        - Oleria_Role
        - Oleria_UserGroup
    FederatedRelationshipConnectionType:
      type: string
      enum:
        - Source
        - SourceAndTarget
        - Target
    SchemaProfile:
      type: string
      enum:
        - Account
        - Membership
        - Governance
        - Risk
        - Access
        - Detection
  responses:
    BadRequest:
      description: The request was malformed, for example an invalid cursor or page size.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: BAD_REQUEST
            message: The request was malformed.
    Unauthorized:
      description: Missing or invalid authentication token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: UNAUTHORIZED
            message: Missing or invalid authentication token.
    Forbidden:
      description: The token lacks the scope required for this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: FORBIDDEN
            message: The token lacks the required scope.
    TooManyRequests:
      description: Rate limit exceeded. Retry after the interval in the Retry-After header.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 0
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: TOO_MANY_REQUESTS
            message: Rate limit exceeded. Retry after the specified interval.
    InternalError:
      description: An unexpected error occurred.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: INTERNAL_ERROR
            message: An unexpected error occurred.
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 client-credentials flow. Request an access token from the
        token endpoint and send it as `Authorization: Bearer <token>`.
      flows:
        clientCredentials:
          tokenUrl: https://auth.prod.oleria.io/oauth/token
          scopes:
            https://devx.{environment}.oleria.io/delete: Irreversibly destroy an object in the source system.
            https://devx.{environment}.oleria.io/read: Read identity and access data, and the jobs that change it.
            https://devx.{environment}.oleria.io/write: >-
              Make reversible changes: grant, enable, assign, revoke and remove
              access.

````