Preparing search index...
The search index is not available
Harmony Auth Documentation
Harmony Auth Documentation
Definitions/User
PostBaseUserBody
Interface PostBaseUserBody
Base request body for creating a user.
interface
PostBaseUserBody
{
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
;
email
:
string
;
name
?:
string
;
nickname
?:
string
;
password
?:
string
;
picture
?:
string
;
userMetadata
?:
{
homeroomId
?:
string
;
siteId
?:
string
}
;
username
?:
string
;
[
key
:
string
]:
any
;
}
Hierarchy (
View Summary
)
PostBaseUserBody
PostAuth0UserBody
PostCognitoUserBody
Indexable
[
key
:
string
]:
any
Index
Properties
app
Metadata
blocked?
email
name?
nickname?
password?
picture?
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
email
email
:
string
Optional
name
name
?:
string
Optional
nickname
nickname
?:
string
Optional
password
password
?:
string
Optional
picture
picture
?:
string
Optional
user
Metadata
userMetadata
?:
{
homeroomId
?:
string
;
siteId
?:
string
}
Optional
username
username
?:
string
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
app
Metadata
blocked
email
name
nickname
password
picture
user
Metadata
username
Harmony Auth Documentation
Loading...
Base request body for creating a user.