The highest tagged major version is v2.

auth

package

v1.26.0 Latest Latest Go to latest Published: Dec 2, 2022 License: Apache-2.0 Imports: 3 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SSHcom/privx-sdk-go

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Auth ¶ added in v0.6.0

type Auth struct {
	// contains filtered or unexported fields
}

Auth is a auth client instance.

func New ¶

func New(api restapi.Connector) *Auth

New creates a new auth client instance, using the argument SDK API client.

func (*Auth) AuthStatus ¶ added in v0.6.0

func (store *Auth) AuthStatus() (*ServiceStatus, error)

AuthStatus get microservice status

func (*Auth) CreateIdpClient ¶ added in v1.26.0

func (store *Auth) CreateIdpClient(idpClient *IDPClient) (IDstruct, error)

CreateIdpClient creates a new identity provider client configuration.

func (*Auth) DeleteIdpClient ¶ added in v1.26.0

func (store *Auth) DeleteIdpClient(idpID string) error

DeleteIdpClient delete identity provider client configuration by ID.

func (*Auth) IdpClient ¶ added in v1.26.0

func (store *Auth) IdpClient(idpID string) (*IDPClient, error)

IdpClient fetches existing identity provider client configuration.

func (*Auth) RegenerateIdpClientConfig ¶ added in v1.26.0

func (store *Auth) RegenerateIdpClientConfig(idpID string) (*IdpClientConfig, error)

RegenerateIdpClientConfig regenerates client_id and client_secret for OIDC identity provider client configuration.

func (*Auth) UpdateIdpClient ¶ added in v1.26.0

func (store *Auth) UpdateIdpClient(idpClient *IDPClient, idpID string) error

UpdateIdpClient updates existing identity provider client configuration definition.

type IDPClient ¶ added in v1.26.0

type IDPClient struct {
	ID                             string            `json:"id"`
	Name                           string            `json:"name"`
	Created                        time.Time         `json:"created,omitempty"`
	Updated                        time.Time         `json:"updated,omitempty"`
	IDPType                        string            `json:"idp_type"`
	OIDCIssuer                     string            `json:"oidc_issuer,omitempty"`
	OIDCAudience                   []string          `json:"oidc_audience"`
	OIDCClientID                   string            `json:"oidc_client_id,omitempty"`
	OIDCClientSecret               string            `json:"oidc_client_secret,omitempty"`
	OIDCScopesEnabled              []string          `json:"oidc_scopes_enabled"`
	OIDCResponseTypesSupported     []string          `json:"oidc_response_types_supported,omitempty"`
	OIDCGrantTypesSupported        []string          `json:"oidc_grant_types_supported,omitempty"`
	OIDCEnablePKCE                 bool              `json:"oidc_code_challenge_method_enabled,omitempty"`
	OIDCEnabledAuthMethod          string            `json:"oidc_auth_method_enabled,omitempty"`
	OIDCAuthMethodPost             bool              `json:"oidc_auth_method_post,omitempty"`
	OIDCGrantTypeRefreshToken      bool              `json:"oidc_grant_type_refresh_token,omitempty"`
	OIDCAllowedRedirectURIs        []string          `json:"oidc_allowed_redirect_uris,omitempty"`
	OIDCDefaultLogoutRedirectURI   string            `json:"oidc_default_logout_redirect_uri,omitempty"`
	OIDCAllowedLogoutRedirectURIs  []string          `json:"oidc_allowed_logout_redirect_uris,omitempty"`
	OIDCAttributeMapping           map[string]string `json:"oidc_attribute_mapping,omitempty"`
	OIDCSignatureAlgorithm         string            `json:"oidc_signature_algorithm,omitempty"`
	OIDCAccessTokenValidInMinutes  int               `json:"oidc_access_token_valid_in_minutes,omitempty"`
	OIDCRefreshTokenValidInMinutes int               `json:"oidc_refresh_token_valid_in_minutes,omitempty"`
	UserFilter                     string            `json:"user_filter,omitempty"`
	Enabled                        bool              `json:"enabled"`
}

IDPClient idp client definition

type IDPClientsResult ¶ added in v1.26.0

type IDPClientsResult struct {
	Count int         `json:"count"`
	Items []IDPClient `json:"items"`
}

IDPClientsResult idp client list result definition

type IDstruct ¶ added in v1.26.0

type IDstruct struct {
	ID string `json:"id"`
}

type IdpClientConfig ¶ added in v1.26.0

type IdpClientConfig struct {
	ClientId     string `json:"client_id"`
	ClientSecret string `json:"client_secret"`
}

IdpClientConfig config definition with client_id and client_secret

type KeyValue ¶ added in v0.6.0

type KeyValue struct {
	Key   string `json:"k"`
	Value string `json:"v"`
}

KeyValue key value definition

type ServiceStatus ¶ added in v0.6.0

type ServiceStatus struct {
	Variant       string     `json:"variant,omitempty"`
	Version       string     `json:"version,omitempty"`
	APIVersion    string     `json:"api_version,omitempty"`
	Status        string     `json:"status,omitempty"`
	StatusMessage string     `json:"status_message,omitempty"`
	ApplicationID string     `json:"app_id,omitempty"`
	ServerMode    string     `json:"server-mode,omitempty"`
	StatusDetails []KeyValue `json:"status_details,omitempty"`
	StartTime     time.Time  `json:"start_time,omitempty"`
}

ServiceStatus auth service status definition

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL