Preparing search index...
The search index is not available
Harmony Auth Documentation
Harmony Auth Documentation
Definitions/User
PatchAuth0UserBody
Interface PatchAuth0UserBody
Patch body for Auth0 users.
interface
PatchAuth0UserBody
{
appMetadata
?:
{
admin
?:
string
;
createdBy
?:
ProductKey
;
ctsAuthorized
?:
boolean
;
ctsUserId
?:
string
;
customerId
?:
string
;
districtId
?:
string
;
egrantsAuthorized
?:
boolean
;
egrantsUserId
?:
string
;
erpAuthorized
?:
boolean
;
erpNcAuthorized
?:
boolean
;
erpNcUserId
?:
string
;
erpTenants
?:
string
;
erpUserId
?:
string
;
fdpAuthorized
?:
boolean
;
fdpStateAgency
?:
string
;
fdpStateCode
?:
string
;
isiteAuthorized
?:
boolean
;
isiteMigration
?:
boolean
;
mcAuthorized
?:
boolean
;
mcUserId
?:
string
;
ooAuthorized
?:
boolean
;
passwordResetRequired
?:
boolean
;
role
?:
string
;
scriptAuthorized
?:
boolean
;
titanAuthorized
?:
boolean
;
titanUserId
?:
string
;
}
;
blocked
?:
boolean
;
clientId
?:
string
;
connection
?:
"district"
|
"self-signup"
;
email
?:
string
;
emailVerified
?:
boolean
;
familyName
?:
string
;
givenName
?:
string
;
name
?:
string
;
nickname
?:
string
;
password
?:
string
;
picture
?:
string
;
sendInvite
?:
boolean
;
userMetadata
?:
{
homeroomId
?:
string
;
siteId
?:
string
}
&
{
mfaOptIn
?:
any
;
notificationSubscriptions
?:
Record
<
string
,
NotificationSubscription
>
;
}
;
username
?:
string
;
[
key
:
string
]:
any
;
}
Hierarchy
Partial
<
PostAuth0UserBody
>
PatchAuth0UserBody
Indexable
[
key
:
string
]:
any
Index
Properties
app
Metadata?
blocked?
client
Id?
connection?
email?
email
Verified?
family
Name?
given
Name?
name?
nickname?
password?
picture?
send
Invite?
user
Metadata?
username?
Properties
Optional
app
Metadata
appMetadata
?:
{
admin
?:
string
;
createdBy
?:
ProductKey
;
ctsAuthorized
?:
boolean
;
ctsUserId
?:
string
;
customerId
?:
string
;
districtId
?:
string
;
egrantsAuthorized
?:
boolean
;
egrantsUserId
?:
string
;
erpAuthorized
?:
boolean
;
erpNcAuthorized
?:
boolean
;
erpNcUserId
?:
string
;
erpTenants
?:
string
;
erpUserId
?:
string
;
fdpAuthorized
?:
boolean
;
fdpStateAgency
?:
string
;
fdpStateCode
?:
string
;
isiteAuthorized
?:
boolean
;
isiteMigration
?:
boolean
;
mcAuthorized
?:
boolean
;
mcUserId
?:
string
;
ooAuthorized
?:
boolean
;
passwordResetRequired
?:
boolean
;
role
?:
string
;
scriptAuthorized
?:
boolean
;
titanAuthorized
?:
boolean
;
titanUserId
?:
string
;
}
Optional
blocked
blocked
?:
boolean
Optional
client
Id
clientId
?:
string
Optional
connection
connection
?:
"district"
|
"self-signup"
Optional
email
email
?:
string
Optional
email
Verified
emailVerified
?:
boolean
Optional
family
Name
familyName
?:
string
Optional
given
Name
givenName
?:
string
Optional
name
name
?:
string
Optional
nickname
nickname
?:
string
Optional
password
password
?:
string
Optional
picture
picture
?:
string
Optional
send
Invite
sendInvite
?:
boolean
Optional
user
Metadata
userMetadata
?:
{
homeroomId
?:
string
;
siteId
?:
string
}
&
{
mfaOptIn
?:
any
;
notificationSubscriptions
?:
Record
<
string
,
NotificationSubscription
>
;
}
Optional
username
username
?:
string
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
app
Metadata
blocked
client
Id
connection
email
email
Verified
family
Name
given
Name
name
nickname
password
picture
send
Invite
user
Metadata
username
Harmony Auth Documentation
Loading...
Patch body for Auth0 users.