Preparing search index...
The search index is not available
Harmony Auth Documentation
Harmony Auth Documentation
Definitions/User
PostAuth0UserBody
Interface PostAuth0UserBody
Request body for creating an Auth0 user.
interface
PostAuth0UserBody
{
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 (
View Summary
)
PostBaseUserBody
PostAuth0UserBody
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
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"
email
email
:
string
Optional
email
Verified
emailVerified
?:
boolean
family
Name
familyName
:
string
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
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...
Request body for creating an Auth0 user.