Class UserApi

UserApi - object-oriented interface

Export

Hierarchy

BaseAPI
- UserApi

Index

Constructors

Properties

axios basePath configuration

Methods

getAuthenticatedUser

Constructors

constructor

new UserApi(configuration?, basePath?, axios?): UserApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns UserApi
Inherited from BaseAPI.constructor
- Defined in client/base.ts:51

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

getAuthenticatedUser

getAuthenticatedUser(requestParameters?, options?): Promise<AxiosResponse<AuthenticatedUser, any>>
現在のアクセストークンで認証中のユーザーの情報を取得します。
Parameters
- requestParameters: UserApiGetAuthenticatedUserRequest = {}
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<AuthenticatedUser, any>>

Summary
認証中のユーザーを取得する

Throws

Memberof
UserApi
- Defined in client/api/user-api.ts:210

Generated using TypeDoc