WorkspaceMembershipsApi | IBM Aspera on Cloud SDK JS

WorkspaceMembershipsApi - object-oriented interface

export

Hierarchy

BaseAPI
- WorkspaceMembershipsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WorkspaceMembershipsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): WorkspaceMembershipsApi

Inherited from BaseAPI.constructor
- Defined in api/base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns WorkspaceMembershipsApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

addWorkspaceMembership

addWorkspaceMembership(requestParameters: WorkspaceMembershipsApiAddWorkspaceMembershipRequest, options?: any): Promise<AxiosResponse<WorkspaceMembershipsResponse>>

- Defined in api/api.ts:11477
Add a user as a member of this workspace.

summary

add_workspace_membership

throws

{RequiredError}

memberof

WorkspaceMembershipsApi

Parameters
- requestParameters: WorkspaceMembershipsApiAddWorkspaceMembershipRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<WorkspaceMembershipsResponse>>

deleteWorkspaceMembership

deleteWorkspaceMembership(requestParameters: WorkspaceMembershipsApiDeleteWorkspaceMembershipRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:11489
Remove a direct workspace membership. Note: If the user has indirect membership, through a group for example, the user still has access to the workspace.

summary

delete_workspace_membership

throws

{RequiredError}

memberof

WorkspaceMembershipsApi

Parameters
- requestParameters: WorkspaceMembershipsApiDeleteWorkspaceMembershipRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>

getWorkspaceMembershipById

getWorkspaceMembershipById(requestParameters: WorkspaceMembershipsApiGetWorkspaceMembershipByIdRequest, options?: any): Promise<AxiosResponse<WorkspaceMembershipsResponse>>

- Defined in api/api.ts:11501
Get information on a specific membership.

summary

get_workspace_membership_by_id

throws

{RequiredError}

memberof

WorkspaceMembershipsApi

Parameters
- requestParameters: WorkspaceMembershipsApiGetWorkspaceMembershipByIdRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<WorkspaceMembershipsResponse>>

getWorkspaceMemberships

getWorkspaceMemberships(requestParameters?: WorkspaceMembershipsApiGetWorkspaceMembershipsRequest, options?: any): Promise<AxiosResponse<WorkspaceMembershipsResponse[]>>

- Defined in api/api.ts:11513
Get information about the current members of a given workspace.

summary

get_workspace_memberships

throws

{RequiredError}

memberof

WorkspaceMembershipsApi

Parameters
- requestParameters: WorkspaceMembershipsApiGetWorkspaceMembershipsRequest = {}
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<WorkspaceMembershipsResponse[]>>

updateWorkspaceMembership

updateWorkspaceMembership(requestParameters: WorkspaceMembershipsApiUpdateWorkspaceMembershipRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:11525
Make an existing workspace member a workspace manager.

summary

update_workspace_membership

throws

{RequiredError}

memberof

WorkspaceMembershipsApi

Parameters
- requestParameters: WorkspaceMembershipsApiUpdateWorkspaceMembershipRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = ...

axios: AxiosInstance = ...

Returns WorkspaceMembershipsApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

addWorkspaceMembership

Parameters

requestParameters: WorkspaceMembershipsApiAddWorkspaceMembershipRequest

Optional options: any

Returns Promise<AxiosResponse<WorkspaceMembershipsResponse>>

deleteWorkspaceMembership

Parameters

requestParameters: WorkspaceMembershipsApiDeleteWorkspaceMembershipRequest

Optional options: any

Returns Promise<AxiosResponse<void>>

getWorkspaceMembershipById

Parameters

requestParameters: WorkspaceMembershipsApiGetWorkspaceMembershipByIdRequest

Optional options: any

Returns Promise<AxiosResponse<WorkspaceMembershipsResponse>>

getWorkspaceMemberships

Parameters

requestParameters: WorkspaceMembershipsApiGetWorkspaceMembershipsRequest = {}

Optional options: any

Returns Promise<AxiosResponse<WorkspaceMembershipsResponse[]>>

updateWorkspaceMembership

Parameters

requestParameters: WorkspaceMembershipsApiUpdateWorkspaceMembershipRequest

Optional options: any

Returns Promise<AxiosResponse<void>>