Class UsersApi

Hierarchy

BaseAPI
- UsersApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new UsersApi(configuration?: Configuration): UsersApi

Inherited from runtime.BaseAPI.constructor
- Defined in runtime.ts:25
Parameters
- configuration: Configuration = ...
Returns UsersApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

createUser

createUser(requestParameters: CreateUserOperationRequest): Promise<UserResponse>

- Defined in apis/UsersApi.ts:100
Add a user to the organization. Create a user

Parameters
- requestParameters: CreateUserOperationRequest
Returns Promise<UserResponse>

createUserRaw

createUserRaw(requestParameters: CreateUserOperationRequest): Promise<ApiResponse<UserResponse>>

- Defined in apis/UsersApi.ts:74
Add a user to the organization. Create a user

Parameters
- requestParameters: CreateUserOperationRequest
Returns Promise<ApiResponse<UserResponse>>

deleteUser

deleteUser(requestParameters: DeleteUserRequest): Promise<string>

- Defined in apis/UsersApi.ts:132
Delete the given user. Delete a user

Parameters
- requestParameters: DeleteUserRequest
Returns Promise<string>

deleteUserRaw

deleteUserRaw(requestParameters: DeleteUserRequest): Promise<ApiResponse<string>>

- Defined in apis/UsersApi.ts:109
Delete the given user. Delete a user

Parameters
- requestParameters: DeleteUserRequest
Returns Promise<ApiResponse<string>>

getUser

getUser(requestParameters: GetUserRequest): Promise<UserResponse>

- Defined in apis/UsersApi.ts:164
Get a specific user's information. Retrieve a user

Parameters
- requestParameters: GetUserRequest
Returns Promise<UserResponse>

getUserRaw

getUserRaw(requestParameters: GetUserRequest): Promise<ApiResponse<UserResponse>>

- Defined in apis/UsersApi.ts:141
Get a specific user's information. Retrieve a user

Parameters
- requestParameters: GetUserRequest
Returns Promise<ApiResponse<UserResponse>>

listUserRoles

listUserRoles(requestParameters: ListUserRolesRequest): Promise<ListUserRolesResponse>

- Defined in apis/UsersApi.ts:200
Returns a list of all user roles in an organization. List all user roles

Parameters
- requestParameters: ListUserRolesRequest
Returns Promise<ListUserRolesResponse>

listUserRolesRaw

listUserRolesRaw(requestParameters: ListUserRolesRequest): Promise<ApiResponse<ListUserRolesResponse>>

- Defined in apis/UsersApi.ts:173
Returns a list of all user roles in an organization. List all user roles

Parameters
- requestParameters: ListUserRolesRequest
Returns Promise<ApiResponse<ListUserRolesResponse>>

listUsers

listUsers(requestParameters: ListUsersRequest): Promise<ListUsersResponse>

- Defined in apis/UsersApi.ts:236
Returns a list of all users in an organization. List all users

Parameters
- requestParameters: ListUsersRequest
Returns Promise<ListUsersResponse>

listUsersRaw

listUsersRaw(requestParameters: ListUsersRequest): Promise<ApiResponse<ListUsersResponse>>

- Defined in apis/UsersApi.ts:209
Returns a list of all users in an organization. List all users

Parameters
- requestParameters: ListUsersRequest
Returns Promise<ApiResponse<ListUsersResponse>>

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from runtime.BaseAPI.request
- Defined in runtime.ts:47
Parameters
- context: RequestOpts
Returns Promise<Response>

updateUser

updateUser(requestParameters: UpdateUserOperationRequest): Promise<UserResponse>

- Defined in apis/UsersApi.ts:275
Update a specific user's information. Update a user

Parameters
- requestParameters: UpdateUserOperationRequest
Returns Promise<UserResponse>

updateUserRaw

updateUserRaw(requestParameters: UpdateUserOperationRequest): Promise<ApiResponse<UserResponse>>

- Defined in apis/UsersApi.ts:245
Update a specific user's information. Update a user

Parameters
- requestParameters: UpdateUserOperationRequest
Returns Promise<ApiResponse<UserResponse>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from runtime.BaseAPI.withMiddleware
- Defined in runtime.ts:31
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T

Inherited from runtime.BaseAPI.withPostMiddleware
- Defined in runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T

Inherited from runtime.BaseAPI.withPreMiddleware
- Defined in runtime.ts:37
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Generated using TypeDoc