endpoints

Documentation

Index

• Constants
• func PingOneEndpoint(host string) oauth2.Endpoint
• func PingOneEnvironmentEndpoint(rootDomain, environmentID string) oauth2.Endpoint
• type ExtendedEndpoint
  • func PingOneEnvironmentExtendedEndpoint(rootDomain, environmentID string) ExtendedEndpoint
  • func PingOneExtendedEndpoint(host string) ExtendedEndpoint

Constants

const (
	AuthURLPath            = "/as/authorize"
	DeviceAuthURLPath      = "/as/device_authorization"
	IntrospectionURLPath   = "/as/introspect"
	IssuerURLPath          = "/as"
	JWKSURLPath            = "/as/jwks"
	PARURLPath             = "/as/par"
	TokenRevocationURLPath = "/as/revoke"
	TokenURLPath           = "/as/token"
)

Functions

func PingOneEndpoint

func PingOneEndpoint(host string) oauth2.Endpoint

PingOneEndpoint returns a new oauth2.Endpoint object for the given custom domain configured on the PingOne environment.

The host parameter should be the custom domain, with the subdomain (if required), but without the protocol (e.g., "bxretail.org" or "auth.bxretail.org").

func PingOneEnvironmentEndpoint

func PingOneEnvironmentEndpoint(rootDomain, environmentID string) oauth2.Endpoint

PingOneEnvironmentEndpoint returns a new oauth2.Endpoint object when not using a custom domain in a PingOne environment. The endpoints are constructed using the root domain and environment ID, which result in the URL format: https://auth.<rootDomain>/<environmentID>/<endpoint path>.

The rootDomain parameter should be a valid PingOne top level domain that applies to the region of the PingOne tenant (e.g., "pingone.com" or "pingone.eu"). Root domains with leading `.` are also supported (e.g., ".pingone.com" or ".pingone.eu").

The environmentID parameter should be a valid PingOne environment ID.

Types

type ExtendedEndpoint

type ExtendedEndpoint struct {
	oauth2.Endpoint
	IntrospectionURL   string
	IssuerURLPath      string
	JWKSURL            string
	PARURL             string
	TokenRevocationURL string
}

func PingOneEnvironmentExtendedEndpoint

func PingOneEnvironmentExtendedEndpoint(rootDomain, environmentID string) ExtendedEndpoint

PingOneEnvironmentExtendedEndpoint returns a new ExtendedEndpoint object when not using a custom domain in a PingOne environment. The endpoints are constructed using the root domain and environment ID, which result in the URL format: https://auth.<rootDomain>/<environmentID>/<endpoint path>.

The rootDomain parameter should be a valid PingOne root domain that applies to the region of the PingOne tenant (e.g., "pingone.com" or "pingone.eu"). Top level domains with leading `.` are also supported (e.g., ".pingone.com" or ".pingone.eu").

The environmentID parameter should be a valid PingOne environment ID.

func PingOneExtendedEndpoint

func PingOneExtendedEndpoint(host string) ExtendedEndpoint

PingOneExtendedEndpoint returns a new ExtendedEndpoint object for the given custom domain configured on the PingOne environment.

The host parameter should be the custom domain, with the subdomain (if required), but without the protocol (e.g., "bxretail.org" or "auth.bxretail.org").