Skip to content

Latest commit

 

History

History
24 lines (14 loc) · 1.24 KB

File metadata and controls

24 lines (14 loc) · 1.24 KB

SubKeyUpdate

A restricted key to update. All the editable fields are replaced: an omitted permissions, company_ids or cors_origins means none.

Properties

Name Type Description Notes
description String Human-readable label, e.g. the name of the tenant the key is for.
active Boolean Whether the key can authenticate. Defaults to true. [optional]
permissions Permissions [optional]
companyIds List<Integer> Companies the key can access. When omitted or empty, the key can access all the companies of the account, including the ones created later. [optional]
corsOrigins List<String> Browser origins allowed to call the API with this key (CORS), e.g. `https://app.example.com&#x60; or `*.example.com`. A key used from a browser is public: keep its permissions and companies minimal. [optional]
id Integer Id of the restricted key to update. [optional]
version Integer Row version read with the key, for optimistic concurrency: a stale version fails with 422. [optional]

Implemented Interfaces

  • Serializable