/linked-account-scopes

Beta

POST

/hris/v1/linked-account-scopes

POST

/api/hris/v1/linked-account-scopes

curl -X POST https://api.merge.dev/api/hris/v1/linked-account-scopes \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "common_models": [
    {
      "model_name": "Employee",
      "model_permissions": {
        "READ": {
          "is_enabled": true
        },
        "WRITE": {
          "is_enabled": false
        }
      },
      "field_permissions": {
        "enabled_fields": [
          "avatar",
          "home_location"
        ],
        "disabled_fields": [
          "work_location"
        ]
      }
    },
    {
      "model_name": "Benefit",
      "model_permissions": {
        "WRITE": {
          "is_enabled": false
        }
      }
    }
  ]
}'

200Successful

{
  "common_models": [
    {
      "model_name": "Employee",
      "model_permissions": {
        "READ": {
          "is_enabled": true
        },
        "WRITE": {
          "is_enabled": false
        }
      },
      "field_permissions": {
        "enabled_fields": [
          "avatar",
          "created_at",
          "custom_fields",
          "date_of_birth",
          "first_name",
          "gender",
          "remote_created_at",
          "remote_data"
        ],
        "disabled_fields": [
          "company",
          "employments",
          "groups",
          "home_location",
          "manager",
          "work_location"
        ]
      }
    }
  ]
}

Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. Learn more

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Request

This endpoint expects an object.

common_modelslist of objectsRequired

The common models you want to update the scopes for

Response

common_modelslist of objects

The common models you want to update the scopes for

Authentication

Headers

Request

Response