%SYS
ExternalUser Class Reference

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. More...

Inheritance diagram for ExternalUser:
Collaboration diagram for ExternalUser:

Static Public Member Functions

_.Library.Status CleanTokens ()
 Deletes any expired AuthTokens.
 
_.Library.String IssueToken (_.Library.String pSession, _.Library.String pReportServer, _.Library.String pReportUser, _.Library.Integer pExpiresIn)
 Creates a new External User, issues it a token, and returns its ID. More...
 
_.Library.Status RevokeToken (_.Library.String pServerName, _.Library.String pSession)
 Revokes any active AuthToken for Session pSession on ReportServer pServerName. More...
 

Public Attributes

 AuthToken
 Token to be exchanged with ReportServer for authentication. More...
 
 ExpiresIn
 The lifetime of AuthToken, in seconds. More...
 
 IssueTime
 When AuthToken was issued. More...
 
 ReportServer
 Name of a valid Report.ServerDefinition that the IRIS User is requesting authentication for. More...
 
 ReportUser
 External username that IRIS user is requesting authentation as. More...
 
 Session
 CSP Session that is requesting authentication. More...
 

Detailed Description

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.

Member Function Documentation

◆ IssueToken()

_.Library.String IssueToken ( _.Library.String  pSession,
_.Library.String  pReportServer,
_.Library.String  pReportUser,
_.Library.Integer  pExpiresIn 
)
static

Creates a new External User, issues it a token, and returns its ID.

The token will expire in pExpiresIn seconds

◆ RevokeToken()

_.Library.Status RevokeToken ( _.Library.String  pServerName,
_.Library.String  pSession 
)
static

Revokes any active AuthToken for Session pSession on ReportServer pServerName.

Deletes the ExternalUser record

Member Data Documentation

◆ AuthToken

AuthToken

Token to be exchanged with ReportServer for authentication.

 

◆ ExpiresIn

ExpiresIn

The lifetime of AuthToken, in seconds.

 

◆ IssueTime

IssueTime

When AuthToken was issued.

 

◆ ReportServer

ReportServer

Name of a valid Report.ServerDefinition that the IRIS User is requesting authentication for.

 

◆ ReportUser

ReportUser

External username that IRIS user is requesting authentation as.

 

◆ Session

Session

CSP Session that is requesting authentication.