Skip to content
Olivares AI docs

List the tenant's provisioned groups with their mapped roles and member counts — the operator's view of what the IdP pushed and what each group confers

GET
/v1/groups
 
curl --request GET \
  --url https://example.com/v1/groups \
  --header 'Authorization: Bearer <token>'

Lists the tenant’s provisioned groups with their mapped roles and member counts: the operator’s view of what the IdP pushed and what each group confers, including the effective-role provenance an admin needs when a member’s direct and acting roles differ.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “ Header Parameters ”
X-Olivares-Tenant
string format: uuid

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

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
groups
required
Array<object>
object
display_name
required
string
external_id

The group’s id in the provisioning IdP.

string
id
required
string format: uuid
mapped_role
required

The role the group’s members are elevated to; empty when unmapped.

string
members
required

The group’s member count.

integer
parent_group_id
required

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

string
provisioned_by
string
workspace_id
required

The workspace where the group is placed; empty when unplaced or concealed from a workspace-confined caller.

string
Example generated 
{
  "groups": [
    {
      "display_name": "example",
      "external_id": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "mapped_role": "example",
      "members": 1,
      "parent_group_id": "example",
      "provisioned_by": "example",
      "workspace_id": "example"
    }
  ]
}

400

Section titled “ 400 ”

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"
  }
}

401

Section titled “ 401 ”

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"
  }
}

403

Section titled “ 403 ”

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"
  }
}

404

Section titled “ 404 ”

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"
  }
}

409

Section titled “ 409 ”

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"
  }
}

429

Section titled “ 429 ”

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"
  }
}