authentication_request

Documentation

Index

• Variables
• func New(authorizationEndpoint string, scope []string, ...) (*url.URL, error)
• type Option
  • func WithACRValues(acrValues []string) Option
  • func WithAccessType(accessType string) Option
  • func WithCodeChallengeForPKCE(codeVerifier pkce.CodeVerifier, codeChallengeMethod pkce.CodeChallengeMethod) Option
  • func WithDisplay(display string) Option
  • func WithIDTokenHint(idTokenHint string) Option
  • func WithLoginHint(loginHint string) Option
  • func WithMaxAge(maxAge int64) Option
  • func WithNonce(nonce string) Option
  • func WithPrompt(prompt string) Option
  • func WithResponseMode(responseMode string) Option
  • func WithUILocales(uiLocales []string) Option

Variables

var ErrParameterIsEmpty = errors.New("openid: Authentication Request: parameter is empty")

Functions

func New

func New(authorizationEndpoint string, scope []string, responseType, clientID, redirectURI, state string, opts ...Option) (*url.URL, error)

New returns URL for redirect response to User-Agent.

• authorization_endpoint: ref. https://openid.net/specs/openid-connect-discovery-1_0.html#:~:text=from%20this%20Issuer.-,authorization_endpoint,-REQUIRED.%20URL%20of
• scope: ref. https://openid.net/specs/openid-connect-core-1_0.html#:~:text=Authorization%20Code%20Flow%3A-,scope,-REQUIRED.%20OpenID%20Connect
• response_type: ref. https://openid.net/specs/openid-connect-core-1_0.html#:~:text=by%20this%20specification.-,response_type,-REQUIRED.%20OAuth%202.0
• client_id: ref. https://openid.net/specs/openid-connect-core-1_0.html#:~:text=value%20is%20code.-,client_id,-REQUIRED.%20OAuth%202.0%20Client
• redirect_uri: ref. https://openid.net/specs/openid-connect-core-1_0.html#:~:text=the%20Authorization%20Server.-,redirect_uri,-REQUIRED.%20Redirection%20URI
• state: ref. https://openid.net/specs/openid-connect-core-1_0.html#:~:text=a%20native%20application.-,state,-RECOMMENDED.%20Opaque%20value

Types

type Option

type Option func(*option)

func WithACRValues

func WithACRValues(acrValues []string) Option

WithACRValues

• acr_values: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=the%20OP%27s%20discretion.-,acr_values,-OPTIONAL.%20Requested%20Authentication

func WithAccessType

func WithAccessType(accessType string) Option

WithAccessType

• access_type: ref. https://developers.google.com/identity/protocols/oauth2/web-server#request-parameter-access_type

func WithCodeChallengeForPKCE

func WithCodeChallengeForPKCE(codeVerifier pkce.CodeVerifier, codeChallengeMethod pkce.CodeChallengeMethod) Option

WithCodeChallengeForPKCE

• code_challenge: REQUIRED. Code challenge. ref. https://www.rfc-editor.org/rfc/rfc7636#:~:text=following%20additional%20parameters%3A-,code_challenge,-REQUIRED.%20%20Code%20challenge
• code_challenge_method: OPTIONAL, defaults to "plain" if not present in the request. Code verifier transformation method is "S256" or "plain". ref. https://www.rfc-editor.org/rfc/rfc7636#:~:text=REQUIRED.%20%20Code%20challenge.-,code_challenge_method,-OPTIONAL

func WithDisplay

func WithDisplay(display string) Option

WithDisplay

• display: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=Section%C2%A015.5.2.-,display,-OPTIONAL.%20ASCII%20string

func WithIDTokenHint

func WithIDTokenHint(idTokenHint string) Option

WithIDTokenHint

• id_token_hint: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=the%20OpenID%20Provider.-,id_token_hint,-OPTIONAL.%20ID%20Token

func WithLoginHint

func WithLoginHint(loginHint string) Option

WithLoginHint

- login_hint: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=the%20id_token_hint%20value.-,login_hint,-OPTIONAL.%20Hint%20to

func WithMaxAge

func WithMaxAge(maxAge int64) Option

WithMaxAge

• max_age: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=error%20is%20returned.-,max_age,-OPTIONAL.%20Maximum%20Authentication

func WithNonce

func WithNonce(nonce string) Option

WithNonce

• nonce: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=following%20request%20parameters%3A-,nonce,-OPTIONAL.%20String%20value

func WithPrompt

func WithPrompt(prompt string) Option

WithPrompt

• prompt: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=an%20appropriate%20display.-,prompt,-OPTIONAL.%20Space%20delimited

func WithResponseMode

func WithResponseMode(responseMode string) Option

WithResponseMode

• response_mode: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=%5BOAuth.Responses%5D%3A-,response_mode,-OPTIONAL.%20Informs%20the

func WithUILocales

func WithUILocales(uiLocales []string) Option

WithUILocales

• ui_locales: ref: https://openid.net/specs/openid-connect-core-1_0.html#:~:text=auth_time%20Claim%20Value.-,ui_locales,-OPTIONAL.%20End%2DUser%27s