Interface IAuthApi
Entry point for communication with a ZEDAL server instance.
public interface IAuthApiProperties
- AccessToken
Gets identifies an access_token for the given refresh_token.
- AccessTokenChanged
Gets or sets callback for the event of Updating the AccessToken.
- ActiveProvider
Gets the Active Endpoint.
- RefreshToken
Gets identifies a refresh_token that depicts a session.
Methods
- ContinueSession(RefreshToken)
Logging into an instance with the refreshToken.
- CreateSession(int, string, string, string, AppToken)
Logging into an instance with the credentials provided.
- CreateSession(string, AppToken)
Logging into an instance with the userId.
- CreateSession(ClientId, string, AppToken)
Logging into an instance with the clientId.
- EndSession()
Logging out of an instance this ends the current session and invalidates the refresh token. In order to continue using the instance, it must be reauthorized.
- EnsureLoggedIn()
Test to determine if we are not logged in or if the jwt token has expired, then try to renew the connection server-side logout should be handled by the client to avoid looping.
- GetCallOptions(int, Metadata)
Builds the CallOption object for Grpc API calls.
- IssueClientId(int, string, string, string, string)
Issues a clientId and secret for the user account that can be used for automated processing.
- ListClientIds()
Lists all existing client ids for the user account.
- ListSessions()
Lists all existing sessions for the user account.
- RefreshAccessToken()
Refreshes the old AccessToken with a new one This bypasses the Token-interceptor !!!.
- RevokeClientId(ClientId)
Revokes a clientId for the user account. All refresh tokens that were issued using this client id will be revoked as well.
- RevokeClientIdByTokenId(string)
Revokes a clientId for the user account. All refresh tokens that were issued using this client id will be revoked as well.
- RevokeRefreshTokenByFamilyId(string)
Invalidate a RefreshToken by its family Ident. Effectively logs out a session.
- RevokeRefreshTokenByToken(string)
Invalidate a refreshToken by the token itself. Effectively logs out a session.