Skip to main content

Interface: MedplumClientOptions

Properties

authorizeUrl

Optional authorizeUrl: string

OAuth2 authorize URL. Optional. Default value is baseUrl + "/oauth2/authorize". Use this if you want to use a separate OAuth server.

Defined in

packages/core/src/client.ts:56


baseUrl

Optional baseUrl: string

Base server URL. Optional. Default value is "https://api.medplum.com/". Use this to point to a custom Medplum deployment.

Defined in

packages/core/src/client.ts:49


clientId

Optional clientId: string

The client ID. Optional. Default is to defer to the server to use the default client. Use this to use a specific client for SMART-on-FHIR.

Defined in

packages/core/src/client.ts:42


fetch

Optional fetch: FetchLike

Optional fetch implementation. Optional. Default is window.fetch. For nodejs applications, consider the 'node-fetch' package.

Defined in

packages/core/src/client.ts:84


logoutUrl

Optional logoutUrl: string

OAuth2 logout URL. Optional. Default value is baseUrl + "/oauth2/logout". Use this if you want to use a separate OAuth server.

Defined in

packages/core/src/client.ts:70


resourceCacheSize

Optional resourceCacheSize: number

Number of resources to store in the cache. Optional. Default value is 1000. Consider using this for performance of displaying Patient or Practitioner resources.

Defined in

packages/core/src/client.ts:77


tokenUrl

Optional tokenUrl: string

OAuth2 token URL. Optional. Default value is baseUrl + "/oauth2/token". Use this if you want to use a separate OAuth server.

Defined in

packages/core/src/client.ts:63

Methods

onUnauthenticated

Optional onUnauthenticated(): void

Optional callback for when the client is unauthenticated. Default is do nothing. For client side applications, consider redirecting to a sign in page.

Returns

void

Defined in

packages/core/src/client.ts:91