Skip to main content
PATCH
/
api
/
v3
/
companies
/
{id}
Partially update a company (PATCH)
curl --request PATCH \
  --url https://paradigm.lighton.ai/api/v3/companies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "dpo_email": "jsmith@example.com",
  "max_users": 123,
  "allow_company_admins_to_manage_sso": true,
  "auto_provision_sso_users": true,
  "storage_limit_company_ws": 123,
  "storage_limit_personal_ws": 123,
  "storage_limit_custom_ws": 123
}
'
{
  "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_sso_users": true,
  "storage_limit_company_ws": -1,
  "storage_limit_personal_ws": -1,
  "storage_limit_custom_ws": -1,
  "login_method": "password"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

Body

​
name
string

Company name

​
dpo_email
string<email> | null

DPO contact email

​
max_users
integer | null

Maximum allowed active users for this company

​
allow_company_admins_to_manage_sso
boolean

Whether company admins can manage SSO configuration

​
auto_provision_sso_users
boolean

Automatically create user accounts when users log in via SSO for the first time.

​
storage_limit_company_ws
integer | null

Company workspace storage limit in MB

​
storage_limit_personal_ws
integer | null

Personal workspace storage limit in MB

​
storage_limit_custom_ws
integer | null

Custom workspace storage limit in MB

Response

Company updated successfully

Serializer for detailed company view

​
id
integer
required
​
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
​
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_sso_users
boolean

Automatically create user accounts when users log in via SSO for the first time.

​
storage_limit_company_ws
integer | null

Company workspace storage limit 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

Personal workspace storage limit 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

Custom workspace storage limit in MB. Leave blank to use the default value. Use 0 to disable uploads.

Required range: -2147483648 <= x <= 2147483647
​
login_method
enum<string>

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

  • password - Password
  • sso - Single Sign On
  • password_and_sso - Password & SSO
Available options:
password,
sso,
password_and_sso