UserWithSecurity

Hierarchy

User
- UserWithSecurity

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new UserWithSecurity(_apiUser: UserJson): UserWithSecurity

Overrides User.constructor
- Defined in model/user/user-with-security.ts:14
Parameters
- _apiUser: UserJson
Returns UserWithSecurity

Accessors

address

address:

Gets the user's address.

city

city:

Gets the user's city.

company

company:

Gets the user's company.

country

country:

Gets the user's country.

createdDate

createdDate:

Gets the user's created date.

deleted

deleted:

Indicates whether the user is deleted.

deletedDate

deletedDate:

Gets the deleted date of the user.

domain

domain:

Gets the user's domain.

email

email:

Gets the user's email address.

fullName

fullName:

Gets the user's full name.

inventory

inventory:

Set the inventory for user. Get the user companyInventory list.

json

json:

Gets the raw JSON object from the API.

locked

locked:

Indicates whether the user is locked out of their account.

phoneNumber

phoneNumber:

Gets the phone number of the user.

rolesCompanyMap

rolesCompanyMap:

Set the roles for user. Get a map of user Role by company ID.

state

state:

Gets the user's state.

userType

userType:

Gets the user type.

username

username:

Gets the user's username.

zip

zip:

Gets the user's zip code.

Methods

assignRole

assignRole(companyUuid: string, roleUuid: string): Promise<any>

Inherited from User.assignRole
- Defined in model/user/user.ts:327
Assign a role to a user.

Parameters
- companyUuid: string
- roleUuid: string
Returns Promise<any>

batchInboxUpdate

batchInboxUpdate(batchUpdate: BatchInboxUpdateRequest): Promise<any>

Inherited from User.batchInboxUpdate
- Defined in model/user/user.ts:435
Updates a batch of inbox messages.

Parameters
- batchUpdate: BatchInboxUpdateRequest
Returns Promise<any>

delete

delete(): Promise<any>

Inherited from User.delete
- Defined in model/user/user.ts:264
Delete the current user.

throws

Error

Returns Promise<any>

deleteMessage

deleteMessage(uuid: string): Promise<InboxMessage>

Inherited from User.deleteMessage
- Defined in model/user/user.ts:453
Deletes inbox message.

Parameters
- uuid: string
Returns Promise<InboxMessage>

endAllActiveSessions

endAllActiveSessions(): Promise<any>

Inherited from User.endAllActiveSessions
- Defined in model/user/user.ts:359
End all active user sessions.

Returns Promise<any>

getAccountEvents

getAccountEvents(offset?: undefined | number, limit?: undefined | number, dateFrom?: undefined | number, dateTo?: undefined | number): Promise<Array<AccountEvent>>

Inherited from User.getAccountEvents
- Defined in model/user/user.ts:500
Get the user account events.

Parameters
- Optional offset: undefined | number
- Optional limit: undefined | number
- Optional dateFrom: undefined | number
- Optional dateTo: undefined | number
Returns Promise<Array<AccountEvent>>

getActiveSessions

getActiveSessions(): Promise<Array<UserSession>>

Inherited from User.getActiveSessions
- Defined in model/user/user.ts:347
Get active sessions for a user.

Returns Promise<Array<UserSession>>

a promise that resolves to a list of active user sessions.

getCatalogs

getCatalogs(companyId: string, location?: undefined | string): Promise<Array<Catalog>>

Inherited from User.getCatalogs
- Defined in model/user/user.ts:722
Get the catalogs for company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<Catalog>>

getCloudTenants

getCloudTenants(companyId: string, location?: undefined | string): Promise<Array<CloudTenant>>

Inherited from User.getCloudTenants
- Defined in model/user/user.ts:668
Get the cloud tenants for a company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<CloudTenant>>

getCompanies

getCompanies(): Promise<Array<Company>>

Inherited from User.getCompanies
- Defined in model/user/user.ts:302
Gets the user's list of companies.

Returns Promise<Array<Company>>

user's list of companies

getEdges

getEdges(companyId: string, location?: undefined | string): Promise<Array<Edge>>

Inherited from User.getEdges
- Defined in model/user/user.ts:630
Get the edges for a company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<Edge>>

getInventory

getInventory(): Promise<Array<CompanyInventory>>

Inherited from User.getInventory
- Defined in model/user/user.ts:291
Gets the user's entity inventory.

Returns Promise<Array<CompanyInventory>>

user's entity inventory

getInventoryInCompany

getInventoryInCompany(companyId: string): Promise<CompanyInventory>

