Gleanex.Client.Authentication (Gleanex v0.1.0)

Copy Markdown View Source

Provides API endpoints related to authentication

Summary

Functions

Check datasource authorization

Create authentication token

Functions

checkdatasourceauth(opts \\ [])

@spec checkdatasourceauth(opts :: keyword()) ::
  {:ok, Gleanex.Client.CheckDatasourceAuthResponse.t()}
  | {:error, Gleanex.Error.t()}

Check datasource authorization

Returns all datasource instances that require per-user OAuth authorization for the authenticated user, along with a transient auth token that can be appended to auth URLs to complete OAuth flows.

Clients construct the full OAuth URL by combining the backend base URL, the authUrlRelativePath from each instance, and the transient auth token: <backend>/<authUrlRelativePath>?transient_auth_token=<token>.

createauthtoken(opts \\ [])

@spec createauthtoken(opts :: keyword()) ::
  {:ok, Gleanex.Client.CreateAuthTokenResponse.t()}
  | {:error, Gleanex.Error.t()}

Create authentication token

Creates an authentication token for the authenticated user. These are specifically intended to be used with the Web SDK.

Note: The tokens generated from this endpoint are not valid tokens for use with the Client API (e.g. /rest/api/v1/*).