curl --request GET \
--url https://cloud.onyx.app/api/manage/admin/user-group \
--header 'Authorization: Bearer <token>'
[
{
"id": 123,
"name": "<string>",
"users": [
{
"id": "<string>",
"email": "<string>",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"role": "limited",
"preferences": {
"chosen_assistants": [
123
],
"hidden_assistants": [],
"visible_assistants": [],
"default_model": "<string>",
"pinned_assistants": [
123
],
"shortcut_enabled": true,
"auto_scroll": true,
"temperature_override_enabled": true
},
"oidc_expiry": "2023-11-07T05:31:56Z",
"current_token_created_at": "2023-11-07T05:31:56Z",
"current_token_expiry_length": 123,
"is_cloud_superuser": false,
"team_name": "<string>",
"is_anonymous_user": true,
"password_configured": true,
"tenant_info": {
"invitation": {
"tenant_id": "<string>",
"number_of_users": 123
},
"new_tenant": {
"tenant_id": "<string>",
"number_of_users": 123
}
}
}
],
"curator_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cc_pairs": [
{
"id": 123,
"name": "<string>",
"connector": {
"name": "<string>",
"source": "ingestion_api",
"input_type": "load_state",
"connector_specific_config": {},
"refresh_freq": 123,
"prune_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z",
"id": 123,
"credential_ids": [
123
],
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z"
},
"credential": {
"credential_json": {},
"admin_public": true,
"source": "ingestion_api",
"name": "<string>",
"curator_public": true,
"groups": [
123
],
"is_user_file": true,
"id": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "<string>",
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z"
},
"access_type": "public"
}
],
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_descriptors": [
{
"id": 123,
"name": "<string>",
"connector": {
"name": "<string>",
"source": "ingestion_api",
"input_type": "load_state",
"connector_specific_config": {},
"refresh_freq": 123,
"prune_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z",
"id": 123,
"credential_ids": [
123
],
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z"
},
"credential": {
"credential_json": {},
"admin_public": true,
"source": "ingestion_api",
"name": "<string>",
"curator_public": true,
"groups": [
123
],
"is_user_file": true,
"id": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "<string>",
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z"
},
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"federated_connectors": [
{
"id": 123,
"name": "<string>",
"source": "<string>",
"entities": {}
}
]
}
],
"personas": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"is_public": true,
"is_visible": true,
"icon_shape": 123,
"icon_color": "<string>",
"uploaded_image_id": "<string>",
"user_file_ids": [
123
],
"user_folder_ids": [
123
],
"display_priority": 123,
"is_default_persona": true,
"builtin_persona": true,
"starter_messages": [
{
"name": "<string>",
"message": "<string>"
}
],
"tools": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<any>"
],
"passthrough_auth": true
}
],
"labels": [
{
"id": 123,
"name": "<string>"
}
],
"owner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
},
"users": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
}
],
"groups": [
123
],
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_summaries": [
{
"id": 123,
"name": "<string>",
"source": "ingestion_api",
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"federated_connector_summaries": [
{
"id": 123,
"name": "<string>",
"source": "federated_slack",
"entities": {}
}
]
}
],
"llm_model_provider_override": "<string>",
"llm_model_version_override": "<string>",
"num_chunks": 123
}
],
"is_up_to_date": true,
"is_up_for_deletion": true
}
]
curl --request GET \
--url https://cloud.onyx.app/api/manage/admin/user-group \
--header 'Authorization: Bearer <token>'
[
{
"id": 123,
"name": "<string>",
"users": [
{
"id": "<string>",
"email": "<string>",
"is_active": true,
"is_superuser": true,
"is_verified": true,
"role": "limited",
"preferences": {
"chosen_assistants": [
123
],
"hidden_assistants": [],
"visible_assistants": [],
"default_model": "<string>",
"pinned_assistants": [
123
],
"shortcut_enabled": true,
"auto_scroll": true,
"temperature_override_enabled": true
},
"oidc_expiry": "2023-11-07T05:31:56Z",
"current_token_created_at": "2023-11-07T05:31:56Z",
"current_token_expiry_length": 123,
"is_cloud_superuser": false,
"team_name": "<string>",
"is_anonymous_user": true,
"password_configured": true,
"tenant_info": {
"invitation": {
"tenant_id": "<string>",
"number_of_users": 123
},
"new_tenant": {
"tenant_id": "<string>",
"number_of_users": 123
}
}
}
],
"curator_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cc_pairs": [
{
"id": 123,
"name": "<string>",
"connector": {
"name": "<string>",
"source": "ingestion_api",
"input_type": "load_state",
"connector_specific_config": {},
"refresh_freq": 123,
"prune_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z",
"id": 123,
"credential_ids": [
123
],
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z"
},
"credential": {
"credential_json": {},
"admin_public": true,
"source": "ingestion_api",
"name": "<string>",
"curator_public": true,
"groups": [
123
],
"is_user_file": true,
"id": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "<string>",
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z"
},
"access_type": "public"
}
],
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_descriptors": [
{
"id": 123,
"name": "<string>",
"connector": {
"name": "<string>",
"source": "ingestion_api",
"input_type": "load_state",
"connector_specific_config": {},
"refresh_freq": 123,
"prune_freq": 123,
"indexing_start": "2023-11-07T05:31:56Z",
"id": 123,
"credential_ids": [
123
],
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z"
},
"credential": {
"credential_json": {},
"admin_public": true,
"source": "ingestion_api",
"name": "<string>",
"curator_public": true,
"groups": [
123
],
"is_user_file": true,
"id": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "<string>",
"time_created": "2023-11-07T05:31:56Z",
"time_updated": "2023-11-07T05:31:56Z"
},
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"federated_connectors": [
{
"id": 123,
"name": "<string>",
"source": "<string>",
"entities": {}
}
]
}
],
"personas": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"is_public": true,
"is_visible": true,
"icon_shape": 123,
"icon_color": "<string>",
"uploaded_image_id": "<string>",
"user_file_ids": [
123
],
"user_folder_ids": [
123
],
"display_priority": 123,
"is_default_persona": true,
"builtin_persona": true,
"starter_messages": [
{
"name": "<string>",
"message": "<string>"
}
],
"tools": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<any>"
],
"passthrough_auth": true
}
],
"labels": [
{
"id": 123,
"name": "<string>"
}
],
"owner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
},
"users": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
}
],
"groups": [
123
],
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_summaries": [
{
"id": 123,
"name": "<string>",
"source": "ingestion_api",
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"federated_connector_summaries": [
{
"id": 123,
"name": "<string>",
"source": "federated_slack",
"entities": {}
}
]
}
],
"llm_model_provider_override": "<string>",
"llm_model_version_override": "<string>",
"num_chunks": 123
}
],
"is_up_to_date": true,
"is_up_for_deletion": true
}
]
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Successful Response
The response is of type UserGroup · object[]
.
Was this page helpful?