Read public client configuration

curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/publicclientconfig \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "themeKeys": [
    "<string>"
  ],
  "boolKeys": [
    "<string>"
  ],
  "integerKeys": [
    "<string>"
  ]
}'

{
  "assistant": {
    "chatBannerText": "<string>",
    "chatBoxDisclaimer": "<string>",
    "chatLinkUrlTemplate": "<string>",
    "chatStarterHeader": "<string>",
    "chatStarterSubheader": "<string>",
    "agentClientConfigs": [
      {
        "agentConfig": {
          "agent": "DEFAULT",
          "mode": "DEFAULT"
        },
        "inputCharLimit": 123
      }
    ],
    "redlistedDatasources": [
      "<string>"
    ],
    "greenlistedDatasourceInstances": [
      "<string>"
    ],
    "gptAgentEnabled": true,
    "fileUpload": {
      "enabled": true,
      "maxFileCount": 123,
      "maxFileSize": 123,
      "uploadTimeoutSeconds": 123
    },
    "chatHistoryEnabled": true,
    "chatGuideUrl": "<string>",
    "promptsEnabled": true,
    "defaultUserCanSharePrompts": true,
    "defaultUserCanShareAgents": true,
    "fileUploadEnabled": true,
    "webSearch": {
      "enabled": true,
      "actionInstanceId": "<string>"
    },
    "chatBarV3Enabled": true,
    "chatBarPlaceholderText": "<string>",
    "agentMigrationStatuses": {
      "advancedPromptsMigrationStatus": "NOT_STARTED"
    }
  },
  "tools": {
    "availableTools": [
      {
        "type": "RETRIEVAL",
        "name": "<string>",
        "displayName": "<string>",
        "toolId": "<string>",
        "displayDescription": "<string>",
        "logoUrl": "<string>",
        "objectName": [
          "HR ticket",
          "Email",
          "Chat message"
        ],
        "knowledgeType": "NEUTRAL_KNOWLEDGE",
        "createdBy": {
          "name": "<string>",
          "obfuscatedId": "<string>"
        },
        "lastUpdatedBy": {
          "name": "<string>",
          "obfuscatedId": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "lastUpdatedAt": "2023-11-07T05:31:56Z",
        "writeActionType": "REDIRECT",
        "authType": "NONE",
        "auth": {
          "isOnPrem": true,
          "usesCentralAuth": true,
          "type": "NONE",
          "grantType": "AUTH_CODE",
          "status": "AWAITING_AUTH",
          "client_url": "<string>",
          "scopes": [
            "<string>"
          ],
          "audiences": [
            "<string>"
          ],
          "authorization_url": "<string>",
          "lastAuthorizedAt": "2023-11-07T05:31:56Z"
        },
        "permissions": {
          "write": {
            "scopeType": "GLOBAL",
            "create": true,
            "update": true,
            "delete": true
          }
        },
        "usageInstructions": "<string>",
        "isSetupFinished": true
      }
    ]
  },
  "shortcuts": {
    "shortcutsPrefix": "<string>",
    "useExternalShortcuts": true
  },
  "search": {
    "available": true,
    "placeholder": "<string>"
  },
  "feedPeopleCelebrationsEnabled": true,
  "feedSuggestedEnabled": true,
  "feedTrendingEnabled": true,
  "feedRecentsEnabled": true,
  "feedMentionsEnabled": true,
  "gptAgentEnabled": true,
  "chatHistoryEnabled": true,
  "boolValues": {},
  "integerValues": {
    "autocompleteDebounceMs": 300,
    "retries": 3
  },
  "companyDisplayName": "<string>",
  "customSerpMarkdown": "<string>",
  "onboardingQuery": "<string>",
  "isOrgChartLinkVisible": true,
  "isOrgChartAccessible": true,
  "isPeopleSetup": true,
  "isPilotMode": true,
  "webAppUrl": "<string>",
  "userOutreach": {
    "weeklyFeedEmailEnabled": true,
    "onboardingCampaignEnabled": true
  },
  "searchLinkUrlTemplate": "<string>",
  "chatLinkUrlTemplate": "<string>",
  "themes": {
    "light": {
      "background": "#fafafa",
      "textPrimary": "#1e1e1e"
    },
    "dark": {
      "background": "#1e1e1e",
      "textPrimary": "#fafafa"
    }
  },
  "brandings": {
    "light": {
      "companyBackgroundImageName": "<string>",
      "companyMobileBackgroundImageName": "<string>",
      "companyLogoUrl": "<string>",
      "companyWideLogoUrl": "<string>",
      "companyLogoBackgroundColor": "<string>"
    },
    "dark": {
      "companyBackgroundImageName": "<string>",
      "companyMobileBackgroundImageName": "<string>",
      "companyLogoUrl": "<string>",
      "companyWideLogoUrl": "<string>",
      "companyLogoBackgroundColor": "<string>"
    },
    "productTerms": {
      "Assistant": {
        "displayName": "<string>",
        "localizations": {}
      },
      "GleanAssistant": {
        "displayName": "<string>",
        "localizations": {}
      },
      "PublicKnowledge": {
        "displayName": "<string>",
        "localizations": {}
      }
    }
  },
  "greetingFormat": "\\%t, \\%n (This would be the current default Glean greeting)",
  "taskSeeAllLabel": "<string>",
  "taskSeeAllLink": "<string>",
  "searchPlaceholder": "<string>",
  "shortcutsPrefix": "<string>",
  "ssoCompanyProvider": "gsuite",
  "showPipelinesSetupBanner": true,
  "feedbackCustomizations": {
    "defaultChannels": [
      "GLEAN_CHANNEL"
    ],
    "featureChannels": {},
    "disclaimer": "<string>",
    "companyPrivacyPolicyLink": "<string>",
    "supportMessage": "<string>",
    "supportLinkText": "<string>",
    "supportLink": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

X-Scio-Actas

string

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

X-Glean-Auth-Type

string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

Body

application/json

Public Config request

Will only send back publicly available config and will ignore other keys

themeKeys

string[]

A list of theme keys to include in the response.

boolKeys

string[]

A list of boolean flag keys to include in the response.

integerKeys

string[]

A list of integer flag keys to include in the response.

Response

200

application/json

Configuration settings for a specific client deployment that are not related to any particular datasource

assistant

object

Configuration settings specific to Assistant features

assistant.chatBannerText

string

Disclaimer message to be displayed as a banner on top of chat. This could be in markdown format with "\n" between each line.

assistant.chatBoxDisclaimer

string

Disclaimer message to be displayed below the chat box. This could be in markdown format.

assistant.chatLinkUrlTemplate

string

The URL to use for outbound links to Glean Chat. Defaults to {webAppUrl}/chat.

assistant.chatStarterHeader

string

Label for the chat header during initial state.

assistant.chatStarterSubheader

string

Label for the chat subheader during initial state.

assistant.agentClientConfigs

object[]

Describes the configurations that GleanChat has based on an AgentConfig.

assistant.redlistedDatasources

string[]

A list of datasources that are disabled in Chat

assistant.greenlistedDatasourceInstances

string[]

A list of datasources that are always visible in Chat

assistant.gptAgentEnabled

boolean

Whether the GPT agent (general mode) for Chat is enabled

assistant.fileUpload

object

Configuration settings for the chat file upload feature

assistant.chatHistoryEnabled

boolean

Whether the chat history for Chat is enabled for the deployment

assistant.chatGuideUrl

string

Redirect URL for "Chat guide" in the default chat starter subheader

assistant.promptsEnabled

boolean

Whether prompt templates feature are enabled for the deployment.

Whether a default user can share prompts to the prompt library.

Whether a default user can share agents to the agent library.

assistant.fileUploadEnabled

boolean

deprecated

Whether file upload for Chat is enabled for the deployment

assistant.webSearch

object

Configuration settings related to web search

assistant.chatBarV3Enabled

boolean

Whether admin has enabled Chat Bar V3 for the deployment. This shall eventually go away when we launch Chat Bar V3 to all customers.

assistant.chatBarPlaceholderText

string

Placeholder text for the chat bar

assistant.agentMigrationStatuses

object

tools

object

deprecated

Configuration settings related to Tools.

tools.availableTools

object[]

List of tools available to the user.

The manifest for a tool that can be used to augment Glean Assistant.

tools.availableTools.type

enum<string>

required

The type of tool.

Available options:

RETRIEVAL,

ACTION

tools.availableTools.name

string

required

Unique identifier for the tool. Name should be understandable by the LLM, and will be used to invoke a tool.

tools.availableTools.displayName

string

required

Human understandable name of the tool. Max 50 characters.

tools.availableTools.displayDescription

string

required

Description of the tool meant for a human.

tools.availableTools.toolId

string

An opaque id which is unique identifier for the tool.

tools.availableTools.logoUrl

string

URL used to fetch the logo.

tools.availableTools.objectName

string

Name of the generated object. This will be used to indicate to the end user what the generated object contains.

Example:

["HR ticket", "Email", "Chat message"]

tools.availableTools.knowledgeType

enum<string>

Indicates the kind of knowledge a tool would access or modify.

Available options:

NEUTRAL_KNOWLEDGE,

COMPANY_KNOWLEDGE,

WORLD_KNOWLEDGE

tools.availableTools.createdBy

object

tools.availableTools.lastUpdatedBy

object

tools.availableTools.createdAt

string

The time the tool was created in ISO format (ISO 8601)

tools.availableTools.lastUpdatedAt

string

The time the tool was last updated in ISO format (ISO 8601)

tools.availableTools.writeActionType

enum<string>

Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.

Available options:

REDIRECT,

EXECUTION

tools.availableTools.authType

enum<string>

The type of authentication being used. Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. 'OAUTH_USER' uses individual user tokens for external API calls. 'DWD' refers to domain wide delegation.

Available options:

NONE,

OAUTH_USER,

OAUTH_ADMIN,

API_KEY,

BASIC_AUTH,

DWD

tools.availableTools.auth

object

Config for tool's authentication method.

tools.availableTools.permissions

object

tools.availableTools.usageInstructions

string

Usage instructions for the LLM to use this action.

tools.availableTools.isSetupFinished

boolean

Whether this action has been fully configured and validated.

shortcuts

object

Configuration settings related to Shortcuts

object

Configuration settings related to Search

feedPeopleCelebrationsEnabled

boolean

Whether people celebrations is enabled or not for the instance

feedSuggestedEnabled

boolean

Whether the suggested feed is enabled

Whether the trending feed is enabled

feedRecentsEnabled

boolean

Whether the recents feed is enabled

feedMentionsEnabled

boolean

Whether the mentions feed is enabled

gptAgentEnabled

boolean

deprecated

Whether the GPT agent for Chat is enabled

chatHistoryEnabled

boolean

deprecated

Whether the chat history for Chat is enabled

boolValues

object

A map of {string, boolean} pairs representing flags that globally guard conditional features. Omitted flags mean the client should use its default state.

integerValues

object

A map of {string, integer} pairs for client consumption.

Example:

{
  "autocompleteDebounceMs": 300,
  "retries": 3
}

companyDisplayName

string

The user-facing name of the company owning the deployment

customSerpMarkdown

string

A markdown string to be displayed on the search results page. Useful for outlinks to help pages.

onboardingQuery

string

A demonstrative query to show during new user onboarding

isOrgChartLinkVisible

boolean

Determines whether the org chart link in the Directory panel is visible to all users.

isOrgChartAccessible

boolean

Determines whether the org chart is accessible to all users, regardless of link visibility. Org chart can be accessible even if the org chart link in Directory is not visible.

isPeopleSetup

boolean

Whether or not people data has been set up.

isPilotMode

boolean

Whether or not the deployment is in pilot mode.

webAppUrl

string

URL the company uses to access the web app

userOutreach

object

searchLinkUrlTemplate

string

The URL to use for outbound links to Glean Search. Defaults to {webAppUrl}/search?q=%s.

chatLinkUrlTemplate

string

deprecated

The URL to use for outbound links to Glean Chat. Defaults to {webAppUrl}/chat.

themes

object

A set of Theme objects to make available to the user based on their chosen preference. If a theme variant is not supplied, the default theme will be used.

themes.light

object

A map of {string, string} pairs where the key represents a known theme option and the value is the CSS color to apply. Supported options are documented in https://dev.glean.com/meta/browser_api/interfaces/Theme.html.

Example:

{
  "background": "#fafafa",
  "textPrimary": "#1e1e1e"
}

themes.dark

object

Example:

{
  "background": "#fafafa",
  "textPrimary": "#1e1e1e"
}

Example:

{
  "light": {
    "background": "#fafafa",
    "textPrimary": "#1e1e1e"
  },
  "dark": {
    "background": "#1e1e1e",
    "textPrimary": "#fafafa"
  }
}

brandings

object

Branding customizations applicable to the current user, such as custom company logos and background images for light and dark mode or company-specific product terminology.

brandings.light

object

A map of visual aspects of the app such as the company background image, logos, logo background colors, and wide company logos.

brandings.dark

object

A map of visual aspects of the app such as the company background image, logos, logo background colors, and wide company logos.

brandings.productTerms

object

Mapping of product terms to the term's description. These product terms should match their counterpart in productTerms.json

greetingFormat

string

Describes how to format the web app greeting. Possible format options include %t - timely greeting %n - the user's first name

Example:

"\\%t, \\%n (This would be the current default Glean greeting)"

taskSeeAllLabel

string

Label for the external link at the end of the Task card in order to guide user to the source.

taskSeeAllLink

string

Link used in conjunction with taskSeeAllLabel to redirect user to the task's source.

searchPlaceholder

string

deprecated

Custom autocomplete box placeholder to replace rotating prompts. Deprecated for search.placeholder

shortcutsPrefix

string

deprecated

Company-wide custom prefix for Go Links.

ssoCompanyProvider

enum<string>

SSO provider used by the company

Available options:

gsuite,

iap,

okta,

okta_saml,

ping,

azure,

onelogin,

onelogin_saml

showPipelinesSetupBanner

boolean

whether to show the running ML pipelines banner

feedbackCustomizations

object

Was this page helpful?

Suggest edits Raise issue

Delete credentialsDelete a user's credentials. Used for Confluence restricted pages and Tableau per-user auth, for example

curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/publicclientconfig \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "themeKeys": [
    "<string>"
  ],
  "boolKeys": [
    "<string>"
  ],
  "integerKeys": [
    "<string>"
  ]
}'

{
  "assistant": {
    "chatBannerText": "<string>",
    "chatBoxDisclaimer": "<string>",
    "chatLinkUrlTemplate": "<string>",
    "chatStarterHeader": "<string>",
    "chatStarterSubheader": "<string>",
    "agentClientConfigs": [
      {
        "agentConfig": {
          "agent": "DEFAULT",
          "mode": "DEFAULT"
        },
        "inputCharLimit": 123
      }
    ],
    "redlistedDatasources": [
      "<string>"
    ],
    "greenlistedDatasourceInstances": [
      "<string>"
    ],
    "gptAgentEnabled": true,
    "fileUpload": {
      "enabled": true,
      "maxFileCount": 123,
      "maxFileSize": 123,
      "uploadTimeoutSeconds": 123
    },
    "chatHistoryEnabled": true,
    "chatGuideUrl": "<string>",
    "promptsEnabled": true,
    "defaultUserCanSharePrompts": true,
    "defaultUserCanShareAgents": true,
    "fileUploadEnabled": true,
    "webSearch": {
      "enabled": true,
      "actionInstanceId": "<string>"
    },
    "chatBarV3Enabled": true,
    "chatBarPlaceholderText": "<string>",
    "agentMigrationStatuses": {
      "advancedPromptsMigrationStatus": "NOT_STARTED"
    }
  },
  "tools": {
    "availableTools": [
      {
        "type": "RETRIEVAL",
        "name": "<string>",
        "displayName": "<string>",
        "toolId": "<string>",
        "displayDescription": "<string>",
        "logoUrl": "<string>",
        "objectName": [
          "HR ticket",
          "Email",
          "Chat message"
        ],
        "knowledgeType": "NEUTRAL_KNOWLEDGE",
        "createdBy": {
          "name": "<string>",
          "obfuscatedId": "<string>"
        },
        "lastUpdatedBy": {
          "name": "<string>",
          "obfuscatedId": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "lastUpdatedAt": "2023-11-07T05:31:56Z",
        "writeActionType": "REDIRECT",
        "authType": "NONE",
        "auth": {
          "isOnPrem": true,
          "usesCentralAuth": true,
          "type": "NONE",
          "grantType": "AUTH_CODE",
          "status": "AWAITING_AUTH",
          "client_url": "<string>",
          "scopes": [
            "<string>"
          ],
          "audiences": [
            "<string>"
          ],
          "authorization_url": "<string>",
          "lastAuthorizedAt": "2023-11-07T05:31:56Z"
        },
        "permissions": {
          "write": {
            "scopeType": "GLOBAL",
            "create": true,
            "update": true,
            "delete": true
          }
        },
        "usageInstructions": "<string>",
        "isSetupFinished": true
      }
    ]
  },
  "shortcuts": {
    "shortcutsPrefix": "<string>",
    "useExternalShortcuts": true
  },
  "search": {
    "available": true,
    "placeholder": "<string>"
  },
  "feedPeopleCelebrationsEnabled": true,
  "feedSuggestedEnabled": true,
  "feedTrendingEnabled": true,
  "feedRecentsEnabled": true,
  "feedMentionsEnabled": true,
  "gptAgentEnabled": true,
  "chatHistoryEnabled": true,
  "boolValues": {},
  "integerValues": {
    "autocompleteDebounceMs": 300,
    "retries": 3
  },
  "companyDisplayName": "<string>",
  "customSerpMarkdown": "<string>",
  "onboardingQuery": "<string>",
  "isOrgChartLinkVisible": true,
  "isOrgChartAccessible": true,
  "isPeopleSetup": true,
  "isPilotMode": true,
  "webAppUrl": "<string>",
  "userOutreach": {
    "weeklyFeedEmailEnabled": true,
    "onboardingCampaignEnabled": true
  },
  "searchLinkUrlTemplate": "<string>",
  "chatLinkUrlTemplate": "<string>",
  "themes": {
    "light": {
      "background": "#fafafa",
      "textPrimary": "#1e1e1e"
    },
    "dark": {
      "background": "#1e1e1e",
      "textPrimary": "#fafafa"
    }
  },
  "brandings": {
    "light": {
      "companyBackgroundImageName": "<string>",
      "companyMobileBackgroundImageName": "<string>",
      "companyLogoUrl": "<string>",
      "companyWideLogoUrl": "<string>",
      "companyLogoBackgroundColor": "<string>"
    },
    "dark": {
      "companyBackgroundImageName": "<string>",
      "companyMobileBackgroundImageName": "<string>",
      "companyLogoUrl": "<string>",
      "companyWideLogoUrl": "<string>",
      "companyLogoBackgroundColor": "<string>"
    },
    "productTerms": {
      "Assistant": {
        "displayName": "<string>",
        "localizations": {}
      },
      "GleanAssistant": {
        "displayName": "<string>",
        "localizations": {}
      },
      "PublicKnowledge": {
        "displayName": "<string>",
        "localizations": {}
      }
    }
  },
  "greetingFormat": "\\%t, \\%n (This would be the current default Glean greeting)",
  "taskSeeAllLabel": "<string>",
  "taskSeeAllLink": "<string>",
  "searchPlaceholder": "<string>",
  "shortcutsPrefix": "<string>",
  "ssoCompanyProvider": "gsuite",
  "showPipelinesSetupBanner": true,
  "feedbackCustomizations": {
    "defaultChannels": [
      "GLEAN_CHANNEL"
    ],
    "featureChannels": {},
    "disclaimer": "<string>",
    "companyPrivacyPolicyLink": "<string>",
    "supportMessage": "<string>",
    "supportLinkText": "<string>",
    "supportLink": "<string>"
  }
}

Indexing API

Client API

Actions API

Authorizations

Headers

Body

Response