Get company details

{ "id": 123, "name": "<string>", "allow_company_admins_to_manage_sso": true, "created_at": "2023-11-07T05:31:56Z", "dpo_email": "jsmith@example.com", "max_users": -1, "auto_provision_external_users": true, "storage_limit_company_ws": -1, "storage_limit_personal_ws": -1, "storage_limit_custom_ws": -1, "login_method": "password", "min_password_length": 16383, "max_password_length": 16383, "kg_tags_enabled": true, "kg_summaries_enabled": true, "kg_queries_enabled": true, "tier": "free", "is_telemetry_enabled": true, "is_telemetry_ids_allowed": true }

{ "id": null, "code": 403, "error": "insufficient_permissions", "detail": "You do not have permission to perform this action.", "doc_url": "https://developers.lighton.ai/errors#insufficient_permissions" }

{ "detail": "System is under maintenance.", "error": "service_maintenance", "mode": "full_shutdown", "reason": "<string>", "started_at": "2023-11-07T05:31:56Z", "endpoint_category_names": [ "<string>" ] }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Response

Company details

Serializer for detailed company view

integer

required

read-only

name

string

required

The name of the company registered in the instance.

Maximum string length: 255

allow_company_admins_to_manage_sso

boolean

required

If the company admins of this company can create & manage their SSO configuration.

created_at

string<date-time>

required

read-only

dpo_email

string<email> | null

Contact email displayed in user profiles for data privacy inquiries.

Maximum string length: 254

max_users

integer

Maximum allowed active users for this company license.

Required range: -2147483648 <= x <= 2147483647

auto_provision_external_users

boolean

Automatically create user accounts when users log in via external auth (SSO/LDAP) for the first time.

storage_limit_company_ws

integer | null

Total storage ceiling for all workspace uploads combined (personal + all shared workspaces), in MB. Leave blank to use the default value. Use 0 to disable uploads.

Required range: -2147483648 <= x <= 2147483647

storage_limit_personal_ws

integer | null

Limit for all combined personal workspaces in this company, in MB. Leave blank to use the default value. Use 0 to disable uploads.

Required range: -2147483648 <= x <= 2147483647

storage_limit_custom_ws

integer | null

Limit for all combined shared workspaces in this company (including the company workspace), in MB. Leave blank to use the default value. Use 0 to disable uploads.

Required range: -2147483648 <= x <= 2147483647

Authentication method(s) allowed for users in this company.

password - Password
sso - Single Sign On
ldap - LDAP

Available options:

password,

sso,

ldap

min_password_length

integer | null

Minimum password length for users in this company. Leave blank to use the platform default (8 characters).

Required range: 0 <= x <= 32767

max_password_length

integer | null

Maximum password length for users in this company. Leave blank to use the platform default (128 characters).

Required range: 0 <= x <= 32767

kg_tags_enabled

boolean

Enable automatic document tagging using Knowledge Graph. Disabling this prevents token consumption for LLM-based tagging. Global setting must also be enabled.

kg_summaries_enabled

boolean

Enable automatic document summarization using Knowledge Graph. Disabling this prevents token consumption for LLM-based summaries. Global setting must also be enabled.

kg_queries_enabled

boolean

Enable automatic query suggestion generation using Knowledge Graph. Disabling this prevents token consumption for LLM-based query suggestions. Global setting must also be enabled.

tier

enum<string>

Commercial tier for this company. Drives entitlements and billing posture.

free - Free
pay-as-you-go - Pay-as-you-go
business - Business

Available options:

free,

pay-as-you-go,

business

is_telemetry_enabled

boolean

If technical telemetry is enabled for this company. No user data is collected.

is_telemetry_ids_allowed

boolean

Include company and user IDs in telemetry. Allows telemetry to be more useful for troubleshooting.

Usage

Models

Workspaces

Users

User Groups

Companies

Authorizations

Path Parameters

Response