Groups

Modify Group or Team

Modify an existing org group or team.

patch/Groups/{id}

Request

  • Base URL
    https://users.lucid.app/scim/v2
  • URL
    https://users.lucid.app/scim/v2/Groups/{id}
  • Auth
    HTTP bearer

Parameters

#/paths/~1Groups~1{id}/get/parameters/0 (unresolved $ref)
#/paths/~1Groups/get/parameters/3 (unresolved $ref)
#/paths/~1Groups/get/parameters/4 (unresolved $ref)

Request body

schemasstring[]

URIs identifying the SCIM schemas that describe this resource's attributes.

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "members"
    }
  ]
}

Response

OK. Returns the modified group or team.

idstring

Will be in the form "lucid-group-1234" with 1234 being the ID of the Lucid org group or team.

schemasstring[]

URIs identifying the SCIM schemas that describe this resource's attributes.

displayNamestring

The name of the org group or team.

metaobject

Example response

{
  "id": "lucid-group-1234",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Group A",
  "members": [
    {
      "value": "lucid-1433",
      "display": "User 1"
    },
    {
      "value": "lucid-5678",
      "display": "User 2"
    },
    {
      "value": "lucid-group-9012",
      "display": "Subgroup A"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.