Set API key workspace permissions

put

https://api.lingohub.com/v2/api-keys/{apiKeyId}/workspace-permissions

Replaces all fourteen configured workspace levels of an active workspace-managed WORKSPACE or USER key. Billing subscription and workspaces must remain NO_ACCESS; granting either returns 403. STACK keys have fixed workspace permissions and return 403, as do user-owned or inactive targets. Default stack permissions, every stack's own permissions, credentials, name, description, expiry and ownership remain unchanged. Equal normalized levels write nothing. Optional If-Match uses getWorkspaceApiKeyPermissionConfiguration's validator under the key lock, with current authorization rechecked after waits. The full configuration response omits ETag; GET it again for the next validator. Self-reduction applies to subsequent requests. Foreign/missing keys return 404. Requires workspace-level API access management permission.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

apiKeyId

string

required

^api_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For an API key, a valid value would be : api_0197c8f2-5a6b-7cde-8f12-3456789abcde

Body Params

Request body to replace all fourteen configured workspace permission levels of an active workspace-managed WORKSPACE or USER key. Every level is required. Billing subscription and workspaces must remain NO_ACCESS.

billing_subscription

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

workspaces

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

members

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

plugins_integrations

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

logs

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

api_access

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

stacks

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

translation_orders

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

work_reports

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

style_guides

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

glossaries

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

translation_memories

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

labels

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

ai_translation

string

enum

required

Configurable API-key permission level. WRITE is exclusive to Quick Translation, which API keys cannot use.

Allowed:

Headers

If-Match

string

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json