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

Properties

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

Detailed Description

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

Property Documentation

◆ AccountId

ulong UVACanvasAccess.Structures.Logins.UserLogin.AccountId
get

The id of the account which the login belongs to.

◆ AuthenticationProviderId

ulong? UVACanvasAccess.Structures.Logins.UserLogin.AuthenticationProviderId
get

The authentication provider id, if any.

◆ AuthenticationProviderType

string UVACanvasAccess.Structures.Logins.UserLogin.AuthenticationProviderType
get

The authentication provider type, if any.

◆ DeclaredUserType

string UVACanvasAccess.Structures.Logins.UserLogin.DeclaredUserType
get

The declared user type, if any.

◆ Id

ulong UVACanvasAccess.Structures.Logins.UserLogin.Id
get

The login id.

◆ IntegrationId

string UVACanvasAccess.Structures.Logins.UserLogin.IntegrationId
get

The integration id.

◆ SisUserId

string UVACanvasAccess.Structures.Logins.UserLogin.SisUserId
get

The login SIS id.

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

◆ UniqueId

string UVACanvasAccess.Structures.Logins.UserLogin.UniqueId
get

The unique identifier, e.g. the user's email or username.

◆ UserId

ulong UVACanvasAccess.Structures.Logins.UserLogin.UserId
get

The id of the user which this login belongs to.

◆ WorkflowState

string UVACanvasAccess.Structures.Logins.UserLogin.WorkflowState
get

The workflow state.


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