Back to Hydra

OAuth2LoginRequest

internal/httpclient/docs/OAuth2LoginRequest.md

26.2.08.2 KB
Original Source

OAuth2LoginRequest

Properties

NameTypeDescriptionNotes
ChallengestringID is the identifier of the login request.
ClientOAuth2Client
OidcContextPointer to OAuth2ConsentRequestOpenIDConnectContext[optional]
RequestUrlstringRequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
RequestedAccessTokenAudiencePointer to []string[optional]
RequestedScopePointer to []string[optional]
SessionIdPointer to stringSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.[optional]
SkipboolSkip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.
SubjectstringSubject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type when accepting the login request, or the request will fail.

Methods

NewOAuth2LoginRequest

func NewOAuth2LoginRequest(challenge string, client OAuth2Client, requestUrl string, skip bool, subject string, ) *OAuth2LoginRequest

NewOAuth2LoginRequest instantiates a new OAuth2LoginRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewOAuth2LoginRequestWithDefaults

func NewOAuth2LoginRequestWithDefaults() *OAuth2LoginRequest

NewOAuth2LoginRequestWithDefaults instantiates a new OAuth2LoginRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetChallenge

func (o *OAuth2LoginRequest) GetChallenge() string

GetChallenge returns the Challenge field if non-nil, zero value otherwise.

GetChallengeOk

func (o *OAuth2LoginRequest) GetChallengeOk() (*string, bool)

GetChallengeOk returns a tuple with the Challenge field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetChallenge

func (o *OAuth2LoginRequest) SetChallenge(v string)

SetChallenge sets Challenge field to given value.

GetClient

func (o *OAuth2LoginRequest) GetClient() OAuth2Client

GetClient returns the Client field if non-nil, zero value otherwise.

GetClientOk

func (o *OAuth2LoginRequest) GetClientOk() (*OAuth2Client, bool)

GetClientOk returns a tuple with the Client field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetClient

func (o *OAuth2LoginRequest) SetClient(v OAuth2Client)

SetClient sets Client field to given value.

GetOidcContext

func (o *OAuth2LoginRequest) GetOidcContext() OAuth2ConsentRequestOpenIDConnectContext

GetOidcContext returns the OidcContext field if non-nil, zero value otherwise.

GetOidcContextOk

func (o *OAuth2LoginRequest) GetOidcContextOk() (*OAuth2ConsentRequestOpenIDConnectContext, bool)

GetOidcContextOk returns a tuple with the OidcContext field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOidcContext

func (o *OAuth2LoginRequest) SetOidcContext(v OAuth2ConsentRequestOpenIDConnectContext)

SetOidcContext sets OidcContext field to given value.

HasOidcContext

func (o *OAuth2LoginRequest) HasOidcContext() bool

HasOidcContext returns a boolean if a field has been set.

GetRequestUrl

func (o *OAuth2LoginRequest) GetRequestUrl() string

GetRequestUrl returns the RequestUrl field if non-nil, zero value otherwise.

GetRequestUrlOk

func (o *OAuth2LoginRequest) GetRequestUrlOk() (*string, bool)

GetRequestUrlOk returns a tuple with the RequestUrl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRequestUrl

func (o *OAuth2LoginRequest) SetRequestUrl(v string)

SetRequestUrl sets RequestUrl field to given value.

GetRequestedAccessTokenAudience

func (o *OAuth2LoginRequest) GetRequestedAccessTokenAudience() []string

GetRequestedAccessTokenAudience returns the RequestedAccessTokenAudience field if non-nil, zero value otherwise.

GetRequestedAccessTokenAudienceOk

func (o *OAuth2LoginRequest) GetRequestedAccessTokenAudienceOk() (*[]string, bool)

GetRequestedAccessTokenAudienceOk returns a tuple with the RequestedAccessTokenAudience field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRequestedAccessTokenAudience

func (o *OAuth2LoginRequest) SetRequestedAccessTokenAudience(v []string)

SetRequestedAccessTokenAudience sets RequestedAccessTokenAudience field to given value.

HasRequestedAccessTokenAudience

func (o *OAuth2LoginRequest) HasRequestedAccessTokenAudience() bool

HasRequestedAccessTokenAudience returns a boolean if a field has been set.

GetRequestedScope

func (o *OAuth2LoginRequest) GetRequestedScope() []string

GetRequestedScope returns the RequestedScope field if non-nil, zero value otherwise.

GetRequestedScopeOk

func (o *OAuth2LoginRequest) GetRequestedScopeOk() (*[]string, bool)

GetRequestedScopeOk returns a tuple with the RequestedScope field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRequestedScope

func (o *OAuth2LoginRequest) SetRequestedScope(v []string)

SetRequestedScope sets RequestedScope field to given value.

HasRequestedScope

func (o *OAuth2LoginRequest) HasRequestedScope() bool

HasRequestedScope returns a boolean if a field has been set.

GetSessionId

func (o *OAuth2LoginRequest) GetSessionId() string

GetSessionId returns the SessionId field if non-nil, zero value otherwise.

GetSessionIdOk

func (o *OAuth2LoginRequest) GetSessionIdOk() (*string, bool)

GetSessionIdOk returns a tuple with the SessionId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSessionId

func (o *OAuth2LoginRequest) SetSessionId(v string)

SetSessionId sets SessionId field to given value.

HasSessionId

func (o *OAuth2LoginRequest) HasSessionId() bool

HasSessionId returns a boolean if a field has been set.

GetSkip

func (o *OAuth2LoginRequest) GetSkip() bool

GetSkip returns the Skip field if non-nil, zero value otherwise.

GetSkipOk

func (o *OAuth2LoginRequest) GetSkipOk() (*bool, bool)

GetSkipOk returns a tuple with the Skip field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSkip

func (o *OAuth2LoginRequest) SetSkip(v bool)

SetSkip sets Skip field to given value.

GetSubject

func (o *OAuth2LoginRequest) GetSubject() string

GetSubject returns the Subject field if non-nil, zero value otherwise.

GetSubjectOk

func (o *OAuth2LoginRequest) GetSubjectOk() (*string, bool)

GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSubject

func (o *OAuth2LoginRequest) SetSubject(v string)

SetSubject sets Subject field to given value.

[Back to Model list] [Back to API list] [Back to README]