Skip to content

Nest (or, with an empty parent_id, un-nest) a group under another group of the same tenant; a member of the child is then also a member of the parent for authorization (409 on a cycle)

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

Nests (or, with an empty parent_id, un-nests) a group under another group of the same tenant: a member of the child is then also a member of the parent for authorization, so a scoped grant on the parent reaches the child’s members. Requires owner authority; a cycle is a 409. Operator-only, never SCIM. 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
parent_id
required

The parent group; an empty string un-nests the group.

string format: uuid
Example generated
{
"parent_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

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

The parent group’s id; empty when the group is top-level.

string
Example generated
{
"display_name": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"parent_group_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"
}
}