EndUserDetailsRequest.md

MergeHRISClient::EndUserDetailsRequest

Properties

Name	Type	Description	Notes
end_user_email_address	String	Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
end_user_organization_name	String	Your end user's organization.
end_user_origin_id	String	This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
categories	Array<CategoriesEnum>	The integration categories to show in Merge Link.
integration	String	The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.	[optional]
link_expiry_mins	Integer	An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.	[optional][default to 30]
should_create_magic_link_url	Boolean	Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.	[optional][default to false]
common_models	Array<CommonModelScopesBodyRequest>	An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.	[optional]
category_common_model_scopes	Hash<String, Array<IndividualCommonModelScopeDeserializerRequest>>	When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.	[optional]
language	String	The language code for the language to localize Merge Link to.	[optional]
integration_specific_config	Hash<String, AnyType>	A JSON object containing integration-specific configuration options.	[optional]

Example

require 'merge_hris_client'

instance = MergeHRISClient::EndUserDetailsRequest.new(
  end_user_email_address: example@gmail.com,
  end_user_organization_name: Test Organization,
  end_user_origin_id: 12345,
  categories: ["hris","ats"],
  integration: bamboohr,
  link_expiry_mins: null,
  should_create_magic_link_url: null,
  common_models: null,
  category_common_model_scopes: {"hris":[{"model_name":"Employee","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}},"field_permissions":{"enabled":["first_name","last_name","personal_email"],"disabled":["preferred_name"]}},{"model_name":"Employment","model_permissions":{"READ":{"is_enabled":false},"WRITE":{"is_enabled":false}},"field_permissions":{"enabled":["effective_date"]}}],"ats":[{"model_name":"Job","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}},"field_permissions":{"enabled":["name"],"disabled":["description"]}},{"model_name":"Department","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}}}]},
  language: null,
  integration_specific_config: {"rippling":{"oauth_code":"3h1jj8ssdf31dfji3o1jjdfjasd"}}
)