Hiyve Components - v1.0.0
Preparing search index...
@hiyve/identity-client
HiyveAuth
Class HiyveAuth
Index
Constructors
constructor
Methods
create
Authorization
Code
create
MCP
Token
create
O
Auth
Client
delete
O
Auth
Client
destroy
exchange
Authorization
Code
get
Access
Token
get
O
Auth
Client
get
Profile
get
User
is
Authenticated
list
MCP
Tokens
list
O
Auth
Clients
list
Trusted
Devices
login
logout
on
Auth
State
Change
on
Tfa
Required
refresh
O
Auth
Token
refresh
Tokens
register
request
Password
Reset
resend
Otp
resend
Verification
reset
Password
revoke
All
Trusted
Devices
revoke
MCP
Token
revoke
Trusted
Device
update
Profile
validate
MCP
Token
verify
Email
verify
Tfa
Constructors
constructor
new
HiyveAuth
(
config
:
HiyveAuthConfig
)
:
HiyveAuth
Parameters
config
:
HiyveAuthConfig
Returns
HiyveAuth
Methods
create
Authorization
Code
createAuthorizationCode
(
params
:
CreateAuthorizationCodeParams
,
)
:
Promise
<
CreateAuthorizationCodeResponse
>
Parameters
params
:
CreateAuthorizationCodeParams
Returns
Promise
<
CreateAuthorizationCodeResponse
>
create
MCP
Token
createMCPToken
(
params
?:
CreateMCPTokenParams
)
:
Promise
<
CreateMCPTokenResponse
>
Parameters
Optional
params
:
CreateMCPTokenParams
Returns
Promise
<
CreateMCPTokenResponse
>
create
O
Auth
Client
createOAuthClient
(
params
:
CreateOAuthClientParams
,
)
:
Promise
<
CreateOAuthClientResponse
>
Parameters
params
:
CreateOAuthClientParams
Returns
Promise
<
CreateOAuthClientResponse
>
delete
O
Auth
Client
deleteOAuthClient
(
clientId
:
string
)
:
Promise
<
{
message
:
string
}
>
Parameters
clientId
:
string
Returns
Promise
<
{
message
:
string
}
>
destroy
destroy
()
:
void
Returns
void
exchange
Authorization
Code
exchangeAuthorizationCode
(
params
:
ExchangeAuthorizationCodeParams
,
)
:
Promise
<
OAuthTokenResponse
>
Parameters
params
:
ExchangeAuthorizationCodeParams
Returns
Promise
<
OAuthTokenResponse
>
get
Access
Token
getAccessToken
()
:
string
|
null
Returns
string
|
null
get
O
Auth
Client
getOAuthClient
(
clientId
:
string
)
:
Promise
<
{
client
:
OAuthClient
}
>
Parameters
clientId
:
string
Returns
Promise
<
{
client
:
OAuthClient
}
>
get
Profile
getProfile
()
:
Promise
<
{
profile
:
UserProfile
}
>
Returns
Promise
<
{
profile
:
UserProfile
}
>
get
User
getUser
()
:
Promise
<
{
user
:
AuthUser
}
>
Returns
Promise
<
{
user
:
AuthUser
}
>
is
Authenticated
isAuthenticated
()
:
boolean
Returns
boolean
list
MCP
Tokens
listMCPTokens
()
:
Promise
<
{
tokens
:
MCPToken
[]
}
>
Returns
Promise
<
{
tokens
:
MCPToken
[]
}
>
list
O
Auth
Clients
listOAuthClients
()
:
Promise
<
{
clients
:
OAuthClient
[]
}
>
Returns
Promise
<
{
clients
:
OAuthClient
[]
}
>
list
Trusted
Devices
listTrustedDevices
()
:
Promise
<
{
devices
:
TrustedDevice
[]
}
>
Returns
Promise
<
{
devices
:
TrustedDevice
[]
}
>
login
login
(
params
:
{
email
:
string
;
password
:
string
}
)
:
Promise
<
LoginResult
>
Parameters
params
:
{
email
:
string
;
password
:
string
}
Returns
Promise
<
LoginResult
>
logout
logout
()
:
Promise
<
void
>
Returns
Promise
<
void
>
on
Auth
State
Change
onAuthStateChange
(
callback
:
(
state
:
AuthStateChange
)
=>
void
)
:
()
=>
void
Parameters
callback
:
(
state
:
AuthStateChange
)
=>
void
Returns
()
=>
void
on
Tfa
Required
onTfaRequired
(
callback
:
(
event
:
TfaRequiredEvent
)
=>
void
)
:
()
=>
void
Parameters
callback
:
(
event
:
TfaRequiredEvent
)
=>
void
Returns
()
=>
void
refresh
O
Auth
Token
refreshOAuthToken
(
params
:
RefreshOAuthTokenParams
)
:
Promise
<
OAuthTokenResponse
>
Parameters
params
:
RefreshOAuthTokenParams
Returns
Promise
<
OAuthTokenResponse
>
refresh
Tokens
refreshTokens
()
:
Promise
<
{
accessToken
:
string
;
expiresIn
:
number
;
refreshToken
:
string
}
,
>
Returns
Promise
<
{
accessToken
:
string
;
expiresIn
:
number
;
refreshToken
:
string
}
>
register
register
(
params
:
{
email
:
string
;
metadata
?:
Record
<
string
,
unknown
>
;
name
?:
string
;
password
:
string
;
}
,
)
:
Promise
<
RegisterResponse
>
Parameters
params
:
{
email
:
string
;
metadata
?:
Record
<
string
,
unknown
>
;
name
?:
string
;
password
:
string
;
}
Returns
Promise
<
RegisterResponse
>
request
Password
Reset
requestPasswordReset
(
params
:
{
email
:
string
}
)
:
Promise
<
{
message
:
string
}
>
Parameters
params
:
{
email
:
string
}
Returns
Promise
<
{
message
:
string
}
>
resend
Otp
resendOtp
()
:
Promise
<
{
expiresIn
:
number
;
message
:
string
}
>
Returns
Promise
<
{
expiresIn
:
number
;
message
:
string
}
>
resend
Verification
resendVerification
(
params
:
{
email
:
string
}
)
:
Promise
<
{
message
:
string
}
>
Parameters
params
:
{
email
:
string
}
Returns
Promise
<
{
message
:
string
}
>
reset
Password
resetPassword
(
params
:
{
password
:
string
;
token
:
string
}
,
)
:
Promise
<
{
message
:
string
}
>
Parameters
params
:
{
password
:
string
;
token
:
string
}
Returns
Promise
<
{
message
:
string
}
>
revoke
All
Trusted
Devices
revokeAllTrustedDevices
()
:
Promise
<
{
count
:
number
;
message
:
string
}
>
Returns
Promise
<
{
count
:
number
;
message
:
string
}
>
revoke
MCP
Token
revokeMCPToken
(
tokenId
:
string
)
:
Promise
<
{
message
:
string
}
>
Parameters
tokenId
:
string
Returns
Promise
<
{
message
:
string
}
>
revoke
Trusted
Device
revokeTrustedDevice
(
deviceId
:
string
)
:
Promise
<
{
message
:
string
}
>
Parameters
deviceId
:
string
Returns
Promise
<
{
message
:
string
}
>
update
Profile
updateProfile
(
params
?:
UpdateProfileParams
)
:
Promise
<
{
profile
:
UserProfile
}
>
Parameters
Optional
params
:
UpdateProfileParams
Returns
Promise
<
{
profile
:
UserProfile
}
>
validate
MCP
Token
validateMCPToken
(
token
:
string
)
:
Promise
<
ValidateMCPTokenResponse
>
Parameters
token
:
string
Returns
Promise
<
ValidateMCPTokenResponse
>
verify
Email
verifyEmail
(
params
:
{
token
:
string
}
)
:
Promise
<
{
message
:
string
}
>
Parameters
params
:
{
token
:
string
}
Returns
Promise
<
{
message
:
string
}
>
verify
Tfa
verifyTfa
(
params
:
{
code
:
string
;
type
?:
string
}
)
:
Promise
<
TfaVerifyResponse
>
Parameters
params
:
{
code
:
string
;
type
?:
string
}
Returns
Promise
<
TfaVerifyResponse
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
Authorization
Code
create
MCP
Token
create
O
Auth
Client
delete
O
Auth
Client
destroy
exchange
Authorization
Code
get
Access
Token
get
O
Auth
Client
get
Profile
get
User
is
Authenticated
list
MCP
Tokens
list
O
Auth
Clients
list
Trusted
Devices
login
logout
on
Auth
State
Change
on
Tfa
Required
refresh
O
Auth
Token
refresh
Tokens
register
request
Password
Reset
resend
Otp
resend
Verification
reset
Password
revoke
All
Trusted
Devices
revoke
MCP
Token
revoke
Trusted
Device
update
Profile
validate
MCP
Token
verify
Email
verify
Tfa
Hiyve Components - v1.0.0
Loading...