Update Console general access

PATCH

/api/workspaces/{workspaceId}/consoles/{id}/sharing

const url = 'http://localhost:8080/api/workspaces/example/consoles/example/sharing';
const options = {
  method: 'PATCH',
  headers: {cookie: 'auth_session=<auth_session>', 'Content-Type': 'application/json'},
  body: '{"access":"private","workspaceRole":"viewer"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url http://localhost:8080/api/workspaces/example/consoles/example/sharing \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "access": "private", "workspaceRole": "viewer" }'

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

workspaceId

required

string

required

string

Request Body

application/json

object

access

string

Allowed values: private workspace

workspaceRole

string

Allowed values: viewer editor

Responses

2XX

Successful response

application/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}