Class EndUsersApi

EndUsersApi - object-oriented interface export EndUsersApi

Hierarchy (view full)

BaseAPI
- EndUsersApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiEndUsersBulkFilePost apiEndUsersInvitePost apiEndUsersPost

Constructors

constructor

new EndUsersApi(configuration?, basePath?, axios?): EndUsersApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns EndUsersApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiEndUsersBulkFilePost

apiEndUsersBulkFilePost(file?, options?): Promise<AxiosResponse<EndUser[], any>>
Parameters
- Optionalfile: File
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EndUser[], any>>
Throws
memberof EndUsersApi
- Defined in src/api/api.ts:16362

apiEndUsersInvitePost

apiEndUsersInvitePost(endUserReadDeets?, options?): Promise<AxiosResponse<string, any>>
Parameters
- OptionalendUserReadDeets: EndUserReadDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any>>
Throws
memberof EndUsersApi
- Defined in src/api/api.ts:16373

apiEndUsersPost

apiEndUsersPost(endUserCreateDeets?, options?): Promise<AxiosResponse<EndUser, any>>
summary Create an end user for a tenant
Parameters
- OptionalendUserCreateDeets: EndUserCreateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EndUser, any>>
Throws
memberof EndUsersApi
- Defined in src/api/api.ts:16385