Report.ExternalUser
persistent class Report.ExternalUser extends %Library.Persistent
SQL Table Name: Report.ExternalUser
This class defines a session to report user map using a user's assigned roles An ExternalUser object will be generated when a user visits %CSP.UI.Portal.ReportServerConfiguration Upon unloading %CSP.UI.Portal.ReportServerConfiguration, all ExternalUser objects for that session without active tokens will be deleted An ExternalUser is issued a token when a user selects to use that role on the ReportServer This ExternalUser will persist until that token is used to authenticate the user to the Logi Report ServerProperty Inventory
Method Inventory
- AllReportRolesClose()
- AllReportRolesExecute()
- AllReportRolesFetch()
- CleanTokens()
- IssueToken()
- RevokeToken()
Properties
property AuthToken as %String;
Token to be exchanged with ReportServer for authentication
Property methods: AuthTokenDisplayToLogical(), AuthTokenGet(), AuthTokenGetStored(), AuthTokenIsValid(), AuthTokenLogicalToDisplay(), AuthTokenLogicalToOdbc(), AuthTokenNormalize(), AuthTokenSet()
property ExpiresIn as %Integer;
The lifetime of AuthToken, in seconds
Property methods: ExpiresInDisplayToLogical(), ExpiresInGet(), ExpiresInGetStored(), ExpiresInIsValid(), ExpiresInLogicalToDisplay(), ExpiresInNormalize(), ExpiresInSet()
property IssueTime as %TimeStamp;
When AuthToken was issued
Property methods: IssueTimeDisplayToLogical(), IssueTimeGet(), IssueTimeGetStored(), IssueTimeIsValid(), IssueTimeLogicalToDisplay(), IssueTimeNormalize(), IssueTimeOdbcToLogical(), IssueTimeSet()
property ReportServer as %String;
Name of a valid %Report.ServerDefinition that the IRIS User is requesting authentication for
Property methods: ReportServerDisplayToLogical(), ReportServerGet(), ReportServerGetStored(), ReportServerIsValid(), ReportServerLogicalToDisplay(), ReportServerLogicalToOdbc(), ReportServerNormalize(), ReportServerSet()
property ReportUser as %String;
External username that IRIS user is requesting authentation as
Property methods: ReportUserDisplayToLogical(), ReportUserGet(), ReportUserGetStored(), ReportUserIsValid(), ReportUserLogicalToDisplay(), ReportUserLogicalToOdbc(), ReportUserNormalize(), ReportUserSet()
property Session as %String;
CSP Session that is requesting authentication
Property methods: SessionDisplayToLogical(), SessionGet(), SessionGetStored(), SessionIsValid(), SessionLogicalToDisplay(), SessionLogicalToOdbc(), SessionNormalize(), SessionSet()
Methods
classmethod AllReportRolesExecute(ByRef qHandle As %Binary, pServerName As %String, SSOEnabled As %Boolean) as %Status
classmethod AllReportRolesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod CleanTokens() as %Status
Deletes any expired AuthTokens
classmethod IssueToken(pSession As %String, pReportServer As %String, pReportUser As %String, pExpiresIn As %Integer = 30) as %String
Creates a new External User, issues it a token, and returns its ID
The token will expire in pExpiresIn seconds
Revokes any active AuthToken for Session pSession on ReportServer pServerName
Deletes the ExternalUser record
Queries
Selects ReportUser As %String
Returns a ResultSet with each of the current users' roles on the selected ReportServer as a row
Applicable roles are to be formatted as _ (for example: TestServer_admin)
Where REPORTSERVER-USER is a valid username on ]]
Indexes
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
Storage
Storage Model: Storage (Report.ExternalUser)
^Report.ExternalUserD(ID) |
= | %%CLASSNAME
Session
ReportServer
ReportUser
AuthToken
IssueTime
Expiration
ExpiresIn
|