Semaphor

Update a group

Updates a group's name or description. Only include the fields you want to change. Set description to null to clear it.

PATCH
/api/management/v1/groups/{groupId}

Authorization

BearerAuth
AuthorizationBearer <token>

A project-scoped access token. Generate one via the Token API with your project ID and project secret.

In: header

Path Parameters

groupId*string

The group's unique identifier.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X patch "https://semaphor.cloud/api/management/v1/groups/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "ORG_GROUP",
  "organizationId": "string",
  "tenantId": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "memberCount": 0,
  "permissions": {
    "canEdit": true,
    "canDelete": true,
    "canManageMembers": true
  },
  "members": [
    {
      "id": "string",
      "groupId": "string",
      "orgUserId": "string",
      "tenantUserId": "string",
      "addedBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "orgUser": {
        "id": "string",
        "name": "string",
        "email": "user@example.com"
      },
      "tenantUser": {
        "id": "string",
        "name": "string",
        "email": "user@example.com"
      }
    }
  ],
  "sharedResources": {
    "count": 0
  }
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string",
  "code": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}