Class UnityEditorAuthenticator

An IAuthenticator implementation to access the user authenticated session in the Unity Editor.

Inheritance
object
UnityEditorAuthenticator
Implements
Inherited Members
Namespace: Unity.Cloud.Identity.Editor
Assembly: Unity.Cloud.Identity.Editor.dll
Syntax
[Obsolete("Deprecated in favor of the UnityEditorServiceAuthorizer.")]
public class UnityEditorAuthenticator : IAuthenticator, IServiceAuthorizer, IAuthenticationStateProvider, IUserInfoProvider, IOrganizationRepository, IDisposable

Constructors

UnityEditorAuthenticator()

Returns an IAuthenticator implementation that expects an access token from a Unity Editor environment.

Declaration
public UnityEditorAuthenticator()

UnityEditorAuthenticator(IAccessTokenExchanger<TargetClientIdToken, UnityServicesToken>)

Returns an IAuthenticator implementation that expects an access token from a Unity Editor environment.

Declaration
public UnityEditorAuthenticator(IAccessTokenExchanger<TargetClientIdToken, UnityServicesToken> accessTokenExchanger)
Parameters
Type Name Description
IAccessTokenExchanger<TargetClientIdToken, UnityServicesToken> accessTokenExchanger

An IAccessTokenExchanger<T1, T2> where the T1 input is a TargetClientIdToken and T2 output is a UnityServicesToken

UnityEditorAuthenticator(IAccessTokenExchanger<TargetClientIdToken, UnityServicesToken>, IUnityEditorAccessTokenProvider)

Returns an IAuthenticator implementation that expects an access token from a Unity Editor environment.

Declaration
public UnityEditorAuthenticator(IAccessTokenExchanger<TargetClientIdToken, UnityServicesToken> accessTokenExchanger, IUnityEditorAccessTokenProvider unityEditorAccessTokenProvider)
Parameters
Type Name Description
IAccessTokenExchanger<TargetClientIdToken, UnityServicesToken> accessTokenExchanger

An IAccessTokenExchanger<T1, T2> where the T1 input is a TargetClientIdToken and T2 output is a UnityServicesToken
IUnityEditorAccessTokenProvider unityEditorAccessTokenProvider

An IUnityEditorAccessTokenProvider reference.

Properties

AuthenticationState

Declaration
public AuthenticationState AuthenticationState { get; }
Property Value
Type Description
AuthenticationState

Methods

AddAuthorization(HttpHeaders)

Declaration
public Task AddAuthorization(HttpHeaders headers)
Parameters
Type Name Description
HttpHeaders headers
Returns
Type Description
Task

Dispose()

Disposes of any IDisposable references.

Declaration
public void Dispose()

Dispose(bool)

Disposes of any IDisposable references.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Dispose pattern boolean value received from public Dispose method.

GetOrganizationAsync(OrganizationId)

Declaration
public Task<IOrganization> GetOrganizationAsync(OrganizationId organizationId)
Parameters
Type Name Description
OrganizationId organizationId
Returns
Type Description
Task<IOrganization>

GetUserInfoAsync()

Declaration
public Task<IUserInfo> GetUserInfoAsync()
Returns
Type Description
Task<IUserInfo>

HasValidPreconditionsAsync()

Indicates if the UnityEditorAuthenticator running instance has access to an access token from the Unity Editor environment.

Declaration
public Task<bool> HasValidPreconditionsAsync()
Returns
Type Description
Task<bool>

If the UnityEditorAuthenticator running instance has access to an access token from the Unity Editor environment.

InitializeAsync()

Declaration
public Task InitializeAsync()
Returns
Type Description
Task

ListOrganizationsAsync(Range, CancellationToken)

Declaration
public IAsyncEnumerable<IOrganization> ListOrganizationsAsync(Range range, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Range range
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerable<IOrganization>

Events

AuthenticationStateChanged

Declaration
public event Action<AuthenticationState> AuthenticationStateChanged
Event Type
Type Description
Action<AuthenticationState>

Implements