Tools

Get end-user authentication status for a tool server.

Changed on

Returns display information and the calling user's current authentication status for the specified tool server.

get/rest/api/v1/tool-servers/{serverId}/auth

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/tool-servers/{serverId}/auth
  • Auth: HTTP bearer

Response

Successful operation

displayNamestring

Human-readable name of the tool server.

logoUrlstring

Logo URL for the tool server.

descriptionstring

Brief description of the tool server.

authStatus'AWAITING_AUTH' | 'AUTHORIZED' required

Authentication status for the calling user.

authType'AUTH_USER_OAUTH' | 'AUTH_ADMIN' | 'AUTH_NONE' required

Authentication mechanism used by an action pack.

  • AUTH_USER_OAUTH: Requires per-user OAuth consent to the third-party tool.
  • AUTH_ADMIN: Uses a service-account / admin-owned credential. End users do not authorize individually.
  • AUTH_NONE: Action pack requires no authentication.

Changes