Class UserManagementApi

Hierarchy (view full)

BaseAPI
- UserManagementApi

Index

Constructors

Properties

Methods

deleteUserWithUserNameRolesWithOfficeId deleteUserWithUserNameRolesWithOfficeIdRaw getRoles getRolesRaw getUserProfile getUserProfileRaw getUsers getUsersRaw getUsersWithUserName getUsersWithUserNameRaw postUserWithUserNameRolesWithOfficeId postUserWithUserNameRolesWithOfficeIdRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new UserManagementApi(configuration?): UserManagementApi
Parameters
- configuration: Configuration = ...
Returns UserManagementApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteUserWithUserNameRolesWithOfficeId

deleteUserWithUserNameRolesWithOfficeId(requestParameters, initOverrides?): Promise<void>
Remove roles from user Delete user with userName roles with officeId
Parameters
- requestParameters: DeleteUserWithUserNameRolesWithOfficeIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:94

deleteUserWithUserNameRolesWithOfficeIdRaw

deleteUserWithUserNameRolesWithOfficeIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Remove roles from user Delete user with userName roles with officeId
Parameters
- requestParameters: DeleteUserWithUserNameRolesWithOfficeIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:60

getRoles

getRoles(initOverrides?): Promise<string[]>
View all roles Get roles
Parameters
- Optional initOverrides: RequestInit
Returns Promise<string[]>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:125

getRolesRaw

getRolesRaw(initOverrides?): Promise<ApiResponse<string[]>>
View all roles Get roles
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string[]>>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:102

getUserProfile

getUserProfile(initOverrides?): Promise<User>
View users' own information Get user profile
Parameters
- Optional initOverrides: RequestInit
Returns Promise<User>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:157

getUserProfileRaw

getUserProfileRaw(initOverrides?): Promise<ApiResponse<User>>
View users' own information Get user profile
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<User>>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:134

getUsers

getUsers(requestParameters?, initOverrides?): Promise<Users>
View all users Get users
Parameters
- requestParameters: GetUsersRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Users>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:201

getUsersRaw

getUsersRaw(requestParameters, initOverrides?): Promise<ApiResponse<Users>>
View all users Get users
Parameters
- requestParameters: GetUsersRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Users>>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:166

getUsersWithUserName

getUsersWithUserName(requestParameters, initOverrides?): Promise<User>
View specific user Get users with userName
Parameters
- requestParameters: GetUsersWithUserNameRequest
- Optional initOverrides: RequestInit
Returns Promise<User>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:237

getUsersWithUserNameRaw

getUsersWithUserNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<User>>
View specific user Get users with userName
Parameters
- requestParameters: GetUsersWithUserNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<User>>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:210

postUserWithUserNameRolesWithOfficeId

postUserWithUserNameRolesWithOfficeId(requestParameters, initOverrides?): Promise<void>
Add roles to user Post user with userName roles with officeId
Parameters
- requestParameters: PostUserWithUserNameRolesWithOfficeIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:280

postUserWithUserNameRolesWithOfficeIdRaw

postUserWithUserNameRolesWithOfficeIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Add roles to user Post user with userName roles with officeId
Parameters
- requestParameters: PostUserWithUserNameRolesWithOfficeIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/UserManagementApi.ts:246

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:47

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:37