Skip to content

README.md

Latest commit

 

History

History
98 lines (61 loc) · 3.92 KB

README.md

File metadata and controls

98 lines (61 loc) · 3.92 KB
Raw

Client.Authentication

Overview

Available Operations

check_datasource_auth

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>.

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as glean:

    res = glean.client.authentication.check_datasource_auth()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CheckDatasourceAuthResponse

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*

create_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/*).

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as glean:

    res = glean.client.authentication.create_token()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CreateAuthTokenResponse

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*