Inherited from User.getInventoryInCompany
- Defined in model/user/user.ts:274
Gets the user's inventory within the specified company..

throws

Error

Parameters
- companyId: string
  
  the ID of the company to retrieve inventory for
Returns Promise<CompanyInventory>

entity inventory

getMedia

getMedia(companyId: string, location?: undefined | string): Promise<Array<Media>>

Inherited from User.getMedia
- Defined in model/user/user.ts:594
Get the media for a company and a user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<Media>>

getMessage

getMessage(uuid: string): Promise<InboxMessage>

Inherited from User.getMessage
- Defined in model/user/user.ts:411
Get a inbox message.

Parameters
- uuid: string
Returns Promise<InboxMessage>

getMessageHeaders

getMessageHeaders(filters: InboxMessageFilterParams): Promise<InboxMessageList>

Inherited from User.getMessageHeaders
- Defined in model/user/user.ts:482
Get the message headers.

Parameters
- filters: InboxMessageFilterParams
Returns Promise<InboxMessageList>

getOrgVdcNetworks

getOrgVdcNetworks(companyId: string, location?: undefined | string): Promise<Array<InternalNetwork>>

Inherited from User.getOrgVdcNetworks
- Defined in model/user/user.ts:686
Get the org vdc networks for company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<InternalNetwork>>

getOrgs

getOrgs(companyId: string, location?: undefined | string): Promise<Array<Org>>

Inherited from User.getOrgs
- Defined in model/user/user.ts:522
Get the orgs for a company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<Org>>

getPicture

getPicture(): Promise<JpegImage>

Inherited from User.getPicture
- Defined in model/user/user.ts:382
Get the user picture.

Returns Promise<JpegImage>

getRole

getRole(companyUuid: string): Promise<Role>

Inherited from User.getRole
- Defined in model/user/user.ts:314
Gets the user's role for a company

Parameters
- companyUuid: string
Returns Promise<Role>

getRoles

getRoles(): Promise<Array<Role>>

- Defined in model/user/user-with-security.ts:122
Get a list of all user's roles.

Returns Promise<Array<Role>>

getUnreadMessageCount

getUnreadMessageCount(folder?: MessageFolder): Promise<MessageCount>

Inherited from User.getUnreadMessageCount
- Defined in model/user/user.ts:465
Get unread message count.

Parameters
- Optional folder: MessageFolder
Returns Promise<MessageCount>

getVappNetworks

getVappNetworks(companyId: string, location?: undefined | string): Promise<Array<VappNetwork>>

Inherited from User.getVappNetworks
- Defined in model/user/user.ts:704
Get the vApp networks for company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<VappNetwork>>

getVappTemplates

getVappTemplates(companyId: string, location?: undefined | string): Promise<Array<VappTemplate>>

Inherited from User.getVappTemplates
- Defined in model/user/user.ts:612
Get the vApp templates for a company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<VappTemplate>>

getVapps

getVapps(companyId: string, location?: undefined | string): Promise<Array<Vapp>>

Inherited from User.getVapps
- Defined in model/user/user.ts:558
Get the vApps for a company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<Vapp>>

getVccFailoverPlans

getVccFailoverPlans(companyId: string, location?: undefined | string): Promise<Array<VCCFailoverPlan>>

Inherited from User.getVccFailoverPlans
- Defined in model/user/user.ts:740
Get the VCC failover plans for a company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<VCCFailoverPlan>>

getVdcs

getVdcs(companyId: string, location?: undefined | string): Promise<Array<Vdc>>

Inherited from User.getVdcs
- Defined in model/user/user.ts:540
Get the vDCS for a company and user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<Vdc>>

getVms

getVms(companyId: string, location?: undefined | string): Promise<Array<Vm>>

Inherited from User.getVms
- Defined in model/user/user.ts:576
Get the VMs for a company and a user.

Parameters
- companyId: string
- Optional location: undefined | string
Returns Promise<Array<Vm>>

getVpgs

getVpgs(companyId: string, location?: undefined | string, expand?: Array<VpgSubEntityRequest>): Promise<Array<ExpandedVpg>>

Inherited from User.getVpgs
- Defined in model/user/user.ts:648
Get the VPGs for the company and user.

Parameters
- companyId: string
- Optional location: undefined | string
- Optional expand: Array<VpgSubEntityRequest>
Returns Promise<Array<ExpandedVpg>>

isPermittedTo

isPermittedTo(permissionType: PermissionType, entityUuid: string): boolean

- Defined in model/user/user-with-security.ts:139
Check whether or not a user is allowed to perform an action or not.

Parameters
- permissionType: PermissionType
- entityUuid: string
Returns boolean

