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.

PUT /v1beta1/organizations/:orgId/groups/:id

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
orgId — path required
id — path required
Body required
{

  "name": "string",

  "title": "string",

  "metadata": {}

}
curl / cURL
curl -L -X PUT 'http://127.0.0.1:7400/v1beta1/organizations/:orgId/groups/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "title": "string",
  "metadata": {}
}'