ORory
Directory Sync

Get event logs for a directory

get/api/v1/dsync/events

Request

  • Base URL
    http://localhost:5225
  • URL
    http://localhost:5225/api/v1/dsync/events
  • Auth
    API key in header Authorization

Query parameters

directoryIdstring

Directory ID (Optional if tenant/product is provided)

tenantstring

Tenant (Optional if directoryId is provided)

productstring

Product (Optional if directoryId is provided)

pageOffsetstring

Starting point from which the set of records are retrieved

pageLimitstring

Number of records to be fetched for the page

pageTokenstring

Token used for DynamoDB pagination

Response

Success

dataEvent[]
pageTokenstring

token for pagination

Example response

{
  "data": [
    {
      "id": "id1",
      "webhook_endpoint": "https://example.com/webhook",
      "created_at": "2024-03-05T17:06:26.074Z",
      "status_code": 200,
      "delivered": true,
      "payload": {
        "directory_id": "58b5cd9dfaa39d47eb8f5f88631f9a629a232016",
        "event": "user.created",
        "tenant": "boxyhq",
        "product": "jackson",
        "data": {
          "id": "038e767b-9bc6-4dbd-975e-fbc38a8e7d82",
          "first_name": "Deepak",
          "last_name": "Prabhakara",
          "email": "deepak@example.com",
          "active": true,
          "raw": {
            "schemas": [
              "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            "userName": "deepak@example.com",
            "name": {
              "givenName": "Deepak",
              "familyName": "Prabhakara"
            },
            "emails": [
              {
                "primary": true,
                "value": "deepak@example.com",
                "type": "work"
              }
            ],
            "title": "CEO",
            "displayName": "Deepak Prabhakara",
            "locale": "en-US",
            "externalId": "00u1ldzzogFkXFmvT5d7",
            "groups": [],
            "active": true
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.