Class MendixSdkClient

constructor

• new MendixSdkClient(username: string, apikey?: undefined | string, password?: undefined | string, openid?: undefined | string, projectsApiEndpoint?: undefined | string, modelServerEndpoint?: undefined | string, options?: SdkOptions): MendixSdkClient

• Create a new client to access Mendix Platform and Model APIs.

  Parameters

  • username: string

    Username of your account (same as username used to log in to the Mendix Development Portal)

  • Optional apikey: undefined | string

    API key for your account.

  • Optional password: undefined | string

    Alternative way to authenticate with username, password and openid

  • Optional openid: undefined | string

    Alternative way to authenticate with username, password and openid

  • Optional projectsApiEndpoint: undefined | string

    For internal use. Connects to a custom instance of the Projects API.

  • Optional modelServerEndpoint: undefined | string

    For internal use. Connects to a custom instance of the Model API.

  • Optional options: SdkOptions

    a JSON object containing configuration options for the SDK Client.

  Returns MendixSdkClient