Sign in
latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

groups

Update a group

put/groups/{groupId}

Path parameters

groupIdstring required

Groups' unique identifier in Luma's database.

Request body

facilitiesstring[]

The IDs of the facilities associated with this group.

usersstring[]

DEPRECATED. Do not use this field. See the "User" resource and use its "groups" array instead.

namestring

Descriptive label of a group. This is the only way to link a group in Luma with another in an external service, as the group doesn't have an "externalId" field.

type'user' | 'system'

Indicates if a group was created by users or by the system.

Response

Group

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

facilitiesstring[]

The IDs of the facilities associated with this group.

usersstring[]

DEPRECATED. Do not use this field. See the User resource and its "groups" property instead.

type'user' | 'system'

Indicates if a group was created by users or by the system.

namestring

Descriptive label of a group. This is the only way to link a group in Luma with another in an external service, as the group doesn't have an "externalId" field.