@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/ui
lib/cognito-session
CognitoLinkableUsers
Type Alias CognitoLinkableUsers<TUser>
The dashboard user services' shape, as linking reads and writes it.
type
CognitoLinkableUsers
<
TUser
extends
{
id
:
string
}
>
=
{
linkCognito
(
input
:
{
cognitoSub
:
string
;
id
:
TUser
[
"id"
]
}
,
)
:
Promise
<
{
ok
:
true
}
|
{
error
:
{
code
:
string
;
message
?:
string
}
;
ok
:
false
}
,
>
;
search
(
input
:
{
cognitoLinked
?:
boolean
;
cognitoSubs
?:
string
[]
;
emails
?:
string
[]
;
pageSize
:
number
;
}
,
)
:
Promise
<
{
value
:
{
items
:
TUser
[]
}
}
>
;
}
Type Parameters
TUser
extends
{
id
:
string
}
Index
Methods
link
Cognito
search
Methods
link
Cognito
linkCognito
(
input
:
{
cognitoSub
:
string
;
id
:
TUser
[
"id"
]
}
,
)
:
Promise
<
{
ok
:
true
}
|
{
error
:
{
code
:
string
;
message
?:
string
}
;
ok
:
false
}
,
>
Parameters
input
:
{
cognitoSub
:
string
;
id
:
TUser
[
"id"
]
}
Returns
Promise
<
{
ok
:
true
}
|
{
error
:
{
code
:
string
;
message
?:
string
}
;
ok
:
false
}
>
search
search
(
input
:
{
cognitoLinked
?:
boolean
;
cognitoSubs
?:
string
[]
;
emails
?:
string
[]
;
pageSize
:
number
;
}
,
)
:
Promise
<
{
value
:
{
items
:
TUser
[]
}
}
>
Parameters
input
:
{
cognitoLinked
?:
boolean
;
cognitoSubs
?:
string
[]
;
emails
?:
string
[]
;
pageSize
:
number
;
}
Returns
Promise
<
{
value
:
{
items
:
TUser
[]
}
}
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
link
Cognito
search
@cfxlabsinc/b2b-services
Loading...
The dashboard user services' shape, as linking reads and writes it.