AMI Web Framework API > Namespace > amiAuth
amiAuth
Alias: amiLogin
The AMI authentication subsystem
Methods
getMqttEndpoint() ->{string}
Gets the current MQTT endpoint
Returns:
The current MQTT endpoint
Type: string
getMqttToken() ->{string}
Gets the current MQTT token
Returns:
The current MQTT token
Type: string
getUserInfo() ->{Object.<string, *>}
Gets the current user information
Returns:
The current user information
Type: Object.<string, *>
getRoleInfo() ->{Object.<string, *>}
Gets the current role information
Returns:
The current role information
Type: Object.<string, *>
getBookmarkInfo() ->{Object.<string, *>}
Gets the current bookmark information
Returns:
The current bookmark information
Type: Object.<string, *>
getDashboardInfo() ->{Object.<string, *>}
Gets the current dashboard information
Returns:
The current dashboard information
Type: Object.<string, *>
getAWFInfo() ->{Object.<string, *>}
Gets the current AMI Web Framework information
Returns:
The current AMI Web Framework information
Type: Object.<string, *>
getUser() ->{string}
Gets the current user
Returns:
The current user
Type: string
getGuest() ->{string}
Gets the current guest user
Returns:
The current guest user
Type: string
getNotBeforeDate() ->{string}
Gets the current user `not before` date
Returns:
The current user `not before` date
Type: string
getNotAfterDate() ->{string}
Gets the current user `not after` date
Returns:
The current user `not after` date
Type: string
getClientDN() ->{string}
Gets the current client DN
Returns:
The current client DN
Type: string
getIssuerDN() ->{string}
Gets the current issuer DN
Returns:
The current issuer DN
Type: string
isValid() ->{boolean}
Checks whether the user is valid or not
Returns:
Type: boolean
isAuthenticated() ->{boolean}
Checks whether the user is authenticated or not
Returns:
Type: boolean
hasRole(roleName) ->{boolean}
Checks whether the user has the given role or not
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| roleName | string | the role |
Returns:
Type: boolean
update() ->{$.Promise}
Update the user information
Returns:
A JQuery promise object
Type: $.Promise
sso()
Opens the SSO popup window
signIn()
Signs in
signOut()
Signs out
changeInfo()
Opens the 'Change Info' modal window
changePass()
Opens the 'Change Password' modal window
changeCertificate()
Opens the 'Change Certificate' modal window
accountStatus()
Opens the 'Account Status' modal window
- Next
- amiCommand