Entitlements

"Entitlements" refer to the list of top accounts that each user has access to.

The SFTP interface allows connected systems to programmatically add, update, or delete entitlements in bulk. This operation is performed by uploading a JSONL (JSON Lines) file, where each line represents an entitlement object.

SFTP

Entitlements File Specification

JSONL File Schema

  • Name
    user_id
    Type
    string (Max 255)
    Description

    The id for the user. This field is required.

  • Name
    top_account_id
    Type
    string (Max 255)
    Description

    The id for the top account that the user is entitled to see. This field is required.

Example JSONL File

entitlements.jsonl

{"user_id": "0f3cb7d4-f5f9-44ce-9694-affd4f10e61d", "top_account_id": "123e4567-e89b-12d3-a456-426614174000"}
{"user_id": "ebe43b23-10a0-4586-a97b-05bc7ce749c5", "top_account_id": "123e4567-e89b-12d3-a456-426614174000"}
{"user_id": "73be3d43-8e63-4082-a0ef-b857e79daecc", "top_account_id": "123e4567-e89b-12d3-a456-426614174000"}
{"user_id": "73be3d43-8e63-4082-a0ef-b857e79daecc", "top_account_id": "987e6543-e21b-45c6-b789-123456789abc"}