Skip to content
Olivares AI docs

List the resolved tenant's member roster (role, workspace scoping, groups)

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

Lists the members of the resolved tenant with the effective role, workspace scoping and directory groups of each.

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
cursor
string
has_more
required
boolean
items
required
Array<object>
object
display_name
string
email
required
string
external_id
string
groups
Array<string>
role
required
string
Allowed values: viewer editor admin owner
sso_only
required
boolean
status
required
string
Allowed values: active inactive error
user_id
required
string format: uuid
workspace_ids
Array<string>
Example 
{
  "items": [
    {
      "role": "viewer",
      "status": "active"
    }
  ]
}

400

Section titled “400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Section titled “409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Section titled “429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}