UVACanvasAccess
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
UVACanvasAccess.Structures.Logins.UserLogin Class Reference

Represents a user login, i.e. an identity used to authenticate with Canvas. More...

Inheritance diagram for UVACanvasAccess.Structures.Logins.UserLogin:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.Logins.UserLogin:
Collaboration graph
[legend]

Public Member Functions

string ToPrettyString ()
 Returns a pretty, formatted string representation of the object.
Returns
The formatted string.

 

Properties

ulong AccountId [get]
 The id of the account which the login belongs to.
 
ulong Id [get]
 The login id.
 
string SisUserId [get]
 The login SIS id.
 
string IntegrationId [get]
 The integration id.
 
string UniqueId [get]
 The unique identifier, e.g. the user's email or username.
 
ulong UserId [get]
 The id of the user which this login belongs to.
 
ulong? AuthenticationProviderId [get]
 The authentication provider id, if any.
 
string AuthenticationProviderType [get]
 The authentication provider type, if any.
 
string WorkflowState [get]
 The workflow state.
 
string DeclaredUserType [get]
 The declared user type, if any.
 

Detailed Description

Represents a user login, i.e. an identity used to authenticate with Canvas.

Member Function Documentation

◆ ToPrettyString()

string UVACanvasAccess.Structures.Logins.UserLogin.ToPrettyString ( )
inline

Returns a pretty, formatted string representation of the object.

Returns
The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

Property Documentation

◆ SisUserId

string UVACanvasAccess.Structures.Logins.UserLogin.SisUserId
get

The login SIS id.

This should correspond to the relevant user's SIS id.


The documentation for this class was generated from the following file: