Interface CurrentUserApi

This API is used to get the details and functionality associated with the current user.

Accessed from the window at window.sas.vi.currentUser.

Example

window.sas.vi.currentUser.getSessionDetails();

interface CurrentUserApi {
    getSessionDetails(): SessionDetails;
    getUserDetails(): Promise<UserSummary>;
    getUserMemberships(limit?: number): Promise<IdentityFlatMembership[]>;
    hasAdminFeatures(): boolean;
    hasFeatures(features: string[]): boolean;
}

Index

Methods

getSessionDetails getUserDetails getUserMemberships hasAdminFeatures hasFeatures

Methods

getSessionDetails

getSessionDetails(): SessionDetails
Returns SessionDetails
The user's current session details.

Method
Description
Gets the object containing the users current session details.

getUserDetails

getUserDetails(): Promise<UserSummary>
Returns Promise<UserSummary>
The current user details.

Method
Description
Gets the object containing the current user details.

getUserMemberships

getUserMemberships(limit?): Promise<IdentityFlatMembership[]>
Parameters
- Optionallimit: number
  Maximum number of groups to be returned. Default: 1000.
Returns Promise<IdentityFlatMembership[]>
A list of group details.

Method
Description
Gets the list of groups to which the current user belongs.

hasAdminFeatures

hasAdminFeatures(): boolean
Returns boolean
A boolean value indicating if the user has access to the administration features.

Method
Description
Verifies if the current user has administration features.

hasFeatures

hasFeatures(features): boolean
Parameters
- features: string[]
  {string[]} Identifiers of the required features.
Returns boolean
A boolean value indicating if the user has access to the features.

Method
Description
Verifies if the current user has a set of features.