Skip to main content

Get Workspace Settings

GET 
/api/workspaces/:id/settings/

Returns the workspace app version settings.

Request​

Path Parameters

    id integerrequired

    A unique integer value identifying this workspace.

Responses​

Schema

    uses_privileged_api booleanrequired

    Specifies whether the app version makes use of the PrivilegedAPI to bypass user management restrictions.

    welcome_text string

    Welcome text to be displayed on the workspace dashboard.

    sdk_version

    object

    required

    Specifies the VIKTOR SDK version with which the app version was built.

    complete string

    Possible values: non-empty

    The complete version of the SDK.

    major integer

    The major version of the SDK.

    minor integer

    The minor version of the SDK.

    patch integer

    The patch version of the SDK.

    pre string

    Possible values: non-empty

    Specifies the pre-release version name. In case of stable release, this value is null.

    app_type string

    Shows the application type. It can be one of tree,simple,editor

    required_oauth2_integrations

    object[]

  • Array [

    • id integer
    name stringrequired

    Possible values: non-empty and <= 256 characters

    A unique name for this OAuth2 integration within the organization

    identity_provider stringrequired

    Possible values: [generic, aps, databricks]

    The type of identity provider (Generic, APS, or Databricks)

    created_by

    object

    The user that created the integration.

    id integer
    name string
    first_name string

    Possible values: non-empty

    last_name string

    Possible values: non-empty

    email email

    Possible values: non-empty

  • ]

Loading...