Directus / @directus/sdk / rest / updateRoles

Function: updateRoles() ​

updateRoles<Schema, TQuery>(keys, item, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { children: ...; description: ...; icon: ...; id: ...; name: ...; parent: ...; policies: ...; users: ... }, (...) extends (...) ? (...) : (...)>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { children: ...; description: ...; icon: ...; id: ...; name: ...; parent: ...; policies: ...; users: ... }, (...) extends (...) ? (...) : (...)>>, FieldsWildcard<UnpackList<IfAny<(...), (...), (...)>>, Exclude<UnpackList<(...)>, (...) extends (...) ? (...) : (...)>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<(...)[(...)]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<(...)> ? Extract<(...), (...)> extends RelatedCollection ? IsNullable<(...), (...), (...)> : never : never }>[K] }>[], Schema>

Defined in: rest/commands/update/roles.ts:21

Update multiple existing roles.

Type Parameters ​

• Schema

• TQuery extends Query<Schema, DirectusRole<Schema>>

Parameters ​

keys ​

DirectusRole<Schema>["id"][]

item ​

NestedPartial<DirectusRole<Schema>>

query? ​

TQuery

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { children: ...; description: ...; icon: ...; id: ...; name: ...; parent: ...; policies: ...; users: ... }, (...) extends (...) ? (...) : (...)>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { children: ...; description: ...; icon: ...; id: ...; name: ...; parent: ...; policies: ...; users: ... }, (...) extends (...) ? (...) : (...)>>, FieldsWildcard<UnpackList<IfAny<(...), (...), (...)>>, Exclude<UnpackList<(...)>, (...) extends (...) ? (...) : (...)>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<(...)[(...)]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<(...)> ? Extract<(...), (...)> extends RelatedCollection ? IsNullable<(...), (...), (...)> : never : never }>[K] }>[], Schema>

Returns the role objects for the updated roles.

Throws ​

Will throw if keys is empty