Skip to content

Place a user group in a workspace of the same tenant, or clear its place with an empty workspace_id; membership and authorization are unchanged

PUT
/v1/groups/{id}/workspace
curl --request PUT \
--url https://example.com/v1/groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/workspace \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "workspace_id": "example" }'

Places or moves a user group in a workspace of the same tenant; an explicit empty workspace_id clears placement. Requires an unconfined admin. Membership, role mapping and group hierarchy are unchanged. Business edition: a Community build answers 501 departments_unavailable.

id
required
string format: uuid

Resource identifier (UUIDv7).

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
object
workspace_id
required

The workspace of the same tenant; an empty string clears the place.

string
Example generated
{
"workspace_id": "example"
}

OK

Media type application/json
object
display_name
required
string
id
required
string format: uuid
workspace_id
required

The workspace’s id; empty when the group is unplaced.

string
Example generated
{
"display_name": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"workspace_id": "example"
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}