LinkTokenApi.md

MergeHRISClient.LinkTokenApi

All URIs are relative to https://api.merge.dev/api/hris/v1

Method	HTTP request	Description
link_token_create	POST /link-token

link_token_create

LinkToken link_token_create(end_user_details_request)

Creates a link token to be used when linking a new end user.

Example

• Api Key Authentication (tokenAuth):

import time
import MergeHRISClient
from MergeHRISClient.api import link_token_api
from MergeHRISClient.model.link_token import LinkToken
from MergeHRISClient.model.end_user_details_request import EndUserDetailsRequest
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/hris/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeHRISClient.Configuration(
    host = "https://api.merge.dev/api/hris/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with MergeHRISClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = link_token_api.LinkTokenApi(api_client)
    end_user_details_request = EndUserDetailsRequest(
        end_user_email_address="end_user_email_address_example",
        end_user_organization_name="end_user_organization_name_example",
        end_user_origin_id="end_user_origin_id_example",
        categories=[
            CategoriesEnum("hris"),
        ],
        integration="integration_example",
        link_expiry_mins=30,
        should_create_magic_link_url=False,
        common_models=[
            CommonModelScopesBodyRequest(
                model_id="hris.Employee",
                enabled_actions=[
                    EnabledActionsEnum("["READ","WRITE"]"),
                ],
                disabled_fields=[
                    "disabled_fields_example",
                ],
            ),
        ],
    ) # EndUserDetailsRequest | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.link_token_create(end_user_details_request)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling LinkTokenApi->link_token_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
end_user_details_request	EndUserDetailsRequest

Return type

LinkToken

Authorization

tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]