markAllMessagesAsRead

markAllMessagesAsRead(request: InboxMarkAllAsReadRequest): Promise<any>

Inherited from User.markAllMessagesAsRead
- Defined in model/user/user.ts:444
Mark all messages in a folder as read.

Parameters
- request: InboxMarkAllAsReadRequest
Returns Promise<any>

markMessageAsRead

markMessageAsRead(uuid: string): Promise<InboxMessage>

Inherited from User.markMessageAsRead
- Defined in model/user/user.ts:423
Mark message as read.

Parameters
- uuid: string
Returns Promise<InboxMessage>

moveMessage

moveMessage(uuid: string, spec: MoveMessageRequest): Promise<InboxMessage>

Inherited from User.moveMessage
- Defined in model/user/user.ts:399
Move a user message to a specified folder.

Parameters
- uuid: string
- spec: MoveMessageRequest
Returns Promise<InboxMessage>

refresh

refresh(): Promise<UserWithSecurity>

Overrides User.refresh
- Defined in model/user/user-with-security.ts:147
Retrieves a new representation of the user from the API.

Returns Promise<UserWithSecurity>

promise that resolves with updated user

toString

toString(): string

Inherited from User.toString
- Defined in model/user/user.ts:224
JSON format.

Returns string

unassignRole

unassignRole(companyUuid: string): Promise<any>

Inherited from User.unassignRole
- Defined in model/user/user.ts:338
Un-assign a role from a user.

Parameters
- companyUuid: string
Returns Promise<any>

update

update(request: UserUpdateRequest): Promise<User>

Inherited from User.update
- Defined in model/user/user.ts:252
Update the user.

Parameters
- request: UserUpdateRequest
Returns Promise<User>

updatePicture

updatePicture(picture: JpegImage): Promise<any>

Inherited from User.updatePicture
- Defined in model/user/user.ts:369
Updates the user's profile picture.

Parameters
- picture: JpegImage
Returns Promise<any>

Static getCurrentUser

getCurrentUser(): Promise<UserWithSecurity>

Overrides User.getCurrentUser
- Defined in model/user/user-with-security.ts:68
Gets the currently authenticated user.

Returns Promise<UserWithSecurity>

Static getUser

getUser(username: string): Promise<UserWithSecurity>

Overrides User.getUser
- Defined in model/user/user-with-security.ts:57
Gets a user by username.

Parameters
- username: string
  
  the user's username
Returns Promise<UserWithSecurity>

Static getUserWithSecurity

getUserWithSecurity(user: User): Promise<UserWithSecurity>

- Defined in model/user/user-with-security.ts:87
Get user with security from an existing user.

Parameters
- user: User
Returns Promise<UserWithSecurity>

Static setup

setup(userWithSecurity: UserWithSecurity): Promise<UserWithSecurity>

- Defined in model/user/user-with-security.ts:97
Setup the userWithSecurity class. That will add the needed inventory and roles to the UserWithSecurity class.

Parameters
- userWithSecurity: UserWithSecurity
Returns Promise<UserWithSecurity>

Generated using TypeDoc

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_apiUser: UserJson

Returns UserWithSecurity

Accessors

address

city

company

country

createdDate

deleted

deletedDate

domain

email

fullName

inventory

json

locked

phoneNumber

rolesCompanyMap

state

userType

username

zip

Methods

assignRole

Parameters

companyUuid: string

roleUuid: string

Returns Promise<any>

batchInboxUpdate

Parameters

batchUpdate: BatchInboxUpdateRequest

Returns Promise<any>

delete

Returns Promise<any>

deleteMessage

Parameters

uuid: string

Returns Promise<InboxMessage>

endAllActiveSessions

Returns Promise<any>

getAccountEvents

Parameters

Optional offset: undefined | number

Optional limit: undefined | number

Optional dateFrom: undefined | number

Optional dateTo: undefined | number

Returns Promise<Array<AccountEvent>>

getActiveSessions

Returns Promise<Array<UserSession>>

getCatalogs

Parameters

companyId: string

Optional location: undefined | string

Returns Promise<Array<Catalog>>

getCloudTenants

Parameters

companyId: string

Optional location: undefined | string

Returns Promise<Array<CloudTenant>>

getCompanies

Returns Promise<Array<Company>>

getEdges

Parameters

companyId: string

Optional location: undefined | string

Returns Promise<Array<Edge>>

getInventory

Returns Promise<Array<CompanyInventory>>

getInventoryInCompany

Parameters

companyId: string

Returns Promise<CompanyInventory>