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