Directus / @directus/sdk / rest / updateUser
Function: updateUser()
updateUser<
Schema
,TQuery
>(key
,item
,query
?):RestCommand
<IfAny
<Schema
,Record
<string
,any
>,Merge
<MappedFunctionFields
<Schema
,UnpackList
<MergeCoreCollection
<Schema
,"directus_users"
,Object
>>> extendsFF
?MapFlatFields
<UnpackList
<MergeCoreCollection
<Schema
,"directus_users"
,Object
>>,FieldsWildcard
<UnpackList
<MergeCoreCollection
<Schema
,"directus_users"
,Object
>>,Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>,PickRelationalFields
<UnpackList
<Mutable
<...>>> extendsnever
?never
:AllKeys
<UnpackList
<...> extendsField
? ... extends ... ? ... : ... :never
>>>,FF
extendsRecord
<string
,string
> ?FF
:Record
<string
,string
>> :never
,PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extendsnever
?never
:{ [Field in string | number | symbol]: Field extends keyof UnpackList<MergeCoreCollection<Schema, "directus_users", Object>> ? Extract<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>,Schema
>
Update an existing user.
Type parameters
• Schema extends object
• TQuery extends Query
<Schema
, DirectusUser
<Schema
>>
Parameters
• key: DirectusUser
<Schema
>["id"
]
The primary key of the user
• item: Partial
<DirectusUser
<Schema
>>
The user data to update
• query?: TQuery
Optional return data query
Returns
RestCommand
<IfAny
<Schema
, Record
<string
, any
>, Merge
<MappedFunctionFields
<Schema
, UnpackList
<MergeCoreCollection
<Schema
, "directus_users"
, Object
>>> extends FF
? MapFlatFields
<UnpackList
<MergeCoreCollection
<Schema
, "directus_users"
, Object
>>, FieldsWildcard
<UnpackList
<MergeCoreCollection
<Schema
, "directus_users"
, Object
>>, Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>, PickRelationalFields
<UnpackList
<Mutable
<...>>> extends never
? never
: AllKeys
<UnpackList
<...> extends Field
? ... extends ... ? ... : ... : never
>>>, FF
extends Record
<string
, string
> ? FF
: Record
<string
, string
>> : never
, PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extends never
? never
: { [Field in string | number | symbol]: Field extends keyof UnpackList<MergeCoreCollection<Schema, "directus_users", Object>> ? Extract<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>, Schema
>
Returns the user object for the updated user.
Throws
Will throw if key is empty