Rockets LogoRockets
AboutAboutGitHubGitHub (opens in a new tab)DiscordDiscord (opens in a new tab)
  • Introduction
    • Philosophy
    • Getting Started
    • UI Framework
    • API Framework
    • README
    • packages
      • README
      • globals
        • AccessControlContext
        • AccessControlGuard
        • AccessControlModule
        • AccessControlService
        • ActionEnum
        • PossessionEnum
        • AccessControlCreateMany
        • AccessControlCreateOne
        • AccessControlDeleteOne
        • AccessControlGrant
        • AccessControlQuery
        • AccessControlReadMany
        • AccessControlReadOne
        • AccessControlRecoverOne
        • AccessControlReplaceOne
        • AccessControlUpdateOne
        • AccessControlContextInterface
        • AccessControlGrantOptionInterface
        • AccessControlMetadataInterface
        • AccessControlOptionsInterface
        • AccessControlQueryOptionInterface
        • AccessControlServiceInterface
        • CanAccess
      • README
      • globals
        • AuthGithubController
        • AuthGithubGuard
        • AuthGithubLoginDto
        • AuthGithubModule
      • README
      • globals
        • AuthJwtGuard
        • AuthJwtModule
        • AuthJwtStrategy
      • README
      • globals
        • AuthLocalController
        • AuthLocalGuard
        • AuthLocalLoginDto
        • AuthLocalModule
        • AuthLocalValidateUserService
        • AuthLocalCredentialsInterface
        • AuthLocalUserLookupServiceInterface
        • AuthLocalValidateUserInterface
        • AuthLocalValidateUserServiceInterface
      • README
      • globals
        • AuthRecoveryController
        • AuthRecoveryModule
        • AuthRecoveryNotificationService
        • AuthRecoveryRecoverLoginDto
        • AuthRecoveryRecoverPasswordDto
        • AuthRecoveryService
        • AuthRecoveryUpdatePasswordDto
        • AuthRecoveryValidatePasscodeDto
      • README
      • globals
        • AuthRefreshDto
        • AuthRefreshGuard
        • AuthRefreshModule
      • README
      • globals
        • AuthenticationJwtResponseDto
        • AuthenticationModule
        • IssueTokenService
        • ValidateUserService
        • VerifyTokenService
        • AuthGuard
        • AuthPublic
        • AuthUser
        • PassportStrategyFactory
        • authenticationDefaultConfig
        • AuthGuardOptions
        • AuthenticationOptionsInterface
        • IssueTokenServiceInterface
        • ValidateUserServiceInterface
        • VerifyTokenServiceInterface
        • AuthGuardCtr
      • README
      • globals
        • CacheCreateDto
        • CacheDto
        • CacheModule
        • CachePostgresEntity
        • CacheService
        • CacheSqliteEntity
        • CacheUpdateDto
      • README
      • globals
        • AuditDto
        • CommonEntityDto
        • ReferenceIdDto
        • AuthUser
        • createSettingsProvider
      • README
      • globals
        • ModuleOptionsControllerInterface
        • ModuleOptionsSettingsInterface
      • README
      • globals
        • CrudCreateManyDto
        • CrudModule
        • CrudQueryHelper
        • CrudResponsePaginatedDto
        • TypeOrmCrudService
        • CrudAction
        • CrudAllow
        • CrudAlwaysPaginate
        • CrudBody
        • CrudCache
        • CrudController
        • CrudCreateMany
        • CrudCreateOne
        • CrudDeleteOne
        • CrudExclude
        • CrudFilter
        • CrudJoin
        • CrudLimit
        • CrudMaxLimit
        • CrudModel
        • CrudParams
        • CrudReadAll
        • CrudReadMany
        • CrudReadOne
        • CrudRecoverOne
        • CrudReplaceOne
        • CrudRequest
        • CrudSerialize
        • CrudSoftDelete
        • CrudSort
        • CrudUpdateOne
        • CrudValidate
        • CrudControllerInterface
        • CrudCreateManyInterface
        • CrudRequestInterface
        • CrudResponsePaginatedInterface
      • README
      • globals
        • EmailModule
        • EmailService
        • EmailOptionsInterface
        • EmailServiceInterface
      • README
      • globals
        • Event
        • EventAsync
        • EventDispatchException
        • EventDispatchService
        • EventListenException
        • EventListenService
        • EventListener
        • EventListenerException
        • EventListenerOn
        • EventModule
        • EventSync
        • EventAsyncInterface
        • EventClassInterface
        • EventInterface
        • EventListenOnInterface
        • EventListenOnOptionsInterface
        • EventListenerInterface
        • EventOptionsInterface
        • EventSyncInterface
        • EVENT_MODULE_DEFAULT_EMITTER_SERVICE_SETTINGS_TOKEN
        • EVENT_MODULE_EMITTER_SERVICE_TOKEN
        • EVENT_MODULE_EVENT_KEY_PREFIX
        • EVENT_MODULE_SETTINGS_TOKEN
      • README
      • globals
        • ExceptionsFilter
        • RuntimeException
        • RuntimeExceptionInterface
        • RuntimeExceptionOptions
        • RuntimeExceptionContext
      • README
      • globals
        • FederatedCreateDto
        • FederatedDto
        • FederatedModule
        • FederatedOAuthService
        • FederatedPostgresEntity
        • FederatedService
        • FederatedSqliteEntity
        • FederatedUpdateDto
        • FederatedCredentialsInterface
        • FederatedEntityInterface
        • FederatedUserLookupServiceInterface
        • FederatedUserMutateServiceInterface
      • README
      • globals
        • InvitationAcceptedEventAsync
        • InvitationController
        • InvitationGetUserEventAsync
        • InvitationModule
        • InvitationPostgresEntity
        • InvitationService
        • InvitationSqliteEntity
      • README
      • globals
        • JwtIssueService
        • JwtModule
        • JwtSignService
        • JwtStrategy
        • JwtVerifyService
        • createVerifyAccessTokenCallback
        • createVerifyRefreshTokenCallback
        • JwtFromRequestFunction
        • JwtIssueServiceInterface
        • JwtStrategyOptionsInterface
        • JwtVerifyServiceInterface
          • README
            • fromAuthHeader
            • fromAuthHeaderAsBearerToken
            • fromAuthHeaderWithScheme
            • fromBodyField
            • fromExtractors
            • fromHeader
            • fromUrlQueryParameter
        • JwtTokenType
        • JwtVerifyTokenCallback
      • README
      • globals
        • LoggerExceptionFilter
        • LoggerModule
        • LoggerRequestInterceptor
        • LoggerSentryTransport
        • LoggerService
        • LoggerTransportService
        • LoggerSentryConfigInterface
        • LoggerSettingsInterface
      • README
      • globals
        • OrgController
        • OrgCreateDto
        • OrgCreateManyDto
        • OrgCrudService
        • OrgDto
        • OrgLookupService
        • OrgMemberPostgresEntity
        • OrgMemberSqliteEntity
        • OrgModule
        • OrgMutateService
        • OrgPaginatedDto
        • OrgPostgresEntity
        • OrgSqliteEntity
        • OrgUpdateDto
        • OrgResource
        • OrgEntityInterface
        • OrgLookupServiceInterface
        • OrgMutateServiceInterface
      • README
      • globals
        • OtpCreateDto
        • OtpModule
        • OtpPostgresEntity
        • OtpService
        • OtpSqliteEntity
      • README
      • globals
        • PasswordCreationService
        • PasswordModule
        • PasswordStorageService
        • PasswordStrengthService
        • PasswordValidationService
        • PasswordStrengthEnum
        • isPasswordStorage
        • PasswordCreateObjectOptionsInterface
        • PasswordCreationServiceInterface
        • PasswordOptionsInterface
        • PasswordStorageInterface
        • PasswordStorageServiceInterface
        • PasswordValidationServiceInterface
      • README
      • globals
        • RoleAssignmentCreateDto
        • RoleAssignmentCreateManyDto
        • RoleAssignmentDto
        • RoleAssignmentPaginatedDto
        • RoleAssignmentPostgresEntity
        • RoleAssignmentSqliteEntity
        • RoleController
        • RoleCreateDto
        • RoleCreateManyDto
        • RoleCrudService
        • RoleDto
        • RoleLookupService
        • RoleModule
        • RoleMutateService
        • RolePaginatedDto
        • RolePostgresEntity
        • RoleService
        • RoleSqliteEntity
        • RoleUpdateDto
        • RoleAssignmentResource
        • RoleResource
        • RoleAssignmentEntityInterface
        • RoleEntityInterface
        • RoleLookupServiceInterface
        • RoleMutateServiceInterface
      • README
      • globals
        • SwaggerUiModule
        • SwaggerUiService
      • README
      • globals
        • TypeOrmExtModule
        • InjectDynamicRepository
        • InjectEntityRepository
        • getDynamicRepositoryToken
        • getEntityRepositoryToken
        • TypeOrmExtEntityOptionInterface
        • TypeOrmExtOptions
      • README
      • globals
        • UserAccessQueryService
        • UserController
        • UserCreateDto
        • UserCreateManyDto
        • UserCrudService
        • UserDto
        • UserException
        • UserLookupService
        • UserModule
        • UserMutateService
        • UserPaginatedDto
        • UserPasswordDto
        • UserPasswordService
        • UserPasswordUpdateDto
        • UserPostgresEntity
        • UserSqliteEntity
        • UserUpdateDto
        • UserResource
        • UserEntityInterface
        • UserLookupServiceInterface
        • UserMutateServiceInterface
        • UserPasswordServiceInterface
      • README
      • globals
        • AuthenticatedUserInterface
        • AuthenticationAccessInterface
        • AuthenticationCodeInterface
        • AuthenticationLoginInterface
        • AuthenticationRefreshInterface
        • AuthenticationResponseInterface
        • AuthorizationPayloadInterface
        • CacheClearInterface
        • CacheCreatableInterface
        • CacheCreateInterface
        • CacheDeleteInterface
        • CacheGetOneInterface
        • CacheInterface
        • CacheUpdatableInterface
        • CacheUpdateInterface
        • EmailSendInterface
        • EmailSendOptionsInterface
        • FederatedCreatableInterface
        • FederatedInterface
        • FederatedUpdatableInterface
        • InvitationAcceptedEventPayloadInterface
        • InvitationGetUserEventPayloadInterface
        • InvitationGetUserEventResponseInterface
        • InvitationInterface
        • OrgCreatableInterface
        • OrgInterface
        • OrgMemberInterface
        • OrgOwnerInterface
        • OrgUpdatableInterface
        • OtpClearInterface
        • OtpCreatableInterface
        • OtpCreateInterface
        • OtpDeleteInterface
        • OtpInterface
        • OtpValidateInterface
        • PasswordPlainCurrentInterface
        • PasswordPlainInterface
        • RoleAssigneesInterface
        • RoleAssignmentCreatableInterface
        • RoleAssignmentInterface
        • RoleCreatableInterface
        • RoleInterface
        • RoleUpdatableInterface
        • UserCreatableInterface
        • UserInterface
        • UserOwnableInterface
        • UserUpdatableInterface
        • INVITATION_MODULE_CATEGORY_ORG_KEY
        • INVITATION_MODULE_CATEGORY_USER_KEY
      • README
      • globals
        • NotAnErrorException
        • mapNonErrorToException
        • AuditDateCreatedInterface
        • AuditDateDeletedInterface
        • AuditDateUpdatedInterface
        • AuditInterface
        • AuditVersionInterface
        • CreateOneInterface
        • ExceptionInterface
        • LiteralObject
        • LookupEmailInterface
        • LookupIdInterface
        • LookupSubjectInterface
        • LookupUsernameInterface
        • ReferenceActiveInterface
        • ReferenceAssigneeInterface
        • ReferenceEmailInterface
        • ReferenceIdInterface
        • ReferenceQueryOptionsInterface
        • ReferenceSubjectInterface
        • ReferenceUsernameInterface
        • RemoveOneInterface
        • ReplaceOneInterface
        • Type
        • UpdateOneInterface
        • AuditDateCreated
        • AuditDateDeleted
        • AuditDateUpdated
        • AuditVersion
        • ExceptionContext
        • ReferenceActive
        • ReferenceAssignment
        • ReferenceEmail
        • ReferenceId
        • ReferenceSubject
        • ReferenceUsername
      • README
      • globals
        • AuditPostgresEntity
        • AuditSqlLiteEntity
        • BaseService
        • CommonPostgresEntity
        • CommonSqliteEntity
        • EntityManagerProxy
        • LookupService
        • MutateService
        • ReferenceIdNoMatchException
        • ReferenceLookupException
        • ReferenceMutateException
        • ReferenceValidationException
        • RepositoryProxy
        • TransactionProxy
        • createEntityManagerMock
        • QueryOptionsInterface
        • SafeTransactionOptionsInterface
        • RunInTransactionCallback
    • README
    • packages
      • README
      • globals
        • AuthProvider
        • useAuth
        • LoginParams
      • README
      • globals
        • ClientProvider
        • default
        • useQuery
      • README
      • globals
        • AppBarDrawer
        • AppBarMain
        • AppBarNav
        • AppBarRoot
        • AuthModule
        • AutocompleteField
        • Avatar
        • Breadcrumbs
        • Checkbox
        • ComposedTable
        • CrudModule
        • Dialog
        • Drawer
        • Dropdown
        • Filter
        • FormFieldSkeleton
        • FormTemplate
        • HeaderAccount
        • Image
        • Link
        • Navbar
        • Notifications
        • OrderableDropDown
        • OtpInput
        • RadioGroup
        • SearchField
        • Select
        • SelectField
        • SideModal
        • SimpleForm
        • Switch
        • Text
        • TextField
        • UsersModule
        • createTableStyles
        • descendingComparator
        • getComparator
        • sortTable
        • stableSort
        • ListItem
        • AppBarRootProps
        • AvatarProps
        • DialogProps
        • DrawerItemProps
        • DrawerProps
        • DropdownItem
        • DropdownProps
        • FilterCommon
        • FilterType
        • FilterVariant
        • HeaderAccountProps
        • ImageProps
        • NavbarProps
        • SchemaFormProps
        • SideModalProps
        • TextFieldProps
        • TextFilter
        • AppBar
        • SchemaForm
        • Table

On This Page

  • Returns
  • Defined in
Question? Give us feedback → (opens in a new tab)Edit this page
API Reference
Rockets React API
react-auth-provider
functions
useAuth

Function: useAuth()

useAuth(): AuthProviderTypes

Returns

AuthProviderTypes

Defined in

index.tsx:21 (opens in a new tab)

AuthProviderLoginParams
2022 © Concepta