Skip to main content

Update group​

Update group

Path Parameters
    orgId string required

    The organization ID to which the group belongs to.

    id string required
Request Body required
    name string required

    The name of the group. The name must be unique within the entire Frontier instance. The name can contain only alphanumeric characters, dashes and underscores.

    title string

    The title can contain any UTF-8 character, used to provide a human-readable name for the group. Can also be left empty.

    metadata object

    Metadata object for groups that can hold key value pairs defined in Group Metaschema. The metadata object can be used to store arbitrary information about the group such as labels, descriptions etc. The default Group Metaschema contains labels and descripton fields. Update the Group Metaschema to add more fields.
    Example:{"labels": {"key": "value"}, "description": "Group description"}

Responses

A successful response.

Schema
    group object
    id string
    name string
    title string
    orgId string
    metadata object
    createdAt date-time

    The time the group was created.

    updatedAt date-time

    The time the group was last updated.

    users object[]
  • Array [
    • id string
    name can either be empty or must start with a character

    Unique name of the user.

    title string

    Name of the user.

    email string
    metadata object
    createdAt date-time

    The time the user was created.

    updatedAt date-time

    The time the user was last updated.

    state string

    The state of the user (enabled or disabled).

    avatar string

    The base64 encoded image string of the user avatar. Should be less than 2MB.

  • ]
Loading...