Categorygithub.com/workos/workos-go/v2pkgsso
package
2.4.2
Repository: https://github.com/workos/workos-go.git
Documentation: pkg.go.dev
Overview
Versions
4
Dependencies
13
Dependents
2
Files
554 SLOC

# README

sso

Go Report Card

A go package to request WorkOS SSO API.

Install

go get -u github.com/workos/workos-go/v2/pkg/sso

How it works

See the SSO integration guide.

# Functions

Configure configures the default client that is used by GetAuthorizationURL, GetProfileAndToken and Login.
DeleteConnection deletes a Connection.
GetAuthorizationURL returns an authorization url generated with the given options.
GetConnection gets a Connection.
GetProfile returns a profile describing the user that authenticated with WorkOS SSO.
GetProfileAndToken returns a profile describing the user that authenticated with WorkOS SSO.
ListConnections gets a list of existing Connections.
Login returns a http.Handler that redirects client to the appropriate login provider.

# Constants

Constants that enumerate a Connection's possible states.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available orders.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available orders.
Constants that enumerate a Connection's possible states.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate a Connection's possible states.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available Connection's linked statuses.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
ResponseLimit is the default number of records to limit a response to.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available connection types.
Constants that enumerate the available Connection's linked statuses.
Constants that enumerate a Connection's possible states.
Constants that enumerate the available connection types.

# Variables

DefaultClient is the client used by GetAuthorizationURL, GetProfileAndToken and Login functions.

# Structs

Client represents a client that fetch SSO data from WorkOS API.
Connection represents a Connection record.
ConnectionDomain represents the domain records associated with a Connection.
DeleteConnectionOpts contains the options to delete a Connection.
GetAuthorizationURLOpts contains the options to pass in order to generate an authorization url.
GetConnectionOpts contains the options to request details for a Connection.
GetProfileAndTokenOpts contains the options to pass in order to get a user profile and access token.
GetProfile contains the options to pass in order to get a user profile.
ListConnectionsOpts contains the options to request a list of Connections.
ListConnectionsResponse describes the response structure when requesting existing Connections.
Profile contains information about an authenticated user.
No description provided by the author

# Type aliases

ConnectionState indicates whether a Connection is able to authenticate users.
ConnectionStatus represents a Connection's linked status.
ConnectionType represents a connection type.
Order represents the order of records.