InterSystems IRIS Data Platform 2020.4 > Class Reference > %SYS namespace > Report.ExternalUser

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 Server

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

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 (Including Private)

classmethod AllReportRolesClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod AllReportRolesExecute(ByRef qHandle As %Binary, pServerName As %String, SSOEnabled As %Boolean) as %Status [ Language = objectscript ]
classmethod AllReportRolesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod CleanTokens() as %Status [ Language = objectscript ]
Deletes any expired AuthTokens
classmethod IssueToken(pSession As %String, pReportServer As %String, pReportUser As %String, pExpiresIn As %Integer = 30) as %String [ Language = objectscript ]
Creates a new External User, issues it a token, and returns its ID The token will expire in pExpiresIn seconds
classmethod RevokeToken(pServerName As %String, pSession As %String) as %Status [ Language = objectscript ]
Revokes any active AuthToken for Session pSession on ReportServer pServerName Deletes the ExternalUser record

Queries

query AllReportRoles(pServerName As %String, SSOEnabled As %Boolean)
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 ]]

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: Storage (Report.ExternalUser)

^Report.ExternalUserD(ID)
=
%%CLASSNAME
Session
ReportServer
ReportUser
AuthToken
IssueTime
Expiration
ExpiresIn
Feedback