Skip to main content

Update a group

PUT /api/admin/groups/:groupId

Update existing user group by group id. It overrides previous group details.

Request

Path Parameters

  • groupId string required

Body

required

createGroupSchema

  • name string required

    The name of the group

  • description string nullable

    A custom description of the group

  • mappingsSSO string[]

    A list of SSO groups that should map to this Unleash group

  • rootRole number nullable

    A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.

  • users object[]

    A list of users belonging to this group

  • Array [
  • user objectrequired

    A minimal user object

  • id integer required

    The user id

  • ]
Responses

groupSchema

Schema
  • id integer

    The group id

  • name string required

    The name of the group

  • description string nullable

    A custom description of the group

  • mappingsSSO string[]

    A list of SSO groups that should map to this Unleash group

  • rootRole number nullable

    A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.

  • createdBy string nullable

    A user who created this group

  • createdAt date-time nullable

    When was this group created

  • users object[]

    A list of users belonging to this group

  • Array [
  • joinedAt date-time

    The date when the user joined the group

  • createdBy string nullable

    The username of the user who added this user to this group

  • user objectrequired

    An Unleash user

  • id integer required

    The user id

  • isAPI boolean deprecated

    Deprecated in v5. Used internally to know which operations the user should be allowed to perform

  • name string nullable

    Name of the user

  • email string

    Email of the user

  • username string nullable

    A unique username for the user

  • imageUrl string

    URL used for the user profile image

  • inviteLink string

    If the user is actively inviting other users, this is the link that can be shared with other users

  • loginAttempts integer

    How many unsuccessful attempts at logging in has the user made

  • emailSent boolean

    Is the welcome email sent to the user or not

  • rootRole integer

    Which root role this user is assigned

  • seenAt date-time nullable

    The last time this user logged in

  • createdAt date-time

    The user was created at this time

  • accountType string

    A user is either an actual User or a Service Account

  • permissions string[]

    Deprecated

  • scimId string nullable

    The SCIM ID of the user, only present if managed by SCIM

  • ]
  • projects string[]

    A list of projects where this group is used

  • userCount integer

    The number of users that belong to this group

  • scimId string nullable

    The SCIM ID of the group, only present if managed by SCIM

Loading...