Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 4.59 KB

File metadata and controls

122 lines (87 loc) · 4.59 KB

Client.Authentication

Overview

Available Operations

CheckDatasourceAuth

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

package main

import(
	"context"
	"os"
	apiclientgo "github.com/gleanwork/api-client-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := apiclientgo.New(
        apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
    )

    res, err := s.Client.Authentication.CheckDatasourceAuth(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.CheckDatasourceAuthResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
opts []operations.Option The options for this request.

Response

*operations.CheckdatasourceauthResponse, error

Errors

Error Type Status Code Content Type
apierrors.APIError 4XX, 5XX */*

CreateToken

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

package main

import(
	"context"
	"os"
	apiclientgo "github.com/gleanwork/api-client-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := apiclientgo.New(
        apiclientgo.WithSecurity(os.Getenv("GLEAN_API_TOKEN")),
    )

    res, err := s.Client.Authentication.CreateToken(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.CreateAuthTokenResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
opts []operations.Option The options for this request.

Response

*operations.CreateauthtokenResponse, error

Errors

Error Type Status Code Content Type
apierrors.APIError 4XX, 5XX */*