Class SecurityTokens

    The security tokens for a user of an app and methods for reading and writing them in the client's container in Azure storage

    Inheritance
    System.Object
    SecurityTokens
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace:AzureFunctionsForSharePoint.Core
    Assembly:AzureFunctionsForSharePoint.Core.dll
    Syntax
    public class SecurityTokens

    Properties

    | Improve this Doc View Source

    AccessToken

    Access token for connecting to SP

    Declaration
    public string AccessToken { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    AccessTokenExpires

    Historically unreliable indicator of when the token expires

    Declaration
    public DateTime AccessTokenExpires { get; set; }
    Property Value
    Type Description
    System.DateTime
    | Improve this Doc View Source

    AppWebUrl

    The web to which the tokens apply

    Declaration
    public string AppWebUrl { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    ClientId

    The client to which the tokens apply

    Declaration
    public string ClientId { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Realm

    The host part of the app web URL

    Declaration
    public string Realm { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    RefreshToken

    Refresh token used to get a new access token

    Declaration
    public string RefreshToken { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    | Improve this Doc View Source

    GetSecurityTokens(String, String)

    Gets the tokens from storage based on the app's config file

    Declaration
    public static SecurityTokens GetSecurityTokens(string cacheKey, string clientId)
    Parameters
    Type Name Description
    System.String cacheKey

    The user's cache key
    System.String clientId

    The client id
    Returns
    Type Description
    SecurityTokens

    The tokens
    | Improve this Doc View Source

    GetSecurityTokens(String, String, String, String)

    Gets the tokens from storage

    Declaration
    public static SecurityTokens GetSecurityTokens(string cacheKey, string clientId, string storageAccount, string storageKey)
    Parameters
    Type Name Description
    System.String cacheKey

    The user's cache key
    System.String clientId

    The client id
    System.String storageAccount

    The storage account
    System.String storageKey

    The storage account key
    Returns
    Type Description
    SecurityTokens

    The tokens
    | Improve this Doc View Source

    StoreSecurityTokens(SecurityTokens, String)

    Saves the tokens to storage based on the app's config file

    Declaration
    public static void StoreSecurityTokens(SecurityTokens tokens, string cacheKey)
    Parameters
    Type Name Description
    SecurityTokens tokens

    The tokens to save
    System.String cacheKey

    The user's cache key
    | Improve this Doc View Source

    StoreSecurityTokens(SecurityTokens, String, String, String)

    Saves the tokens to storage

    Declaration
    public static void StoreSecurityTokens(SecurityTokens tokens, string cacheKey, string storageAccount, string storageKey)
    Parameters
    Type Name Description
    SecurityTokens tokens

    The tokens
    System.String cacheKey

    The user's cache key
    System.String storageAccount

    The storage account
    System.String storageKey

    The storage account key