docs.unity3d.com
  • Manual
  • Scripting API
  • Changelog
  • License

    • Unity.DigitalTwins.Identity
      • AuthenticationState
      • BrowserAuthenticatedAccessTokenProvider
      • CommandLineAccessTokenProvider
      • DeviceToken
      • HttpPkceRequestHandler
      • IActivatePlatformSupport
      • IAuthenticator
      • IInteractiveAuthenticator
      • IPkceConfigurationProvider
      • IPkcePlatformSupport
      • IPkceRequestHandler
      • IPreAuthenticatedAccessTokenProvider
      • IUserInfoProvider
      • LaunchArgumentsParser
      • LicenseInfo
      • LicenseType
      • OrganizationInfo
      • PersonalAccessTokenProvider
      • PkceAuthenticator
      • PkceConfiguration
      • PkceConfigurationProvider
      • PreAuthenticatedHostAccessTokenProvider
      • UserInfo
      • UserInfoProvider
    • Unity.DigitalTwins.Identity.Runtime
      • AndroidActivatePlatformSupport
      • AndroidPkcePlatformSupport
      • CompositeAuthenticator
      • EditorActivateFromUrl
      • EditorActivatePlatformSupport
      • EditorPkcePlatformSupport
      • IosActivatePlatformSupport
      • IosPkcePlatformSupport
      • LinuxActivatePlatformSupport
      • LinuxPkcePlatformSupport
      • OsxActivatePlatformSupport
      • OsxPkcePlatformSupport
      • PlatformSupportFactory
      • WebglActivatePlatformSupport
      • WebglPkcePlatformSupport
      • WindowsActivatePlatformSupport
      • WindowsPkcePlatformSupport

    Class HttpPkceRequestHandler

    This class handles all http requests required in the Proof Key Code Exchange authentication flow.

    Inheritance
    Object
    HttpPkceRequestHandler
    Implements
    IPkceRequestHandler
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.DigitalTwins.Identity
    Assembly: solution.dll
    Syntax
    public class HttpPkceRequestHandler : IPkceRequestHandler

    Constructors

    HttpPkceRequestHandler(IHttpClient, IPkceConfigurationProvider)

    Creates a HttpPkceRequestHandler that handles all http requests required in the Proof Key Code Exchange authentication flow.

    Declaration
    public HttpPkceRequestHandler(IHttpClient httpClient, IPkceConfigurationProvider pkceConfigurationProvider)
    Parameters
    Type Name Description
    Unity.DigitalTwins.Common.IHttpClient httpClient

    The Unity.DigitalTwins.Common.IHttpClient instance required to make http requests.

    IPkceConfigurationProvider pkceConfigurationProvider

    The IPkceConfigurationProvider instance used to fetch the PkceConfiguration holding endpoints url.

    Methods

    ExchangeCodeForDeviceTokenAsync(String)

    Creates a Task that sends an http request to the TokenUrl to exchange a code for a DeviceToken.

    Declaration
    public async Task<DeviceToken> ExchangeCodeForDeviceTokenAsync(string tokenEndPointParams)
    Parameters
    Type Name Description
    String tokenEndPointParams

    The application/x-www-form-urlencoded string value that holds all parameters required to reach the TokenUrl endpoint.

    Returns
    Type Description
    Task<DeviceToken>

    A Task that results in a DeviceToken when completed.

    RefreshTokenAsync(String, String)

    Creates a Task that sends an http request to the RefreshTokenUrl to refresh the current DeviceToken.

    Declaration
    public async Task<DeviceToken> RefreshTokenAsync(string tokenEndPointParams, string refreshToken)
    Parameters
    Type Name Description
    String tokenEndPointParams

    The application/x-www-form-urlencoded string value that holds all parameters required to reach the RefreshTokenUrl endpoint.

    String refreshToken

    The refresh token string value to persist if no refresh token value is returned from RefreshTokenUrl endpoint.

    Returns
    Type Description
    Task<DeviceToken>

    A Task that results in a DeviceToken when completed.

    RevokeRefreshTokenAsync(String)

    Creates a Task that sends an http request to the LogoutUrl to revoke the current DeviceToken.

    Declaration
    public async Task RevokeRefreshTokenAsync(string revokeEndPointParams)
    Parameters
    Type Name Description
    String revokeEndPointParams

    The application/x-www-form-urlencoded string value that holds all parameters required to reach the LogoutUrl endpoint.

    Returns
    Type Description
    Task

    A Task.

    Implements

    IPkceRequestHandler
    Back to top Generated by DocFX
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023