language
stringlengths 0
24
| filename
stringlengths 9
214
| code
stringlengths 99
9.93M
|
|---|---|---|
Go | hydra/internal/httpclient/model_o_auth2_redirect_to.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// OAuth2RedirectTo Contains a redirect URL used to complete a login, consent, or logout request.
type OAuth2RedirectTo struct {
// RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.
RedirectTo string `json:"redirect_to"`
}
// NewOAuth2RedirectTo instantiates a new OAuth2RedirectTo 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
func NewOAuth2RedirectTo(redirectTo string) *OAuth2RedirectTo {
this := OAuth2RedirectTo{}
this.RedirectTo = redirectTo
return &this
}
// NewOAuth2RedirectToWithDefaults instantiates a new OAuth2RedirectTo 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
func NewOAuth2RedirectToWithDefaults() *OAuth2RedirectTo {
this := OAuth2RedirectTo{}
return &this
}
// GetRedirectTo returns the RedirectTo field value
func (o *OAuth2RedirectTo) GetRedirectTo() string {
if o == nil {
var ret string
return ret
}
return o.RedirectTo
}
// GetRedirectToOk returns a tuple with the RedirectTo field value
// and a boolean to check if the value has been set.
func (o *OAuth2RedirectTo) GetRedirectToOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.RedirectTo, true
}
// SetRedirectTo sets field value
func (o *OAuth2RedirectTo) SetRedirectTo(v string) {
o.RedirectTo = v
}
func (o OAuth2RedirectTo) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if true {
toSerialize["redirect_to"] = o.RedirectTo
}
return json.Marshal(toSerialize)
}
type NullableOAuth2RedirectTo struct {
value *OAuth2RedirectTo
isSet bool
}
func (v NullableOAuth2RedirectTo) Get() *OAuth2RedirectTo {
return v.value
}
func (v *NullableOAuth2RedirectTo) Set(val *OAuth2RedirectTo) {
v.value = val
v.isSet = true
}
func (v NullableOAuth2RedirectTo) IsSet() bool {
return v.isSet
}
func (v *NullableOAuth2RedirectTo) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableOAuth2RedirectTo(val *OAuth2RedirectTo) *NullableOAuth2RedirectTo {
return &NullableOAuth2RedirectTo{value: val, isSet: true}
}
func (v NullableOAuth2RedirectTo) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableOAuth2RedirectTo) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_o_auth2_token_exchange.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// OAuth2TokenExchange OAuth2 Token Exchange Result
type OAuth2TokenExchange struct {
// The access token issued by the authorization server.
AccessToken *string `json:"access_token,omitempty"`
// The lifetime in seconds of the access token. For example, the value \"3600\" denotes that the access token will expire in one hour from the time the response was generated.
ExpiresIn *int64 `json:"expires_in,omitempty"`
// To retrieve a refresh token request the id_token scope.
IdToken *int64 `json:"id_token,omitempty"`
// The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope \"offline\" to your access token request.
RefreshToken *string `json:"refresh_token,omitempty"`
// The scope of the access token
Scope *string `json:"scope,omitempty"`
// The type of the token issued
TokenType *string `json:"token_type,omitempty"`
}
// NewOAuth2TokenExchange instantiates a new OAuth2TokenExchange 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
func NewOAuth2TokenExchange() *OAuth2TokenExchange {
this := OAuth2TokenExchange{}
return &this
}
// NewOAuth2TokenExchangeWithDefaults instantiates a new OAuth2TokenExchange 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
func NewOAuth2TokenExchangeWithDefaults() *OAuth2TokenExchange {
this := OAuth2TokenExchange{}
return &this
}
// GetAccessToken returns the AccessToken field value if set, zero value otherwise.
func (o *OAuth2TokenExchange) GetAccessToken() string {
if o == nil || o.AccessToken == nil {
var ret string
return ret
}
return *o.AccessToken
}
// GetAccessTokenOk returns a tuple with the AccessToken field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OAuth2TokenExchange) GetAccessTokenOk() (*string, bool) {
if o == nil || o.AccessToken == nil {
return nil, false
}
return o.AccessToken, true
}
// HasAccessToken returns a boolean if a field has been set.
func (o *OAuth2TokenExchange) HasAccessToken() bool {
if o != nil && o.AccessToken != nil {
return true
}
return false
}
// SetAccessToken gets a reference to the given string and assigns it to the AccessToken field.
func (o *OAuth2TokenExchange) SetAccessToken(v string) {
o.AccessToken = &v
}
// GetExpiresIn returns the ExpiresIn field value if set, zero value otherwise.
func (o *OAuth2TokenExchange) GetExpiresIn() int64 {
if o == nil || o.ExpiresIn == nil {
var ret int64
return ret
}
return *o.ExpiresIn
}
// GetExpiresInOk returns a tuple with the ExpiresIn field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OAuth2TokenExchange) GetExpiresInOk() (*int64, bool) {
if o == nil || o.ExpiresIn == nil {
return nil, false
}
return o.ExpiresIn, true
}
// HasExpiresIn returns a boolean if a field has been set.
func (o *OAuth2TokenExchange) HasExpiresIn() bool {
if o != nil && o.ExpiresIn != nil {
return true
}
return false
}
// SetExpiresIn gets a reference to the given int64 and assigns it to the ExpiresIn field.
func (o *OAuth2TokenExchange) SetExpiresIn(v int64) {
o.ExpiresIn = &v
}
// GetIdToken returns the IdToken field value if set, zero value otherwise.
func (o *OAuth2TokenExchange) GetIdToken() int64 {
if o == nil || o.IdToken == nil {
var ret int64
return ret
}
return *o.IdToken
}
// GetIdTokenOk returns a tuple with the IdToken field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OAuth2TokenExchange) GetIdTokenOk() (*int64, bool) {
if o == nil || o.IdToken == nil {
return nil, false
}
return o.IdToken, true
}
// HasIdToken returns a boolean if a field has been set.
func (o *OAuth2TokenExchange) HasIdToken() bool {
if o != nil && o.IdToken != nil {
return true
}
return false
}
// SetIdToken gets a reference to the given int64 and assigns it to the IdToken field.
func (o *OAuth2TokenExchange) SetIdToken(v int64) {
o.IdToken = &v
}
// GetRefreshToken returns the RefreshToken field value if set, zero value otherwise.
func (o *OAuth2TokenExchange) GetRefreshToken() string {
if o == nil || o.RefreshToken == nil {
var ret string
return ret
}
return *o.RefreshToken
}
// GetRefreshTokenOk returns a tuple with the RefreshToken field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OAuth2TokenExchange) GetRefreshTokenOk() (*string, bool) {
if o == nil || o.RefreshToken == nil {
return nil, false
}
return o.RefreshToken, true
}
// HasRefreshToken returns a boolean if a field has been set.
func (o *OAuth2TokenExchange) HasRefreshToken() bool {
if o != nil && o.RefreshToken != nil {
return true
}
return false
}
// SetRefreshToken gets a reference to the given string and assigns it to the RefreshToken field.
func (o *OAuth2TokenExchange) SetRefreshToken(v string) {
o.RefreshToken = &v
}
// GetScope returns the Scope field value if set, zero value otherwise.
func (o *OAuth2TokenExchange) GetScope() string {
if o == nil || o.Scope == nil {
var ret string
return ret
}
return *o.Scope
}
// GetScopeOk returns a tuple with the Scope field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OAuth2TokenExchange) GetScopeOk() (*string, bool) {
if o == nil || o.Scope == nil {
return nil, false
}
return o.Scope, true
}
// HasScope returns a boolean if a field has been set.
func (o *OAuth2TokenExchange) HasScope() bool {
if o != nil && o.Scope != nil {
return true
}
return false
}
// SetScope gets a reference to the given string and assigns it to the Scope field.
func (o *OAuth2TokenExchange) SetScope(v string) {
o.Scope = &v
}
// GetTokenType returns the TokenType field value if set, zero value otherwise.
func (o *OAuth2TokenExchange) GetTokenType() string {
if o == nil || o.TokenType == nil {
var ret string
return ret
}
return *o.TokenType
}
// GetTokenTypeOk returns a tuple with the TokenType field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OAuth2TokenExchange) GetTokenTypeOk() (*string, bool) {
if o == nil || o.TokenType == nil {
return nil, false
}
return o.TokenType, true
}
// HasTokenType returns a boolean if a field has been set.
func (o *OAuth2TokenExchange) HasTokenType() bool {
if o != nil && o.TokenType != nil {
return true
}
return false
}
// SetTokenType gets a reference to the given string and assigns it to the TokenType field.
func (o *OAuth2TokenExchange) SetTokenType(v string) {
o.TokenType = &v
}
func (o OAuth2TokenExchange) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.AccessToken != nil {
toSerialize["access_token"] = o.AccessToken
}
if o.ExpiresIn != nil {
toSerialize["expires_in"] = o.ExpiresIn
}
if o.IdToken != nil {
toSerialize["id_token"] = o.IdToken
}
if o.RefreshToken != nil {
toSerialize["refresh_token"] = o.RefreshToken
}
if o.Scope != nil {
toSerialize["scope"] = o.Scope
}
if o.TokenType != nil {
toSerialize["token_type"] = o.TokenType
}
return json.Marshal(toSerialize)
}
type NullableOAuth2TokenExchange struct {
value *OAuth2TokenExchange
isSet bool
}
func (v NullableOAuth2TokenExchange) Get() *OAuth2TokenExchange {
return v.value
}
func (v *NullableOAuth2TokenExchange) Set(val *OAuth2TokenExchange) {
v.value = val
v.isSet = true
}
func (v NullableOAuth2TokenExchange) IsSet() bool {
return v.isSet
}
func (v *NullableOAuth2TokenExchange) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableOAuth2TokenExchange(val *OAuth2TokenExchange) *NullableOAuth2TokenExchange {
return &NullableOAuth2TokenExchange{value: val, isSet: true}
}
func (v NullableOAuth2TokenExchange) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableOAuth2TokenExchange) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_pagination.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// Pagination struct for Pagination
type Pagination struct {
// Items per page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
PageSize *int64 `json:"page_size,omitempty"`
// Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
PageToken *string `json:"page_token,omitempty"`
}
// NewPagination instantiates a new Pagination 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
func NewPagination() *Pagination {
this := Pagination{}
var pageSize int64 = 250
this.PageSize = &pageSize
var pageToken string = "1"
this.PageToken = &pageToken
return &this
}
// NewPaginationWithDefaults instantiates a new Pagination 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
func NewPaginationWithDefaults() *Pagination {
this := Pagination{}
var pageSize int64 = 250
this.PageSize = &pageSize
var pageToken string = "1"
this.PageToken = &pageToken
return &this
}
// GetPageSize returns the PageSize field value if set, zero value otherwise.
func (o *Pagination) GetPageSize() int64 {
if o == nil || o.PageSize == nil {
var ret int64
return ret
}
return *o.PageSize
}
// GetPageSizeOk returns a tuple with the PageSize field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Pagination) GetPageSizeOk() (*int64, bool) {
if o == nil || o.PageSize == nil {
return nil, false
}
return o.PageSize, true
}
// HasPageSize returns a boolean if a field has been set.
func (o *Pagination) HasPageSize() bool {
if o != nil && o.PageSize != nil {
return true
}
return false
}
// SetPageSize gets a reference to the given int64 and assigns it to the PageSize field.
func (o *Pagination) SetPageSize(v int64) {
o.PageSize = &v
}
// GetPageToken returns the PageToken field value if set, zero value otherwise.
func (o *Pagination) GetPageToken() string {
if o == nil || o.PageToken == nil {
var ret string
return ret
}
return *o.PageToken
}
// GetPageTokenOk returns a tuple with the PageToken field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Pagination) GetPageTokenOk() (*string, bool) {
if o == nil || o.PageToken == nil {
return nil, false
}
return o.PageToken, true
}
// HasPageToken returns a boolean if a field has been set.
func (o *Pagination) HasPageToken() bool {
if o != nil && o.PageToken != nil {
return true
}
return false
}
// SetPageToken gets a reference to the given string and assigns it to the PageToken field.
func (o *Pagination) SetPageToken(v string) {
o.PageToken = &v
}
func (o Pagination) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.PageSize != nil {
toSerialize["page_size"] = o.PageSize
}
if o.PageToken != nil {
toSerialize["page_token"] = o.PageToken
}
return json.Marshal(toSerialize)
}
type NullablePagination struct {
value *Pagination
isSet bool
}
func (v NullablePagination) Get() *Pagination {
return v.value
}
func (v *NullablePagination) Set(val *Pagination) {
v.value = val
v.isSet = true
}
func (v NullablePagination) IsSet() bool {
return v.isSet
}
func (v *NullablePagination) Unset() {
v.value = nil
v.isSet = false
}
func NewNullablePagination(val *Pagination) *NullablePagination {
return &NullablePagination{value: val, isSet: true}
}
func (v NullablePagination) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullablePagination) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_pagination_headers.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// PaginationHeaders struct for PaginationHeaders
type PaginationHeaders struct {
// The link header contains pagination links. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). in: header
Link *string `json:"link,omitempty"`
// The total number of clients. in: header
XTotalCount *string `json:"x-total-count,omitempty"`
}
// NewPaginationHeaders instantiates a new PaginationHeaders 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
func NewPaginationHeaders() *PaginationHeaders {
this := PaginationHeaders{}
return &this
}
// NewPaginationHeadersWithDefaults instantiates a new PaginationHeaders 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
func NewPaginationHeadersWithDefaults() *PaginationHeaders {
this := PaginationHeaders{}
return &this
}
// GetLink returns the Link field value if set, zero value otherwise.
func (o *PaginationHeaders) GetLink() string {
if o == nil || o.Link == nil {
var ret string
return ret
}
return *o.Link
}
// GetLinkOk returns a tuple with the Link field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *PaginationHeaders) GetLinkOk() (*string, bool) {
if o == nil || o.Link == nil {
return nil, false
}
return o.Link, true
}
// HasLink returns a boolean if a field has been set.
func (o *PaginationHeaders) HasLink() bool {
if o != nil && o.Link != nil {
return true
}
return false
}
// SetLink gets a reference to the given string and assigns it to the Link field.
func (o *PaginationHeaders) SetLink(v string) {
o.Link = &v
}
// GetXTotalCount returns the XTotalCount field value if set, zero value otherwise.
func (o *PaginationHeaders) GetXTotalCount() string {
if o == nil || o.XTotalCount == nil {
var ret string
return ret
}
return *o.XTotalCount
}
// GetXTotalCountOk returns a tuple with the XTotalCount field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *PaginationHeaders) GetXTotalCountOk() (*string, bool) {
if o == nil || o.XTotalCount == nil {
return nil, false
}
return o.XTotalCount, true
}
// HasXTotalCount returns a boolean if a field has been set.
func (o *PaginationHeaders) HasXTotalCount() bool {
if o != nil && o.XTotalCount != nil {
return true
}
return false
}
// SetXTotalCount gets a reference to the given string and assigns it to the XTotalCount field.
func (o *PaginationHeaders) SetXTotalCount(v string) {
o.XTotalCount = &v
}
func (o PaginationHeaders) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Link != nil {
toSerialize["link"] = o.Link
}
if o.XTotalCount != nil {
toSerialize["x-total-count"] = o.XTotalCount
}
return json.Marshal(toSerialize)
}
type NullablePaginationHeaders struct {
value *PaginationHeaders
isSet bool
}
func (v NullablePaginationHeaders) Get() *PaginationHeaders {
return v.value
}
func (v *NullablePaginationHeaders) Set(val *PaginationHeaders) {
v.value = val
v.isSet = true
}
func (v NullablePaginationHeaders) IsSet() bool {
return v.isSet
}
func (v *NullablePaginationHeaders) Unset() {
v.value = nil
v.isSet = false
}
func NewNullablePaginationHeaders(val *PaginationHeaders) *NullablePaginationHeaders {
return &NullablePaginationHeaders{value: val, isSet: true}
}
func (v NullablePaginationHeaders) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullablePaginationHeaders) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_reject_o_auth2_request.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// RejectOAuth2Request struct for RejectOAuth2Request
type RejectOAuth2Request struct {
// The error should follow the OAuth2 error format (e.g. `invalid_request`, `login_required`). Defaults to `request_denied`.
Error *string `json:"error,omitempty"`
// Debug contains information to help resolve the problem as a developer. Usually not exposed to the public but only in the server logs.
ErrorDebug *string `json:"error_debug,omitempty"`
// Description of the error in a human readable format.
ErrorDescription *string `json:"error_description,omitempty"`
// Hint to help resolve the error.
ErrorHint *string `json:"error_hint,omitempty"`
// Represents the HTTP status code of the error (e.g. 401 or 403) Defaults to 400
StatusCode *int64 `json:"status_code,omitempty"`
}
// NewRejectOAuth2Request instantiates a new RejectOAuth2Request 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
func NewRejectOAuth2Request() *RejectOAuth2Request {
this := RejectOAuth2Request{}
return &this
}
// NewRejectOAuth2RequestWithDefaults instantiates a new RejectOAuth2Request 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
func NewRejectOAuth2RequestWithDefaults() *RejectOAuth2Request {
this := RejectOAuth2Request{}
return &this
}
// GetError returns the Error field value if set, zero value otherwise.
func (o *RejectOAuth2Request) GetError() string {
if o == nil || o.Error == nil {
var ret string
return ret
}
return *o.Error
}
// GetErrorOk returns a tuple with the Error field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RejectOAuth2Request) GetErrorOk() (*string, bool) {
if o == nil || o.Error == nil {
return nil, false
}
return o.Error, true
}
// HasError returns a boolean if a field has been set.
func (o *RejectOAuth2Request) HasError() bool {
if o != nil && o.Error != nil {
return true
}
return false
}
// SetError gets a reference to the given string and assigns it to the Error field.
func (o *RejectOAuth2Request) SetError(v string) {
o.Error = &v
}
// GetErrorDebug returns the ErrorDebug field value if set, zero value otherwise.
func (o *RejectOAuth2Request) GetErrorDebug() string {
if o == nil || o.ErrorDebug == nil {
var ret string
return ret
}
return *o.ErrorDebug
}
// GetErrorDebugOk returns a tuple with the ErrorDebug field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RejectOAuth2Request) GetErrorDebugOk() (*string, bool) {
if o == nil || o.ErrorDebug == nil {
return nil, false
}
return o.ErrorDebug, true
}
// HasErrorDebug returns a boolean if a field has been set.
func (o *RejectOAuth2Request) HasErrorDebug() bool {
if o != nil && o.ErrorDebug != nil {
return true
}
return false
}
// SetErrorDebug gets a reference to the given string and assigns it to the ErrorDebug field.
func (o *RejectOAuth2Request) SetErrorDebug(v string) {
o.ErrorDebug = &v
}
// GetErrorDescription returns the ErrorDescription field value if set, zero value otherwise.
func (o *RejectOAuth2Request) GetErrorDescription() string {
if o == nil || o.ErrorDescription == nil {
var ret string
return ret
}
return *o.ErrorDescription
}
// GetErrorDescriptionOk returns a tuple with the ErrorDescription field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RejectOAuth2Request) GetErrorDescriptionOk() (*string, bool) {
if o == nil || o.ErrorDescription == nil {
return nil, false
}
return o.ErrorDescription, true
}
// HasErrorDescription returns a boolean if a field has been set.
func (o *RejectOAuth2Request) HasErrorDescription() bool {
if o != nil && o.ErrorDescription != nil {
return true
}
return false
}
// SetErrorDescription gets a reference to the given string and assigns it to the ErrorDescription field.
func (o *RejectOAuth2Request) SetErrorDescription(v string) {
o.ErrorDescription = &v
}
// GetErrorHint returns the ErrorHint field value if set, zero value otherwise.
func (o *RejectOAuth2Request) GetErrorHint() string {
if o == nil || o.ErrorHint == nil {
var ret string
return ret
}
return *o.ErrorHint
}
// GetErrorHintOk returns a tuple with the ErrorHint field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RejectOAuth2Request) GetErrorHintOk() (*string, bool) {
if o == nil || o.ErrorHint == nil {
return nil, false
}
return o.ErrorHint, true
}
// HasErrorHint returns a boolean if a field has been set.
func (o *RejectOAuth2Request) HasErrorHint() bool {
if o != nil && o.ErrorHint != nil {
return true
}
return false
}
// SetErrorHint gets a reference to the given string and assigns it to the ErrorHint field.
func (o *RejectOAuth2Request) SetErrorHint(v string) {
o.ErrorHint = &v
}
// GetStatusCode returns the StatusCode field value if set, zero value otherwise.
func (o *RejectOAuth2Request) GetStatusCode() int64 {
if o == nil || o.StatusCode == nil {
var ret int64
return ret
}
return *o.StatusCode
}
// GetStatusCodeOk returns a tuple with the StatusCode field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RejectOAuth2Request) GetStatusCodeOk() (*int64, bool) {
if o == nil || o.StatusCode == nil {
return nil, false
}
return o.StatusCode, true
}
// HasStatusCode returns a boolean if a field has been set.
func (o *RejectOAuth2Request) HasStatusCode() bool {
if o != nil && o.StatusCode != nil {
return true
}
return false
}
// SetStatusCode gets a reference to the given int64 and assigns it to the StatusCode field.
func (o *RejectOAuth2Request) SetStatusCode(v int64) {
o.StatusCode = &v
}
func (o RejectOAuth2Request) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Error != nil {
toSerialize["error"] = o.Error
}
if o.ErrorDebug != nil {
toSerialize["error_debug"] = o.ErrorDebug
}
if o.ErrorDescription != nil {
toSerialize["error_description"] = o.ErrorDescription
}
if o.ErrorHint != nil {
toSerialize["error_hint"] = o.ErrorHint
}
if o.StatusCode != nil {
toSerialize["status_code"] = o.StatusCode
}
return json.Marshal(toSerialize)
}
type NullableRejectOAuth2Request struct {
value *RejectOAuth2Request
isSet bool
}
func (v NullableRejectOAuth2Request) Get() *RejectOAuth2Request {
return v.value
}
func (v *NullableRejectOAuth2Request) Set(val *RejectOAuth2Request) {
v.value = val
v.isSet = true
}
func (v NullableRejectOAuth2Request) IsSet() bool {
return v.isSet
}
func (v *NullableRejectOAuth2Request) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableRejectOAuth2Request(val *RejectOAuth2Request) *NullableRejectOAuth2Request {
return &NullableRejectOAuth2Request{value: val, isSet: true}
}
func (v NullableRejectOAuth2Request) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableRejectOAuth2Request) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_rfc6749_error_json.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// RFC6749ErrorJson struct for RFC6749ErrorJson
type RFC6749ErrorJson struct {
Error *string `json:"error,omitempty"`
ErrorDebug *string `json:"error_debug,omitempty"`
ErrorDescription *string `json:"error_description,omitempty"`
ErrorHint *string `json:"error_hint,omitempty"`
StatusCode *int64 `json:"status_code,omitempty"`
}
// NewRFC6749ErrorJson instantiates a new RFC6749ErrorJson 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
func NewRFC6749ErrorJson() *RFC6749ErrorJson {
this := RFC6749ErrorJson{}
return &this
}
// NewRFC6749ErrorJsonWithDefaults instantiates a new RFC6749ErrorJson 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
func NewRFC6749ErrorJsonWithDefaults() *RFC6749ErrorJson {
this := RFC6749ErrorJson{}
return &this
}
// GetError returns the Error field value if set, zero value otherwise.
func (o *RFC6749ErrorJson) GetError() string {
if o == nil || o.Error == nil {
var ret string
return ret
}
return *o.Error
}
// GetErrorOk returns a tuple with the Error field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RFC6749ErrorJson) GetErrorOk() (*string, bool) {
if o == nil || o.Error == nil {
return nil, false
}
return o.Error, true
}
// HasError returns a boolean if a field has been set.
func (o *RFC6749ErrorJson) HasError() bool {
if o != nil && o.Error != nil {
return true
}
return false
}
// SetError gets a reference to the given string and assigns it to the Error field.
func (o *RFC6749ErrorJson) SetError(v string) {
o.Error = &v
}
// GetErrorDebug returns the ErrorDebug field value if set, zero value otherwise.
func (o *RFC6749ErrorJson) GetErrorDebug() string {
if o == nil || o.ErrorDebug == nil {
var ret string
return ret
}
return *o.ErrorDebug
}
// GetErrorDebugOk returns a tuple with the ErrorDebug field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RFC6749ErrorJson) GetErrorDebugOk() (*string, bool) {
if o == nil || o.ErrorDebug == nil {
return nil, false
}
return o.ErrorDebug, true
}
// HasErrorDebug returns a boolean if a field has been set.
func (o *RFC6749ErrorJson) HasErrorDebug() bool {
if o != nil && o.ErrorDebug != nil {
return true
}
return false
}
// SetErrorDebug gets a reference to the given string and assigns it to the ErrorDebug field.
func (o *RFC6749ErrorJson) SetErrorDebug(v string) {
o.ErrorDebug = &v
}
// GetErrorDescription returns the ErrorDescription field value if set, zero value otherwise.
func (o *RFC6749ErrorJson) GetErrorDescription() string {
if o == nil || o.ErrorDescription == nil {
var ret string
return ret
}
return *o.ErrorDescription
}
// GetErrorDescriptionOk returns a tuple with the ErrorDescription field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RFC6749ErrorJson) GetErrorDescriptionOk() (*string, bool) {
if o == nil || o.ErrorDescription == nil {
return nil, false
}
return o.ErrorDescription, true
}
// HasErrorDescription returns a boolean if a field has been set.
func (o *RFC6749ErrorJson) HasErrorDescription() bool {
if o != nil && o.ErrorDescription != nil {
return true
}
return false
}
// SetErrorDescription gets a reference to the given string and assigns it to the ErrorDescription field.
func (o *RFC6749ErrorJson) SetErrorDescription(v string) {
o.ErrorDescription = &v
}
// GetErrorHint returns the ErrorHint field value if set, zero value otherwise.
func (o *RFC6749ErrorJson) GetErrorHint() string {
if o == nil || o.ErrorHint == nil {
var ret string
return ret
}
return *o.ErrorHint
}
// GetErrorHintOk returns a tuple with the ErrorHint field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RFC6749ErrorJson) GetErrorHintOk() (*string, bool) {
if o == nil || o.ErrorHint == nil {
return nil, false
}
return o.ErrorHint, true
}
// HasErrorHint returns a boolean if a field has been set.
func (o *RFC6749ErrorJson) HasErrorHint() bool {
if o != nil && o.ErrorHint != nil {
return true
}
return false
}
// SetErrorHint gets a reference to the given string and assigns it to the ErrorHint field.
func (o *RFC6749ErrorJson) SetErrorHint(v string) {
o.ErrorHint = &v
}
// GetStatusCode returns the StatusCode field value if set, zero value otherwise.
func (o *RFC6749ErrorJson) GetStatusCode() int64 {
if o == nil || o.StatusCode == nil {
var ret int64
return ret
}
return *o.StatusCode
}
// GetStatusCodeOk returns a tuple with the StatusCode field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *RFC6749ErrorJson) GetStatusCodeOk() (*int64, bool) {
if o == nil || o.StatusCode == nil {
return nil, false
}
return o.StatusCode, true
}
// HasStatusCode returns a boolean if a field has been set.
func (o *RFC6749ErrorJson) HasStatusCode() bool {
if o != nil && o.StatusCode != nil {
return true
}
return false
}
// SetStatusCode gets a reference to the given int64 and assigns it to the StatusCode field.
func (o *RFC6749ErrorJson) SetStatusCode(v int64) {
o.StatusCode = &v
}
func (o RFC6749ErrorJson) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Error != nil {
toSerialize["error"] = o.Error
}
if o.ErrorDebug != nil {
toSerialize["error_debug"] = o.ErrorDebug
}
if o.ErrorDescription != nil {
toSerialize["error_description"] = o.ErrorDescription
}
if o.ErrorHint != nil {
toSerialize["error_hint"] = o.ErrorHint
}
if o.StatusCode != nil {
toSerialize["status_code"] = o.StatusCode
}
return json.Marshal(toSerialize)
}
type NullableRFC6749ErrorJson struct {
value *RFC6749ErrorJson
isSet bool
}
func (v NullableRFC6749ErrorJson) Get() *RFC6749ErrorJson {
return v.value
}
func (v *NullableRFC6749ErrorJson) Set(val *RFC6749ErrorJson) {
v.value = val
v.isSet = true
}
func (v NullableRFC6749ErrorJson) IsSet() bool {
return v.isSet
}
func (v *NullableRFC6749ErrorJson) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableRFC6749ErrorJson(val *RFC6749ErrorJson) *NullableRFC6749ErrorJson {
return &NullableRFC6749ErrorJson{value: val, isSet: true}
}
func (v NullableRFC6749ErrorJson) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableRFC6749ErrorJson) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_token_pagination.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// TokenPagination struct for TokenPagination
type TokenPagination struct {
// Items per page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
PageSize *int64 `json:"page_size,omitempty"`
// Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
PageToken *string `json:"page_token,omitempty"`
}
// NewTokenPagination instantiates a new TokenPagination 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
func NewTokenPagination() *TokenPagination {
this := TokenPagination{}
var pageSize int64 = 250
this.PageSize = &pageSize
var pageToken string = "1"
this.PageToken = &pageToken
return &this
}
// NewTokenPaginationWithDefaults instantiates a new TokenPagination 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
func NewTokenPaginationWithDefaults() *TokenPagination {
this := TokenPagination{}
var pageSize int64 = 250
this.PageSize = &pageSize
var pageToken string = "1"
this.PageToken = &pageToken
return &this
}
// GetPageSize returns the PageSize field value if set, zero value otherwise.
func (o *TokenPagination) GetPageSize() int64 {
if o == nil || o.PageSize == nil {
var ret int64
return ret
}
return *o.PageSize
}
// GetPageSizeOk returns a tuple with the PageSize field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TokenPagination) GetPageSizeOk() (*int64, bool) {
if o == nil || o.PageSize == nil {
return nil, false
}
return o.PageSize, true
}
// HasPageSize returns a boolean if a field has been set.
func (o *TokenPagination) HasPageSize() bool {
if o != nil && o.PageSize != nil {
return true
}
return false
}
// SetPageSize gets a reference to the given int64 and assigns it to the PageSize field.
func (o *TokenPagination) SetPageSize(v int64) {
o.PageSize = &v
}
// GetPageToken returns the PageToken field value if set, zero value otherwise.
func (o *TokenPagination) GetPageToken() string {
if o == nil || o.PageToken == nil {
var ret string
return ret
}
return *o.PageToken
}
// GetPageTokenOk returns a tuple with the PageToken field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TokenPagination) GetPageTokenOk() (*string, bool) {
if o == nil || o.PageToken == nil {
return nil, false
}
return o.PageToken, true
}
// HasPageToken returns a boolean if a field has been set.
func (o *TokenPagination) HasPageToken() bool {
if o != nil && o.PageToken != nil {
return true
}
return false
}
// SetPageToken gets a reference to the given string and assigns it to the PageToken field.
func (o *TokenPagination) SetPageToken(v string) {
o.PageToken = &v
}
func (o TokenPagination) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.PageSize != nil {
toSerialize["page_size"] = o.PageSize
}
if o.PageToken != nil {
toSerialize["page_token"] = o.PageToken
}
return json.Marshal(toSerialize)
}
type NullableTokenPagination struct {
value *TokenPagination
isSet bool
}
func (v NullableTokenPagination) Get() *TokenPagination {
return v.value
}
func (v *NullableTokenPagination) Set(val *TokenPagination) {
v.value = val
v.isSet = true
}
func (v NullableTokenPagination) IsSet() bool {
return v.isSet
}
func (v *NullableTokenPagination) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableTokenPagination(val *TokenPagination) *NullableTokenPagination {
return &NullableTokenPagination{value: val, isSet: true}
}
func (v NullableTokenPagination) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableTokenPagination) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_token_pagination_headers.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// TokenPaginationHeaders struct for TokenPaginationHeaders
type TokenPaginationHeaders struct {
// The link header contains pagination links. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). in: header
Link *string `json:"link,omitempty"`
// The total number of clients. in: header
XTotalCount *string `json:"x-total-count,omitempty"`
}
// NewTokenPaginationHeaders instantiates a new TokenPaginationHeaders 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
func NewTokenPaginationHeaders() *TokenPaginationHeaders {
this := TokenPaginationHeaders{}
return &this
}
// NewTokenPaginationHeadersWithDefaults instantiates a new TokenPaginationHeaders 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
func NewTokenPaginationHeadersWithDefaults() *TokenPaginationHeaders {
this := TokenPaginationHeaders{}
return &this
}
// GetLink returns the Link field value if set, zero value otherwise.
func (o *TokenPaginationHeaders) GetLink() string {
if o == nil || o.Link == nil {
var ret string
return ret
}
return *o.Link
}
// GetLinkOk returns a tuple with the Link field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TokenPaginationHeaders) GetLinkOk() (*string, bool) {
if o == nil || o.Link == nil {
return nil, false
}
return o.Link, true
}
// HasLink returns a boolean if a field has been set.
func (o *TokenPaginationHeaders) HasLink() bool {
if o != nil && o.Link != nil {
return true
}
return false
}
// SetLink gets a reference to the given string and assigns it to the Link field.
func (o *TokenPaginationHeaders) SetLink(v string) {
o.Link = &v
}
// GetXTotalCount returns the XTotalCount field value if set, zero value otherwise.
func (o *TokenPaginationHeaders) GetXTotalCount() string {
if o == nil || o.XTotalCount == nil {
var ret string
return ret
}
return *o.XTotalCount
}
// GetXTotalCountOk returns a tuple with the XTotalCount field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TokenPaginationHeaders) GetXTotalCountOk() (*string, bool) {
if o == nil || o.XTotalCount == nil {
return nil, false
}
return o.XTotalCount, true
}
// HasXTotalCount returns a boolean if a field has been set.
func (o *TokenPaginationHeaders) HasXTotalCount() bool {
if o != nil && o.XTotalCount != nil {
return true
}
return false
}
// SetXTotalCount gets a reference to the given string and assigns it to the XTotalCount field.
func (o *TokenPaginationHeaders) SetXTotalCount(v string) {
o.XTotalCount = &v
}
func (o TokenPaginationHeaders) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Link != nil {
toSerialize["link"] = o.Link
}
if o.XTotalCount != nil {
toSerialize["x-total-count"] = o.XTotalCount
}
return json.Marshal(toSerialize)
}
type NullableTokenPaginationHeaders struct {
value *TokenPaginationHeaders
isSet bool
}
func (v NullableTokenPaginationHeaders) Get() *TokenPaginationHeaders {
return v.value
}
func (v *NullableTokenPaginationHeaders) Set(val *TokenPaginationHeaders) {
v.value = val
v.isSet = true
}
func (v NullableTokenPaginationHeaders) IsSet() bool {
return v.isSet
}
func (v *NullableTokenPaginationHeaders) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableTokenPaginationHeaders(val *TokenPaginationHeaders) *NullableTokenPaginationHeaders {
return &NullableTokenPaginationHeaders{value: val, isSet: true}
}
func (v NullableTokenPaginationHeaders) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableTokenPaginationHeaders) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_token_pagination_request_parameters.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// TokenPaginationRequestParameters The `Link` HTTP header contains multiple links (`first`, `next`, `last`, `previous`) formatted as: `<https://{project-slug}.projects.oryapis.com/admin/clients?page_size={limit}&page_token={offset}>; rel=\"{page}\"` For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
type TokenPaginationRequestParameters struct {
// Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
PageSize *int64 `json:"page_size,omitempty"`
// Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
PageToken *string `json:"page_token,omitempty"`
}
// NewTokenPaginationRequestParameters instantiates a new TokenPaginationRequestParameters 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
func NewTokenPaginationRequestParameters() *TokenPaginationRequestParameters {
this := TokenPaginationRequestParameters{}
var pageSize int64 = 250
this.PageSize = &pageSize
var pageToken string = "1"
this.PageToken = &pageToken
return &this
}
// NewTokenPaginationRequestParametersWithDefaults instantiates a new TokenPaginationRequestParameters 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
func NewTokenPaginationRequestParametersWithDefaults() *TokenPaginationRequestParameters {
this := TokenPaginationRequestParameters{}
var pageSize int64 = 250
this.PageSize = &pageSize
var pageToken string = "1"
this.PageToken = &pageToken
return &this
}
// GetPageSize returns the PageSize field value if set, zero value otherwise.
func (o *TokenPaginationRequestParameters) GetPageSize() int64 {
if o == nil || o.PageSize == nil {
var ret int64
return ret
}
return *o.PageSize
}
// GetPageSizeOk returns a tuple with the PageSize field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TokenPaginationRequestParameters) GetPageSizeOk() (*int64, bool) {
if o == nil || o.PageSize == nil {
return nil, false
}
return o.PageSize, true
}
// HasPageSize returns a boolean if a field has been set.
func (o *TokenPaginationRequestParameters) HasPageSize() bool {
if o != nil && o.PageSize != nil {
return true
}
return false
}
// SetPageSize gets a reference to the given int64 and assigns it to the PageSize field.
func (o *TokenPaginationRequestParameters) SetPageSize(v int64) {
o.PageSize = &v
}
// GetPageToken returns the PageToken field value if set, zero value otherwise.
func (o *TokenPaginationRequestParameters) GetPageToken() string {
if o == nil || o.PageToken == nil {
var ret string
return ret
}
return *o.PageToken
}
// GetPageTokenOk returns a tuple with the PageToken field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TokenPaginationRequestParameters) GetPageTokenOk() (*string, bool) {
if o == nil || o.PageToken == nil {
return nil, false
}
return o.PageToken, true
}
// HasPageToken returns a boolean if a field has been set.
func (o *TokenPaginationRequestParameters) HasPageToken() bool {
if o != nil && o.PageToken != nil {
return true
}
return false
}
// SetPageToken gets a reference to the given string and assigns it to the PageToken field.
func (o *TokenPaginationRequestParameters) SetPageToken(v string) {
o.PageToken = &v
}
func (o TokenPaginationRequestParameters) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.PageSize != nil {
toSerialize["page_size"] = o.PageSize
}
if o.PageToken != nil {
toSerialize["page_token"] = o.PageToken
}
return json.Marshal(toSerialize)
}
type NullableTokenPaginationRequestParameters struct {
value *TokenPaginationRequestParameters
isSet bool
}
func (v NullableTokenPaginationRequestParameters) Get() *TokenPaginationRequestParameters {
return v.value
}
func (v *NullableTokenPaginationRequestParameters) Set(val *TokenPaginationRequestParameters) {
v.value = val
v.isSet = true
}
func (v NullableTokenPaginationRequestParameters) IsSet() bool {
return v.isSet
}
func (v *NullableTokenPaginationRequestParameters) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableTokenPaginationRequestParameters(val *TokenPaginationRequestParameters) *NullableTokenPaginationRequestParameters {
return &NullableTokenPaginationRequestParameters{value: val, isSet: true}
}
func (v NullableTokenPaginationRequestParameters) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableTokenPaginationRequestParameters) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_token_pagination_response_headers.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// TokenPaginationResponseHeaders The `Link` HTTP header contains multiple links (`first`, `next`, `last`, `previous`) formatted as: `<https://{project-slug}.projects.oryapis.com/admin/clients?page_size={limit}&page_token={offset}>; rel=\"{page}\"` For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
type TokenPaginationResponseHeaders struct {
// The Link HTTP Header The `Link` header contains a comma-delimited list of links to the following pages: first: The first page of results. next: The next page of results. prev: The previous page of results. last: The last page of results. Pages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted. Examples: </clients?page_size=5&page_token=0>; rel=\"first\",</clients?page_size=5&page_token=15>; rel=\"next\",</clients?page_size=5&page_token=5>; rel=\"prev\",</clients?page_size=5&page_token=20>; rel=\"last\"
Link *string `json:"link,omitempty"`
// The X-Total-Count HTTP Header The `X-Total-Count` header contains the total number of items in the collection.
XTotalCount *int64 `json:"x-total-count,omitempty"`
}
// NewTokenPaginationResponseHeaders instantiates a new TokenPaginationResponseHeaders 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
func NewTokenPaginationResponseHeaders() *TokenPaginationResponseHeaders {
this := TokenPaginationResponseHeaders{}
return &this
}
// NewTokenPaginationResponseHeadersWithDefaults instantiates a new TokenPaginationResponseHeaders 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
func NewTokenPaginationResponseHeadersWithDefaults() *TokenPaginationResponseHeaders {
this := TokenPaginationResponseHeaders{}
return &this
}
// GetLink returns the Link field value if set, zero value otherwise.
func (o *TokenPaginationResponseHeaders) GetLink() string {
if o == nil || o.Link == nil {
var ret string
return ret
}
return *o.Link
}
// GetLinkOk returns a tuple with the Link field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TokenPaginationResponseHeaders) GetLinkOk() (*string, bool) {
if o == nil || o.Link == nil {
return nil, false
}
return o.Link, true
}
// HasLink returns a boolean if a field has been set.
func (o *TokenPaginationResponseHeaders) HasLink() bool {
if o != nil && o.Link != nil {
return true
}
return false
}
// SetLink gets a reference to the given string and assigns it to the Link field.
func (o *TokenPaginationResponseHeaders) SetLink(v string) {
o.Link = &v
}
// GetXTotalCount returns the XTotalCount field value if set, zero value otherwise.
func (o *TokenPaginationResponseHeaders) GetXTotalCount() int64 {
if o == nil || o.XTotalCount == nil {
var ret int64
return ret
}
return *o.XTotalCount
}
// GetXTotalCountOk returns a tuple with the XTotalCount field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TokenPaginationResponseHeaders) GetXTotalCountOk() (*int64, bool) {
if o == nil || o.XTotalCount == nil {
return nil, false
}
return o.XTotalCount, true
}
// HasXTotalCount returns a boolean if a field has been set.
func (o *TokenPaginationResponseHeaders) HasXTotalCount() bool {
if o != nil && o.XTotalCount != nil {
return true
}
return false
}
// SetXTotalCount gets a reference to the given int64 and assigns it to the XTotalCount field.
func (o *TokenPaginationResponseHeaders) SetXTotalCount(v int64) {
o.XTotalCount = &v
}
func (o TokenPaginationResponseHeaders) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Link != nil {
toSerialize["link"] = o.Link
}
if o.XTotalCount != nil {
toSerialize["x-total-count"] = o.XTotalCount
}
return json.Marshal(toSerialize)
}
type NullableTokenPaginationResponseHeaders struct {
value *TokenPaginationResponseHeaders
isSet bool
}
func (v NullableTokenPaginationResponseHeaders) Get() *TokenPaginationResponseHeaders {
return v.value
}
func (v *NullableTokenPaginationResponseHeaders) Set(val *TokenPaginationResponseHeaders) {
v.value = val
v.isSet = true
}
func (v NullableTokenPaginationResponseHeaders) IsSet() bool {
return v.isSet
}
func (v *NullableTokenPaginationResponseHeaders) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableTokenPaginationResponseHeaders(val *TokenPaginationResponseHeaders) *NullableTokenPaginationResponseHeaders {
return &NullableTokenPaginationResponseHeaders{value: val, isSet: true}
}
func (v NullableTokenPaginationResponseHeaders) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableTokenPaginationResponseHeaders) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_trusted_o_auth2_jwt_grant_issuer.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
"time"
)
// TrustedOAuth2JwtGrantIssuer OAuth2 JWT Bearer Grant Type Issuer Trust Relationship
type TrustedOAuth2JwtGrantIssuer struct {
// The \"allow_any_subject\" indicates that the issuer is allowed to have any principal as the subject of the JWT.
AllowAnySubject *bool `json:"allow_any_subject,omitempty"`
// The \"created_at\" indicates, when grant was created.
CreatedAt *time.Time `json:"created_at,omitempty"`
// The \"expires_at\" indicates, when grant will expire, so we will reject assertion from \"issuer\" targeting \"subject\".
ExpiresAt *time.Time `json:"expires_at,omitempty"`
Id *string `json:"id,omitempty"`
// The \"issuer\" identifies the principal that issued the JWT assertion (same as \"iss\" claim in JWT).
Issuer *string `json:"issuer,omitempty"`
PublicKey *TrustedOAuth2JwtGrantJsonWebKey `json:"public_key,omitempty"`
// The \"scope\" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749])
Scope []string `json:"scope,omitempty"`
// The \"subject\" identifies the principal that is the subject of the JWT.
Subject *string `json:"subject,omitempty"`
}
// NewTrustedOAuth2JwtGrantIssuer instantiates a new TrustedOAuth2JwtGrantIssuer 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
func NewTrustedOAuth2JwtGrantIssuer() *TrustedOAuth2JwtGrantIssuer {
this := TrustedOAuth2JwtGrantIssuer{}
return &this
}
// NewTrustedOAuth2JwtGrantIssuerWithDefaults instantiates a new TrustedOAuth2JwtGrantIssuer 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
func NewTrustedOAuth2JwtGrantIssuerWithDefaults() *TrustedOAuth2JwtGrantIssuer {
this := TrustedOAuth2JwtGrantIssuer{}
return &this
}
// GetAllowAnySubject returns the AllowAnySubject field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantIssuer) GetAllowAnySubject() bool {
if o == nil || o.AllowAnySubject == nil {
var ret bool
return ret
}
return *o.AllowAnySubject
}
// GetAllowAnySubjectOk returns a tuple with the AllowAnySubject field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantIssuer) GetAllowAnySubjectOk() (*bool, bool) {
if o == nil || o.AllowAnySubject == nil {
return nil, false
}
return o.AllowAnySubject, true
}
// HasAllowAnySubject returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantIssuer) HasAllowAnySubject() bool {
if o != nil && o.AllowAnySubject != nil {
return true
}
return false
}
// SetAllowAnySubject gets a reference to the given bool and assigns it to the AllowAnySubject field.
func (o *TrustedOAuth2JwtGrantIssuer) SetAllowAnySubject(v bool) {
o.AllowAnySubject = &v
}
// GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantIssuer) GetCreatedAt() time.Time {
if o == nil || o.CreatedAt == nil {
var ret time.Time
return ret
}
return *o.CreatedAt
}
// GetCreatedAtOk returns a tuple with the CreatedAt field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantIssuer) GetCreatedAtOk() (*time.Time, bool) {
if o == nil || o.CreatedAt == nil {
return nil, false
}
return o.CreatedAt, true
}
// HasCreatedAt returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantIssuer) HasCreatedAt() bool {
if o != nil && o.CreatedAt != nil {
return true
}
return false
}
// SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.
func (o *TrustedOAuth2JwtGrantIssuer) SetCreatedAt(v time.Time) {
o.CreatedAt = &v
}
// GetExpiresAt returns the ExpiresAt field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantIssuer) GetExpiresAt() time.Time {
if o == nil || o.ExpiresAt == nil {
var ret time.Time
return ret
}
return *o.ExpiresAt
}
// GetExpiresAtOk returns a tuple with the ExpiresAt field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantIssuer) GetExpiresAtOk() (*time.Time, bool) {
if o == nil || o.ExpiresAt == nil {
return nil, false
}
return o.ExpiresAt, true
}
// HasExpiresAt returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantIssuer) HasExpiresAt() bool {
if o != nil && o.ExpiresAt != nil {
return true
}
return false
}
// SetExpiresAt gets a reference to the given time.Time and assigns it to the ExpiresAt field.
func (o *TrustedOAuth2JwtGrantIssuer) SetExpiresAt(v time.Time) {
o.ExpiresAt = &v
}
// GetId returns the Id field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantIssuer) GetId() string {
if o == nil || o.Id == nil {
var ret string
return ret
}
return *o.Id
}
// GetIdOk returns a tuple with the Id field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantIssuer) GetIdOk() (*string, bool) {
if o == nil || o.Id == nil {
return nil, false
}
return o.Id, true
}
// HasId returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantIssuer) HasId() bool {
if o != nil && o.Id != nil {
return true
}
return false
}
// SetId gets a reference to the given string and assigns it to the Id field.
func (o *TrustedOAuth2JwtGrantIssuer) SetId(v string) {
o.Id = &v
}
// GetIssuer returns the Issuer field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantIssuer) GetIssuer() string {
if o == nil || o.Issuer == nil {
var ret string
return ret
}
return *o.Issuer
}
// GetIssuerOk returns a tuple with the Issuer field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantIssuer) GetIssuerOk() (*string, bool) {
if o == nil || o.Issuer == nil {
return nil, false
}
return o.Issuer, true
}
// HasIssuer returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantIssuer) HasIssuer() bool {
if o != nil && o.Issuer != nil {
return true
}
return false
}
// SetIssuer gets a reference to the given string and assigns it to the Issuer field.
func (o *TrustedOAuth2JwtGrantIssuer) SetIssuer(v string) {
o.Issuer = &v
}
// GetPublicKey returns the PublicKey field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantIssuer) GetPublicKey() TrustedOAuth2JwtGrantJsonWebKey {
if o == nil || o.PublicKey == nil {
var ret TrustedOAuth2JwtGrantJsonWebKey
return ret
}
return *o.PublicKey
}
// GetPublicKeyOk returns a tuple with the PublicKey field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantIssuer) GetPublicKeyOk() (*TrustedOAuth2JwtGrantJsonWebKey, bool) {
if o == nil || o.PublicKey == nil {
return nil, false
}
return o.PublicKey, true
}
// HasPublicKey returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantIssuer) HasPublicKey() bool {
if o != nil && o.PublicKey != nil {
return true
}
return false
}
// SetPublicKey gets a reference to the given TrustedOAuth2JwtGrantJsonWebKey and assigns it to the PublicKey field.
func (o *TrustedOAuth2JwtGrantIssuer) SetPublicKey(v TrustedOAuth2JwtGrantJsonWebKey) {
o.PublicKey = &v
}
// GetScope returns the Scope field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantIssuer) GetScope() []string {
if o == nil || o.Scope == nil {
var ret []string
return ret
}
return o.Scope
}
// GetScopeOk returns a tuple with the Scope field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantIssuer) GetScopeOk() ([]string, bool) {
if o == nil || o.Scope == nil {
return nil, false
}
return o.Scope, true
}
// HasScope returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantIssuer) HasScope() bool {
if o != nil && o.Scope != nil {
return true
}
return false
}
// SetScope gets a reference to the given []string and assigns it to the Scope field.
func (o *TrustedOAuth2JwtGrantIssuer) SetScope(v []string) {
o.Scope = v
}
// GetSubject returns the Subject field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantIssuer) GetSubject() string {
if o == nil || o.Subject == nil {
var ret string
return ret
}
return *o.Subject
}
// GetSubjectOk returns a tuple with the Subject field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantIssuer) GetSubjectOk() (*string, bool) {
if o == nil || o.Subject == nil {
return nil, false
}
return o.Subject, true
}
// HasSubject returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantIssuer) HasSubject() bool {
if o != nil && o.Subject != nil {
return true
}
return false
}
// SetSubject gets a reference to the given string and assigns it to the Subject field.
func (o *TrustedOAuth2JwtGrantIssuer) SetSubject(v string) {
o.Subject = &v
}
func (o TrustedOAuth2JwtGrantIssuer) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.AllowAnySubject != nil {
toSerialize["allow_any_subject"] = o.AllowAnySubject
}
if o.CreatedAt != nil {
toSerialize["created_at"] = o.CreatedAt
}
if o.ExpiresAt != nil {
toSerialize["expires_at"] = o.ExpiresAt
}
if o.Id != nil {
toSerialize["id"] = o.Id
}
if o.Issuer != nil {
toSerialize["issuer"] = o.Issuer
}
if o.PublicKey != nil {
toSerialize["public_key"] = o.PublicKey
}
if o.Scope != nil {
toSerialize["scope"] = o.Scope
}
if o.Subject != nil {
toSerialize["subject"] = o.Subject
}
return json.Marshal(toSerialize)
}
type NullableTrustedOAuth2JwtGrantIssuer struct {
value *TrustedOAuth2JwtGrantIssuer
isSet bool
}
func (v NullableTrustedOAuth2JwtGrantIssuer) Get() *TrustedOAuth2JwtGrantIssuer {
return v.value
}
func (v *NullableTrustedOAuth2JwtGrantIssuer) Set(val *TrustedOAuth2JwtGrantIssuer) {
v.value = val
v.isSet = true
}
func (v NullableTrustedOAuth2JwtGrantIssuer) IsSet() bool {
return v.isSet
}
func (v *NullableTrustedOAuth2JwtGrantIssuer) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableTrustedOAuth2JwtGrantIssuer(val *TrustedOAuth2JwtGrantIssuer) *NullableTrustedOAuth2JwtGrantIssuer {
return &NullableTrustedOAuth2JwtGrantIssuer{value: val, isSet: true}
}
func (v NullableTrustedOAuth2JwtGrantIssuer) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableTrustedOAuth2JwtGrantIssuer) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_trusted_o_auth2_jwt_grant_json_web_key.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// TrustedOAuth2JwtGrantJsonWebKey OAuth2 JWT Bearer Grant Type Issuer Trusted JSON Web Key
type TrustedOAuth2JwtGrantJsonWebKey struct {
// The \"key_id\" is key unique identifier (same as kid header in jws/jwt).
Kid *string `json:"kid,omitempty"`
// The \"set\" is basically a name for a group(set) of keys. Will be the same as \"issuer\" in grant.
Set *string `json:"set,omitempty"`
}
// NewTrustedOAuth2JwtGrantJsonWebKey instantiates a new TrustedOAuth2JwtGrantJsonWebKey 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
func NewTrustedOAuth2JwtGrantJsonWebKey() *TrustedOAuth2JwtGrantJsonWebKey {
this := TrustedOAuth2JwtGrantJsonWebKey{}
return &this
}
// NewTrustedOAuth2JwtGrantJsonWebKeyWithDefaults instantiates a new TrustedOAuth2JwtGrantJsonWebKey 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
func NewTrustedOAuth2JwtGrantJsonWebKeyWithDefaults() *TrustedOAuth2JwtGrantJsonWebKey {
this := TrustedOAuth2JwtGrantJsonWebKey{}
return &this
}
// GetKid returns the Kid field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantJsonWebKey) GetKid() string {
if o == nil || o.Kid == nil {
var ret string
return ret
}
return *o.Kid
}
// GetKidOk returns a tuple with the Kid field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantJsonWebKey) GetKidOk() (*string, bool) {
if o == nil || o.Kid == nil {
return nil, false
}
return o.Kid, true
}
// HasKid returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantJsonWebKey) HasKid() bool {
if o != nil && o.Kid != nil {
return true
}
return false
}
// SetKid gets a reference to the given string and assigns it to the Kid field.
func (o *TrustedOAuth2JwtGrantJsonWebKey) SetKid(v string) {
o.Kid = &v
}
// GetSet returns the Set field value if set, zero value otherwise.
func (o *TrustedOAuth2JwtGrantJsonWebKey) GetSet() string {
if o == nil || o.Set == nil {
var ret string
return ret
}
return *o.Set
}
// GetSetOk returns a tuple with the Set field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustedOAuth2JwtGrantJsonWebKey) GetSetOk() (*string, bool) {
if o == nil || o.Set == nil {
return nil, false
}
return o.Set, true
}
// HasSet returns a boolean if a field has been set.
func (o *TrustedOAuth2JwtGrantJsonWebKey) HasSet() bool {
if o != nil && o.Set != nil {
return true
}
return false
}
// SetSet gets a reference to the given string and assigns it to the Set field.
func (o *TrustedOAuth2JwtGrantJsonWebKey) SetSet(v string) {
o.Set = &v
}
func (o TrustedOAuth2JwtGrantJsonWebKey) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Kid != nil {
toSerialize["kid"] = o.Kid
}
if o.Set != nil {
toSerialize["set"] = o.Set
}
return json.Marshal(toSerialize)
}
type NullableTrustedOAuth2JwtGrantJsonWebKey struct {
value *TrustedOAuth2JwtGrantJsonWebKey
isSet bool
}
func (v NullableTrustedOAuth2JwtGrantJsonWebKey) Get() *TrustedOAuth2JwtGrantJsonWebKey {
return v.value
}
func (v *NullableTrustedOAuth2JwtGrantJsonWebKey) Set(val *TrustedOAuth2JwtGrantJsonWebKey) {
v.value = val
v.isSet = true
}
func (v NullableTrustedOAuth2JwtGrantJsonWebKey) IsSet() bool {
return v.isSet
}
func (v *NullableTrustedOAuth2JwtGrantJsonWebKey) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableTrustedOAuth2JwtGrantJsonWebKey(val *TrustedOAuth2JwtGrantJsonWebKey) *NullableTrustedOAuth2JwtGrantJsonWebKey {
return &NullableTrustedOAuth2JwtGrantJsonWebKey{value: val, isSet: true}
}
func (v NullableTrustedOAuth2JwtGrantJsonWebKey) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableTrustedOAuth2JwtGrantJsonWebKey) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_trust_o_auth2_jwt_grant_issuer.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
"time"
)
// TrustOAuth2JwtGrantIssuer Trust OAuth2 JWT Bearer Grant Type Issuer Request Body
type TrustOAuth2JwtGrantIssuer struct {
// The \"allow_any_subject\" indicates that the issuer is allowed to have any principal as the subject of the JWT.
AllowAnySubject *bool `json:"allow_any_subject,omitempty"`
// The \"expires_at\" indicates, when grant will expire, so we will reject assertion from \"issuer\" targeting \"subject\".
ExpiresAt time.Time `json:"expires_at"`
// The \"issuer\" identifies the principal that issued the JWT assertion (same as \"iss\" claim in JWT).
Issuer string `json:"issuer"`
Jwk JsonWebKey `json:"jwk"`
// The \"scope\" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749])
Scope []string `json:"scope"`
// The \"subject\" identifies the principal that is the subject of the JWT.
Subject *string `json:"subject,omitempty"`
}
// NewTrustOAuth2JwtGrantIssuer instantiates a new TrustOAuth2JwtGrantIssuer 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
func NewTrustOAuth2JwtGrantIssuer(expiresAt time.Time, issuer string, jwk JsonWebKey, scope []string) *TrustOAuth2JwtGrantIssuer {
this := TrustOAuth2JwtGrantIssuer{}
this.ExpiresAt = expiresAt
this.Issuer = issuer
this.Jwk = jwk
this.Scope = scope
return &this
}
// NewTrustOAuth2JwtGrantIssuerWithDefaults instantiates a new TrustOAuth2JwtGrantIssuer 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
func NewTrustOAuth2JwtGrantIssuerWithDefaults() *TrustOAuth2JwtGrantIssuer {
this := TrustOAuth2JwtGrantIssuer{}
return &this
}
// GetAllowAnySubject returns the AllowAnySubject field value if set, zero value otherwise.
func (o *TrustOAuth2JwtGrantIssuer) GetAllowAnySubject() bool {
if o == nil || o.AllowAnySubject == nil {
var ret bool
return ret
}
return *o.AllowAnySubject
}
// GetAllowAnySubjectOk returns a tuple with the AllowAnySubject field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustOAuth2JwtGrantIssuer) GetAllowAnySubjectOk() (*bool, bool) {
if o == nil || o.AllowAnySubject == nil {
return nil, false
}
return o.AllowAnySubject, true
}
// HasAllowAnySubject returns a boolean if a field has been set.
func (o *TrustOAuth2JwtGrantIssuer) HasAllowAnySubject() bool {
if o != nil && o.AllowAnySubject != nil {
return true
}
return false
}
// SetAllowAnySubject gets a reference to the given bool and assigns it to the AllowAnySubject field.
func (o *TrustOAuth2JwtGrantIssuer) SetAllowAnySubject(v bool) {
o.AllowAnySubject = &v
}
// GetExpiresAt returns the ExpiresAt field value
func (o *TrustOAuth2JwtGrantIssuer) GetExpiresAt() time.Time {
if o == nil {
var ret time.Time
return ret
}
return o.ExpiresAt
}
// GetExpiresAtOk returns a tuple with the ExpiresAt field value
// and a boolean to check if the value has been set.
func (o *TrustOAuth2JwtGrantIssuer) GetExpiresAtOk() (*time.Time, bool) {
if o == nil {
return nil, false
}
return &o.ExpiresAt, true
}
// SetExpiresAt sets field value
func (o *TrustOAuth2JwtGrantIssuer) SetExpiresAt(v time.Time) {
o.ExpiresAt = v
}
// GetIssuer returns the Issuer field value
func (o *TrustOAuth2JwtGrantIssuer) GetIssuer() string {
if o == nil {
var ret string
return ret
}
return o.Issuer
}
// GetIssuerOk returns a tuple with the Issuer field value
// and a boolean to check if the value has been set.
func (o *TrustOAuth2JwtGrantIssuer) GetIssuerOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.Issuer, true
}
// SetIssuer sets field value
func (o *TrustOAuth2JwtGrantIssuer) SetIssuer(v string) {
o.Issuer = v
}
// GetJwk returns the Jwk field value
func (o *TrustOAuth2JwtGrantIssuer) GetJwk() JsonWebKey {
if o == nil {
var ret JsonWebKey
return ret
}
return o.Jwk
}
// GetJwkOk returns a tuple with the Jwk field value
// and a boolean to check if the value has been set.
func (o *TrustOAuth2JwtGrantIssuer) GetJwkOk() (*JsonWebKey, bool) {
if o == nil {
return nil, false
}
return &o.Jwk, true
}
// SetJwk sets field value
func (o *TrustOAuth2JwtGrantIssuer) SetJwk(v JsonWebKey) {
o.Jwk = v
}
// GetScope returns the Scope field value
func (o *TrustOAuth2JwtGrantIssuer) GetScope() []string {
if o == nil {
var ret []string
return ret
}
return o.Scope
}
// GetScopeOk returns a tuple with the Scope field value
// and a boolean to check if the value has been set.
func (o *TrustOAuth2JwtGrantIssuer) GetScopeOk() ([]string, bool) {
if o == nil {
return nil, false
}
return o.Scope, true
}
// SetScope sets field value
func (o *TrustOAuth2JwtGrantIssuer) SetScope(v []string) {
o.Scope = v
}
// GetSubject returns the Subject field value if set, zero value otherwise.
func (o *TrustOAuth2JwtGrantIssuer) GetSubject() string {
if o == nil || o.Subject == nil {
var ret string
return ret
}
return *o.Subject
}
// GetSubjectOk returns a tuple with the Subject field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *TrustOAuth2JwtGrantIssuer) GetSubjectOk() (*string, bool) {
if o == nil || o.Subject == nil {
return nil, false
}
return o.Subject, true
}
// HasSubject returns a boolean if a field has been set.
func (o *TrustOAuth2JwtGrantIssuer) HasSubject() bool {
if o != nil && o.Subject != nil {
return true
}
return false
}
// SetSubject gets a reference to the given string and assigns it to the Subject field.
func (o *TrustOAuth2JwtGrantIssuer) SetSubject(v string) {
o.Subject = &v
}
func (o TrustOAuth2JwtGrantIssuer) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.AllowAnySubject != nil {
toSerialize["allow_any_subject"] = o.AllowAnySubject
}
if true {
toSerialize["expires_at"] = o.ExpiresAt
}
if true {
toSerialize["issuer"] = o.Issuer
}
if true {
toSerialize["jwk"] = o.Jwk
}
if true {
toSerialize["scope"] = o.Scope
}
if o.Subject != nil {
toSerialize["subject"] = o.Subject
}
return json.Marshal(toSerialize)
}
type NullableTrustOAuth2JwtGrantIssuer struct {
value *TrustOAuth2JwtGrantIssuer
isSet bool
}
func (v NullableTrustOAuth2JwtGrantIssuer) Get() *TrustOAuth2JwtGrantIssuer {
return v.value
}
func (v *NullableTrustOAuth2JwtGrantIssuer) Set(val *TrustOAuth2JwtGrantIssuer) {
v.value = val
v.isSet = true
}
func (v NullableTrustOAuth2JwtGrantIssuer) IsSet() bool {
return v.isSet
}
func (v *NullableTrustOAuth2JwtGrantIssuer) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableTrustOAuth2JwtGrantIssuer(val *TrustOAuth2JwtGrantIssuer) *NullableTrustOAuth2JwtGrantIssuer {
return &NullableTrustOAuth2JwtGrantIssuer{value: val, isSet: true}
}
func (v NullableTrustOAuth2JwtGrantIssuer) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableTrustOAuth2JwtGrantIssuer) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_verifiable_credential_priming_response.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// VerifiableCredentialPrimingResponse struct for VerifiableCredentialPrimingResponse
type VerifiableCredentialPrimingResponse struct {
CNonce *string `json:"c_nonce,omitempty"`
CNonceExpiresIn *int64 `json:"c_nonce_expires_in,omitempty"`
Error *string `json:"error,omitempty"`
ErrorDebug *string `json:"error_debug,omitempty"`
ErrorDescription *string `json:"error_description,omitempty"`
ErrorHint *string `json:"error_hint,omitempty"`
Format *string `json:"format,omitempty"`
StatusCode *int64 `json:"status_code,omitempty"`
}
// NewVerifiableCredentialPrimingResponse instantiates a new VerifiableCredentialPrimingResponse 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
func NewVerifiableCredentialPrimingResponse() *VerifiableCredentialPrimingResponse {
this := VerifiableCredentialPrimingResponse{}
return &this
}
// NewVerifiableCredentialPrimingResponseWithDefaults instantiates a new VerifiableCredentialPrimingResponse 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
func NewVerifiableCredentialPrimingResponseWithDefaults() *VerifiableCredentialPrimingResponse {
this := VerifiableCredentialPrimingResponse{}
return &this
}
// GetCNonce returns the CNonce field value if set, zero value otherwise.
func (o *VerifiableCredentialPrimingResponse) GetCNonce() string {
if o == nil || o.CNonce == nil {
var ret string
return ret
}
return *o.CNonce
}
// GetCNonceOk returns a tuple with the CNonce field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialPrimingResponse) GetCNonceOk() (*string, bool) {
if o == nil || o.CNonce == nil {
return nil, false
}
return o.CNonce, true
}
// HasCNonce returns a boolean if a field has been set.
func (o *VerifiableCredentialPrimingResponse) HasCNonce() bool {
if o != nil && o.CNonce != nil {
return true
}
return false
}
// SetCNonce gets a reference to the given string and assigns it to the CNonce field.
func (o *VerifiableCredentialPrimingResponse) SetCNonce(v string) {
o.CNonce = &v
}
// GetCNonceExpiresIn returns the CNonceExpiresIn field value if set, zero value otherwise.
func (o *VerifiableCredentialPrimingResponse) GetCNonceExpiresIn() int64 {
if o == nil || o.CNonceExpiresIn == nil {
var ret int64
return ret
}
return *o.CNonceExpiresIn
}
// GetCNonceExpiresInOk returns a tuple with the CNonceExpiresIn field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialPrimingResponse) GetCNonceExpiresInOk() (*int64, bool) {
if o == nil || o.CNonceExpiresIn == nil {
return nil, false
}
return o.CNonceExpiresIn, true
}
// HasCNonceExpiresIn returns a boolean if a field has been set.
func (o *VerifiableCredentialPrimingResponse) HasCNonceExpiresIn() bool {
if o != nil && o.CNonceExpiresIn != nil {
return true
}
return false
}
// SetCNonceExpiresIn gets a reference to the given int64 and assigns it to the CNonceExpiresIn field.
func (o *VerifiableCredentialPrimingResponse) SetCNonceExpiresIn(v int64) {
o.CNonceExpiresIn = &v
}
// GetError returns the Error field value if set, zero value otherwise.
func (o *VerifiableCredentialPrimingResponse) GetError() string {
if o == nil || o.Error == nil {
var ret string
return ret
}
return *o.Error
}
// GetErrorOk returns a tuple with the Error field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialPrimingResponse) GetErrorOk() (*string, bool) {
if o == nil || o.Error == nil {
return nil, false
}
return o.Error, true
}
// HasError returns a boolean if a field has been set.
func (o *VerifiableCredentialPrimingResponse) HasError() bool {
if o != nil && o.Error != nil {
return true
}
return false
}
// SetError gets a reference to the given string and assigns it to the Error field.
func (o *VerifiableCredentialPrimingResponse) SetError(v string) {
o.Error = &v
}
// GetErrorDebug returns the ErrorDebug field value if set, zero value otherwise.
func (o *VerifiableCredentialPrimingResponse) GetErrorDebug() string {
if o == nil || o.ErrorDebug == nil {
var ret string
return ret
}
return *o.ErrorDebug
}
// GetErrorDebugOk returns a tuple with the ErrorDebug field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialPrimingResponse) GetErrorDebugOk() (*string, bool) {
if o == nil || o.ErrorDebug == nil {
return nil, false
}
return o.ErrorDebug, true
}
// HasErrorDebug returns a boolean if a field has been set.
func (o *VerifiableCredentialPrimingResponse) HasErrorDebug() bool {
if o != nil && o.ErrorDebug != nil {
return true
}
return false
}
// SetErrorDebug gets a reference to the given string and assigns it to the ErrorDebug field.
func (o *VerifiableCredentialPrimingResponse) SetErrorDebug(v string) {
o.ErrorDebug = &v
}
// GetErrorDescription returns the ErrorDescription field value if set, zero value otherwise.
func (o *VerifiableCredentialPrimingResponse) GetErrorDescription() string {
if o == nil || o.ErrorDescription == nil {
var ret string
return ret
}
return *o.ErrorDescription
}
// GetErrorDescriptionOk returns a tuple with the ErrorDescription field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialPrimingResponse) GetErrorDescriptionOk() (*string, bool) {
if o == nil || o.ErrorDescription == nil {
return nil, false
}
return o.ErrorDescription, true
}
// HasErrorDescription returns a boolean if a field has been set.
func (o *VerifiableCredentialPrimingResponse) HasErrorDescription() bool {
if o != nil && o.ErrorDescription != nil {
return true
}
return false
}
// SetErrorDescription gets a reference to the given string and assigns it to the ErrorDescription field.
func (o *VerifiableCredentialPrimingResponse) SetErrorDescription(v string) {
o.ErrorDescription = &v
}
// GetErrorHint returns the ErrorHint field value if set, zero value otherwise.
func (o *VerifiableCredentialPrimingResponse) GetErrorHint() string {
if o == nil || o.ErrorHint == nil {
var ret string
return ret
}
return *o.ErrorHint
}
// GetErrorHintOk returns a tuple with the ErrorHint field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialPrimingResponse) GetErrorHintOk() (*string, bool) {
if o == nil || o.ErrorHint == nil {
return nil, false
}
return o.ErrorHint, true
}
// HasErrorHint returns a boolean if a field has been set.
func (o *VerifiableCredentialPrimingResponse) HasErrorHint() bool {
if o != nil && o.ErrorHint != nil {
return true
}
return false
}
// SetErrorHint gets a reference to the given string and assigns it to the ErrorHint field.
func (o *VerifiableCredentialPrimingResponse) SetErrorHint(v string) {
o.ErrorHint = &v
}
// GetFormat returns the Format field value if set, zero value otherwise.
func (o *VerifiableCredentialPrimingResponse) GetFormat() string {
if o == nil || o.Format == nil {
var ret string
return ret
}
return *o.Format
}
// GetFormatOk returns a tuple with the Format field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialPrimingResponse) GetFormatOk() (*string, bool) {
if o == nil || o.Format == nil {
return nil, false
}
return o.Format, true
}
// HasFormat returns a boolean if a field has been set.
func (o *VerifiableCredentialPrimingResponse) HasFormat() bool {
if o != nil && o.Format != nil {
return true
}
return false
}
// SetFormat gets a reference to the given string and assigns it to the Format field.
func (o *VerifiableCredentialPrimingResponse) SetFormat(v string) {
o.Format = &v
}
// GetStatusCode returns the StatusCode field value if set, zero value otherwise.
func (o *VerifiableCredentialPrimingResponse) GetStatusCode() int64 {
if o == nil || o.StatusCode == nil {
var ret int64
return ret
}
return *o.StatusCode
}
// GetStatusCodeOk returns a tuple with the StatusCode field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialPrimingResponse) GetStatusCodeOk() (*int64, bool) {
if o == nil || o.StatusCode == nil {
return nil, false
}
return o.StatusCode, true
}
// HasStatusCode returns a boolean if a field has been set.
func (o *VerifiableCredentialPrimingResponse) HasStatusCode() bool {
if o != nil && o.StatusCode != nil {
return true
}
return false
}
// SetStatusCode gets a reference to the given int64 and assigns it to the StatusCode field.
func (o *VerifiableCredentialPrimingResponse) SetStatusCode(v int64) {
o.StatusCode = &v
}
func (o VerifiableCredentialPrimingResponse) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.CNonce != nil {
toSerialize["c_nonce"] = o.CNonce
}
if o.CNonceExpiresIn != nil {
toSerialize["c_nonce_expires_in"] = o.CNonceExpiresIn
}
if o.Error != nil {
toSerialize["error"] = o.Error
}
if o.ErrorDebug != nil {
toSerialize["error_debug"] = o.ErrorDebug
}
if o.ErrorDescription != nil {
toSerialize["error_description"] = o.ErrorDescription
}
if o.ErrorHint != nil {
toSerialize["error_hint"] = o.ErrorHint
}
if o.Format != nil {
toSerialize["format"] = o.Format
}
if o.StatusCode != nil {
toSerialize["status_code"] = o.StatusCode
}
return json.Marshal(toSerialize)
}
type NullableVerifiableCredentialPrimingResponse struct {
value *VerifiableCredentialPrimingResponse
isSet bool
}
func (v NullableVerifiableCredentialPrimingResponse) Get() *VerifiableCredentialPrimingResponse {
return v.value
}
func (v *NullableVerifiableCredentialPrimingResponse) Set(val *VerifiableCredentialPrimingResponse) {
v.value = val
v.isSet = true
}
func (v NullableVerifiableCredentialPrimingResponse) IsSet() bool {
return v.isSet
}
func (v *NullableVerifiableCredentialPrimingResponse) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableVerifiableCredentialPrimingResponse(val *VerifiableCredentialPrimingResponse) *NullableVerifiableCredentialPrimingResponse {
return &NullableVerifiableCredentialPrimingResponse{value: val, isSet: true}
}
func (v NullableVerifiableCredentialPrimingResponse) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableVerifiableCredentialPrimingResponse) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_verifiable_credential_proof.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// VerifiableCredentialProof struct for VerifiableCredentialProof
type VerifiableCredentialProof struct {
Jwt *string `json:"jwt,omitempty"`
ProofType *string `json:"proof_type,omitempty"`
}
// NewVerifiableCredentialProof instantiates a new VerifiableCredentialProof 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
func NewVerifiableCredentialProof() *VerifiableCredentialProof {
this := VerifiableCredentialProof{}
return &this
}
// NewVerifiableCredentialProofWithDefaults instantiates a new VerifiableCredentialProof 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
func NewVerifiableCredentialProofWithDefaults() *VerifiableCredentialProof {
this := VerifiableCredentialProof{}
return &this
}
// GetJwt returns the Jwt field value if set, zero value otherwise.
func (o *VerifiableCredentialProof) GetJwt() string {
if o == nil || o.Jwt == nil {
var ret string
return ret
}
return *o.Jwt
}
// GetJwtOk returns a tuple with the Jwt field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialProof) GetJwtOk() (*string, bool) {
if o == nil || o.Jwt == nil {
return nil, false
}
return o.Jwt, true
}
// HasJwt returns a boolean if a field has been set.
func (o *VerifiableCredentialProof) HasJwt() bool {
if o != nil && o.Jwt != nil {
return true
}
return false
}
// SetJwt gets a reference to the given string and assigns it to the Jwt field.
func (o *VerifiableCredentialProof) SetJwt(v string) {
o.Jwt = &v
}
// GetProofType returns the ProofType field value if set, zero value otherwise.
func (o *VerifiableCredentialProof) GetProofType() string {
if o == nil || o.ProofType == nil {
var ret string
return ret
}
return *o.ProofType
}
// GetProofTypeOk returns a tuple with the ProofType field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialProof) GetProofTypeOk() (*string, bool) {
if o == nil || o.ProofType == nil {
return nil, false
}
return o.ProofType, true
}
// HasProofType returns a boolean if a field has been set.
func (o *VerifiableCredentialProof) HasProofType() bool {
if o != nil && o.ProofType != nil {
return true
}
return false
}
// SetProofType gets a reference to the given string and assigns it to the ProofType field.
func (o *VerifiableCredentialProof) SetProofType(v string) {
o.ProofType = &v
}
func (o VerifiableCredentialProof) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Jwt != nil {
toSerialize["jwt"] = o.Jwt
}
if o.ProofType != nil {
toSerialize["proof_type"] = o.ProofType
}
return json.Marshal(toSerialize)
}
type NullableVerifiableCredentialProof struct {
value *VerifiableCredentialProof
isSet bool
}
func (v NullableVerifiableCredentialProof) Get() *VerifiableCredentialProof {
return v.value
}
func (v *NullableVerifiableCredentialProof) Set(val *VerifiableCredentialProof) {
v.value = val
v.isSet = true
}
func (v NullableVerifiableCredentialProof) IsSet() bool {
return v.isSet
}
func (v *NullableVerifiableCredentialProof) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableVerifiableCredentialProof(val *VerifiableCredentialProof) *NullableVerifiableCredentialProof {
return &NullableVerifiableCredentialProof{value: val, isSet: true}
}
func (v NullableVerifiableCredentialProof) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableVerifiableCredentialProof) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_verifiable_credential_response.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// VerifiableCredentialResponse struct for VerifiableCredentialResponse
type VerifiableCredentialResponse struct {
CredentialDraft00 *string `json:"credential_draft_00,omitempty"`
Format *string `json:"format,omitempty"`
}
// NewVerifiableCredentialResponse instantiates a new VerifiableCredentialResponse 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
func NewVerifiableCredentialResponse() *VerifiableCredentialResponse {
this := VerifiableCredentialResponse{}
return &this
}
// NewVerifiableCredentialResponseWithDefaults instantiates a new VerifiableCredentialResponse 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
func NewVerifiableCredentialResponseWithDefaults() *VerifiableCredentialResponse {
this := VerifiableCredentialResponse{}
return &this
}
// GetCredentialDraft00 returns the CredentialDraft00 field value if set, zero value otherwise.
func (o *VerifiableCredentialResponse) GetCredentialDraft00() string {
if o == nil || o.CredentialDraft00 == nil {
var ret string
return ret
}
return *o.CredentialDraft00
}
// GetCredentialDraft00Ok returns a tuple with the CredentialDraft00 field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialResponse) GetCredentialDraft00Ok() (*string, bool) {
if o == nil || o.CredentialDraft00 == nil {
return nil, false
}
return o.CredentialDraft00, true
}
// HasCredentialDraft00 returns a boolean if a field has been set.
func (o *VerifiableCredentialResponse) HasCredentialDraft00() bool {
if o != nil && o.CredentialDraft00 != nil {
return true
}
return false
}
// SetCredentialDraft00 gets a reference to the given string and assigns it to the CredentialDraft00 field.
func (o *VerifiableCredentialResponse) SetCredentialDraft00(v string) {
o.CredentialDraft00 = &v
}
// GetFormat returns the Format field value if set, zero value otherwise.
func (o *VerifiableCredentialResponse) GetFormat() string {
if o == nil || o.Format == nil {
var ret string
return ret
}
return *o.Format
}
// GetFormatOk returns a tuple with the Format field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VerifiableCredentialResponse) GetFormatOk() (*string, bool) {
if o == nil || o.Format == nil {
return nil, false
}
return o.Format, true
}
// HasFormat returns a boolean if a field has been set.
func (o *VerifiableCredentialResponse) HasFormat() bool {
if o != nil && o.Format != nil {
return true
}
return false
}
// SetFormat gets a reference to the given string and assigns it to the Format field.
func (o *VerifiableCredentialResponse) SetFormat(v string) {
o.Format = &v
}
func (o VerifiableCredentialResponse) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.CredentialDraft00 != nil {
toSerialize["credential_draft_00"] = o.CredentialDraft00
}
if o.Format != nil {
toSerialize["format"] = o.Format
}
return json.Marshal(toSerialize)
}
type NullableVerifiableCredentialResponse struct {
value *VerifiableCredentialResponse
isSet bool
}
func (v NullableVerifiableCredentialResponse) Get() *VerifiableCredentialResponse {
return v.value
}
func (v *NullableVerifiableCredentialResponse) Set(val *VerifiableCredentialResponse) {
v.value = val
v.isSet = true
}
func (v NullableVerifiableCredentialResponse) IsSet() bool {
return v.isSet
}
func (v *NullableVerifiableCredentialResponse) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableVerifiableCredentialResponse(val *VerifiableCredentialResponse) *NullableVerifiableCredentialResponse {
return &NullableVerifiableCredentialResponse{value: val, isSet: true}
}
func (v NullableVerifiableCredentialResponse) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableVerifiableCredentialResponse) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Go | hydra/internal/httpclient/model_version.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// Version struct for Version
type Version struct {
// Version is the service's version.
Version *string `json:"version,omitempty"`
}
// NewVersion instantiates a new Version 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
func NewVersion() *Version {
this := Version{}
return &this
}
// NewVersionWithDefaults instantiates a new Version 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
func NewVersionWithDefaults() *Version {
this := Version{}
return &this
}
// GetVersion returns the Version field value if set, zero value otherwise.
func (o *Version) GetVersion() string {
if o == nil || o.Version == nil {
var ret string
return ret
}
return *o.Version
}
// GetVersionOk returns a tuple with the Version field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Version) GetVersionOk() (*string, bool) {
if o == nil || o.Version == nil {
return nil, false
}
return o.Version, true
}
// HasVersion returns a boolean if a field has been set.
func (o *Version) HasVersion() bool {
if o != nil && o.Version != nil {
return true
}
return false
}
// SetVersion gets a reference to the given string and assigns it to the Version field.
func (o *Version) SetVersion(v string) {
o.Version = &v
}
func (o Version) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Version != nil {
toSerialize["version"] = o.Version
}
return json.Marshal(toSerialize)
}
type NullableVersion struct {
value *Version
isSet bool
}
func (v NullableVersion) Get() *Version {
return v.value
}
func (v *NullableVersion) Set(val *Version) {
v.value = val
v.isSet = true
}
func (v NullableVersion) IsSet() bool {
return v.isSet
}
func (v *NullableVersion) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableVersion(val *Version) *NullableVersion {
return &NullableVersion{value: val, isSet: true}
}
func (v NullableVersion) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableVersion) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
Markdown | hydra/internal/httpclient/README.md | # Go API client for openapi
Documentation for all of Ory Hydra's APIs.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version:
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
## Installation
Install the following dependencies:
```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
```
Put the package under your project folder and add the following in import:
```golang
import openapi "github.com/ory/hydra-client-go"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```golang
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```
## Configuration of Server URL
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
### Select Server Configuration
For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.
```golang
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)
```
### Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.
```golang
ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```
Note, enum values are always validated and all unused variables are silently ignored.
### URLs Configuration per Operation
Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.
```
ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*JwkApi* | [**CreateJsonWebKeySet**](docs/JwkApi.md#createjsonwebkeyset) | **Post** /admin/keys/{set} | Create JSON Web Key
*JwkApi* | [**DeleteJsonWebKey**](docs/JwkApi.md#deletejsonwebkey) | **Delete** /admin/keys/{set}/{kid} | Delete JSON Web Key
*JwkApi* | [**DeleteJsonWebKeySet**](docs/JwkApi.md#deletejsonwebkeyset) | **Delete** /admin/keys/{set} | Delete JSON Web Key Set
*JwkApi* | [**GetJsonWebKey**](docs/JwkApi.md#getjsonwebkey) | **Get** /admin/keys/{set}/{kid} | Get JSON Web Key
*JwkApi* | [**GetJsonWebKeySet**](docs/JwkApi.md#getjsonwebkeyset) | **Get** /admin/keys/{set} | Retrieve a JSON Web Key Set
*JwkApi* | [**SetJsonWebKey**](docs/JwkApi.md#setjsonwebkey) | **Put** /admin/keys/{set}/{kid} | Set JSON Web Key
*JwkApi* | [**SetJsonWebKeySet**](docs/JwkApi.md#setjsonwebkeyset) | **Put** /admin/keys/{set} | Update a JSON Web Key Set
*MetadataApi* | [**GetVersion**](docs/MetadataApi.md#getversion) | **Get** /version | Return Running Software Version.
*MetadataApi* | [**IsAlive**](docs/MetadataApi.md#isalive) | **Get** /health/alive | Check HTTP Server Status
*MetadataApi* | [**IsReady**](docs/MetadataApi.md#isready) | **Get** /health/ready | Check HTTP Server and Database Status
*OAuth2Api* | [**AcceptOAuth2ConsentRequest**](docs/OAuth2Api.md#acceptoauth2consentrequest) | **Put** /admin/oauth2/auth/requests/consent/accept | Accept OAuth 2.0 Consent Request
*OAuth2Api* | [**AcceptOAuth2LoginRequest**](docs/OAuth2Api.md#acceptoauth2loginrequest) | **Put** /admin/oauth2/auth/requests/login/accept | Accept OAuth 2.0 Login Request
*OAuth2Api* | [**AcceptOAuth2LogoutRequest**](docs/OAuth2Api.md#acceptoauth2logoutrequest) | **Put** /admin/oauth2/auth/requests/logout/accept | Accept OAuth 2.0 Session Logout Request
*OAuth2Api* | [**CreateOAuth2Client**](docs/OAuth2Api.md#createoauth2client) | **Post** /admin/clients | Create OAuth 2.0 Client
*OAuth2Api* | [**DeleteOAuth2Client**](docs/OAuth2Api.md#deleteoauth2client) | **Delete** /admin/clients/{id} | Delete OAuth 2.0 Client
*OAuth2Api* | [**DeleteOAuth2Token**](docs/OAuth2Api.md#deleteoauth2token) | **Delete** /admin/oauth2/tokens | Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
*OAuth2Api* | [**DeleteTrustedOAuth2JwtGrantIssuer**](docs/OAuth2Api.md#deletetrustedoauth2jwtgrantissuer) | **Delete** /admin/trust/grants/jwt-bearer/issuers/{id} | Delete Trusted OAuth2 JWT Bearer Grant Type Issuer
*OAuth2Api* | [**GetOAuth2Client**](docs/OAuth2Api.md#getoauth2client) | **Get** /admin/clients/{id} | Get an OAuth 2.0 Client
*OAuth2Api* | [**GetOAuth2ConsentRequest**](docs/OAuth2Api.md#getoauth2consentrequest) | **Get** /admin/oauth2/auth/requests/consent | Get OAuth 2.0 Consent Request
*OAuth2Api* | [**GetOAuth2LoginRequest**](docs/OAuth2Api.md#getoauth2loginrequest) | **Get** /admin/oauth2/auth/requests/login | Get OAuth 2.0 Login Request
*OAuth2Api* | [**GetOAuth2LogoutRequest**](docs/OAuth2Api.md#getoauth2logoutrequest) | **Get** /admin/oauth2/auth/requests/logout | Get OAuth 2.0 Session Logout Request
*OAuth2Api* | [**GetTrustedOAuth2JwtGrantIssuer**](docs/OAuth2Api.md#gettrustedoauth2jwtgrantissuer) | **Get** /admin/trust/grants/jwt-bearer/issuers/{id} | Get Trusted OAuth2 JWT Bearer Grant Type Issuer
*OAuth2Api* | [**IntrospectOAuth2Token**](docs/OAuth2Api.md#introspectoauth2token) | **Post** /admin/oauth2/introspect | Introspect OAuth2 Access and Refresh Tokens
*OAuth2Api* | [**ListOAuth2Clients**](docs/OAuth2Api.md#listoauth2clients) | **Get** /admin/clients | List OAuth 2.0 Clients
*OAuth2Api* | [**ListOAuth2ConsentSessions**](docs/OAuth2Api.md#listoauth2consentsessions) | **Get** /admin/oauth2/auth/sessions/consent | List OAuth 2.0 Consent Sessions of a Subject
*OAuth2Api* | [**ListTrustedOAuth2JwtGrantIssuers**](docs/OAuth2Api.md#listtrustedoauth2jwtgrantissuers) | **Get** /admin/trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers
*OAuth2Api* | [**OAuth2Authorize**](docs/OAuth2Api.md#oauth2authorize) | **Get** /oauth2/auth | OAuth 2.0 Authorize Endpoint
*OAuth2Api* | [**Oauth2TokenExchange**](docs/OAuth2Api.md#oauth2tokenexchange) | **Post** /oauth2/token | The OAuth 2.0 Token Endpoint
*OAuth2Api* | [**PatchOAuth2Client**](docs/OAuth2Api.md#patchoauth2client) | **Patch** /admin/clients/{id} | Patch OAuth 2.0 Client
*OAuth2Api* | [**RejectOAuth2ConsentRequest**](docs/OAuth2Api.md#rejectoauth2consentrequest) | **Put** /admin/oauth2/auth/requests/consent/reject | Reject OAuth 2.0 Consent Request
*OAuth2Api* | [**RejectOAuth2LoginRequest**](docs/OAuth2Api.md#rejectoauth2loginrequest) | **Put** /admin/oauth2/auth/requests/login/reject | Reject OAuth 2.0 Login Request
*OAuth2Api* | [**RejectOAuth2LogoutRequest**](docs/OAuth2Api.md#rejectoauth2logoutrequest) | **Put** /admin/oauth2/auth/requests/logout/reject | Reject OAuth 2.0 Session Logout Request
*OAuth2Api* | [**RevokeOAuth2ConsentSessions**](docs/OAuth2Api.md#revokeoauth2consentsessions) | **Delete** /admin/oauth2/auth/sessions/consent | Revoke OAuth 2.0 Consent Sessions of a Subject
*OAuth2Api* | [**RevokeOAuth2LoginSessions**](docs/OAuth2Api.md#revokeoauth2loginsessions) | **Delete** /admin/oauth2/auth/sessions/login | Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
*OAuth2Api* | [**RevokeOAuth2Token**](docs/OAuth2Api.md#revokeoauth2token) | **Post** /oauth2/revoke | Revoke OAuth 2.0 Access or Refresh Token
*OAuth2Api* | [**SetOAuth2Client**](docs/OAuth2Api.md#setoauth2client) | **Put** /admin/clients/{id} | Set OAuth 2.0 Client
*OAuth2Api* | [**SetOAuth2ClientLifespans**](docs/OAuth2Api.md#setoauth2clientlifespans) | **Put** /admin/clients/{id}/lifespans | Set OAuth2 Client Token Lifespans
*OAuth2Api* | [**TrustOAuth2JwtGrantIssuer**](docs/OAuth2Api.md#trustoauth2jwtgrantissuer) | **Post** /admin/trust/grants/jwt-bearer/issuers | Trust OAuth2 JWT Bearer Grant Type Issuer
*OidcApi* | [**CreateOidcDynamicClient**](docs/OidcApi.md#createoidcdynamicclient) | **Post** /oauth2/register | Register OAuth2 Client using OpenID Dynamic Client Registration
*OidcApi* | [**CreateVerifiableCredential**](docs/OidcApi.md#createverifiablecredential) | **Post** /credentials | Issues a Verifiable Credential
*OidcApi* | [**DeleteOidcDynamicClient**](docs/OidcApi.md#deleteoidcdynamicclient) | **Delete** /oauth2/register/{id} | Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
*OidcApi* | [**DiscoverOidcConfiguration**](docs/OidcApi.md#discoveroidcconfiguration) | **Get** /.well-known/openid-configuration | OpenID Connect Discovery
*OidcApi* | [**GetOidcDynamicClient**](docs/OidcApi.md#getoidcdynamicclient) | **Get** /oauth2/register/{id} | Get OAuth2 Client using OpenID Dynamic Client Registration
*OidcApi* | [**GetOidcUserInfo**](docs/OidcApi.md#getoidcuserinfo) | **Get** /userinfo | OpenID Connect Userinfo
*OidcApi* | [**RevokeOidcSession**](docs/OidcApi.md#revokeoidcsession) | **Get** /oauth2/sessions/logout | OpenID Connect Front- and Back-channel Enabled Logout
*OidcApi* | [**SetOidcDynamicClient**](docs/OidcApi.md#setoidcdynamicclient) | **Put** /oauth2/register/{id} | Set OAuth2 Client using OpenID Dynamic Client Registration
*WellknownApi* | [**DiscoverJsonWebKeys**](docs/WellknownApi.md#discoverjsonwebkeys) | **Get** /.well-known/jwks.json | Discover Well-Known JSON Web Keys
## Documentation For Models
- [AcceptOAuth2ConsentRequest](docs/AcceptOAuth2ConsentRequest.md)
- [AcceptOAuth2ConsentRequestSession](docs/AcceptOAuth2ConsentRequestSession.md)
- [AcceptOAuth2LoginRequest](docs/AcceptOAuth2LoginRequest.md)
- [CreateJsonWebKeySet](docs/CreateJsonWebKeySet.md)
- [CreateVerifiableCredentialRequestBody](docs/CreateVerifiableCredentialRequestBody.md)
- [CredentialSupportedDraft00](docs/CredentialSupportedDraft00.md)
- [ErrorOAuth2](docs/ErrorOAuth2.md)
- [GenericError](docs/GenericError.md)
- [GetVersion200Response](docs/GetVersion200Response.md)
- [HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
- [HealthStatus](docs/HealthStatus.md)
- [IntrospectedOAuth2Token](docs/IntrospectedOAuth2Token.md)
- [IsReady200Response](docs/IsReady200Response.md)
- [IsReady503Response](docs/IsReady503Response.md)
- [JsonPatch](docs/JsonPatch.md)
- [JsonWebKey](docs/JsonWebKey.md)
- [JsonWebKeySet](docs/JsonWebKeySet.md)
- [OAuth2Client](docs/OAuth2Client.md)
- [OAuth2ClientTokenLifespans](docs/OAuth2ClientTokenLifespans.md)
- [OAuth2ConsentRequest](docs/OAuth2ConsentRequest.md)
- [OAuth2ConsentRequestOpenIDConnectContext](docs/OAuth2ConsentRequestOpenIDConnectContext.md)
- [OAuth2ConsentSession](docs/OAuth2ConsentSession.md)
- [OAuth2ConsentSessionExpiresAt](docs/OAuth2ConsentSessionExpiresAt.md)
- [OAuth2LoginRequest](docs/OAuth2LoginRequest.md)
- [OAuth2LogoutRequest](docs/OAuth2LogoutRequest.md)
- [OAuth2RedirectTo](docs/OAuth2RedirectTo.md)
- [OAuth2TokenExchange](docs/OAuth2TokenExchange.md)
- [OidcConfiguration](docs/OidcConfiguration.md)
- [OidcUserInfo](docs/OidcUserInfo.md)
- [Pagination](docs/Pagination.md)
- [PaginationHeaders](docs/PaginationHeaders.md)
- [RFC6749ErrorJson](docs/RFC6749ErrorJson.md)
- [RejectOAuth2Request](docs/RejectOAuth2Request.md)
- [TokenPagination](docs/TokenPagination.md)
- [TokenPaginationHeaders](docs/TokenPaginationHeaders.md)
- [TokenPaginationRequestParameters](docs/TokenPaginationRequestParameters.md)
- [TokenPaginationResponseHeaders](docs/TokenPaginationResponseHeaders.md)
- [TrustOAuth2JwtGrantIssuer](docs/TrustOAuth2JwtGrantIssuer.md)
- [TrustedOAuth2JwtGrantIssuer](docs/TrustedOAuth2JwtGrantIssuer.md)
- [TrustedOAuth2JwtGrantJsonWebKey](docs/TrustedOAuth2JwtGrantJsonWebKey.md)
- [VerifiableCredentialPrimingResponse](docs/VerifiableCredentialPrimingResponse.md)
- [VerifiableCredentialProof](docs/VerifiableCredentialProof.md)
- [VerifiableCredentialResponse](docs/VerifiableCredentialResponse.md)
- [Version](docs/Version.md)
## Documentation For Authorization
### basic
- **Type**: HTTP basic authentication
Example
```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```
### bearer
- **Type**: HTTP Bearer token authentication
Example
```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```
### oauth2
- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://hydra.demo.ory.sh/oauth2/auth
- **Scopes**:
- **offline**: A scope required when requesting refresh tokens (alias for `offline_access`)
- **offline_access**: A scope required when requesting refresh tokens
- **openid**: Request an OpenID Connect ID Token
Example
```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```
Or via OAuth2 module to automatically refresh tokens and perform user authentication.
```golang
import "golang.org/x/oauth2"
/* Perform OAuth2 round trip request and obtain a token */
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```
## Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:
* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`
## Author
[email protected] |
Go | hydra/internal/httpclient/response.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"net/http"
)
// APIResponse stores the API response returned by the server.
type APIResponse struct {
*http.Response `json:"-"`
Message string `json:"message,omitempty"`
// Operation is the name of the OpenAPI operation.
Operation string `json:"operation,omitempty"`
// RequestURL is the request URL. This value is always available, even if the
// embedded *http.Response is nil.
RequestURL string `json:"url,omitempty"`
// Method is the HTTP method used for the request. This value is always
// available, even if the embedded *http.Response is nil.
Method string `json:"method,omitempty"`
// Payload holds the contents of the response body (which may be nil or empty).
// This is provided here as the raw response.Body() reader will have already
// been drained.
Payload []byte `json:"-"`
}
// NewAPIResponse returns a new APIResponse object.
func NewAPIResponse(r *http.Response) *APIResponse {
response := &APIResponse{Response: r}
return response
}
// NewAPIResponseWithError returns a new APIResponse object with the provided error message.
func NewAPIResponseWithError(errorMessage string) *APIResponse {
response := &APIResponse{Message: errorMessage}
return response
} |
Go | hydra/internal/httpclient/utils.go | /*
Ory Hydra API
Documentation for all of Ory Hydra's APIs.
API version:
Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
"time"
)
// PtrBool is a helper routine that returns a pointer to given boolean value.
func PtrBool(v bool) *bool { return &v }
// PtrInt is a helper routine that returns a pointer to given integer value.
func PtrInt(v int) *int { return &v }
// PtrInt32 is a helper routine that returns a pointer to given integer value.
func PtrInt32(v int32) *int32 { return &v }
// PtrInt64 is a helper routine that returns a pointer to given integer value.
func PtrInt64(v int64) *int64 { return &v }
// PtrFloat32 is a helper routine that returns a pointer to given float value.
func PtrFloat32(v float32) *float32 { return &v }
// PtrFloat64 is a helper routine that returns a pointer to given float value.
func PtrFloat64(v float64) *float64 { return &v }
// PtrString is a helper routine that returns a pointer to given string value.
func PtrString(v string) *string { return &v }
// PtrTime is helper routine that returns a pointer to given Time value.
func PtrTime(v time.Time) *time.Time { return &v }
type NullableBool struct {
value *bool
isSet bool
}
func (v NullableBool) Get() *bool {
return v.value
}
func (v *NullableBool) Set(val *bool) {
v.value = val
v.isSet = true
}
func (v NullableBool) IsSet() bool {
return v.isSet
}
func (v *NullableBool) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableBool(val *bool) *NullableBool {
return &NullableBool{value: val, isSet: true}
}
func (v NullableBool) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableBool) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}
type NullableInt struct {
value *int
isSet bool
}
func (v NullableInt) Get() *int {
return v.value
}
func (v *NullableInt) Set(val *int) {
v.value = val
v.isSet = true
}
func (v NullableInt) IsSet() bool {
return v.isSet
}
func (v *NullableInt) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableInt(val *int) *NullableInt {
return &NullableInt{value: val, isSet: true}
}
func (v NullableInt) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableInt) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}
type NullableInt32 struct {
value *int32
isSet bool
}
func (v NullableInt32) Get() *int32 {
return v.value
}
func (v *NullableInt32) Set(val *int32) {
v.value = val
v.isSet = true
}
func (v NullableInt32) IsSet() bool {
return v.isSet
}
func (v *NullableInt32) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableInt32(val *int32) *NullableInt32 {
return &NullableInt32{value: val, isSet: true}
}
func (v NullableInt32) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableInt32) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}
type NullableInt64 struct {
value *int64
isSet bool
}
func (v NullableInt64) Get() *int64 {
return v.value
}
func (v *NullableInt64) Set(val *int64) {
v.value = val
v.isSet = true
}
func (v NullableInt64) IsSet() bool {
return v.isSet
}
func (v *NullableInt64) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableInt64(val *int64) *NullableInt64 {
return &NullableInt64{value: val, isSet: true}
}
func (v NullableInt64) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableInt64) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}
type NullableFloat32 struct {
value *float32
isSet bool
}
func (v NullableFloat32) Get() *float32 {
return v.value
}
func (v *NullableFloat32) Set(val *float32) {
v.value = val
v.isSet = true
}
func (v NullableFloat32) IsSet() bool {
return v.isSet
}
func (v *NullableFloat32) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableFloat32(val *float32) *NullableFloat32 {
return &NullableFloat32{value: val, isSet: true}
}
func (v NullableFloat32) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableFloat32) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}
type NullableFloat64 struct {
value *float64
isSet bool
}
func (v NullableFloat64) Get() *float64 {
return v.value
}
func (v *NullableFloat64) Set(val *float64) {
v.value = val
v.isSet = true
}
func (v NullableFloat64) IsSet() bool {
return v.isSet
}
func (v *NullableFloat64) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableFloat64(val *float64) *NullableFloat64 {
return &NullableFloat64{value: val, isSet: true}
}
func (v NullableFloat64) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableFloat64) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}
type NullableString struct {
value *string
isSet bool
}
func (v NullableString) Get() *string {
return v.value
}
func (v *NullableString) Set(val *string) {
v.value = val
v.isSet = true
}
func (v NullableString) IsSet() bool {
return v.isSet
}
func (v *NullableString) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableString(val *string) *NullableString {
return &NullableString{value: val, isSet: true}
}
func (v NullableString) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableString) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}
type NullableTime struct {
value *time.Time
isSet bool
}
func (v NullableTime) Get() *time.Time {
return v.value
}
func (v *NullableTime) Set(val *time.Time) {
v.value = val
v.isSet = true
}
func (v NullableTime) IsSet() bool {
return v.isSet
}
func (v *NullableTime) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableTime(val *time.Time) *NullableTime {
return &NullableTime{value: val, isSet: true}
}
func (v NullableTime) MarshalJSON() ([]byte, error) {
return v.value.MarshalJSON()
}
func (v *NullableTime) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
} |
hydra/internal/httpclient/.openapi-generator/FILES | .gitignore
.openapi-generator-ignore
.travis.yml
README.md
api/openapi.yaml
api_jwk.go
api_metadata.go
api_o_auth2.go
api_oidc.go
api_wellknown.go
client.go
configuration.go
docs/AcceptOAuth2ConsentRequest.md
docs/AcceptOAuth2ConsentRequestSession.md
docs/AcceptOAuth2LoginRequest.md
docs/CreateJsonWebKeySet.md
docs/CreateVerifiableCredentialRequestBody.md
docs/CredentialSupportedDraft00.md
docs/ErrorOAuth2.md
docs/GenericError.md
docs/GetVersion200Response.md
docs/HealthNotReadyStatus.md
docs/HealthStatus.md
docs/IntrospectedOAuth2Token.md
docs/IsReady200Response.md
docs/IsReady503Response.md
docs/JsonPatch.md
docs/JsonWebKey.md
docs/JsonWebKeySet.md
docs/JwkApi.md
docs/MetadataApi.md
docs/OAuth2Api.md
docs/OAuth2Client.md
docs/OAuth2ClientTokenLifespans.md
docs/OAuth2ConsentRequest.md
docs/OAuth2ConsentRequestOpenIDConnectContext.md
docs/OAuth2ConsentSession.md
docs/OAuth2ConsentSessionExpiresAt.md
docs/OAuth2LoginRequest.md
docs/OAuth2LogoutRequest.md
docs/OAuth2RedirectTo.md
docs/OAuth2TokenExchange.md
docs/OidcApi.md
docs/OidcConfiguration.md
docs/OidcUserInfo.md
docs/Pagination.md
docs/PaginationHeaders.md
docs/RFC6749ErrorJson.md
docs/RejectOAuth2Request.md
docs/TokenPagination.md
docs/TokenPaginationHeaders.md
docs/TokenPaginationRequestParameters.md
docs/TokenPaginationResponseHeaders.md
docs/TrustOAuth2JwtGrantIssuer.md
docs/TrustedOAuth2JwtGrantIssuer.md
docs/TrustedOAuth2JwtGrantJsonWebKey.md
docs/VerifiableCredentialPrimingResponse.md
docs/VerifiableCredentialProof.md
docs/VerifiableCredentialResponse.md
docs/Version.md
docs/WellknownApi.md
git_push.sh
go.mod
go.sum
model_accept_o_auth2_consent_request.go
model_accept_o_auth2_consent_request_session.go
model_accept_o_auth2_login_request.go
model_create_json_web_key_set.go
model_create_verifiable_credential_request_body.go
model_credential_supported_draft00.go
model_error_o_auth2.go
model_generic_error.go
model_get_version_200_response.go
model_health_not_ready_status.go
model_health_status.go
model_introspected_o_auth2_token.go
model_is_ready_200_response.go
model_is_ready_503_response.go
model_json_patch.go
model_json_web_key.go
model_json_web_key_set.go
model_o_auth2_client.go
model_o_auth2_client_token_lifespans.go
model_o_auth2_consent_request.go
model_o_auth2_consent_request_open_id_connect_context.go
model_o_auth2_consent_session.go
model_o_auth2_consent_session_expires_at.go
model_o_auth2_login_request.go
model_o_auth2_logout_request.go
model_o_auth2_redirect_to.go
model_o_auth2_token_exchange.go
model_oidc_configuration.go
model_oidc_user_info.go
model_pagination.go
model_pagination_headers.go
model_reject_o_auth2_request.go
model_rfc6749_error_json.go
model_token_pagination.go
model_token_pagination_headers.go
model_token_pagination_request_parameters.go
model_token_pagination_response_headers.go
model_trust_o_auth2_jwt_grant_issuer.go
model_trusted_o_auth2_jwt_grant_issuer.go
model_trusted_o_auth2_jwt_grant_json_web_key.go
model_verifiable_credential_priming_response.go
model_verifiable_credential_proof.go
model_verifiable_credential_response.go
model_version.go
response.go
utils.go |
|
YAML | hydra/internal/httpclient/api/openapi.yaml | openapi: 3.0.3
info:
contact:
email: [email protected]
description: |
Documentation for all of Ory Hydra's APIs.
license:
name: Apache 2.0
title: Ory Hydra API
version: ""
servers:
- url: /
tags:
- description: OAuth 2.0
name: oAuth2
- description: OpenID Connect
name: oidc
- description: JSON Web Keys
name: jwk
- description: Well-Known Endpoints
name: wellknown
- description: Service Metadata
name: metadata
paths:
/.well-known/jwks.json:
get:
description: "This endpoint returns JSON Web Keys required to verifying OpenID\
\ Connect ID Tokens and,\nif enabled, OAuth 2.0 JWT Access Tokens. This endpoint\
\ can be used with client libraries like\n[node-jwks-rsa](https://github.com/auth0/node-jwks-rsa)\
\ among others."
operationId: discoverJsonWebKeys
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/jsonWebKeySet'
description: jsonWebKeySet
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Discover Well-Known JSON Web Keys
tags:
- wellknown
/.well-known/openid-configuration:
get:
description: "A mechanism for an OpenID Connect Relying Party to discover the\
\ End-User's OpenID Provider and obtain information needed to interact with\
\ it, including its OAuth 2.0 endpoint locations.\n\nPopular libraries for\
\ OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang),\
\ and others.\nFor a full list of clients go here: https://openid.net/developers/certified/"
operationId: discoverOidcConfiguration
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oidcConfiguration'
description: oidcConfiguration
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: OpenID Connect Discovery
tags:
- oidc
/admin/clients:
get:
description: "This endpoint lists all clients in the database, and never returns\
\ client secrets.\nAs a default it lists the first 100 clients."
operationId: listOAuth2Clients
parameters:
- description: "Items per Page\n\nThis is the number of items per page to return.\n\
For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
explode: true
in: query
name: page_size
required: false
schema:
default: 250
format: int64
maximum: 500
minimum: 1
type: integer
style: form
- description: "Next Page Token\n\nThe next page token.\nFor details on pagination\
\ please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
explode: true
in: query
name: page_token
required: false
schema:
default: "1"
minimum: 1
type: string
style: form
- description: The name of the clients to filter by.
explode: true
in: query
name: client_name
required: false
schema:
type: string
style: form
- description: The owner of the clients to filter by.
explode: true
in: query
name: owner
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/oAuth2Client'
type: array
description: Paginated OAuth2 Client List Response
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
summary: List OAuth 2.0 Clients
tags:
- oAuth2
post:
description: "Create a new OAuth 2.0 client. If you pass `client_secret` the\
\ secret is used, otherwise a random secret\nis generated. The secret is echoed\
\ in the response. It is not possible to retrieve it later on."
operationId: createOAuth2Client
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: OAuth 2.0 Client Request Body
required: true
x-originalParamName: Body
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: oAuth2Client
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Bad Request Error Response
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
summary: Create OAuth 2.0 Client
tags:
- oAuth2
/admin/clients/{id}:
delete:
description: "Delete an existing OAuth 2.0 Client by its ID.\n\nOAuth 2.0 clients\
\ are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0\
\ clients are\ngenerated for applications which want to consume your OAuth\
\ 2.0 or OpenID Connect capabilities.\n\nMake sure that this endpoint is well\
\ protected and only callable by first-party components."
operationId: deleteOAuth2Client
parameters:
- description: The id of the OAuth 2.0 Client.
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
description: genericError
summary: Delete OAuth 2.0 Client
tags:
- oAuth2
get:
description: "Get an OAuth 2.0 client by its ID. This endpoint never returns\
\ the client secret.\n\nOAuth 2.0 clients are used to perform OAuth 2.0 and\
\ OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications\
\ which want to consume your OAuth 2.0 or OpenID Connect capabilities."
operationId: getOAuth2Client
parameters:
- description: The id of the OAuth 2.0 Client.
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: oAuth2Client
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
summary: Get an OAuth 2.0 Client
tags:
- oAuth2
patch:
description: "Patch an existing OAuth 2.0 Client using JSON Patch. If you pass\
\ `client_secret`\nthe secret will be updated and returned via the API. This\
\ is the\nonly time you will be able to retrieve the client secret, so write\
\ it down and keep it safe.\n\nOAuth 2.0 clients are used to perform OAuth\
\ 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated\
\ for applications which want to consume your OAuth 2.0 or OpenID Connect\
\ capabilities."
operationId: patchOAuth2Client
parameters:
- description: The id of the OAuth 2.0 Client.
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/jsonPatchDocument'
description: OAuth 2.0 Client JSON Patch Body
required: true
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: oAuth2Client
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Not Found Error Response
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
summary: Patch OAuth 2.0 Client
tags:
- oAuth2
put:
description: "Replaces an existing OAuth 2.0 Client with the payload you send.\
\ If you pass `client_secret` the secret is used,\notherwise the existing\
\ secret is used.\n\nIf set, the secret is echoed in the response. It is not\
\ possible to retrieve it later on.\n\nOAuth 2.0 Clients are used to perform\
\ OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated\
\ for applications which want to consume your OAuth 2.0 or OpenID Connect\
\ capabilities."
operationId: setOAuth2Client
parameters:
- description: OAuth 2.0 Client ID
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: OAuth 2.0 Client Request Body
required: true
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: oAuth2Client
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Bad Request Error Response
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Not Found Error Response
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
summary: Set OAuth 2.0 Client
tags:
- oAuth2
/admin/clients/{id}/lifespans:
put:
description: Set lifespans of different token types issued for this OAuth 2.0
client. Does not modify other fields.
operationId: setOAuth2ClientLifespans
parameters:
- description: OAuth 2.0 Client ID
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2ClientTokenLifespans'
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: oAuth2Client
default:
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
description: genericError
summary: Set OAuth2 Client Token Lifespans
tags:
- oAuth2
/admin/keys/{set}:
delete:
description: "Use this endpoint to delete a complete JSON Web Key Set and all\
\ the keys in that set.\n\nA JSON Web Key (JWK) is a JavaScript Object Notation\
\ (JSON) data structure that represents a cryptographic key. A JWK Set is\
\ a JSON data structure that represents a set of JWKs. A JSON Web Key is identified\
\ by its set and key id. ORY Hydra uses this functionality to store cryptographic\
\ keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens),\
\ and allows storing user-defined keys as well."
operationId: deleteJsonWebKeySet
parameters:
- description: The JSON Web Key Set
explode: false
in: path
name: set
required: true
schema:
type: string
style: simple
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Delete JSON Web Key Set
tags:
- jwk
get:
description: "This endpoint can be used to retrieve JWK Sets stored in ORY Hydra.\n\
\nA JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure\
\ that represents a cryptographic key. A JWK Set is a JSON data structure\
\ that represents a set of JWKs. A JSON Web Key is identified by its set and\
\ key id. ORY Hydra uses this functionality to store cryptographic keys used\
\ for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows\
\ storing user-defined keys as well."
operationId: getJsonWebKeySet
parameters:
- description: JSON Web Key Set ID
explode: false
in: path
name: set
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/jsonWebKeySet'
description: jsonWebKeySet
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Retrieve a JSON Web Key Set
tags:
- jwk
post:
description: "This endpoint is capable of generating JSON Web Key Sets for you.\
\ There a different strategies available, such as symmetric cryptographic\
\ keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If\
\ the specified JSON Web Key Set does not exist, it will be created.\n\nA\
\ JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure\
\ that represents a cryptographic key. A JWK Set is a JSON data structure\
\ that represents a set of JWKs. A JSON Web Key is identified by its set and\
\ key id. ORY Hydra uses this functionality to store cryptographic keys used\
\ for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows\
\ storing user-defined keys as well."
operationId: createJsonWebKeySet
parameters:
- description: The JSON Web Key Set ID
explode: false
in: path
name: set
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createJsonWebKeySet'
required: true
x-originalParamName: Body
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/jsonWebKeySet'
description: jsonWebKeySet
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Create JSON Web Key
tags:
- jwk
put:
description: "Use this method if you do not want to let Hydra generate the JWKs\
\ for you, but instead save your own.\n\nA JSON Web Key (JWK) is a JavaScript\
\ Object Notation (JSON) data structure that represents a cryptographic key.\
\ A JWK Set is a JSON data structure that represents a set of JWKs. A JSON\
\ Web Key is identified by its set and key id. ORY Hydra uses this functionality\
\ to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID\
\ Connect ID tokens), and allows storing user-defined keys as well."
operationId: setJsonWebKeySet
parameters:
- description: The JSON Web Key Set ID
explode: false
in: path
name: set
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/jsonWebKeySet'
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/jsonWebKeySet'
description: jsonWebKeySet
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Update a JSON Web Key Set
tags:
- jwk
/admin/keys/{set}/{kid}:
delete:
description: "Use this endpoint to delete a single JSON Web Key.\n\nA JSON Web\
\ Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents\
\ a cryptographic key. A\nJWK Set is a JSON data structure that represents\
\ a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra\
\ uses\nthis functionality to store cryptographic keys used for TLS and JSON\
\ Web Tokens (such as OpenID Connect ID tokens),\nand allows storing user-defined\
\ keys as well."
operationId: deleteJsonWebKey
parameters:
- description: The JSON Web Key Set
explode: false
in: path
name: set
required: true
schema:
type: string
style: simple
- description: The JSON Web Key ID (kid)
explode: false
in: path
name: kid
required: true
schema:
type: string
style: simple
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Delete JSON Web Key
tags:
- jwk
get:
description: This endpoint returns a singular JSON Web Key contained in a set.
It is identified by the set and the specific key ID (kid).
operationId: getJsonWebKey
parameters:
- description: JSON Web Key Set ID
explode: false
in: path
name: set
required: true
schema:
type: string
style: simple
- description: JSON Web Key ID
explode: false
in: path
name: kid
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/jsonWebKeySet'
description: jsonWebKeySet
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Get JSON Web Key
tags:
- jwk
put:
description: "Use this method if you do not want to let Hydra generate the JWKs\
\ for you, but instead save your own.\n\nA JSON Web Key (JWK) is a JavaScript\
\ Object Notation (JSON) data structure that represents a cryptographic key.\
\ A JWK Set is a JSON data structure that represents a set of JWKs. A JSON\
\ Web Key is identified by its set and key id. ORY Hydra uses this functionality\
\ to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID\
\ Connect ID tokens), and allows storing user-defined keys as well."
operationId: setJsonWebKey
parameters:
- description: The JSON Web Key Set ID
explode: false
in: path
name: set
required: true
schema:
type: string
style: simple
- description: JSON Web Key ID
explode: false
in: path
name: kid
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/jsonWebKey'
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/jsonWebKey'
description: jsonWebKey
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Set JSON Web Key
tags:
- jwk
/admin/oauth2/auth/requests/consent:
get:
description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow\
\ is initiated, Ory asks the login provider\nto authenticate the subject and\
\ then tell Ory now about it. If the subject authenticated, he/she must now\
\ be asked if\nthe OAuth 2.0 Client which initiated the flow should be allowed\
\ to access the resources on the subject's behalf.\n\nThe consent challenge\
\ is appended to the consent provider's URL to which the subject's user-agent\
\ (browser) is redirected to. The consent\nprovider uses that challenge to\
\ fetch information on the OAuth2 request and then tells Ory if the subject\
\ accepted\nor rejected the request.\n\nThe default consent provider is available\
\ via the Ory Managed Account Experience. To customize the consent provider,\
\ please\nhead over to the OAuth 2.0 documentation."
operationId: getOAuth2ConsentRequest
parameters:
- description: OAuth 2.0 Consent Request Challenge
explode: true
in: query
name: consent_challenge
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2ConsentRequest'
description: oAuth2ConsentRequest
"410":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2RedirectTo'
description: oAuth2RedirectTo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Get OAuth 2.0 Consent Request
tags:
- oAuth2
/admin/oauth2/auth/requests/consent/accept:
put:
description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow\
\ is initiated, Ory asks the login provider\nto authenticate the subject and\
\ then tell Ory now about it. If the subject authenticated, he/she must now\
\ be asked if\nthe OAuth 2.0 Client which initiated the flow should be allowed\
\ to access the resources on the subject's behalf.\n\nThe consent challenge\
\ is appended to the consent provider's URL to which the subject's user-agent\
\ (browser) is redirected to. The consent\nprovider uses that challenge to\
\ fetch information on the OAuth2 request and then tells Ory if the subject\
\ accepted\nor rejected the request.\n\nThis endpoint tells Ory that the subject\
\ has authorized the OAuth 2.0 client to access resources on his/her behalf.\n\
The consent provider includes additional information, such as session data\
\ for access and ID tokens, and if the\nconsent request should be used as\
\ basis for future requests.\n\nThe response contains a redirect URL which\
\ the consent provider should redirect the user-agent to.\n\nThe default consent\
\ provider is available via the Ory Managed Account Experience. To customize\
\ the consent provider, please\nhead over to the OAuth 2.0 documentation."
operationId: acceptOAuth2ConsentRequest
parameters:
- description: OAuth 2.0 Consent Request Challenge
explode: true
in: query
name: consent_challenge
required: true
schema:
type: string
style: form
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/acceptOAuth2ConsentRequest'
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2RedirectTo'
description: oAuth2RedirectTo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Accept OAuth 2.0 Consent Request
tags:
- oAuth2
/admin/oauth2/auth/requests/consent/reject:
put:
description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow\
\ is initiated, Ory asks the login provider\nto authenticate the subject and\
\ then tell Ory now about it. If the subject authenticated, he/she must now\
\ be asked if\nthe OAuth 2.0 Client which initiated the flow should be allowed\
\ to access the resources on the subject's behalf.\n\nThe consent challenge\
\ is appended to the consent provider's URL to which the subject's user-agent\
\ (browser) is redirected to. The consent\nprovider uses that challenge to\
\ fetch information on the OAuth2 request and then tells Ory if the subject\
\ accepted\nor rejected the request.\n\nThis endpoint tells Ory that the subject\
\ has not authorized the OAuth 2.0 client to access resources on his/her behalf.\n\
The consent provider must include a reason why the consent was not granted.\n\
\nThe response contains a redirect URL which the consent provider should redirect\
\ the user-agent to.\n\nThe default consent provider is available via the\
\ Ory Managed Account Experience. To customize the consent provider, please\n\
head over to the OAuth 2.0 documentation."
operationId: rejectOAuth2ConsentRequest
parameters:
- description: OAuth 2.0 Consent Request Challenge
explode: true
in: query
name: consent_challenge
required: true
schema:
type: string
style: form
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/rejectOAuth2Request'
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2RedirectTo'
description: oAuth2RedirectTo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Reject OAuth 2.0 Consent Request
tags:
- oAuth2
/admin/oauth2/auth/requests/login:
get:
description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow\
\ is initiated, Ory asks the login provider\nto authenticate the subject and\
\ then tell the Ory OAuth2 Service about it.\n\nPer default, the login provider\
\ is Ory itself. You may use a different login provider which needs to be\
\ a web-app\nyou write and host, and it must be able to authenticate (\"show\
\ the subject a login screen\")\na subject (in OAuth2 the proper name for\
\ subject is \"resource owner\").\n\nThe authentication challenge is appended\
\ to the login provider URL to which the subject's user-agent (browser) is\
\ redirected to. The login\nprovider uses that challenge to fetch information\
\ on the OAuth2 request and then accept or reject the requested authentication\
\ process."
operationId: getOAuth2LoginRequest
parameters:
- description: OAuth 2.0 Login Request Challenge
explode: true
in: query
name: login_challenge
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2LoginRequest'
description: oAuth2LoginRequest
"410":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2RedirectTo'
description: oAuth2RedirectTo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Get OAuth 2.0 Login Request
tags:
- oAuth2
/admin/oauth2/auth/requests/login/accept:
put:
description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow\
\ is initiated, Ory asks the login provider\nto authenticate the subject and\
\ then tell the Ory OAuth2 Service about it.\n\nThe authentication challenge\
\ is appended to the login provider URL to which the subject's user-agent\
\ (browser) is redirected to. The login\nprovider uses that challenge to fetch\
\ information on the OAuth2 request and then accept or reject the requested\
\ authentication process.\n\nThis endpoint tells Ory that the subject has\
\ successfully authenticated and includes additional information such as\n\
the subject's ID and if Ory should remember the subject's subject agent for\
\ future authentication attempts by setting\na cookie.\n\nThe response contains\
\ a redirect URL which the login provider should redirect the user-agent to."
operationId: acceptOAuth2LoginRequest
parameters:
- description: OAuth 2.0 Login Request Challenge
explode: true
in: query
name: login_challenge
required: true
schema:
type: string
style: form
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/acceptOAuth2LoginRequest'
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2RedirectTo'
description: oAuth2RedirectTo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Accept OAuth 2.0 Login Request
tags:
- oAuth2
/admin/oauth2/auth/requests/login/reject:
put:
description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow\
\ is initiated, Ory asks the login provider\nto authenticate the subject and\
\ then tell the Ory OAuth2 Service about it.\n\nThe authentication challenge\
\ is appended to the login provider URL to which the subject's user-agent\
\ (browser) is redirected to. The login\nprovider uses that challenge to fetch\
\ information on the OAuth2 request and then accept or reject the requested\
\ authentication process.\n\nThis endpoint tells Ory that the subject has\
\ not authenticated and includes a reason why the authentication\nwas denied.\n\
\nThe response contains a redirect URL which the login provider should redirect\
\ the user-agent to."
operationId: rejectOAuth2LoginRequest
parameters:
- description: OAuth 2.0 Login Request Challenge
explode: true
in: query
name: login_challenge
required: true
schema:
type: string
style: form
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/rejectOAuth2Request'
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2RedirectTo'
description: oAuth2RedirectTo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Reject OAuth 2.0 Login Request
tags:
- oAuth2
/admin/oauth2/auth/requests/logout:
get:
description: Use this endpoint to fetch an Ory OAuth 2.0 logout request.
operationId: getOAuth2LogoutRequest
parameters:
- explode: true
in: query
name: logout_challenge
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2LogoutRequest'
description: oAuth2LogoutRequest
"410":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2RedirectTo'
description: oAuth2RedirectTo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Get OAuth 2.0 Session Logout Request
tags:
- oAuth2
/admin/oauth2/auth/requests/logout/accept:
put:
description: "When a user or an application requests Ory OAuth 2.0 to remove\
\ the session state of a subject, this endpoint is used to confirm that logout\
\ request.\n\nThe response contains a redirect URL which the consent provider\
\ should redirect the user-agent to."
operationId: acceptOAuth2LogoutRequest
parameters:
- description: OAuth 2.0 Logout Request Challenge
explode: true
in: query
name: logout_challenge
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2RedirectTo'
description: oAuth2RedirectTo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Accept OAuth 2.0 Session Logout Request
tags:
- oAuth2
/admin/oauth2/auth/requests/logout/reject:
put:
description: "When a user or an application requests Ory OAuth 2.0 to remove\
\ the session state of a subject, this endpoint is used to deny that logout\
\ request.\nNo HTTP request body is required.\n\nThe response is empty as\
\ the logout provider has to chose what action to perform next."
operationId: rejectOAuth2LogoutRequest
parameters:
- explode: true
in: query
name: logout_challenge
required: true
schema:
type: string
style: form
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Reject OAuth 2.0 Session Logout Request
tags:
- oAuth2
/admin/oauth2/auth/sessions/consent:
delete:
description: |-
This endpoint revokes a subject's granted consent sessions and invalidates all
associated OAuth 2.0 Access Tokens. You may also only revoke sessions for a specific OAuth 2.0 Client ID.
operationId: revokeOAuth2ConsentSessions
parameters:
- description: |-
OAuth 2.0 Consent Subject
The subject whose consent sessions should be deleted.
explode: true
in: query
name: subject
required: true
schema:
type: string
style: form
- description: "OAuth 2.0 Client ID\n\nIf set, deletes only those consent sessions\
\ that have been granted to the specified OAuth 2.0 Client ID."
explode: true
in: query
name: client
required: false
schema:
type: string
style: form
- description: |-
Revoke All Consent Sessions
If set to `true` deletes all consent sessions by the Subject that have been granted.
explode: true
in: query
name: all
required: false
schema:
type: boolean
style: form
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Revoke OAuth 2.0 Consent Sessions of a Subject
tags:
- oAuth2
get:
description: "This endpoint lists all subject's granted consent sessions, including\
\ client and granted scope.\nIf the subject is unknown or has not granted\
\ any consent sessions yet, the endpoint returns an\nempty JSON array with\
\ status code 200 OK."
operationId: listOAuth2ConsentSessions
parameters:
- description: "Items per Page\n\nThis is the number of items per page to return.\n\
For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
explode: true
in: query
name: page_size
required: false
schema:
default: 250
format: int64
maximum: 500
minimum: 1
type: integer
style: form
- description: "Next Page Token\n\nThe next page token.\nFor details on pagination\
\ please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
explode: true
in: query
name: page_token
required: false
schema:
default: "1"
minimum: 1
type: string
style: form
- description: The subject to list the consent sessions for.
explode: true
in: query
name: subject
required: true
schema:
type: string
style: form
- description: The login session id to list the consent sessions for.
explode: true
in: query
name: login_session_id
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2ConsentSessions'
description: oAuth2ConsentSessions
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: List OAuth 2.0 Consent Sessions of a Subject
tags:
- oAuth2
/admin/oauth2/auth/sessions/login:
delete:
description: "This endpoint invalidates authentication sessions. After revoking\
\ the authentication session(s), the subject\nhas to re-authenticate at the\
\ Ory OAuth2 Provider. This endpoint does not invalidate any tokens.\n\nIf\
\ you send the subject in a query param, all authentication sessions that\
\ belong to that subject are revoked.\nNo OpennID Connect Front- or Back-channel\
\ logout is performed in this case.\n\nAlternatively, you can send a SessionID\
\ via `sid` query param, in which case, only the session that is connected\n\
to that SessionID is revoked. OpenID Connect Back-channel logout is performed\
\ in this case."
operationId: revokeOAuth2LoginSessions
parameters:
- description: |-
OAuth 2.0 Subject
The subject to revoke authentication sessions for.
explode: true
in: query
name: subject
required: false
schema:
type: string
style: form
- description: |-
OAuth 2.0 Subject
The subject to revoke authentication sessions for.
explode: true
in: query
name: sid
required: false
schema:
type: string
style: form
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
tags:
- oAuth2
/admin/oauth2/introspect:
post:
description: "The introspection endpoint allows to check if a token (both refresh\
\ and access) is active or not. An active token\nis neither expired nor revoked.\
\ If a token is active, additional information on the token will be included.\
\ You can\nset additional data for a token by setting `session.access_token`\
\ during the consent flow."
operationId: introspectOAuth2Token
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/introspectOAuth2Token_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/introspectedOAuth2Token'
description: introspectedOAuth2Token
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Introspect OAuth2 Access and Refresh Tokens
tags:
- oAuth2
/admin/oauth2/tokens:
delete:
description: This endpoint deletes OAuth2 access tokens issued to an OAuth 2.0
Client from the database.
operationId: deleteOAuth2Token
parameters:
- description: OAuth 2.0 Client ID
explode: true
in: query
name: client_id
required: true
schema:
type: string
style: form
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
tags:
- oAuth2
/admin/trust/grants/jwt-bearer/issuers:
get:
description: Use this endpoint to list all trusted JWT Bearer Grant Type Issuers.
operationId: listTrustedOAuth2JwtGrantIssuers
parameters:
- explode: true
in: query
name: MaxItems
required: false
schema:
format: int64
type: integer
style: form
- explode: true
in: query
name: DefaultItems
required: false
schema:
format: int64
type: integer
style: form
- description: "If optional \"issuer\" is supplied, only jwt-bearer grants with\
\ this issuer will be returned."
explode: true
in: query
name: issuer
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/trustedOAuth2JwtGrantIssuers'
description: trustedOAuth2JwtGrantIssuers
default:
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
description: genericError
summary: List Trusted OAuth2 JWT Bearer Grant Type Issuers
tags:
- oAuth2
post:
description: "Use this endpoint to establish a trust relationship for a JWT\
\ issuer\nto perform JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication\n\
and Authorization Grants [RFC7523](https://datatracker.ietf.org/doc/html/rfc7523)."
operationId: trustOAuth2JwtGrantIssuer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/trustOAuth2JwtGrantIssuer'
x-originalParamName: Body
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/trustedOAuth2JwtGrantIssuer'
description: trustedOAuth2JwtGrantIssuer
default:
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
description: genericError
summary: Trust OAuth2 JWT Bearer Grant Type Issuer
tags:
- oAuth2
/admin/trust/grants/jwt-bearer/issuers/{id}:
delete:
description: "Use this endpoint to delete trusted JWT Bearer Grant Type Issuer.\
\ The ID is the one returned when you\ncreated the trust relationship.\n\n\
Once deleted, the associated issuer will no longer be able to perform the\
\ JSON Web Token (JWT) Profile\nfor OAuth 2.0 Client Authentication and Authorization\
\ Grant."
operationId: deleteTrustedOAuth2JwtGrantIssuer
parameters:
- description: The id of the desired grant
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
description: genericError
summary: Delete Trusted OAuth2 JWT Bearer Grant Type Issuer
tags:
- oAuth2
get:
description: |-
Use this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you
created the trust relationship.
operationId: getTrustedOAuth2JwtGrantIssuer
parameters:
- description: The id of the desired grant
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/trustedOAuth2JwtGrantIssuer'
description: trustedOAuth2JwtGrantIssuer
default:
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
description: genericError
summary: Get Trusted OAuth2 JWT Bearer Grant Type Issuer
tags:
- oAuth2
/credentials:
post:
description: |-
This endpoint creates a verifiable credential that attests that the user
authenticated with the provided access token owns a certain public/private key
pair.
More information can be found at
https://openid.net/specs/openid-connect-userinfo-vc-1_0.html.
operationId: createVerifiableCredential
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVerifiableCredentialRequestBody'
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/verifiableCredentialResponse'
description: verifiableCredentialResponse
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/verifiableCredentialPrimingResponse'
description: verifiableCredentialPrimingResponse
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: Issues a Verifiable Credential
tags:
- oidc
/health/alive:
get:
description: "This endpoint returns a HTTP 200 status code when Ory Hydra is\
\ accepting incoming\nHTTP requests. This status does currently not include\
\ checks whether the database connection is working.\n\nIf the service supports\
\ TLS Edge Termination, this endpoint does not require the\n`X-Forwarded-Proto`\
\ header to be set.\n\nBe aware that if you are running multiple nodes of\
\ this service, the health status will never\nrefer to the cluster state,\
\ only to a single instance."
operationId: isAlive
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/healthStatus'
description: Ory Hydra is ready to accept connections.
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
description: genericError
summary: Check HTTP Server Status
tags:
- metadata
/health/ready:
get:
description: "This endpoint returns a HTTP 200 status code when Ory Hydra is\
\ up running and the environment dependencies (e.g.\nthe database) are responsive\
\ as well.\n\nIf the service supports TLS Edge Termination, this endpoint\
\ does not require the\n`X-Forwarded-Proto` header to be set.\n\nBe aware\
\ that if you are running multiple nodes of Ory Hydra, the health status will\
\ never\nrefer to the cluster state, only to a single instance."
operationId: isReady
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/isReady_200_response'
description: Ory Hydra is ready to accept requests.
"503":
content:
application/json:
schema:
$ref: '#/components/schemas/isReady_503_response'
description: Ory Kratos is not yet ready to accept requests.
summary: Check HTTP Server and Database Status
tags:
- metadata
/oauth2/auth:
get:
description: |-
Use open source libraries to perform OAuth 2.0 and OpenID Connect
available for any programming language. You can find a list of libraries at https://oauth.net/code/
The Ory SDK is not yet able to this endpoint properly.
operationId: oAuth2Authorize
responses:
"302":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
summary: OAuth 2.0 Authorize Endpoint
tags:
- oAuth2
/oauth2/register:
post:
description: |-
This endpoint behaves like the administrative counterpart (`createOAuth2Client`) but is capable of facing the
public internet directly and can be used in self-service. It implements the OpenID Connect
Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint
is disabled by default. It can be enabled by an administrator.
Please note that using this endpoint you are not able to choose the `client_secret` nor the `client_id` as those
values will be server generated when specifying `token_endpoint_auth_method` as `client_secret_basic` or
`client_secret_post`.
The `client_secret` will be returned in the response and you will not be able to retrieve it later on.
Write the secret down and keep it somewhere safe.
operationId: createOidcDynamicClient
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: Dynamic Client Registration Request Body
required: true
x-originalParamName: Body
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: oAuth2Client
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Bad Request Error Response
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
summary: Register OAuth2 Client using OpenID Dynamic Client Registration
tags:
- oidc
/oauth2/register/{id}:
delete:
description: "This endpoint behaves like the administrative counterpart (`deleteOAuth2Client`)\
\ but is capable of facing the\npublic internet directly and can be used in\
\ self-service. It implements the OpenID Connect\nDynamic Client Registration\
\ Protocol. This feature needs to be enabled in the configuration. This endpoint\n\
is disabled by default. It can be enabled by an administrator.\n\nTo use this\
\ endpoint, you will need to present the client's authentication credentials.\
\ If the OAuth2 Client\nuses the Token Endpoint Authentication Method `client_secret_post`,\
\ you need to present the client secret in the URL query.\nIf it uses `client_secret_basic`,\
\ present the Client ID and the Client Secret in the Authorization header.\n\
\nOAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows.\
\ Usually, OAuth 2.0 clients are\ngenerated for applications which want to\
\ consume your OAuth 2.0 or OpenID Connect capabilities."
operationId: deleteOidcDynamicClient
parameters:
- description: The id of the OAuth 2.0 Client.
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"204":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
description: genericError
security:
- bearer: []
summary: Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration
Management Protocol
tags:
- oidc
get:
description: "This endpoint behaves like the administrative counterpart (`getOAuth2Client`)\
\ but is capable of facing the\npublic internet directly and can be used in\
\ self-service. It implements the OpenID Connect\nDynamic Client Registration\
\ Protocol.\n\nTo use this endpoint, you will need to present the client's\
\ authentication credentials. If the OAuth2 Client\nuses the Token Endpoint\
\ Authentication Method `client_secret_post`, you need to present the client\
\ secret in the URL query.\nIf it uses `client_secret_basic`, present the\
\ Client ID and the Client Secret in the Authorization header."
operationId: getOidcDynamicClient
parameters:
- description: The id of the OAuth 2.0 Client.
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: oAuth2Client
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
security:
- bearer: []
summary: Get OAuth2 Client using OpenID Dynamic Client Registration
tags:
- oidc
put:
description: "This endpoint behaves like the administrative counterpart (`setOAuth2Client`)\
\ but is capable of facing the\npublic internet directly to be used by third\
\ parties. It implements the OpenID Connect\nDynamic Client Registration Protocol.\n\
\nThis feature is disabled per default. It can be enabled by a system administrator.\n\
\nIf you pass `client_secret` the secret is used, otherwise the existing secret\
\ is used. If set, the secret is echoed in the response.\nIt is not possible\
\ to retrieve it later on.\n\nTo use this endpoint, you will need to present\
\ the client's authentication credentials. If the OAuth2 Client\nuses the\
\ Token Endpoint Authentication Method `client_secret_post`, you need to present\
\ the client secret in the URL query.\nIf it uses `client_secret_basic`, present\
\ the Client ID and the Client Secret in the Authorization header.\n\nOAuth\
\ 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually,\
\ OAuth 2.0 clients are\ngenerated for applications which want to consume\
\ your OAuth 2.0 or OpenID Connect capabilities."
operationId: setOidcDynamicClient
parameters:
- description: OAuth 2.0 Client ID
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: OAuth 2.0 Client Request Body
required: true
x-originalParamName: Body
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2Client'
description: oAuth2Client
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Not Found Error Response
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
security:
- bearer: []
summary: Set OAuth2 Client using OpenID Dynamic Client Registration
tags:
- oidc
/oauth2/revoke:
post:
description: "Revoking a token (both access and refresh) means that the tokens\
\ will be invalid. A revoked access token can no\nlonger be used to make access\
\ requests, and a revoked refresh token can no longer be used to refresh an\
\ access token.\nRevoking a refresh token also invalidates the access token\
\ that was created with it. A token may only be revoked by\nthe client the\
\ token was generated for."
operationId: revokeOAuth2Token
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/revokeOAuth2Token_request'
responses:
"200":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
security:
- basic: []
- oauth2: []
summary: Revoke OAuth 2.0 Access or Refresh Token
tags:
- oAuth2
/oauth2/sessions/logout:
get:
description: |-
This endpoint initiates and completes user logout at the Ory OAuth2 & OpenID provider and initiates OpenID Connect Front- / Back-channel logout:
https://openid.net/specs/openid-connect-frontchannel-1_0.html
https://openid.net/specs/openid-connect-backchannel-1_0.html
Back-channel logout is performed asynchronously and does not affect logout flow.
operationId: revokeOidcSession
responses:
"302":
description: "Empty responses are sent when, for example, resources are\
\ deleted. The HTTP status code for empty responses is\ntypically 201."
summary: OpenID Connect Front- and Back-channel Enabled Logout
tags:
- oidc
/oauth2/token:
post:
description: |-
Use open source libraries to perform OAuth 2.0 and OpenID Connect
available for any programming language. You can find a list of libraries here https://oauth.net/code/
The Ory SDK is not yet able to this endpoint properly.
operationId: oauth2TokenExchange
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/oauth2TokenExchange_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oAuth2TokenExchange'
description: oAuth2TokenExchange
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
security:
- basic: []
- oauth2: []
summary: The OAuth 2.0 Token Endpoint
tags:
- oAuth2
/userinfo:
get:
description: "This endpoint returns the payload of the ID Token, including `session.id_token`\
\ values, of\nthe provided OAuth 2.0 Access Token's consent request.\n\nIn\
\ the case of authentication error, a WWW-Authenticate header might be set\
\ in the response\nwith more information about the error. See [the spec](https://datatracker.ietf.org/doc/html/rfc6750#section-3)\n\
for more details about header format."
operationId: getOidcUserInfo
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/oidcUserInfo'
description: oidcUserInfo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: errorOAuth2
security:
- oauth2: []
summary: OpenID Connect Userinfo
tags:
- oidc
/version:
get:
description: "This endpoint returns the version of Ory Hydra.\n\nIf the service\
\ supports TLS Edge Termination, this endpoint does not require the\n`X-Forwarded-Proto`\
\ header to be set.\n\nBe aware that if you are running multiple nodes of\
\ this service, the version will never\nrefer to the cluster state, only to\
\ a single instance."
operationId: getVersion
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getVersion_200_response'
description: Returns the Ory Hydra version.
summary: Return Running Software Version.
tags:
- metadata
components:
responses:
emptyResponse:
description: "Empty responses are sent when, for example, resources are deleted.\
\ The HTTP status code for empty responses is\ntypically 201."
errorOAuth2BadRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Bad Request Error Response
errorOAuth2Default:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Default Error Response
errorOAuth2NotFound:
content:
application/json:
schema:
$ref: '#/components/schemas/errorOAuth2'
description: Not Found Error Response
listOAuth2Clients:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/oAuth2Client'
type: array
description: Paginated OAuth2 Client List Response
schemas:
CreateVerifiableCredentialRequestBody:
example:
types:
- types
- types
format: format
proof:
proof_type: proof_type
jwt: jwt
properties:
format:
type: string
proof:
$ref: '#/components/schemas/VerifiableCredentialProof'
types:
items:
type: string
type: array
title: CreateVerifiableCredentialRequestBody contains the request body to request
a verifiable credential.
type: object
DefaultError: {}
JSONRawMessage:
title: "JSONRawMessage represents a json.RawMessage that works well with JSON,\
\ SQL, and Swagger."
NullBool:
nullable: true
type: boolean
NullDuration:
description: "Specify a time duration in milliseconds, seconds, minutes, hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
NullInt:
nullable: true
type: integer
NullString:
nullable: true
type: string
NullTime:
format: date-time
nullable: true
type: string
NullUUID:
format: uuid4
nullable: true
type: string
RFC6749ErrorJson:
properties:
error:
type: string
error_debug:
type: string
error_description:
type: string
error_hint:
type: string
status_code:
format: int64
type: integer
title: RFC6749ErrorJson is a helper struct for JSON encoding/decoding of RFC6749Error.
type: object
StringSliceJSONFormat:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
Time:
format: date-time
type: string
UUID:
format: uuid4
type: string
VerifiableCredentialProof:
example:
proof_type: proof_type
jwt: jwt
properties:
jwt:
type: string
proof_type:
type: string
title: VerifiableCredentialProof contains the proof of a verifiable credential.
type: object
acceptOAuth2ConsentRequest:
properties:
grant_access_token_audience:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
grant_scope:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
handled_at:
format: date-time
title: NullTime implements sql.NullTime functionality.
type: string
remember:
description: "Remember, if set to true, tells ORY Hydra to remember this\
\ consent authorization and reuse it if the same\nclient asks the same\
\ user for the same, or a subset of, scope."
type: boolean
remember_for:
description: "RememberFor sets how long the consent authorization should\
\ be remembered for in seconds. If set to `0`, the\nauthorization will\
\ be remembered indefinitely."
format: int64
type: integer
session:
$ref: '#/components/schemas/acceptOAuth2ConsentRequestSession'
title: The request payload used to accept a consent request.
type: object
acceptOAuth2ConsentRequestSession:
example:
access_token: ""
id_token: ""
properties:
access_token:
description: "AccessToken sets session data for the access and refresh token,\
\ as well as any future tokens issued by the\nrefresh grant. Keep in mind\
\ that this data will be available to anyone performing OAuth 2.0 Challenge\
\ Introspection.\nIf only your services can perform OAuth 2.0 Challenge\
\ Introspection, this is usually fine. But if third parties\ncan access\
\ that endpoint as well, sensitive data from the session might be exposed\
\ to them. Use with care!"
id_token:
description: |-
IDToken sets session data for the OpenID Connect ID token. Keep in mind that the session'id payloads are readable
by anyone that has access to the ID Challenge. Use with care!
title: Pass session data to a consent request.
type: object
acceptOAuth2LoginRequest:
properties:
acr:
description: "ACR sets the Authentication AuthorizationContext Class Reference\
\ value for this authentication session. You can use it\nto express that,\
\ for example, a user authenticated using two factor authentication."
type: string
amr:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
context:
title: "JSONRawMessage represents a json.RawMessage that works well with\
\ JSON, SQL, and Swagger."
extend_session_lifespan:
description: "Extend OAuth2 authentication session lifespan\n\nIf set to\
\ `true`, the OAuth2 authentication cookie lifespan is extended. This\
\ is for example useful if you want the user to be able to use `prompt=none`\
\ continuously.\n\nThis value can only be set to `true` if the user has\
\ an authentication, which is the case if the `skip` value is `true`."
type: boolean
force_subject_identifier:
description: "ForceSubjectIdentifier forces the \"pairwise\" user ID of\
\ the end-user that authenticated. The \"pairwise\" user ID refers to\
\ the\n(Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg]\
\ of the OpenID\nConnect specification. It allows you to set an obfuscated\
\ subject (\"user\") identifier that is unique to the client.\n\nPlease\
\ note that this changes the user ID on endpoint /userinfo and sub claim\
\ of the ID Token. It does not change the\nsub claim in the OAuth 2.0\
\ Introspection.\n\nPer default, ORY Hydra handles this value with its\
\ own algorithm. In case you want to set this yourself\nyou can use this\
\ field. Please note that setting this field has no effect if `pairwise`\
\ is not configured in\nORY Hydra or the OAuth 2.0 Client does not expect\
\ a pairwise identifier (set via `subject_type` key in the client's\n\
configuration).\n\nPlease also be aware that ORY Hydra is unable to properly\
\ compute this value during authentication. This implies\nthat you have\
\ to compute this value on every authentication process (probably depending\
\ on the client ID or some\nother unique value).\n\nIf you fail to compute\
\ the proper value, then authentication processes which have id_token_hint\
\ set might fail."
type: string
identity_provider_session_id:
description: "IdentityProviderSessionID is the session ID of the end-user\
\ that authenticated.\nIf specified, we will use this value to propagate\
\ the logout."
type: string
remember:
description: "Remember, if set to true, tells ORY Hydra to remember this\
\ user by telling the user agent (browser) to store\na cookie with authentication\
\ data. If the same user performs another OAuth 2.0 Authorization Request,\
\ he/she\nwill not be asked to log in again."
type: boolean
remember_for:
description: "RememberFor sets how long the authentication should be remembered\
\ for in seconds. If set to `0`, the\nauthorization will be remembered\
\ for the duration of the browser session (using a session cookie)."
format: int64
type: integer
subject:
description: Subject is the user ID of the end-user that authenticated.
type: string
required:
- subject
title: HandledLoginRequest is the request payload used to accept a login request.
type: object
createJsonWebKeySet:
description: Create JSON Web Key Set Request Body
properties:
alg:
description: "JSON Web Key Algorithm\n\nThe algorithm to be used for creating\
\ the key. Supports `RS256`, `ES256`, `ES512`, `HS512`, and `HS256`."
type: string
kid:
description: |-
JSON Web Key ID
The Key ID of the key to be created.
type: string
use:
description: |-
JSON Web Key Use
The "use" (public key use) parameter identifies the intended use of
the public key. The "use" parameter is employed to indicate whether
a public key is used for encrypting data or verifying the signature
on data. Valid values are "enc" and "sig".
type: string
required:
- alg
- kid
- use
type: object
credentialSupportedDraft00:
description: Includes information about the supported verifiable credentials.
example:
types:
- types
- types
cryptographic_suites_supported:
- cryptographic_suites_supported
- cryptographic_suites_supported
cryptographic_binding_methods_supported:
- cryptographic_binding_methods_supported
- cryptographic_binding_methods_supported
format: format
properties:
cryptographic_binding_methods_supported:
description: |-
OpenID Connect Verifiable Credentials Cryptographic Binding Methods Supported
Contains a list of cryptographic binding methods supported for signing the proof.
items:
type: string
type: array
cryptographic_suites_supported:
description: |-
OpenID Connect Verifiable Credentials Cryptographic Suites Supported
Contains a list of cryptographic suites methods supported for signing the proof.
items:
type: string
type: array
format:
description: |-
OpenID Connect Verifiable Credentials Format
Contains the format that is supported by this authorization server.
type: string
types:
description: |-
OpenID Connect Verifiable Credentials Types
Contains the types of verifiable credentials supported.
items:
type: string
type: array
title: Verifiable Credentials Metadata (Draft 00)
type: object
errorOAuth2:
description: Error
example:
error_debug: error_debug
status_code: 401
error_description: error_description
error: error
error_hint: The redirect URL is not allowed.
properties:
error:
description: Error
type: string
error_debug:
description: |-
Error Debug Information
Only available in dev mode.
type: string
error_description:
description: Error Description
type: string
error_hint:
description: |-
Error Hint
Helps the user identify the error cause.
example: The redirect URL is not allowed.
type: string
status_code:
description: HTTP Status Code
example: 401
format: int64
type: integer
type: object
genericError:
properties:
code:
description: The status code
example: 404
format: int64
type: integer
debug:
description: |-
Debug information
This field is often not exposed to protect against leaking
sensitive information.
example: SQL field "foo" is not a bool.
type: string
details:
description: Further error details
id:
description: |-
The error ID
Useful when trying to identify various errors in application logic.
type: string
message:
description: |-
Error message
The error's message.
example: The resource could not be found
type: string
reason:
description: A human-readable reason for the error
example: User with ID 1234 does not exist.
type: string
request:
description: |-
The request ID
The request ID is often exposed internally in order to trace
errors across service architectures. This is often a UUID.
example: d7ef54b1-ec15-46e6-bccb-524b82c035e6
type: string
status:
description: The status description
example: Not Found
type: string
required:
- message
type: object
healthNotReadyStatus:
properties:
errors:
additionalProperties:
type: string
description: Errors contains a list of errors that caused the not ready
status.
type: object
type: object
healthStatus:
example:
status: status
properties:
status:
description: Status always contains "ok".
type: string
type: object
introspectedOAuth2Token:
description: "Introspection contains an access token's session data as specified\
\ by\n[IETF RFC 7662](https://tools.ietf.org/html/rfc7662)"
example:
ext:
key: ""
sub: sub
iss: iss
active: true
obfuscated_subject: obfuscated_subject
token_type: token_type
client_id: client_id
aud:
- aud
- aud
nbf: 1
token_use: token_use
scope: scope
exp: 0
iat: 6
username: username
properties:
active:
description: "Active is a boolean indicator of whether or not the presented\
\ token\nis currently active. The specifics of a token's \"active\" state\n\
will vary depending on the implementation of the authorization\nserver\
\ and the information it keeps about its tokens, but a \"true\"\nvalue\
\ return for the \"active\" property will generally indicate\nthat a given\
\ token has been issued by this authorization server,\nhas not been revoked\
\ by the resource owner, and is within its\ngiven time window of validity\
\ (e.g., after its issuance time and\nbefore its expiration time)."
type: boolean
aud:
description: Audience contains a list of the token's intended audiences.
items:
type: string
type: array
client_id:
description: |-
ID is aclient identifier for the OAuth 2.0 client that
requested this token.
type: string
exp:
description: "Expires at is an integer timestamp, measured in the number\
\ of seconds\nsince January 1 1970 UTC, indicating when this token will\
\ expire."
format: int64
type: integer
ext:
additionalProperties: {}
description: Extra is arbitrary data set by the session.
type: object
iat:
description: "Issued at is an integer timestamp, measured in the number\
\ of seconds\nsince January 1 1970 UTC, indicating when this token was\n\
originally issued."
format: int64
type: integer
iss:
description: IssuerURL is a string representing the issuer of this token
type: string
nbf:
description: "NotBefore is an integer timestamp, measured in the number\
\ of seconds\nsince January 1 1970 UTC, indicating when this token is\
\ not to be\nused before."
format: int64
type: integer
obfuscated_subject:
description: |-
ObfuscatedSubject is set when the subject identifier algorithm was set to "pairwise" during authorization.
It is the `sub` value of the ID Token that was issued.
type: string
scope:
description: |-
Scope is a JSON string containing a space-separated list of
scopes associated with this token.
type: string
sub:
description: "Subject of the token, as defined in JWT [RFC7519].\nUsually\
\ a machine-readable identifier of the resource owner who\nauthorized\
\ this token."
type: string
token_type:
description: "TokenType is the introspected token's type, typically `Bearer`."
type: string
token_use:
description: "TokenUse is the introspected token's use, for example `access_token`\
\ or `refresh_token`."
type: string
username:
description: |-
Username is a human-readable identifier for the resource owner who
authorized this token.
type: string
required:
- active
type: object
jsonPatch:
description: A JSONPatch document as defined by RFC 6902
properties:
from:
description: "This field is used together with operation \"move\" and uses\
\ JSON Pointer notation.\n\nLearn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5)."
example: /name
type: string
op:
description: "The operation to be performed. One of \"add\", \"remove\"\
, \"replace\", \"move\", \"copy\", or \"test\"."
example: replace
type: string
path:
description: "The path to the target path. Uses JSON pointer notation.\n\
\nLearn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5)."
example: /name
type: string
value:
description: "The value to be used within the operations.\n\nLearn more\
\ [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5)."
example: foobar
required:
- op
- path
type: object
jsonPatchDocument:
description: A JSONPatchDocument request
items:
$ref: '#/components/schemas/jsonPatch'
type: array
jsonWebKey:
example:
d: T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE
e: AQAB
crv: P-256
use: sig
kid: 1603dfe0af8f4596
x5c:
- x5c
- x5c
k: GawgguFyGrWKav7AX4VKUg
dp: G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0
dq: s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk
"n": vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0
p: 6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ
kty: RSA
q: 0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ
qi: GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU
x: f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU
"y": x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0
alg: RS256
properties:
alg:
description: "The \"alg\" (algorithm) parameter identifies the algorithm\
\ intended for\nuse with the key. The values used should either be registered\
\ in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\n\
established by [JWA] or be a value that contains a Collision-\nResistant\
\ Name."
example: RS256
type: string
crv:
example: P-256
type: string
d:
example: T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE
type: string
dp:
example: G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0
type: string
dq:
example: s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk
type: string
e:
example: AQAB
type: string
k:
example: GawgguFyGrWKav7AX4VKUg
type: string
kid:
description: "The \"kid\" (key ID) parameter is used to match a specific\
\ key. This\nis used, for instance, to choose among a set of keys within\
\ a JWK Set\nduring key rollover. The structure of the \"kid\" value\
\ is\nunspecified. When \"kid\" values are used within a JWK Set, different\n\
keys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample\
\ in which different keys might use the same \"kid\" value is if\nthey\
\ have different \"kty\" (key type) values but are considered to be\n\
equivalent alternatives by the application using them.) The \"kid\"\n\
value is a case-sensitive string."
example: 1603dfe0af8f4596
type: string
kty:
description: "The \"kty\" (key type) parameter identifies the cryptographic\
\ algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\"\
\ values should\neither be registered in the IANA \"JSON Web Key Types\"\
\ registry\nestablished by [JWA] or be a value that contains a Collision-\n\
Resistant Name. The \"kty\" value is a case-sensitive string."
example: RSA
type: string
"n":
example: vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0
type: string
p:
example: 6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ
type: string
q:
example: 0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ
type: string
qi:
example: GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU
type: string
use:
description: |-
Use ("public key use") identifies the intended use of
the public key. The "use" parameter is employed to indicate whether
a public key is used for encrypting data or verifying the signature
on data. Values are commonly "sig" (signature) or "enc" (encryption).
example: sig
type: string
x:
example: f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU
type: string
x5c:
description: "The \"x5c\" (X.509 certificate chain) parameter contains a\
\ chain of one\nor more PKIX certificates [RFC5280]. The certificate\
\ chain is\nrepresented as a JSON array of certificate value strings.\
\ Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648]\
\ --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\n\
The PKIX certificate containing the key value MUST be the first\ncertificate."
items:
type: string
type: array
"y":
example: x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0
type: string
required:
- alg
- kid
- kty
- use
type: object
jsonWebKeySet:
description: JSON Web Key Set
example:
keys:
- d: T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE
e: AQAB
crv: P-256
use: sig
kid: 1603dfe0af8f4596
x5c:
- x5c
- x5c
k: GawgguFyGrWKav7AX4VKUg
dp: G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0
dq: s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk
"n": vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0
p: 6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ
kty: RSA
q: 0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ
qi: GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU
x: f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU
"y": x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0
alg: RS256
- d: T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE
e: AQAB
crv: P-256
use: sig
kid: 1603dfe0af8f4596
x5c:
- x5c
- x5c
k: GawgguFyGrWKav7AX4VKUg
dp: G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0
dq: s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk
"n": vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0
p: 6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ
kty: RSA
q: 0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ
qi: GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU
x: f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU
"y": x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0
alg: RS256
properties:
keys:
description: "List of JSON Web Keys\n\nThe value of the \"keys\" parameter\
\ is an array of JSON Web Key (JWK)\nvalues. By default, the order of\
\ the JWK values within the array does\nnot imply an order of preference\
\ among them, although applications\nof JWK Sets can choose to assign\
\ a meaning to the order for their\npurposes, if desired."
items:
$ref: '#/components/schemas/jsonWebKey'
type: array
type: object
nullDuration:
nullable: true
pattern: "^[0-9]+(ns|us|ms|s|m|h)$"
type: string
nullInt64:
nullable: true
type: integer
nullTime:
format: date-time
title: NullTime implements sql.NullTime functionality.
type: string
oAuth2Client:
description: "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect\
\ flows. Usually, OAuth 2.0 clients are\ngenerated for applications which\
\ want to consume your OAuth 2.0 or OpenID Connect capabilities."
example:
metadata: ""
token_endpoint_auth_signing_alg: token_endpoint_auth_signing_alg
client_uri: client_uri
jwt_bearer_grant_access_token_lifespan: jwt_bearer_grant_access_token_lifespan
jwks: ""
logo_uri: logo_uri
created_at: 2000-01-23T04:56:07.000+00:00
registration_client_uri: registration_client_uri
allowed_cors_origins:
- allowed_cors_origins
- allowed_cors_origins
refresh_token_grant_access_token_lifespan: refresh_token_grant_access_token_lifespan
registration_access_token: registration_access_token
client_id: client_id
token_endpoint_auth_method: client_secret_basic
userinfo_signed_response_alg: userinfo_signed_response_alg
authorization_code_grant_id_token_lifespan: authorization_code_grant_id_token_lifespan
authorization_code_grant_refresh_token_lifespan: authorization_code_grant_refresh_token_lifespan
client_credentials_grant_access_token_lifespan: client_credentials_grant_access_token_lifespan
updated_at: 2000-01-23T04:56:07.000+00:00
scope: scope1 scope-2 scope.3 scope:4
request_uris:
- request_uris
- request_uris
client_secret: client_secret
backchannel_logout_session_required: true
backchannel_logout_uri: backchannel_logout_uri
client_name: client_name
policy_uri: policy_uri
owner: owner
skip_consent: true
audience:
- audience
- audience
authorization_code_grant_access_token_lifespan: authorization_code_grant_access_token_lifespan
post_logout_redirect_uris:
- post_logout_redirect_uris
- post_logout_redirect_uris
grant_types:
- grant_types
- grant_types
subject_type: subject_type
refresh_token_grant_refresh_token_lifespan: refresh_token_grant_refresh_token_lifespan
redirect_uris:
- redirect_uris
- redirect_uris
sector_identifier_uri: sector_identifier_uri
frontchannel_logout_session_required: true
frontchannel_logout_uri: frontchannel_logout_uri
refresh_token_grant_id_token_lifespan: refresh_token_grant_id_token_lifespan
implicit_grant_id_token_lifespan: implicit_grant_id_token_lifespan
client_secret_expires_at: 0
implicit_grant_access_token_lifespan: implicit_grant_access_token_lifespan
access_token_strategy: access_token_strategy
jwks_uri: jwks_uri
request_object_signing_alg: request_object_signing_alg
tos_uri: tos_uri
contacts:
- contacts
- contacts
response_types:
- response_types
- response_types
properties:
access_token_strategy:
description: "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is\
\ the strategy used to generate access tokens.\nValid options are `jwt`\
\ and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens\n\
Setting the stragegy here overrides the global setting in `strategies.access_token`."
type: string
allowed_cors_origins:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
audience:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
authorization_code_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
authorization_code_grant_id_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
authorization_code_grant_refresh_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
backchannel_logout_session_required:
description: "OpenID Connect Back-Channel Logout Session Required\n\nBoolean\
\ value specifying whether the RP requires that a sid (session ID) Claim\
\ be included in the Logout\nToken to identify the RP session with the\
\ OP when the backchannel_logout_uri is used.\nIf omitted, the default\
\ value is false."
type: boolean
backchannel_logout_uri:
description: |-
OpenID Connect Back-Channel Logout URI
RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.
type: string
client_credentials_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
client_id:
description: |-
OAuth 2.0 Client ID
The ID is autogenerated and immutable.
type: string
client_name:
description: |-
OAuth 2.0 Client Name
The human-readable name of the client to be presented to the
end-user during authorization.
type: string
client_secret:
description: "OAuth 2.0 Client Secret\n\nThe secret will be included in\
\ the create request as cleartext, and then\nnever again. The secret is\
\ kept in hashed format and is not recoverable once lost."
type: string
client_secret_expires_at:
description: |-
OAuth 2.0 Client Secret Expires At
The field is currently not supported and its value is always 0.
format: int64
type: integer
client_uri:
description: "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web\
\ page providing information about the client.\nIf present, the server\
\ SHOULD display this URL to the end-user in\na clickable fashion."
type: string
contacts:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
created_at:
description: |-
OAuth 2.0 Client Creation Date
CreatedAt returns the timestamp of the client's creation.
format: date-time
type: string
frontchannel_logout_session_required:
description: "OpenID Connect Front-Channel Logout Session Required\n\nBoolean\
\ value specifying whether the RP requires that iss (issuer) and sid (session\
\ ID) query parameters be\nincluded to identify the RP session with the\
\ OP when the frontchannel_logout_uri is used.\nIf omitted, the default\
\ value is false."
type: boolean
frontchannel_logout_uri:
description: "OpenID Connect Front-Channel Logout URI\n\nRP URL that will\
\ cause the RP to log itself out when rendered in an iframe by the OP.\
\ An iss (issuer) query\nparameter and a sid (session ID) query parameter\
\ MAY be included by the OP to enable the RP to validate the\nrequest\
\ and to determine which of the potentially multiple sessions is to be\
\ logged out; if either is\nincluded, both MUST be."
type: string
grant_types:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
implicit_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
implicit_grant_id_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
jwks:
description: "OAuth 2.0 Client JSON Web Key Set\n\nClient's JSON Web Key\
\ Set [JWK] document, passed by value. The semantics of the jwks parameter\
\ are the same as\nthe jwks_uri parameter, other than that the JWK Set\
\ is passed by value, rather than by reference. This parameter\nis intended\
\ only to be used by Clients that, for some reason, are unable to use\
\ the jwks_uri parameter, for\ninstance, by native applications that might\
\ not have a location to host the contents of the JWK Set. If a Client\n\
can use jwks_uri, it MUST NOT use jwks. One significant downside of jwks\
\ is that it does not enable key rotation\n(which jwks_uri does, as described\
\ in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri\
\ and jwks\nparameters MUST NOT be used together."
jwks_uri:
description: "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's\
\ JSON Web Key Set [JWK] document. If the Client signs requests to the\
\ Server, it contains\nthe signing key(s) the Server uses to validate\
\ signatures from the Client. The JWK Set MAY also contain the\nClient's\
\ encryption keys(s), which are used by the Server to encrypt responses\
\ to the Client. When both signing\nand encryption keys are made available,\
\ a use (Key Use) parameter value is REQUIRED for all keys in the referenced\n\
JWK Set to indicate each key's intended usage. Although some algorithms\
\ allow the same key to be used for both\nsignatures and encryption, doing\
\ so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY\
\ be used\nto provide X.509 representations of keys provided. When used,\
\ the bare key values MUST still be present and MUST\nmatch those in the\
\ certificate."
type: string
jwt_bearer_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
logo_uri:
description: |-
OAuth 2.0 Client Logo URI
A URL string referencing the client's logo.
type: string
metadata:
title: "JSONRawMessage represents a json.RawMessage that works well with\
\ JSON, SQL, and Swagger."
owner:
description: |-
OAuth 2.0 Client Owner
Owner is a string identifying the owner of the OAuth 2.0 Client.
type: string
policy_uri:
description: "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that\
\ points to a human-readable privacy policy document\nthat describes how\
\ the deployment organization collects, uses,\nretains, and discloses\
\ personal data."
type: string
post_logout_redirect_uris:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
redirect_uris:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
refresh_token_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
refresh_token_grant_id_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
refresh_token_grant_refresh_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
registration_access_token:
description: "OpenID Connect Dynamic Client Registration Access Token\n\n\
RegistrationAccessToken can be used to update, get, or delete the OAuth2\
\ Client. It is sent when creating a client\nusing Dynamic Client Registration."
type: string
registration_client_uri:
description: "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI\
\ is the URL used to update, get, or delete the OAuth2 Client."
type: string
request_object_signing_alg:
description: "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS]\
\ alg algorithm [JWA] that MUST be used for signing Request Objects sent\
\ to the OP. All Request Objects\nfrom this Client MUST be rejected, if\
\ not signed with this algorithm."
type: string
request_uris:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
response_types:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
scope:
description: "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated\
\ list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749])\
\ that the client\ncan use when requesting access tokens."
example: scope1 scope-2 scope.3 scope:4
type: string
sector_identifier_uri:
description: |-
OpenID Connect Sector Identifier URI
URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a
file with a single JSON array of redirect_uri values.
type: string
skip_consent:
description: |-
SkipConsent skips the consent screen for this client. This field can only
be set from the admin API.
type: boolean
subject_type:
description: |-
OpenID Connect Subject Type
The `subject_types_supported` Discovery parameter contains a
list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.
type: string
token_endpoint_auth_method:
default: client_secret_basic
description: "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested\
\ Client Authentication method for the Token Endpoint. The options are:\n\
\n`client_secret_basic`: (default) Send `client_id` and `client_secret`\
\ as `application/x-www-form-urlencoded` encoded in the HTTP Authorization\
\ header.\n`client_secret_post`: Send `client_id` and `client_secret`\
\ as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`:\
\ Use JSON Web Tokens to authenticate the client.\n`none`: Used for public\
\ clients (native apps, mobile apps) which can not have secrets."
type: string
token_endpoint_auth_signing_alg:
description: |-
OAuth 2.0 Token Endpoint Signing Algorithm
Requested Client Authentication signing algorithm for the Token Endpoint.
type: string
tos_uri:
description: |-
OAuth 2.0 Client Terms of Service URI
A URL string pointing to a human-readable terms of service
document for the client that describes a contractual relationship
between the end-user and the client that the end-user accepts when
authorizing the client.
type: string
updated_at:
description: |-
OAuth 2.0 Client Last Update Date
UpdatedAt returns the timestamp of the last update.
format: date-time
type: string
userinfo_signed_response_alg:
description: "OpenID Connect Request Userinfo Signed Response Algorithm\n\
\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If\
\ this is specified, the response will be JWT\n[JWT] serialized, and signed\
\ using JWS. The default, if omitted, is for the UserInfo Response to\
\ return the Claims\nas a UTF-8 encoded JSON object using the application/json\
\ content-type."
type: string
title: OAuth 2.0 Client
type: object
oAuth2ClientTokenLifespans:
description: Lifespans of different token types issued for this OAuth 2.0 Client.
properties:
authorization_code_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
authorization_code_grant_id_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
authorization_code_grant_refresh_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
client_credentials_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
implicit_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
implicit_grant_id_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
jwt_bearer_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
refresh_token_grant_access_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
refresh_token_grant_id_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
refresh_token_grant_refresh_token_lifespan:
description: "Specify a time duration in milliseconds, seconds, minutes,\
\ hours."
pattern: "^([0-9]+(ns|us|ms|s|m|h))*$"
title: Time duration
type: string
title: OAuth 2.0 Client Token Lifespans
type: object
oAuth2ConsentRequest:
example:
requested_access_token_audience:
- requested_access_token_audience
- requested_access_token_audience
login_challenge: login_challenge
subject: subject
amr:
- amr
- amr
oidc_context:
login_hint: login_hint
ui_locales:
- ui_locales
- ui_locales
id_token_hint_claims:
key: ""
acr_values:
- acr_values
- acr_values
display: display
skip: true
request_url: request_url
acr: acr
context: ""
challenge: challenge
client:
metadata: ""
token_endpoint_auth_signing_alg: token_endpoint_auth_signing_alg
client_uri: client_uri
jwt_bearer_grant_access_token_lifespan: jwt_bearer_grant_access_token_lifespan
jwks: ""
logo_uri: logo_uri
created_at: 2000-01-23T04:56:07.000+00:00
registration_client_uri: registration_client_uri
allowed_cors_origins:
- allowed_cors_origins
- allowed_cors_origins
refresh_token_grant_access_token_lifespan: refresh_token_grant_access_token_lifespan
registration_access_token: registration_access_token
client_id: client_id
token_endpoint_auth_method: client_secret_basic
userinfo_signed_response_alg: userinfo_signed_response_alg
authorization_code_grant_id_token_lifespan: authorization_code_grant_id_token_lifespan
authorization_code_grant_refresh_token_lifespan: authorization_code_grant_refresh_token_lifespan
client_credentials_grant_access_token_lifespan: client_credentials_grant_access_token_lifespan
updated_at: 2000-01-23T04:56:07.000+00:00
scope: scope1 scope-2 scope.3 scope:4
request_uris:
- request_uris
- request_uris
client_secret: client_secret
backchannel_logout_session_required: true
backchannel_logout_uri: backchannel_logout_uri
client_name: client_name
policy_uri: policy_uri
owner: owner
skip_consent: true
audience:
- audience
- audience
authorization_code_grant_access_token_lifespan: authorization_code_grant_access_token_lifespan
post_logout_redirect_uris:
- post_logout_redirect_uris
- post_logout_redirect_uris
grant_types:
- grant_types
- grant_types
subject_type: subject_type
refresh_token_grant_refresh_token_lifespan: refresh_token_grant_refresh_token_lifespan
redirect_uris:
- redirect_uris
- redirect_uris
sector_identifier_uri: sector_identifier_uri
frontchannel_logout_session_required: true
frontchannel_logout_uri: frontchannel_logout_uri
refresh_token_grant_id_token_lifespan: refresh_token_grant_id_token_lifespan
implicit_grant_id_token_lifespan: implicit_grant_id_token_lifespan
client_secret_expires_at: 0
implicit_grant_access_token_lifespan: implicit_grant_access_token_lifespan
access_token_strategy: access_token_strategy
jwks_uri: jwks_uri
request_object_signing_alg: request_object_signing_alg
tos_uri: tos_uri
contacts:
- contacts
- contacts
response_types:
- response_types
- response_types
login_session_id: login_session_id
requested_scope:
- requested_scope
- requested_scope
properties:
acr:
description: "ACR represents the Authentication AuthorizationContext Class\
\ Reference value for this authentication session. You can use it\nto\
\ express that, for example, a user authenticated using two factor authentication."
type: string
amr:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
challenge:
description: |-
ID is the identifier ("authorization challenge") of the consent authorization request. It is used to
identify the session.
type: string
client:
$ref: '#/components/schemas/oAuth2Client'
context:
title: "JSONRawMessage represents a json.RawMessage that works well with\
\ JSON, SQL, and Swagger."
login_challenge:
description: |-
LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate
a login and consent request in the login & consent app.
type: string
login_session_id:
description: |-
LoginSessionID 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.
type: string
oidc_context:
$ref: '#/components/schemas/oAuth2ConsentRequestOpenIDConnectContext'
request_url:
description: "RequestURL is the original OAuth 2.0 Authorization URL requested\
\ by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0\
\ Authorization Code or OAuth 2.0 Implicit flow. This URL is typically\
\ not needed, but\nmight come in handy if you want to deal with additional\
\ request parameters."
type: string
requested_access_token_audience:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
requested_scope:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
skip:
description: "Skip, if true, implies that the client has requested the same\
\ scopes from the same user previously.\nIf true, you must not ask the\
\ user to grant the requested scopes. You must however either allow or\
\ deny the\nconsent request using the usual API call."
type: boolean
subject:
description: "Subject is the user ID of the end-user that authenticated.\
\ Now, that end user needs to grant or deny the scope\nrequested by the\
\ OAuth 2.0 client."
type: string
required:
- challenge
title: Contains information on an ongoing consent request.
type: object
oAuth2ConsentRequestOpenIDConnectContext:
example:
login_hint: login_hint
ui_locales:
- ui_locales
- ui_locales
id_token_hint_claims:
key: ""
acr_values:
- acr_values
- acr_values
display: display
properties:
acr_values:
description: "ACRValues is the Authentication AuthorizationContext Class\
\ Reference requested in the OAuth 2.0 Authorization request.\nIt is a\
\ parameter defined by OpenID Connect and expresses which level of authentication\
\ (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n>\
\ Requested Authentication AuthorizationContext Class Reference values.\
\ Space-separated string that specifies the acr values\nthat the Authorization\
\ Server is being requested to use for processing this Authentication\
\ Request, with the\nvalues appearing in order of preference. The Authentication\
\ AuthorizationContext Class satisfied by the authentication\nperformed\
\ is returned as the acr Claim Value, as specified in Section 2. The acr\
\ Claim is requested as a\nVoluntary Claim by this parameter."
items:
type: string
type: array
display:
description: "Display is a string value that specifies how the Authorization\
\ Server displays the authentication and consent user interface pages\
\ to the End-User.\nThe defined values are:\npage: The Authorization Server\
\ SHOULD display the authentication and consent UI consistent with a full\
\ User Agent page view. If the display parameter is not specified, this\
\ is the default display mode.\npopup: The Authorization Server SHOULD\
\ display the authentication and consent UI consistent with a popup User\
\ Agent window. The popup User Agent window should be of an appropriate\
\ size for a login-focused dialog and should not obscure the entire window\
\ that it is popping up over.\ntouch: The Authorization Server SHOULD\
\ display the authentication and consent UI consistent with a device that\
\ leverages a touch interface.\nwap: The Authorization Server SHOULD display\
\ the authentication and consent UI consistent with a \"feature phone\"\
\ type display.\n\nThe Authorization Server MAY also attempt to detect\
\ the capabilities of the User Agent and present an appropriate display."
type: string
id_token_hint_claims:
additionalProperties: {}
description: |-
IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the
End-User's current or past authenticated session with the Client.
type: object
login_hint:
description: |-
LoginHint hints about the login identifier the End-User might use to log in (if necessary).
This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)
and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a
phone number in the format specified for the phone_number Claim. The use of this parameter is optional.
type: string
ui_locales:
description: "UILocales is the End-User'id preferred languages and scripts\
\ for the user interface, represented as a\nspace-separated list of BCP47\
\ [RFC5646] language tag values, ordered by preference. For instance,\
\ the value\n\"fr-CA fr en\" represents a preference for French as spoken\
\ in Canada, then French (without a region designation),\nfollowed by\
\ English (without a region designation). An error SHOULD NOT result if\
\ some or all of the requested\nlocales are not supported by the OpenID\
\ Provider."
items:
type: string
type: array
title: Contains optional information about the OpenID Connect request.
type: object
oAuth2ConsentSession:
description: A completed OAuth 2.0 Consent Session.
example:
remember: true
consent_request:
requested_access_token_audience:
- requested_access_token_audience
- requested_access_token_audience
login_challenge: login_challenge
subject: subject
amr:
- amr
- amr
oidc_context:
login_hint: login_hint
ui_locales:
- ui_locales
- ui_locales
id_token_hint_claims:
key: ""
acr_values:
- acr_values
- acr_values
display: display
skip: true
request_url: request_url
acr: acr
context: ""
challenge: challenge
client:
metadata: ""
token_endpoint_auth_signing_alg: token_endpoint_auth_signing_alg
client_uri: client_uri
jwt_bearer_grant_access_token_lifespan: jwt_bearer_grant_access_token_lifespan
jwks: ""
logo_uri: logo_uri
created_at: 2000-01-23T04:56:07.000+00:00
registration_client_uri: registration_client_uri
allowed_cors_origins:
- allowed_cors_origins
- allowed_cors_origins
refresh_token_grant_access_token_lifespan: refresh_token_grant_access_token_lifespan
registration_access_token: registration_access_token
client_id: client_id
token_endpoint_auth_method: client_secret_basic
userinfo_signed_response_alg: userinfo_signed_response_alg
authorization_code_grant_id_token_lifespan: authorization_code_grant_id_token_lifespan
authorization_code_grant_refresh_token_lifespan: authorization_code_grant_refresh_token_lifespan
client_credentials_grant_access_token_lifespan: client_credentials_grant_access_token_lifespan
updated_at: 2000-01-23T04:56:07.000+00:00
scope: scope1 scope-2 scope.3 scope:4
request_uris:
- request_uris
- request_uris
client_secret: client_secret
backchannel_logout_session_required: true
backchannel_logout_uri: backchannel_logout_uri
client_name: client_name
policy_uri: policy_uri
owner: owner
skip_consent: true
audience:
- audience
- audience
authorization_code_grant_access_token_lifespan: authorization_code_grant_access_token_lifespan
post_logout_redirect_uris:
- post_logout_redirect_uris
- post_logout_redirect_uris
grant_types:
- grant_types
- grant_types
subject_type: subject_type
refresh_token_grant_refresh_token_lifespan: refresh_token_grant_refresh_token_lifespan
redirect_uris:
- redirect_uris
- redirect_uris
sector_identifier_uri: sector_identifier_uri
frontchannel_logout_session_required: true
frontchannel_logout_uri: frontchannel_logout_uri
refresh_token_grant_id_token_lifespan: refresh_token_grant_id_token_lifespan
implicit_grant_id_token_lifespan: implicit_grant_id_token_lifespan
client_secret_expires_at: 0
implicit_grant_access_token_lifespan: implicit_grant_access_token_lifespan
access_token_strategy: access_token_strategy
jwks_uri: jwks_uri
request_object_signing_alg: request_object_signing_alg
tos_uri: tos_uri
contacts:
- contacts
- contacts
response_types:
- response_types
- response_types
login_session_id: login_session_id
requested_scope:
- requested_scope
- requested_scope
expires_at:
access_token: 2000-01-23T04:56:07.000+00:00
refresh_token: 2000-01-23T04:56:07.000+00:00
par_context: 2000-01-23T04:56:07.000+00:00
id_token: 2000-01-23T04:56:07.000+00:00
authorize_code: 2000-01-23T04:56:07.000+00:00
session:
access_token: ""
id_token: ""
grant_access_token_audience:
- grant_access_token_audience
- grant_access_token_audience
handled_at: 2000-01-23T04:56:07.000+00:00
grant_scope:
- grant_scope
- grant_scope
remember_for: 0
properties:
consent_request:
$ref: '#/components/schemas/oAuth2ConsentRequest'
expires_at:
$ref: '#/components/schemas/oAuth2ConsentSession_expires_at'
grant_access_token_audience:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
grant_scope:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
handled_at:
format: date-time
title: NullTime implements sql.NullTime functionality.
type: string
remember:
description: "Remember Consent\n\nRemember, if set to true, tells ORY Hydra\
\ to remember this consent authorization and reuse it if the same\nclient\
\ asks the same user for the same, or a subset of, scope."
type: boolean
remember_for:
description: "Remember Consent For\n\nRememberFor sets how long the consent\
\ authorization should be remembered for in seconds. If set to `0`, the\n\
authorization will be remembered indefinitely."
format: int64
type: integer
session:
$ref: '#/components/schemas/acceptOAuth2ConsentRequestSession'
title: OAuth 2.0 Consent Session
type: object
oAuth2ConsentSessions:
description: List of OAuth 2.0 Consent Sessions
items:
$ref: '#/components/schemas/oAuth2ConsentSession'
type: array
oAuth2LoginRequest:
example:
requested_access_token_audience:
- requested_access_token_audience
- requested_access_token_audience
subject: subject
oidc_context:
login_hint: login_hint
ui_locales:
- ui_locales
- ui_locales
id_token_hint_claims:
key: ""
acr_values:
- acr_values
- acr_values
display: display
challenge: challenge
client:
metadata: ""
token_endpoint_auth_signing_alg: token_endpoint_auth_signing_alg
client_uri: client_uri
jwt_bearer_grant_access_token_lifespan: jwt_bearer_grant_access_token_lifespan
jwks: ""
logo_uri: logo_uri
created_at: 2000-01-23T04:56:07.000+00:00
registration_client_uri: registration_client_uri
allowed_cors_origins:
- allowed_cors_origins
- allowed_cors_origins
refresh_token_grant_access_token_lifespan: refresh_token_grant_access_token_lifespan
registration_access_token: registration_access_token
client_id: client_id
token_endpoint_auth_method: client_secret_basic
userinfo_signed_response_alg: userinfo_signed_response_alg
authorization_code_grant_id_token_lifespan: authorization_code_grant_id_token_lifespan
authorization_code_grant_refresh_token_lifespan: authorization_code_grant_refresh_token_lifespan
client_credentials_grant_access_token_lifespan: client_credentials_grant_access_token_lifespan
updated_at: 2000-01-23T04:56:07.000+00:00
scope: scope1 scope-2 scope.3 scope:4
request_uris:
- request_uris
- request_uris
client_secret: client_secret
backchannel_logout_session_required: true
backchannel_logout_uri: backchannel_logout_uri
client_name: client_name
policy_uri: policy_uri
owner: owner
skip_consent: true
audience:
- audience
- audience
authorization_code_grant_access_token_lifespan: authorization_code_grant_access_token_lifespan
post_logout_redirect_uris:
- post_logout_redirect_uris
- post_logout_redirect_uris
grant_types:
- grant_types
- grant_types
subject_type: subject_type
refresh_token_grant_refresh_token_lifespan: refresh_token_grant_refresh_token_lifespan
redirect_uris:
- redirect_uris
- redirect_uris
sector_identifier_uri: sector_identifier_uri
frontchannel_logout_session_required: true
frontchannel_logout_uri: frontchannel_logout_uri
refresh_token_grant_id_token_lifespan: refresh_token_grant_id_token_lifespan
implicit_grant_id_token_lifespan: implicit_grant_id_token_lifespan
client_secret_expires_at: 0
implicit_grant_access_token_lifespan: implicit_grant_access_token_lifespan
access_token_strategy: access_token_strategy
jwks_uri: jwks_uri
request_object_signing_alg: request_object_signing_alg
tos_uri: tos_uri
contacts:
- contacts
- contacts
response_types:
- response_types
- response_types
session_id: session_id
skip: true
request_url: request_url
requested_scope:
- requested_scope
- requested_scope
properties:
challenge:
description: |-
ID is the identifier ("login challenge") of the login request. It is used to
identify the session.
type: string
client:
$ref: '#/components/schemas/oAuth2Client'
oidc_context:
$ref: '#/components/schemas/oAuth2ConsentRequestOpenIDConnectContext'
request_url:
description: "RequestURL is the original OAuth 2.0 Authorization URL requested\
\ by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0\
\ Authorization Code or OAuth 2.0 Implicit flow. This URL is typically\
\ not needed, but\nmight come in handy if you want to deal with additional\
\ request parameters."
type: string
requested_access_token_audience:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
requested_scope:
items:
type: string
title: "StringSliceJSONFormat represents []string{} which is encoded to/from\
\ JSON for SQL storage."
type: array
session_id:
description: |-
SessionID 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.
type: string
skip:
description: "Skip, if true, implies that the client has requested the same\
\ scopes from the same user previously.\nIf true, you can skip asking\
\ the user to grant the requested scopes, and simply forward the user\
\ to the redirect URL.\n\nThis feature allows you to update / set session\
\ information."
type: boolean
subject:
description: "Subject is the user ID of the end-user that authenticated.\
\ Now, that end user needs to grant or deny the scope\nrequested by the\
\ OAuth 2.0 client. If this value is set and `skip` is true, you MUST\
\ include this subject type\nwhen accepting the login request, or the\
\ request will fail."
type: string
required:
- challenge
- client
- request_url
- requested_access_token_audience
- requested_scope
- skip
- subject
title: Contains information on an ongoing login request.
type: object
oAuth2LogoutRequest:
example:
subject: subject
challenge: challenge
client:
metadata: ""
token_endpoint_auth_signing_alg: token_endpoint_auth_signing_alg
client_uri: client_uri
jwt_bearer_grant_access_token_lifespan: jwt_bearer_grant_access_token_lifespan
jwks: ""
logo_uri: logo_uri
created_at: 2000-01-23T04:56:07.000+00:00
registration_client_uri: registration_client_uri
allowed_cors_origins:
- allowed_cors_origins
- allowed_cors_origins
refresh_token_grant_access_token_lifespan: refresh_token_grant_access_token_lifespan
registration_access_token: registration_access_token
client_id: client_id
token_endpoint_auth_method: client_secret_basic
userinfo_signed_response_alg: userinfo_signed_response_alg
authorization_code_grant_id_token_lifespan: authorization_code_grant_id_token_lifespan
authorization_code_grant_refresh_token_lifespan: authorization_code_grant_refresh_token_lifespan
client_credentials_grant_access_token_lifespan: client_credentials_grant_access_token_lifespan
updated_at: 2000-01-23T04:56:07.000+00:00
scope: scope1 scope-2 scope.3 scope:4
request_uris:
- request_uris
- request_uris
client_secret: client_secret
backchannel_logout_session_required: true
backchannel_logout_uri: backchannel_logout_uri
client_name: client_name
policy_uri: policy_uri
owner: owner
skip_consent: true
audience:
- audience
- audience
authorization_code_grant_access_token_lifespan: authorization_code_grant_access_token_lifespan
post_logout_redirect_uris:
- post_logout_redirect_uris
- post_logout_redirect_uris
grant_types:
- grant_types
- grant_types
subject_type: subject_type
refresh_token_grant_refresh_token_lifespan: refresh_token_grant_refresh_token_lifespan
redirect_uris:
- redirect_uris
- redirect_uris
sector_identifier_uri: sector_identifier_uri
frontchannel_logout_session_required: true
frontchannel_logout_uri: frontchannel_logout_uri
refresh_token_grant_id_token_lifespan: refresh_token_grant_id_token_lifespan
implicit_grant_id_token_lifespan: implicit_grant_id_token_lifespan
client_secret_expires_at: 0
implicit_grant_access_token_lifespan: implicit_grant_access_token_lifespan
access_token_strategy: access_token_strategy
jwks_uri: jwks_uri
request_object_signing_alg: request_object_signing_alg
tos_uri: tos_uri
contacts:
- contacts
- contacts
response_types:
- response_types
- response_types
rp_initiated: true
request_url: request_url
sid: sid
properties:
challenge:
description: |-
Challenge is the identifier ("logout challenge") of the logout authentication request. It is used to
identify the session.
type: string
client:
$ref: '#/components/schemas/oAuth2Client'
request_url:
description: RequestURL is the original Logout URL requested.
type: string
rp_initiated:
description: "RPInitiated is set to true if the request was initiated by\
\ a Relying Party (RP), also known as an OAuth 2.0 Client."
type: boolean
sid:
description: SessionID is the login session ID that was requested to log
out.
type: string
subject:
description: Subject is the user for whom the logout was request.
type: string
title: Contains information about an ongoing logout request.
type: object
oAuth2RedirectTo:
description: "Contains a redirect URL used to complete a login, consent, or\
\ logout request."
example:
redirect_to: redirect_to
properties:
redirect_to:
description: RedirectURL is the URL which you should redirect the user's
browser to once the authentication process is completed.
type: string
required:
- redirect_to
title: OAuth 2.0 Redirect Browser To
type: object
oAuth2TokenExchange:
description: OAuth2 Token Exchange Result
example:
access_token: access_token
refresh_token: refresh_token
scope: scope
id_token: 6
token_type: token_type
expires_in: 0
properties:
access_token:
description: The access token issued by the authorization server.
type: string
expires_in:
description: "The lifetime in seconds of the access token. For\nexample,\
\ the value \"3600\" denotes that the access token will\nexpire in one\
\ hour from the time the response was generated."
format: int64
type: integer
id_token:
description: To retrieve a refresh token request the id_token scope.
format: int64
type: integer
refresh_token:
description: "The refresh token, which can be used to obtain new\naccess\
\ tokens. To retrieve it add the scope \"offline\" to your access token\
\ request."
type: string
scope:
description: The scope of the access token
type: string
token_type:
description: The type of the token issued
type: string
type: object
oidcConfiguration:
description: |-
Includes links to several endpoints (for example `/oauth2/token`) and exposes information on supported signature algorithms
among others.
example:
request_parameter_supported: true
claims_parameter_supported: true
backchannel_logout_supported: true
scopes_supported:
- scopes_supported
- scopes_supported
issuer: https://playground.ory.sh/ory-hydra/public/
userinfo_signed_response_alg:
- userinfo_signed_response_alg
- userinfo_signed_response_alg
authorization_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/auth
claims_supported:
- claims_supported
- claims_supported
userinfo_signing_alg_values_supported:
- userinfo_signing_alg_values_supported
- userinfo_signing_alg_values_supported
token_endpoint_auth_methods_supported:
- token_endpoint_auth_methods_supported
- token_endpoint_auth_methods_supported
backchannel_logout_session_supported: true
response_modes_supported:
- response_modes_supported
- response_modes_supported
id_token_signed_response_alg:
- id_token_signed_response_alg
- id_token_signed_response_alg
token_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/token
response_types_supported:
- response_types_supported
- response_types_supported
request_uri_parameter_supported: true
grant_types_supported:
- grant_types_supported
- grant_types_supported
end_session_endpoint: end_session_endpoint
revocation_endpoint: revocation_endpoint
userinfo_endpoint: userinfo_endpoint
frontchannel_logout_supported: true
require_request_uri_registration: true
code_challenge_methods_supported:
- code_challenge_methods_supported
- code_challenge_methods_supported
credentials_endpoint_draft_00: credentials_endpoint_draft_00
frontchannel_logout_session_supported: true
jwks_uri: "https://{slug}.projects.oryapis.com/.well-known/jwks.json"
credentials_supported_draft_00:
- types:
- types
- types
cryptographic_suites_supported:
- cryptographic_suites_supported
- cryptographic_suites_supported
cryptographic_binding_methods_supported:
- cryptographic_binding_methods_supported
- cryptographic_binding_methods_supported
format: format
- types:
- types
- types
cryptographic_suites_supported:
- cryptographic_suites_supported
- cryptographic_suites_supported
cryptographic_binding_methods_supported:
- cryptographic_binding_methods_supported
- cryptographic_binding_methods_supported
format: format
subject_types_supported:
- subject_types_supported
- subject_types_supported
id_token_signing_alg_values_supported:
- id_token_signing_alg_values_supported
- id_token_signing_alg_values_supported
registration_endpoint: https://playground.ory.sh/ory-hydra/admin/client
request_object_signing_alg_values_supported:
- request_object_signing_alg_values_supported
- request_object_signing_alg_values_supported
properties:
authorization_endpoint:
description: OAuth 2.0 Authorization Endpoint URL
example: https://playground.ory.sh/ory-hydra/public/oauth2/auth
type: string
backchannel_logout_session_supported:
description: "OpenID Connect Back-Channel Logout Session Required\n\nBoolean\
\ value specifying whether the OP can pass a sid (session ID) Claim in\
\ the Logout Token to identify the RP\nsession with the OP. If supported,\
\ the sid Claim is also included in ID Tokens issued by the OP"
type: boolean
backchannel_logout_supported:
description: "OpenID Connect Back-Channel Logout Supported\n\nBoolean value\
\ specifying whether the OP supports back-channel logout, with true indicating\
\ support."
type: boolean
claims_parameter_supported:
description: "OpenID Connect Claims Parameter Parameter Supported\n\nBoolean\
\ value specifying whether the OP supports use of the claims parameter,\
\ with true indicating support."
type: boolean
claims_supported:
description: "OpenID Connect Supported Claims\n\nJSON array containing a\
\ list of the Claim Names of the Claims that the OpenID Provider MAY be\
\ able to supply\nvalues for. Note that for privacy or other reasons,\
\ this might not be an exhaustive list."
items:
type: string
type: array
code_challenge_methods_supported:
description: "OAuth 2.0 PKCE Supported Code Challenge Methods\n\nJSON array\
\ containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code\
\ challenge methods supported\nby this authorization server."
items:
type: string
type: array
credentials_endpoint_draft_00:
description: |-
OpenID Connect Verifiable Credentials Endpoint
Contains the URL of the Verifiable Credentials Endpoint.
type: string
credentials_supported_draft_00:
description: |-
OpenID Connect Verifiable Credentials Supported
JSON array containing a list of the Verifiable Credentials supported by this authorization server.
items:
$ref: '#/components/schemas/credentialSupportedDraft00'
type: array
end_session_endpoint:
description: |-
OpenID Connect End-Session Endpoint
URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.
type: string
frontchannel_logout_session_supported:
description: "OpenID Connect Front-Channel Logout Session Required\n\nBoolean\
\ value specifying whether the OP can pass iss (issuer) and sid (session\
\ ID) query parameters to identify\nthe RP session with the OP when the\
\ frontchannel_logout_uri is used. If supported, the sid Claim is also\n\
included in ID Tokens issued by the OP."
type: boolean
frontchannel_logout_supported:
description: "OpenID Connect Front-Channel Logout Supported\n\nBoolean value\
\ specifying whether the OP supports HTTP-based logout, with true indicating\
\ support."
type: boolean
grant_types_supported:
description: |-
OAuth 2.0 Supported Grant Types
JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.
items:
type: string
type: array
id_token_signed_response_alg:
description: |-
OpenID Connect Default ID Token Signing Algorithms
Algorithm used to sign OpenID Connect ID Tokens.
items:
type: string
type: array
id_token_signing_alg_values_supported:
description: |-
OpenID Connect Supported ID Token Signing Algorithms
JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token
to encode the Claims in a JWT.
items:
type: string
type: array
issuer:
description: "OpenID Connect Issuer URL\n\nAn URL using the https scheme\
\ with no query or fragment component that the OP asserts as its IssuerURL\
\ Identifier.\nIf IssuerURL discovery is supported , this value MUST be\
\ identical to the issuer value returned\nby WebFinger. This also MUST\
\ be identical to the iss Claim value in ID Tokens issued from this IssuerURL."
example: https://playground.ory.sh/ory-hydra/public/
type: string
jwks_uri:
description: "OpenID Connect Well-Known JSON Web Keys URL\n\nURL of the\
\ OP's JSON Web Key Set [JWK] document. This contains the signing key(s)\
\ the RP uses to validate\nsignatures from the OP. The JWK Set MAY also\
\ contain the Server's encryption key(s), which are used by RPs\nto encrypt\
\ requests to the Server. When both signing and encryption keys are made\
\ available, a use (Key Use)\nparameter value is REQUIRED for all keys\
\ in the referenced JWK Set to indicate each key's intended usage.\nAlthough\
\ some algorithms allow the same key to be used for both signatures and\
\ encryption, doing so is\nNOT RECOMMENDED, as it is less secure. The\
\ JWK x5c parameter MAY be used to provide X.509 representations of\n\
keys provided. When used, the bare key values MUST still be present and\
\ MUST match those in the certificate."
example: "https://{slug}.projects.oryapis.com/.well-known/jwks.json"
type: string
registration_endpoint:
description: OpenID Connect Dynamic Client Registration Endpoint URL
example: https://playground.ory.sh/ory-hydra/admin/client
type: string
request_object_signing_alg_values_supported:
description: "OpenID Connect Supported Request Object Signing Algorithms\n\
\nJSON array containing a list of the JWS signing algorithms (alg values)\
\ supported by the OP for Request Objects,\nwhich are described in Section\
\ 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used\
\ both when\nthe Request Object is passed by value (using the request\
\ parameter) and when it is passed by reference\n(using the request_uri\
\ parameter)."
items:
type: string
type: array
request_parameter_supported:
description: "OpenID Connect Request Parameter Supported\n\nBoolean value\
\ specifying whether the OP supports use of the request parameter, with\
\ true indicating support."
type: boolean
request_uri_parameter_supported:
description: "OpenID Connect Request URI Parameter Supported\n\nBoolean\
\ value specifying whether the OP supports use of the request_uri parameter,\
\ with true indicating support."
type: boolean
require_request_uri_registration:
description: |-
OpenID Connect Requires Request URI Registration
Boolean value specifying whether the OP requires any request_uri values used to be pre-registered
using the request_uris registration parameter.
type: boolean
response_modes_supported:
description: |-
OAuth 2.0 Supported Response Modes
JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
items:
type: string
type: array
response_types_supported:
description: "OAuth 2.0 Supported Response Types\n\nJSON array containing\
\ a list of the OAuth 2.0 response_type values that this OP supports.\
\ Dynamic OpenID\nProviders MUST support the code, id_token, and the token\
\ id_token Response Type values."
items:
type: string
type: array
revocation_endpoint:
description: |-
OAuth 2.0 Token Revocation URL
URL of the authorization server's OAuth 2.0 revocation endpoint.
type: string
scopes_supported:
description: "OAuth 2.0 Supported Scope Values\n\nJSON array containing\
\ a list of the OAuth 2.0 [RFC6749] scope values that this server supports.\
\ The server MUST\nsupport the openid scope value. Servers MAY choose\
\ not to advertise some supported scope values even when this parameter\
\ is used"
items:
type: string
type: array
subject_types_supported:
description: |-
OpenID Connect Supported Subject Types
JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include
pairwise and public.
items:
type: string
type: array
token_endpoint:
description: OAuth 2.0 Token Endpoint URL
example: https://playground.ory.sh/ory-hydra/public/oauth2/token
type: string
token_endpoint_auth_methods_supported:
description: "OAuth 2.0 Supported Client Authentication Methods\n\nJSON\
\ array containing a list of Client Authentication methods supported by\
\ this Token Endpoint. The options are\nclient_secret_post, client_secret_basic,\
\ client_secret_jwt, and private_key_jwt, as described in Section 9 of\
\ OpenID Connect Core 1.0"
items:
type: string
type: array
userinfo_endpoint:
description: |-
OpenID Connect Userinfo URL
URL of the OP's UserInfo Endpoint.
type: string
userinfo_signed_response_alg:
description: |-
OpenID Connect User Userinfo Signing Algorithm
Algorithm used to sign OpenID Connect Userinfo Responses.
items:
type: string
type: array
userinfo_signing_alg_values_supported:
description: "OpenID Connect Supported Userinfo Signing Algorithm\n\nJSON\
\ array containing a list of the JWS [JWS] signing algorithms (alg values)\
\ [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT\
\ [JWT]."
items:
type: string
type: array
required:
- authorization_endpoint
- id_token_signed_response_alg
- id_token_signing_alg_values_supported
- issuer
- jwks_uri
- response_types_supported
- subject_types_supported
- token_endpoint
- userinfo_signed_response_alg
title: OpenID Connect Discovery Metadata
type: object
oidcUserInfo:
description: OpenID Connect Userinfo
example:
sub: sub
website: website
zoneinfo: zoneinfo
birthdate: birthdate
email_verified: true
gender: gender
profile: profile
phone_number_verified: true
preferred_username: preferred_username
given_name: given_name
locale: locale
middle_name: middle_name
picture: picture
updated_at: 0
name: name
nickname: nickname
phone_number: phone_number
family_name: family_name
email: email
properties:
birthdate:
description: "End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑\
2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted.\
\ To represent only the year, YYYY format is allowed. Note that depending\
\ on the underlying platform's date related function, providing just year\
\ can result in varying month and day, so the implementers need to take\
\ this factor into account to correctly process the dates."
type: string
email:
description: "End-User's preferred e-mail address. Its value MUST conform\
\ to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon\
\ this value being unique, as discussed in Section 5.7."
type: string
email_verified:
description: "True if the End-User's e-mail address has been verified; otherwise\
\ false. When this Claim Value is true, this means that the OP took affirmative\
\ steps to ensure that this e-mail address was controlled by the End-User\
\ at the time the verification was performed. The means by which an e-mail\
\ address is verified is context-specific, and dependent upon the trust\
\ framework or contractual agreements within which the parties are operating."
type: boolean
family_name:
description: "Surname(s) or last name(s) of the End-User. Note that in some\
\ cultures, people can have multiple family names or no family name; all\
\ can be present, with the names being separated by space characters."
type: string
gender:
description: End-User's gender. Values defined by this specification are
female and male. Other values MAY be used when neither of the defined
values are applicable.
type: string
given_name:
description: "Given name(s) or first name(s) of the End-User. Note that\
\ in some cultures, people can have multiple given names; all can be present,\
\ with the names being separated by space characters."
type: string
locale:
description: "End-User's locale, represented as a BCP47 [RFC5646] language\
\ tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code\
\ in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase,\
\ separated by a dash. For example, en-US or fr-CA. As a compatibility\
\ note, some implementations have used an underscore as the separator\
\ rather than a dash, for example, en_US; Relying Parties MAY choose to\
\ accept this locale syntax as well."
type: string
middle_name:
description: "Middle name(s) of the End-User. Note that in some cultures,\
\ people can have multiple middle names; all can be present, with the\
\ names being separated by space characters. Also note that in some cultures,\
\ middle names are not used."
type: string
name:
description: "End-User's full name in displayable form including all name\
\ parts, possibly including titles and suffixes, ordered according to\
\ the End-User's locale and preferences."
type: string
nickname:
description: "Casual name of the End-User that may or may not be the same\
\ as the given_name. For instance, a nickname value of Mike might be returned\
\ alongside a given_name value of Michael."
type: string
phone_number:
description: "End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED\
\ as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2)\
\ 687 2400. If the phone number contains an extension, it is RECOMMENDED\
\ that the extension be represented using the RFC 3966 [RFC3966] extension\
\ syntax, for example, +1 (604) 555-1234;ext=5678."
type: string
phone_number_verified:
description: "True if the End-User's phone number has been verified; otherwise\
\ false. When this Claim Value is true, this means that the OP took affirmative\
\ steps to ensure that this phone number was controlled by the End-User\
\ at the time the verification was performed. The means by which a phone\
\ number is verified is context-specific, and dependent upon the trust\
\ framework or contractual agreements within which the parties are operating.\
\ When true, the phone_number Claim MUST be in E.164 format and any extensions\
\ MUST be represented in RFC 3966 format."
type: boolean
picture:
description: "URL of the End-User's profile picture. This URL MUST refer\
\ to an image file (for example, a PNG, JPEG, or GIF image file), rather\
\ than to a Web page containing an image. Note that this URL SHOULD specifically\
\ reference a profile photo of the End-User suitable for displaying when\
\ describing the End-User, rather than an arbitrary photo taken by the\
\ End-User."
type: string
preferred_username:
description: "Non-unique shorthand name by which the End-User wishes to\
\ be referred to at the RP, such as janedoe or j.doe. This value MAY be\
\ any valid JSON string including special characters such as @, /, or\
\ whitespace."
type: string
profile:
description: URL of the End-User's profile page. The contents of this Web
page SHOULD be about the End-User.
type: string
sub:
description: Subject - Identifier for the End-User at the IssuerURL.
type: string
updated_at:
description: Time the End-User's information was last updated. Its value
is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z
as measured in UTC until the date/time.
format: int64
type: integer
website:
description: URL of the End-User's Web page or blog. This Web page SHOULD
contain information published by the End-User or an organization that
the End-User is affiliated with.
type: string
zoneinfo:
description: "String from zoneinfo [zoneinfo] time zone database representing\
\ the End-User's time zone. For example, Europe/Paris or America/Los_Angeles."
type: string
type: object
pagination:
properties:
page_size:
default: 250
description: "Items per page\n\nThis is the number of items per page to\
\ return.\nFor details on pagination please head over to the [pagination\
\ documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
format: int64
maximum: 1000
minimum: 1
type: integer
page_token:
default: "1"
description: "Next Page Token\n\nThe next page token.\nFor details on pagination\
\ please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
minimum: 1
type: string
type: object
paginationHeaders:
properties:
link:
description: "The link header contains pagination links.\n\nFor details\
\ on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).\n\
\nin: header"
type: string
x-total-count:
description: "The total number of clients.\n\nin: header"
type: string
type: object
rejectOAuth2Request:
properties:
error:
description: "The error should follow the OAuth2 error format (e.g. `invalid_request`,\
\ `login_required`).\n\nDefaults to `request_denied`."
type: string
error_debug:
description: |-
Debug contains information to help resolve the problem as a developer. Usually not exposed
to the public but only in the server logs.
type: string
error_description:
description: Description of the error in a human readable format.
type: string
error_hint:
description: Hint to help resolve the error.
type: string
status_code:
description: |-
Represents the HTTP status code of the error (e.g. 401 or 403)
Defaults to 400
format: int64
type: integer
title: The request payload used to accept a login or consent request.
type: object
tokenPagination:
properties:
page_size:
default: 250
description: "Items per page\n\nThis is the number of items per page to\
\ return.\nFor details on pagination please head over to the [pagination\
\ documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
format: int64
maximum: 1000
minimum: 1
type: integer
page_token:
default: "1"
description: "Next Page Token\n\nThe next page token.\nFor details on pagination\
\ please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
minimum: 1
type: string
type: object
tokenPaginationHeaders:
properties:
link:
description: "The link header contains pagination links.\n\nFor details\
\ on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).\n\
\nin: header"
type: string
x-total-count:
description: "The total number of clients.\n\nin: header"
type: string
type: object
tokenPaginationRequestParameters:
description: "The `Link` HTTP header contains multiple links (`first`, `next`,\
\ `last`, `previous`) formatted as:\n`<https://{project-slug}.projects.oryapis.com/admin/clients?page_size={limit}&page_token={offset}>;\
\ rel=\"{page}\"`\n\nFor details on pagination please head over to the [pagination\
\ documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
properties:
page_size:
default: 250
description: "Items per Page\n\nThis is the number of items per page to\
\ return.\nFor details on pagination please head over to the [pagination\
\ documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
format: int64
maximum: 500
minimum: 1
type: integer
page_token:
default: "1"
description: "Next Page Token\n\nThe next page token.\nFor details on pagination\
\ please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
minimum: 1
type: string
title: Pagination Request Parameters
type: object
tokenPaginationResponseHeaders:
description: "The `Link` HTTP header contains multiple links (`first`, `next`,\
\ `last`, `previous`) formatted as:\n`<https://{project-slug}.projects.oryapis.com/admin/clients?page_size={limit}&page_token={offset}>;\
\ rel=\"{page}\"`\n\nFor details on pagination please head over to the [pagination\
\ documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination)."
properties:
link:
description: "The Link HTTP Header\n\nThe `Link` header contains a comma-delimited\
\ list of links to the following pages:\n\nfirst: The first page of results.\n\
next: The next page of results.\nprev: The previous page of results.\n\
last: The last page of results.\n\nPages are omitted if they do not exist.\
\ For example, if there is no next page, the `next` link is omitted. Examples:\n\
\n</clients?page_size=5&page_token=0>; rel=\"first\",</clients?page_size=5&page_token=15>;\
\ rel=\"next\",</clients?page_size=5&page_token=5>; rel=\"prev\",</clients?page_size=5&page_token=20>;\
\ rel=\"last\""
type: string
x-total-count:
description: |-
The X-Total-Count HTTP Header
The `X-Total-Count` header contains the total number of items in the collection.
format: int64
type: integer
title: Pagination Response Header
type: object
trustOAuth2JwtGrantIssuer:
description: Trust OAuth2 JWT Bearer Grant Type Issuer Request Body
properties:
allow_any_subject:
description: The "allow_any_subject" indicates that the issuer is allowed
to have any principal as the subject of the JWT.
type: boolean
expires_at:
description: "The \"expires_at\" indicates, when grant will expire, so we\
\ will reject assertion from \"issuer\" targeting \"subject\"."
format: date-time
type: string
issuer:
description: The "issuer" identifies the principal that issued the JWT assertion
(same as "iss" claim in JWT).
example: https://jwt-idp.example.com
type: string
jwk:
$ref: '#/components/schemas/jsonWebKey'
scope:
description: "The \"scope\" contains list of scope values (as described\
\ in Section 3.3 of OAuth 2.0 [RFC6749])"
example:
- openid
- offline
items:
type: string
type: array
subject:
description: The "subject" identifies the principal that is the subject
of the JWT.
example: [email protected]
type: string
required:
- expires_at
- issuer
- jwk
- scope
type: object
trustedOAuth2JwtGrantIssuer:
description: OAuth2 JWT Bearer Grant Type Issuer Trust Relationship
example:
public_key:
set: https://jwt-idp.example.com
kid: 123e4567-e89b-12d3-a456-426655440000
expires_at: 2000-01-23T04:56:07.000+00:00
subject: [email protected]
scope:
- openid
- offline
created_at: 2000-01-23T04:56:07.000+00:00
id: 9edc811f-4e28-453c-9b46-4de65f00217f
allow_any_subject: true
issuer: https://jwt-idp.example.com
properties:
allow_any_subject:
description: The "allow_any_subject" indicates that the issuer is allowed
to have any principal as the subject of the JWT.
type: boolean
created_at:
description: "The \"created_at\" indicates, when grant was created."
format: date-time
type: string
expires_at:
description: "The \"expires_at\" indicates, when grant will expire, so we\
\ will reject assertion from \"issuer\" targeting \"subject\"."
format: date-time
type: string
id:
example: 9edc811f-4e28-453c-9b46-4de65f00217f
type: string
issuer:
description: The "issuer" identifies the principal that issued the JWT assertion
(same as "iss" claim in JWT).
example: https://jwt-idp.example.com
type: string
public_key:
$ref: '#/components/schemas/trustedOAuth2JwtGrantJsonWebKey'
scope:
description: "The \"scope\" contains list of scope values (as described\
\ in Section 3.3 of OAuth 2.0 [RFC6749])"
example:
- openid
- offline
items:
type: string
type: array
subject:
description: The "subject" identifies the principal that is the subject
of the JWT.
example: [email protected]
type: string
type: object
trustedOAuth2JwtGrantIssuers:
description: OAuth2 JWT Bearer Grant Type Issuer Trust Relationships
items:
$ref: '#/components/schemas/trustedOAuth2JwtGrantIssuer'
type: array
trustedOAuth2JwtGrantJsonWebKey:
description: OAuth2 JWT Bearer Grant Type Issuer Trusted JSON Web Key
example:
set: https://jwt-idp.example.com
kid: 123e4567-e89b-12d3-a456-426655440000
properties:
kid:
description: The "key_id" is key unique identifier (same as kid header in
jws/jwt).
example: 123e4567-e89b-12d3-a456-426655440000
type: string
set:
description: The "set" is basically a name for a group(set) of keys. Will
be the same as "issuer" in grant.
example: https://jwt-idp.example.com
type: string
type: object
unexpectedError:
type: string
verifiableCredentialPrimingResponse:
properties:
c_nonce:
type: string
c_nonce_expires_in:
format: int64
type: integer
error:
type: string
error_debug:
type: string
error_description:
type: string
error_hint:
type: string
format:
type: string
status_code:
format: int64
type: integer
title: VerifiableCredentialPrimingResponse contains the nonce to include in
the proof-of-possession JWT.
type: object
verifiableCredentialResponse:
example:
credential_draft_00: credential_draft_00
format: format
properties:
credential_draft_00:
type: string
format:
type: string
title: VerifiableCredentialResponse contains the verifiable credential.
type: object
version:
properties:
version:
description: Version is the service's version.
type: string
type: object
introspectOAuth2Token_request:
properties:
scope:
description: "An optional, space separated list of required scopes. If the\
\ access token was not granted one of the\nscopes, the result of active\
\ will be false."
type: string
x-formData-name: scope
token:
description: "The string value of the token. For access tokens, this\nis\
\ the \"access_token\" value returned from the token endpoint\ndefined\
\ in OAuth 2.0. For refresh tokens, this is the \"refresh_token\"\nvalue\
\ returned."
required:
- token
type: string
x-formData-name: token
required:
- token
type: object
isReady_200_response:
example:
status: status
properties:
status:
description: Always "ok".
type: string
type: object
isReady_503_response:
properties:
errors:
additionalProperties:
type: string
description: Errors contains a list of errors that caused the not ready
status.
type: object
type: object
revokeOAuth2Token_request:
properties:
client_id:
type: string
x-formData-name: client_id
client_secret:
type: string
x-formData-name: client_secret
token:
required:
- token
type: string
x-formData-name: token
required:
- token
type: object
oauth2TokenExchange_request:
properties:
client_id:
type: string
x-formData-name: client_id
code:
type: string
x-formData-name: code
grant_type:
required:
- grant_type
type: string
x-formData-name: grant_type
redirect_uri:
type: string
x-formData-name: redirect_uri
refresh_token:
type: string
x-formData-name: refresh_token
required:
- grant_type
type: object
getVersion_200_response:
example:
version: version
properties:
version:
description: The version of Ory Hydra.
type: string
type: object
oAuth2ConsentSession_expires_at:
example:
access_token: 2000-01-23T04:56:07.000+00:00
refresh_token: 2000-01-23T04:56:07.000+00:00
par_context: 2000-01-23T04:56:07.000+00:00
id_token: 2000-01-23T04:56:07.000+00:00
authorize_code: 2000-01-23T04:56:07.000+00:00
properties:
access_token:
format: date-time
type: string
authorize_code:
format: date-time
type: string
id_token:
format: date-time
type: string
par_context:
format: date-time
type: string
refresh_token:
format: date-time
type: string
type: object
securitySchemes:
basic:
scheme: basic
type: http
bearer:
scheme: bearer
type: http
oauth2:
flows:
authorizationCode:
authorizationUrl: https://hydra.demo.ory.sh/oauth2/auth
scopes:
offline: A scope required when requesting refresh tokens (alias for `offline_access`)
offline_access: A scope required when requesting refresh tokens
openid: Request an OpenID Connect ID Token
tokenUrl: https://hydra.demo.ory.sh/oauth2/token
type: oauth2
x-forwarded-proto: string
x-request-id: string |
Markdown | hydra/internal/httpclient/docs/AcceptOAuth2ConsentRequest.md | # AcceptOAuth2ConsentRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**GrantAccessTokenAudience** | Pointer to **[]string** | | [optional]
**GrantScope** | Pointer to **[]string** | | [optional]
**HandledAt** | Pointer to **time.Time** | | [optional]
**Remember** | Pointer to **bool** | Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope. | [optional]
**RememberFor** | Pointer to **int64** | RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. | [optional]
**Session** | Pointer to [**AcceptOAuth2ConsentRequestSession**](AcceptOAuth2ConsentRequestSession.md) | | [optional]
## Methods
### NewAcceptOAuth2ConsentRequest
`func NewAcceptOAuth2ConsentRequest() *AcceptOAuth2ConsentRequest`
NewAcceptOAuth2ConsentRequest instantiates a new AcceptOAuth2ConsentRequest 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
### NewAcceptOAuth2ConsentRequestWithDefaults
`func NewAcceptOAuth2ConsentRequestWithDefaults() *AcceptOAuth2ConsentRequest`
NewAcceptOAuth2ConsentRequestWithDefaults instantiates a new AcceptOAuth2ConsentRequest 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
### GetGrantAccessTokenAudience
`func (o *AcceptOAuth2ConsentRequest) GetGrantAccessTokenAudience() []string`
GetGrantAccessTokenAudience returns the GrantAccessTokenAudience field if non-nil, zero value otherwise.
### GetGrantAccessTokenAudienceOk
`func (o *AcceptOAuth2ConsentRequest) GetGrantAccessTokenAudienceOk() (*[]string, bool)`
GetGrantAccessTokenAudienceOk returns a tuple with the GrantAccessTokenAudience field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetGrantAccessTokenAudience
`func (o *AcceptOAuth2ConsentRequest) SetGrantAccessTokenAudience(v []string)`
SetGrantAccessTokenAudience sets GrantAccessTokenAudience field to given value.
### HasGrantAccessTokenAudience
`func (o *AcceptOAuth2ConsentRequest) HasGrantAccessTokenAudience() bool`
HasGrantAccessTokenAudience returns a boolean if a field has been set.
### GetGrantScope
`func (o *AcceptOAuth2ConsentRequest) GetGrantScope() []string`
GetGrantScope returns the GrantScope field if non-nil, zero value otherwise.
### GetGrantScopeOk
`func (o *AcceptOAuth2ConsentRequest) GetGrantScopeOk() (*[]string, bool)`
GetGrantScopeOk returns a tuple with the GrantScope field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetGrantScope
`func (o *AcceptOAuth2ConsentRequest) SetGrantScope(v []string)`
SetGrantScope sets GrantScope field to given value.
### HasGrantScope
`func (o *AcceptOAuth2ConsentRequest) HasGrantScope() bool`
HasGrantScope returns a boolean if a field has been set.
### GetHandledAt
`func (o *AcceptOAuth2ConsentRequest) GetHandledAt() time.Time`
GetHandledAt returns the HandledAt field if non-nil, zero value otherwise.
### GetHandledAtOk
`func (o *AcceptOAuth2ConsentRequest) GetHandledAtOk() (*time.Time, bool)`
GetHandledAtOk returns a tuple with the HandledAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetHandledAt
`func (o *AcceptOAuth2ConsentRequest) SetHandledAt(v time.Time)`
SetHandledAt sets HandledAt field to given value.
### HasHandledAt
`func (o *AcceptOAuth2ConsentRequest) HasHandledAt() bool`
HasHandledAt returns a boolean if a field has been set.
### GetRemember
`func (o *AcceptOAuth2ConsentRequest) GetRemember() bool`
GetRemember returns the Remember field if non-nil, zero value otherwise.
### GetRememberOk
`func (o *AcceptOAuth2ConsentRequest) GetRememberOk() (*bool, bool)`
GetRememberOk returns a tuple with the Remember field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRemember
`func (o *AcceptOAuth2ConsentRequest) SetRemember(v bool)`
SetRemember sets Remember field to given value.
### HasRemember
`func (o *AcceptOAuth2ConsentRequest) HasRemember() bool`
HasRemember returns a boolean if a field has been set.
### GetRememberFor
`func (o *AcceptOAuth2ConsentRequest) GetRememberFor() int64`
GetRememberFor returns the RememberFor field if non-nil, zero value otherwise.
### GetRememberForOk
`func (o *AcceptOAuth2ConsentRequest) GetRememberForOk() (*int64, bool)`
GetRememberForOk returns a tuple with the RememberFor field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRememberFor
`func (o *AcceptOAuth2ConsentRequest) SetRememberFor(v int64)`
SetRememberFor sets RememberFor field to given value.
### HasRememberFor
`func (o *AcceptOAuth2ConsentRequest) HasRememberFor() bool`
HasRememberFor returns a boolean if a field has been set.
### GetSession
`func (o *AcceptOAuth2ConsentRequest) GetSession() AcceptOAuth2ConsentRequestSession`
GetSession returns the Session field if non-nil, zero value otherwise.
### GetSessionOk
`func (o *AcceptOAuth2ConsentRequest) GetSessionOk() (*AcceptOAuth2ConsentRequestSession, bool)`
GetSessionOk returns a tuple with the Session field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSession
`func (o *AcceptOAuth2ConsentRequest) SetSession(v AcceptOAuth2ConsentRequestSession)`
SetSession sets Session field to given value.
### HasSession
`func (o *AcceptOAuth2ConsentRequest) HasSession() bool`
HasSession returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/AcceptOAuth2ConsentRequestSession.md | # AcceptOAuth2ConsentRequestSession
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessToken** | Pointer to **interface{}** | AccessToken sets session data for the access and refresh token, as well as any future tokens issued by the refresh grant. Keep in mind that this data will be available to anyone performing OAuth 2.0 Challenge Introspection. If only your services can perform OAuth 2.0 Challenge Introspection, this is usually fine. But if third parties can access that endpoint as well, sensitive data from the session might be exposed to them. Use with care! | [optional]
**IdToken** | Pointer to **interface{}** | IDToken sets session data for the OpenID Connect ID token. Keep in mind that the session'id payloads are readable by anyone that has access to the ID Challenge. Use with care! | [optional]
## Methods
### NewAcceptOAuth2ConsentRequestSession
`func NewAcceptOAuth2ConsentRequestSession() *AcceptOAuth2ConsentRequestSession`
NewAcceptOAuth2ConsentRequestSession instantiates a new AcceptOAuth2ConsentRequestSession 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
### NewAcceptOAuth2ConsentRequestSessionWithDefaults
`func NewAcceptOAuth2ConsentRequestSessionWithDefaults() *AcceptOAuth2ConsentRequestSession`
NewAcceptOAuth2ConsentRequestSessionWithDefaults instantiates a new AcceptOAuth2ConsentRequestSession 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
### GetAccessToken
`func (o *AcceptOAuth2ConsentRequestSession) GetAccessToken() interface{}`
GetAccessToken returns the AccessToken field if non-nil, zero value otherwise.
### GetAccessTokenOk
`func (o *AcceptOAuth2ConsentRequestSession) GetAccessTokenOk() (*interface{}, bool)`
GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAccessToken
`func (o *AcceptOAuth2ConsentRequestSession) SetAccessToken(v interface{})`
SetAccessToken sets AccessToken field to given value.
### HasAccessToken
`func (o *AcceptOAuth2ConsentRequestSession) HasAccessToken() bool`
HasAccessToken returns a boolean if a field has been set.
### SetAccessTokenNil
`func (o *AcceptOAuth2ConsentRequestSession) SetAccessTokenNil(b bool)`
SetAccessTokenNil sets the value for AccessToken to be an explicit nil
### UnsetAccessToken
`func (o *AcceptOAuth2ConsentRequestSession) UnsetAccessToken()`
UnsetAccessToken ensures that no value is present for AccessToken, not even an explicit nil
### GetIdToken
`func (o *AcceptOAuth2ConsentRequestSession) GetIdToken() interface{}`
GetIdToken returns the IdToken field if non-nil, zero value otherwise.
### GetIdTokenOk
`func (o *AcceptOAuth2ConsentRequestSession) GetIdTokenOk() (*interface{}, bool)`
GetIdTokenOk returns a tuple with the IdToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIdToken
`func (o *AcceptOAuth2ConsentRequestSession) SetIdToken(v interface{})`
SetIdToken sets IdToken field to given value.
### HasIdToken
`func (o *AcceptOAuth2ConsentRequestSession) HasIdToken() bool`
HasIdToken returns a boolean if a field has been set.
### SetIdTokenNil
`func (o *AcceptOAuth2ConsentRequestSession) SetIdTokenNil(b bool)`
SetIdTokenNil sets the value for IdToken to be an explicit nil
### UnsetIdToken
`func (o *AcceptOAuth2ConsentRequestSession) UnsetIdToken()`
UnsetIdToken ensures that no value is present for IdToken, not even an explicit nil
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/AcceptOAuth2LoginRequest.md | # AcceptOAuth2LoginRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Acr** | Pointer to **string** | ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication. | [optional]
**Amr** | Pointer to **[]string** | | [optional]
**Context** | Pointer to **interface{}** | | [optional]
**ExtendSessionLifespan** | Pointer to **bool** | Extend OAuth2 authentication session lifespan If set to `true`, the OAuth2 authentication cookie lifespan is extended. This is for example useful if you want the user to be able to use `prompt=none` continuously. This value can only be set to `true` if the user has an authentication, which is the case if the `skip` value is `true`. | [optional]
**ForceSubjectIdentifier** | Pointer to **string** | ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail. | [optional]
**IdentityProviderSessionId** | Pointer to **string** | IdentityProviderSessionID is the session ID of the end-user that authenticated. If specified, we will use this value to propagate the logout. | [optional]
**Remember** | Pointer to **bool** | Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again. | [optional]
**RememberFor** | Pointer to **int64** | RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). | [optional]
**Subject** | **string** | Subject is the user ID of the end-user that authenticated. |
## Methods
### NewAcceptOAuth2LoginRequest
`func NewAcceptOAuth2LoginRequest(subject string, ) *AcceptOAuth2LoginRequest`
NewAcceptOAuth2LoginRequest instantiates a new AcceptOAuth2LoginRequest 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
### NewAcceptOAuth2LoginRequestWithDefaults
`func NewAcceptOAuth2LoginRequestWithDefaults() *AcceptOAuth2LoginRequest`
NewAcceptOAuth2LoginRequestWithDefaults instantiates a new AcceptOAuth2LoginRequest 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
### GetAcr
`func (o *AcceptOAuth2LoginRequest) GetAcr() string`
GetAcr returns the Acr field if non-nil, zero value otherwise.
### GetAcrOk
`func (o *AcceptOAuth2LoginRequest) GetAcrOk() (*string, bool)`
GetAcrOk returns a tuple with the Acr field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAcr
`func (o *AcceptOAuth2LoginRequest) SetAcr(v string)`
SetAcr sets Acr field to given value.
### HasAcr
`func (o *AcceptOAuth2LoginRequest) HasAcr() bool`
HasAcr returns a boolean if a field has been set.
### GetAmr
`func (o *AcceptOAuth2LoginRequest) GetAmr() []string`
GetAmr returns the Amr field if non-nil, zero value otherwise.
### GetAmrOk
`func (o *AcceptOAuth2LoginRequest) GetAmrOk() (*[]string, bool)`
GetAmrOk returns a tuple with the Amr field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAmr
`func (o *AcceptOAuth2LoginRequest) SetAmr(v []string)`
SetAmr sets Amr field to given value.
### HasAmr
`func (o *AcceptOAuth2LoginRequest) HasAmr() bool`
HasAmr returns a boolean if a field has been set.
### GetContext
`func (o *AcceptOAuth2LoginRequest) GetContext() interface{}`
GetContext returns the Context field if non-nil, zero value otherwise.
### GetContextOk
`func (o *AcceptOAuth2LoginRequest) GetContextOk() (*interface{}, bool)`
GetContextOk returns a tuple with the Context field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetContext
`func (o *AcceptOAuth2LoginRequest) SetContext(v interface{})`
SetContext sets Context field to given value.
### HasContext
`func (o *AcceptOAuth2LoginRequest) HasContext() bool`
HasContext returns a boolean if a field has been set.
### SetContextNil
`func (o *AcceptOAuth2LoginRequest) SetContextNil(b bool)`
SetContextNil sets the value for Context to be an explicit nil
### UnsetContext
`func (o *AcceptOAuth2LoginRequest) UnsetContext()`
UnsetContext ensures that no value is present for Context, not even an explicit nil
### GetExtendSessionLifespan
`func (o *AcceptOAuth2LoginRequest) GetExtendSessionLifespan() bool`
GetExtendSessionLifespan returns the ExtendSessionLifespan field if non-nil, zero value otherwise.
### GetExtendSessionLifespanOk
`func (o *AcceptOAuth2LoginRequest) GetExtendSessionLifespanOk() (*bool, bool)`
GetExtendSessionLifespanOk returns a tuple with the ExtendSessionLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetExtendSessionLifespan
`func (o *AcceptOAuth2LoginRequest) SetExtendSessionLifespan(v bool)`
SetExtendSessionLifespan sets ExtendSessionLifespan field to given value.
### HasExtendSessionLifespan
`func (o *AcceptOAuth2LoginRequest) HasExtendSessionLifespan() bool`
HasExtendSessionLifespan returns a boolean if a field has been set.
### GetForceSubjectIdentifier
`func (o *AcceptOAuth2LoginRequest) GetForceSubjectIdentifier() string`
GetForceSubjectIdentifier returns the ForceSubjectIdentifier field if non-nil, zero value otherwise.
### GetForceSubjectIdentifierOk
`func (o *AcceptOAuth2LoginRequest) GetForceSubjectIdentifierOk() (*string, bool)`
GetForceSubjectIdentifierOk returns a tuple with the ForceSubjectIdentifier field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetForceSubjectIdentifier
`func (o *AcceptOAuth2LoginRequest) SetForceSubjectIdentifier(v string)`
SetForceSubjectIdentifier sets ForceSubjectIdentifier field to given value.
### HasForceSubjectIdentifier
`func (o *AcceptOAuth2LoginRequest) HasForceSubjectIdentifier() bool`
HasForceSubjectIdentifier returns a boolean if a field has been set.
### GetIdentityProviderSessionId
`func (o *AcceptOAuth2LoginRequest) GetIdentityProviderSessionId() string`
GetIdentityProviderSessionId returns the IdentityProviderSessionId field if non-nil, zero value otherwise.
### GetIdentityProviderSessionIdOk
`func (o *AcceptOAuth2LoginRequest) GetIdentityProviderSessionIdOk() (*string, bool)`
GetIdentityProviderSessionIdOk returns a tuple with the IdentityProviderSessionId field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIdentityProviderSessionId
`func (o *AcceptOAuth2LoginRequest) SetIdentityProviderSessionId(v string)`
SetIdentityProviderSessionId sets IdentityProviderSessionId field to given value.
### HasIdentityProviderSessionId
`func (o *AcceptOAuth2LoginRequest) HasIdentityProviderSessionId() bool`
HasIdentityProviderSessionId returns a boolean if a field has been set.
### GetRemember
`func (o *AcceptOAuth2LoginRequest) GetRemember() bool`
GetRemember returns the Remember field if non-nil, zero value otherwise.
### GetRememberOk
`func (o *AcceptOAuth2LoginRequest) GetRememberOk() (*bool, bool)`
GetRememberOk returns a tuple with the Remember field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRemember
`func (o *AcceptOAuth2LoginRequest) SetRemember(v bool)`
SetRemember sets Remember field to given value.
### HasRemember
`func (o *AcceptOAuth2LoginRequest) HasRemember() bool`
HasRemember returns a boolean if a field has been set.
### GetRememberFor
`func (o *AcceptOAuth2LoginRequest) GetRememberFor() int64`
GetRememberFor returns the RememberFor field if non-nil, zero value otherwise.
### GetRememberForOk
`func (o *AcceptOAuth2LoginRequest) GetRememberForOk() (*int64, bool)`
GetRememberForOk returns a tuple with the RememberFor field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRememberFor
`func (o *AcceptOAuth2LoginRequest) SetRememberFor(v int64)`
SetRememberFor sets RememberFor field to given value.
### HasRememberFor
`func (o *AcceptOAuth2LoginRequest) HasRememberFor() bool`
HasRememberFor returns a boolean if a field has been set.
### GetSubject
`func (o *AcceptOAuth2LoginRequest) GetSubject() string`
GetSubject returns the Subject field if non-nil, zero value otherwise.
### GetSubjectOk
`func (o *AcceptOAuth2LoginRequest) 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 *AcceptOAuth2LoginRequest) SetSubject(v string)`
SetSubject sets Subject field to given value.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/CreateJsonWebKeySet.md | # CreateJsonWebKeySet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Alg** | **string** | JSON Web Key Algorithm The algorithm to be used for creating the key. Supports `RS256`, `ES256`, `ES512`, `HS512`, and `HS256`. |
**Kid** | **string** | JSON Web Key ID The Key ID of the key to be created. |
**Use** | **string** | JSON Web Key Use The \"use\" (public key use) parameter identifies the intended use of the public key. The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Valid values are \"enc\" and \"sig\". |
## Methods
### NewCreateJsonWebKeySet
`func NewCreateJsonWebKeySet(alg string, kid string, use string, ) *CreateJsonWebKeySet`
NewCreateJsonWebKeySet instantiates a new CreateJsonWebKeySet 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
### NewCreateJsonWebKeySetWithDefaults
`func NewCreateJsonWebKeySetWithDefaults() *CreateJsonWebKeySet`
NewCreateJsonWebKeySetWithDefaults instantiates a new CreateJsonWebKeySet 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
### GetAlg
`func (o *CreateJsonWebKeySet) GetAlg() string`
GetAlg returns the Alg field if non-nil, zero value otherwise.
### GetAlgOk
`func (o *CreateJsonWebKeySet) GetAlgOk() (*string, bool)`
GetAlgOk returns a tuple with the Alg field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAlg
`func (o *CreateJsonWebKeySet) SetAlg(v string)`
SetAlg sets Alg field to given value.
### GetKid
`func (o *CreateJsonWebKeySet) GetKid() string`
GetKid returns the Kid field if non-nil, zero value otherwise.
### GetKidOk
`func (o *CreateJsonWebKeySet) GetKidOk() (*string, bool)`
GetKidOk returns a tuple with the Kid field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetKid
`func (o *CreateJsonWebKeySet) SetKid(v string)`
SetKid sets Kid field to given value.
### GetUse
`func (o *CreateJsonWebKeySet) GetUse() string`
GetUse returns the Use field if non-nil, zero value otherwise.
### GetUseOk
`func (o *CreateJsonWebKeySet) GetUseOk() (*string, bool)`
GetUseOk returns a tuple with the Use field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUse
`func (o *CreateJsonWebKeySet) SetUse(v string)`
SetUse sets Use field to given value.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/CreateVerifiableCredentialRequestBody.md | # CreateVerifiableCredentialRequestBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Format** | Pointer to **string** | | [optional]
**Proof** | Pointer to [**VerifiableCredentialProof**](VerifiableCredentialProof.md) | | [optional]
**Types** | Pointer to **[]string** | | [optional]
## Methods
### NewCreateVerifiableCredentialRequestBody
`func NewCreateVerifiableCredentialRequestBody() *CreateVerifiableCredentialRequestBody`
NewCreateVerifiableCredentialRequestBody instantiates a new CreateVerifiableCredentialRequestBody 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
### NewCreateVerifiableCredentialRequestBodyWithDefaults
`func NewCreateVerifiableCredentialRequestBodyWithDefaults() *CreateVerifiableCredentialRequestBody`
NewCreateVerifiableCredentialRequestBodyWithDefaults instantiates a new CreateVerifiableCredentialRequestBody 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
### GetFormat
`func (o *CreateVerifiableCredentialRequestBody) GetFormat() string`
GetFormat returns the Format field if non-nil, zero value otherwise.
### GetFormatOk
`func (o *CreateVerifiableCredentialRequestBody) GetFormatOk() (*string, bool)`
GetFormatOk returns a tuple with the Format field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFormat
`func (o *CreateVerifiableCredentialRequestBody) SetFormat(v string)`
SetFormat sets Format field to given value.
### HasFormat
`func (o *CreateVerifiableCredentialRequestBody) HasFormat() bool`
HasFormat returns a boolean if a field has been set.
### GetProof
`func (o *CreateVerifiableCredentialRequestBody) GetProof() VerifiableCredentialProof`
GetProof returns the Proof field if non-nil, zero value otherwise.
### GetProofOk
`func (o *CreateVerifiableCredentialRequestBody) GetProofOk() (*VerifiableCredentialProof, bool)`
GetProofOk returns a tuple with the Proof field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetProof
`func (o *CreateVerifiableCredentialRequestBody) SetProof(v VerifiableCredentialProof)`
SetProof sets Proof field to given value.
### HasProof
`func (o *CreateVerifiableCredentialRequestBody) HasProof() bool`
HasProof returns a boolean if a field has been set.
### GetTypes
`func (o *CreateVerifiableCredentialRequestBody) GetTypes() []string`
GetTypes returns the Types field if non-nil, zero value otherwise.
### GetTypesOk
`func (o *CreateVerifiableCredentialRequestBody) GetTypesOk() (*[]string, bool)`
GetTypesOk returns a tuple with the Types field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTypes
`func (o *CreateVerifiableCredentialRequestBody) SetTypes(v []string)`
SetTypes sets Types field to given value.
### HasTypes
`func (o *CreateVerifiableCredentialRequestBody) HasTypes() bool`
HasTypes returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/CredentialSupportedDraft00.md | # CredentialSupportedDraft00
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CryptographicBindingMethodsSupported** | Pointer to **[]string** | OpenID Connect Verifiable Credentials Cryptographic Binding Methods Supported Contains a list of cryptographic binding methods supported for signing the proof. | [optional]
**CryptographicSuitesSupported** | Pointer to **[]string** | OpenID Connect Verifiable Credentials Cryptographic Suites Supported Contains a list of cryptographic suites methods supported for signing the proof. | [optional]
**Format** | Pointer to **string** | OpenID Connect Verifiable Credentials Format Contains the format that is supported by this authorization server. | [optional]
**Types** | Pointer to **[]string** | OpenID Connect Verifiable Credentials Types Contains the types of verifiable credentials supported. | [optional]
## Methods
### NewCredentialSupportedDraft00
`func NewCredentialSupportedDraft00() *CredentialSupportedDraft00`
NewCredentialSupportedDraft00 instantiates a new CredentialSupportedDraft00 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
### NewCredentialSupportedDraft00WithDefaults
`func NewCredentialSupportedDraft00WithDefaults() *CredentialSupportedDraft00`
NewCredentialSupportedDraft00WithDefaults instantiates a new CredentialSupportedDraft00 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
### GetCryptographicBindingMethodsSupported
`func (o *CredentialSupportedDraft00) GetCryptographicBindingMethodsSupported() []string`
GetCryptographicBindingMethodsSupported returns the CryptographicBindingMethodsSupported field if non-nil, zero value otherwise.
### GetCryptographicBindingMethodsSupportedOk
`func (o *CredentialSupportedDraft00) GetCryptographicBindingMethodsSupportedOk() (*[]string, bool)`
GetCryptographicBindingMethodsSupportedOk returns a tuple with the CryptographicBindingMethodsSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCryptographicBindingMethodsSupported
`func (o *CredentialSupportedDraft00) SetCryptographicBindingMethodsSupported(v []string)`
SetCryptographicBindingMethodsSupported sets CryptographicBindingMethodsSupported field to given value.
### HasCryptographicBindingMethodsSupported
`func (o *CredentialSupportedDraft00) HasCryptographicBindingMethodsSupported() bool`
HasCryptographicBindingMethodsSupported returns a boolean if a field has been set.
### GetCryptographicSuitesSupported
`func (o *CredentialSupportedDraft00) GetCryptographicSuitesSupported() []string`
GetCryptographicSuitesSupported returns the CryptographicSuitesSupported field if non-nil, zero value otherwise.
### GetCryptographicSuitesSupportedOk
`func (o *CredentialSupportedDraft00) GetCryptographicSuitesSupportedOk() (*[]string, bool)`
GetCryptographicSuitesSupportedOk returns a tuple with the CryptographicSuitesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCryptographicSuitesSupported
`func (o *CredentialSupportedDraft00) SetCryptographicSuitesSupported(v []string)`
SetCryptographicSuitesSupported sets CryptographicSuitesSupported field to given value.
### HasCryptographicSuitesSupported
`func (o *CredentialSupportedDraft00) HasCryptographicSuitesSupported() bool`
HasCryptographicSuitesSupported returns a boolean if a field has been set.
### GetFormat
`func (o *CredentialSupportedDraft00) GetFormat() string`
GetFormat returns the Format field if non-nil, zero value otherwise.
### GetFormatOk
`func (o *CredentialSupportedDraft00) GetFormatOk() (*string, bool)`
GetFormatOk returns a tuple with the Format field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFormat
`func (o *CredentialSupportedDraft00) SetFormat(v string)`
SetFormat sets Format field to given value.
### HasFormat
`func (o *CredentialSupportedDraft00) HasFormat() bool`
HasFormat returns a boolean if a field has been set.
### GetTypes
`func (o *CredentialSupportedDraft00) GetTypes() []string`
GetTypes returns the Types field if non-nil, zero value otherwise.
### GetTypesOk
`func (o *CredentialSupportedDraft00) GetTypesOk() (*[]string, bool)`
GetTypesOk returns a tuple with the Types field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTypes
`func (o *CredentialSupportedDraft00) SetTypes(v []string)`
SetTypes sets Types field to given value.
### HasTypes
`func (o *CredentialSupportedDraft00) HasTypes() bool`
HasTypes returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/ErrorOAuth2.md | # ErrorOAuth2
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Error** | Pointer to **string** | Error | [optional]
**ErrorDebug** | Pointer to **string** | Error Debug Information Only available in dev mode. | [optional]
**ErrorDescription** | Pointer to **string** | Error Description | [optional]
**ErrorHint** | Pointer to **string** | Error Hint Helps the user identify the error cause. | [optional]
**StatusCode** | Pointer to **int64** | HTTP Status Code | [optional]
## Methods
### NewErrorOAuth2
`func NewErrorOAuth2() *ErrorOAuth2`
NewErrorOAuth2 instantiates a new ErrorOAuth2 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
### NewErrorOAuth2WithDefaults
`func NewErrorOAuth2WithDefaults() *ErrorOAuth2`
NewErrorOAuth2WithDefaults instantiates a new ErrorOAuth2 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
### GetError
`func (o *ErrorOAuth2) GetError() string`
GetError returns the Error field if non-nil, zero value otherwise.
### GetErrorOk
`func (o *ErrorOAuth2) GetErrorOk() (*string, bool)`
GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetError
`func (o *ErrorOAuth2) SetError(v string)`
SetError sets Error field to given value.
### HasError
`func (o *ErrorOAuth2) HasError() bool`
HasError returns a boolean if a field has been set.
### GetErrorDebug
`func (o *ErrorOAuth2) GetErrorDebug() string`
GetErrorDebug returns the ErrorDebug field if non-nil, zero value otherwise.
### GetErrorDebugOk
`func (o *ErrorOAuth2) GetErrorDebugOk() (*string, bool)`
GetErrorDebugOk returns a tuple with the ErrorDebug field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorDebug
`func (o *ErrorOAuth2) SetErrorDebug(v string)`
SetErrorDebug sets ErrorDebug field to given value.
### HasErrorDebug
`func (o *ErrorOAuth2) HasErrorDebug() bool`
HasErrorDebug returns a boolean if a field has been set.
### GetErrorDescription
`func (o *ErrorOAuth2) GetErrorDescription() string`
GetErrorDescription returns the ErrorDescription field if non-nil, zero value otherwise.
### GetErrorDescriptionOk
`func (o *ErrorOAuth2) GetErrorDescriptionOk() (*string, bool)`
GetErrorDescriptionOk returns a tuple with the ErrorDescription field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorDescription
`func (o *ErrorOAuth2) SetErrorDescription(v string)`
SetErrorDescription sets ErrorDescription field to given value.
### HasErrorDescription
`func (o *ErrorOAuth2) HasErrorDescription() bool`
HasErrorDescription returns a boolean if a field has been set.
### GetErrorHint
`func (o *ErrorOAuth2) GetErrorHint() string`
GetErrorHint returns the ErrorHint field if non-nil, zero value otherwise.
### GetErrorHintOk
`func (o *ErrorOAuth2) GetErrorHintOk() (*string, bool)`
GetErrorHintOk returns a tuple with the ErrorHint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorHint
`func (o *ErrorOAuth2) SetErrorHint(v string)`
SetErrorHint sets ErrorHint field to given value.
### HasErrorHint
`func (o *ErrorOAuth2) HasErrorHint() bool`
HasErrorHint returns a boolean if a field has been set.
### GetStatusCode
`func (o *ErrorOAuth2) GetStatusCode() int64`
GetStatusCode returns the StatusCode field if non-nil, zero value otherwise.
### GetStatusCodeOk
`func (o *ErrorOAuth2) GetStatusCodeOk() (*int64, bool)`
GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetStatusCode
`func (o *ErrorOAuth2) SetStatusCode(v int64)`
SetStatusCode sets StatusCode field to given value.
### HasStatusCode
`func (o *ErrorOAuth2) HasStatusCode() bool`
HasStatusCode returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/GenericError.md | # GenericError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Code** | Pointer to **int64** | The status code | [optional]
**Debug** | Pointer to **string** | Debug information This field is often not exposed to protect against leaking sensitive information. | [optional]
**Details** | Pointer to **interface{}** | Further error details | [optional]
**Id** | Pointer to **string** | The error ID Useful when trying to identify various errors in application logic. | [optional]
**Message** | **string** | Error message The error's message. |
**Reason** | Pointer to **string** | A human-readable reason for the error | [optional]
**Request** | Pointer to **string** | The request ID The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID. | [optional]
**Status** | Pointer to **string** | The status description | [optional]
## Methods
### NewGenericError
`func NewGenericError(message string, ) *GenericError`
NewGenericError instantiates a new GenericError 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
### NewGenericErrorWithDefaults
`func NewGenericErrorWithDefaults() *GenericError`
NewGenericErrorWithDefaults instantiates a new GenericError 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
### GetCode
`func (o *GenericError) GetCode() int64`
GetCode returns the Code field if non-nil, zero value otherwise.
### GetCodeOk
`func (o *GenericError) GetCodeOk() (*int64, bool)`
GetCodeOk returns a tuple with the Code field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCode
`func (o *GenericError) SetCode(v int64)`
SetCode sets Code field to given value.
### HasCode
`func (o *GenericError) HasCode() bool`
HasCode returns a boolean if a field has been set.
### GetDebug
`func (o *GenericError) GetDebug() string`
GetDebug returns the Debug field if non-nil, zero value otherwise.
### GetDebugOk
`func (o *GenericError) GetDebugOk() (*string, bool)`
GetDebugOk returns a tuple with the Debug field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDebug
`func (o *GenericError) SetDebug(v string)`
SetDebug sets Debug field to given value.
### HasDebug
`func (o *GenericError) HasDebug() bool`
HasDebug returns a boolean if a field has been set.
### GetDetails
`func (o *GenericError) GetDetails() interface{}`
GetDetails returns the Details field if non-nil, zero value otherwise.
### GetDetailsOk
`func (o *GenericError) GetDetailsOk() (*interface{}, bool)`
GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDetails
`func (o *GenericError) SetDetails(v interface{})`
SetDetails sets Details field to given value.
### HasDetails
`func (o *GenericError) HasDetails() bool`
HasDetails returns a boolean if a field has been set.
### SetDetailsNil
`func (o *GenericError) SetDetailsNil(b bool)`
SetDetailsNil sets the value for Details to be an explicit nil
### UnsetDetails
`func (o *GenericError) UnsetDetails()`
UnsetDetails ensures that no value is present for Details, not even an explicit nil
### GetId
`func (o *GenericError) GetId() string`
GetId returns the Id field if non-nil, zero value otherwise.
### GetIdOk
`func (o *GenericError) GetIdOk() (*string, bool)`
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetId
`func (o *GenericError) SetId(v string)`
SetId sets Id field to given value.
### HasId
`func (o *GenericError) HasId() bool`
HasId returns a boolean if a field has been set.
### GetMessage
`func (o *GenericError) GetMessage() string`
GetMessage returns the Message field if non-nil, zero value otherwise.
### GetMessageOk
`func (o *GenericError) GetMessageOk() (*string, bool)`
GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetMessage
`func (o *GenericError) SetMessage(v string)`
SetMessage sets Message field to given value.
### GetReason
`func (o *GenericError) GetReason() string`
GetReason returns the Reason field if non-nil, zero value otherwise.
### GetReasonOk
`func (o *GenericError) GetReasonOk() (*string, bool)`
GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetReason
`func (o *GenericError) SetReason(v string)`
SetReason sets Reason field to given value.
### HasReason
`func (o *GenericError) HasReason() bool`
HasReason returns a boolean if a field has been set.
### GetRequest
`func (o *GenericError) GetRequest() string`
GetRequest returns the Request field if non-nil, zero value otherwise.
### GetRequestOk
`func (o *GenericError) GetRequestOk() (*string, bool)`
GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRequest
`func (o *GenericError) SetRequest(v string)`
SetRequest sets Request field to given value.
### HasRequest
`func (o *GenericError) HasRequest() bool`
HasRequest returns a boolean if a field has been set.
### GetStatus
`func (o *GenericError) GetStatus() string`
GetStatus returns the Status field if non-nil, zero value otherwise.
### GetStatusOk
`func (o *GenericError) GetStatusOk() (*string, bool)`
GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetStatus
`func (o *GenericError) SetStatus(v string)`
SetStatus sets Status field to given value.
### HasStatus
`func (o *GenericError) HasStatus() bool`
HasStatus returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/GetVersion200Response.md | # GetVersion200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Version** | Pointer to **string** | The version of Ory Hydra. | [optional]
## Methods
### NewGetVersion200Response
`func NewGetVersion200Response() *GetVersion200Response`
NewGetVersion200Response instantiates a new GetVersion200Response 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
### NewGetVersion200ResponseWithDefaults
`func NewGetVersion200ResponseWithDefaults() *GetVersion200Response`
NewGetVersion200ResponseWithDefaults instantiates a new GetVersion200Response 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
### GetVersion
`func (o *GetVersion200Response) GetVersion() string`
GetVersion returns the Version field if non-nil, zero value otherwise.
### GetVersionOk
`func (o *GetVersion200Response) GetVersionOk() (*string, bool)`
GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetVersion
`func (o *GetVersion200Response) SetVersion(v string)`
SetVersion sets Version field to given value.
### HasVersion
`func (o *GetVersion200Response) HasVersion() bool`
HasVersion returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/HealthNotReadyStatus.md | # HealthNotReadyStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Errors** | Pointer to **map[string]string** | Errors contains a list of errors that caused the not ready status. | [optional]
## Methods
### NewHealthNotReadyStatus
`func NewHealthNotReadyStatus() *HealthNotReadyStatus`
NewHealthNotReadyStatus instantiates a new HealthNotReadyStatus 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
### NewHealthNotReadyStatusWithDefaults
`func NewHealthNotReadyStatusWithDefaults() *HealthNotReadyStatus`
NewHealthNotReadyStatusWithDefaults instantiates a new HealthNotReadyStatus 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
### GetErrors
`func (o *HealthNotReadyStatus) GetErrors() map[string]string`
GetErrors returns the Errors field if non-nil, zero value otherwise.
### GetErrorsOk
`func (o *HealthNotReadyStatus) GetErrorsOk() (*map[string]string, bool)`
GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrors
`func (o *HealthNotReadyStatus) SetErrors(v map[string]string)`
SetErrors sets Errors field to given value.
### HasErrors
`func (o *HealthNotReadyStatus) HasErrors() bool`
HasErrors returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/HealthStatus.md | # HealthStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Status** | Pointer to **string** | Status always contains \"ok\". | [optional]
## Methods
### NewHealthStatus
`func NewHealthStatus() *HealthStatus`
NewHealthStatus instantiates a new HealthStatus 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
### NewHealthStatusWithDefaults
`func NewHealthStatusWithDefaults() *HealthStatus`
NewHealthStatusWithDefaults instantiates a new HealthStatus 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
### GetStatus
`func (o *HealthStatus) GetStatus() string`
GetStatus returns the Status field if non-nil, zero value otherwise.
### GetStatusOk
`func (o *HealthStatus) GetStatusOk() (*string, bool)`
GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetStatus
`func (o *HealthStatus) SetStatus(v string)`
SetStatus sets Status field to given value.
### HasStatus
`func (o *HealthStatus) HasStatus() bool`
HasStatus returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/IntrospectedOAuth2Token.md | # IntrospectedOAuth2Token
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Active** | **bool** | Active is a boolean indicator of whether or not the presented token is currently active. The specifics of a token's \"active\" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a \"true\" value return for the \"active\" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time). |
**Aud** | Pointer to **[]string** | Audience contains a list of the token's intended audiences. | [optional]
**ClientId** | Pointer to **string** | ID is aclient identifier for the OAuth 2.0 client that requested this token. | [optional]
**Exp** | Pointer to **int64** | Expires at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire. | [optional]
**Ext** | Pointer to **map[string]interface{}** | Extra is arbitrary data set by the session. | [optional]
**Iat** | Pointer to **int64** | Issued at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued. | [optional]
**Iss** | Pointer to **string** | IssuerURL is a string representing the issuer of this token | [optional]
**Nbf** | Pointer to **int64** | NotBefore is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before. | [optional]
**ObfuscatedSubject** | Pointer to **string** | ObfuscatedSubject is set when the subject identifier algorithm was set to \"pairwise\" during authorization. It is the `sub` value of the ID Token that was issued. | [optional]
**Scope** | Pointer to **string** | Scope is a JSON string containing a space-separated list of scopes associated with this token. | [optional]
**Sub** | Pointer to **string** | Subject of the token, as defined in JWT [RFC7519]. Usually a machine-readable identifier of the resource owner who authorized this token. | [optional]
**TokenType** | Pointer to **string** | TokenType is the introspected token's type, typically `Bearer`. | [optional]
**TokenUse** | Pointer to **string** | TokenUse is the introspected token's use, for example `access_token` or `refresh_token`. | [optional]
**Username** | Pointer to **string** | Username is a human-readable identifier for the resource owner who authorized this token. | [optional]
## Methods
### NewIntrospectedOAuth2Token
`func NewIntrospectedOAuth2Token(active bool, ) *IntrospectedOAuth2Token`
NewIntrospectedOAuth2Token instantiates a new IntrospectedOAuth2Token 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
### NewIntrospectedOAuth2TokenWithDefaults
`func NewIntrospectedOAuth2TokenWithDefaults() *IntrospectedOAuth2Token`
NewIntrospectedOAuth2TokenWithDefaults instantiates a new IntrospectedOAuth2Token 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
### GetActive
`func (o *IntrospectedOAuth2Token) GetActive() bool`
GetActive returns the Active field if non-nil, zero value otherwise.
### GetActiveOk
`func (o *IntrospectedOAuth2Token) GetActiveOk() (*bool, bool)`
GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetActive
`func (o *IntrospectedOAuth2Token) SetActive(v bool)`
SetActive sets Active field to given value.
### GetAud
`func (o *IntrospectedOAuth2Token) GetAud() []string`
GetAud returns the Aud field if non-nil, zero value otherwise.
### GetAudOk
`func (o *IntrospectedOAuth2Token) GetAudOk() (*[]string, bool)`
GetAudOk returns a tuple with the Aud field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAud
`func (o *IntrospectedOAuth2Token) SetAud(v []string)`
SetAud sets Aud field to given value.
### HasAud
`func (o *IntrospectedOAuth2Token) HasAud() bool`
HasAud returns a boolean if a field has been set.
### GetClientId
`func (o *IntrospectedOAuth2Token) GetClientId() string`
GetClientId returns the ClientId field if non-nil, zero value otherwise.
### GetClientIdOk
`func (o *IntrospectedOAuth2Token) GetClientIdOk() (*string, bool)`
GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClientId
`func (o *IntrospectedOAuth2Token) SetClientId(v string)`
SetClientId sets ClientId field to given value.
### HasClientId
`func (o *IntrospectedOAuth2Token) HasClientId() bool`
HasClientId returns a boolean if a field has been set.
### GetExp
`func (o *IntrospectedOAuth2Token) GetExp() int64`
GetExp returns the Exp field if non-nil, zero value otherwise.
### GetExpOk
`func (o *IntrospectedOAuth2Token) GetExpOk() (*int64, bool)`
GetExpOk returns a tuple with the Exp field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetExp
`func (o *IntrospectedOAuth2Token) SetExp(v int64)`
SetExp sets Exp field to given value.
### HasExp
`func (o *IntrospectedOAuth2Token) HasExp() bool`
HasExp returns a boolean if a field has been set.
### GetExt
`func (o *IntrospectedOAuth2Token) GetExt() map[string]interface{}`
GetExt returns the Ext field if non-nil, zero value otherwise.
### GetExtOk
`func (o *IntrospectedOAuth2Token) GetExtOk() (*map[string]interface{}, bool)`
GetExtOk returns a tuple with the Ext field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetExt
`func (o *IntrospectedOAuth2Token) SetExt(v map[string]interface{})`
SetExt sets Ext field to given value.
### HasExt
`func (o *IntrospectedOAuth2Token) HasExt() bool`
HasExt returns a boolean if a field has been set.
### GetIat
`func (o *IntrospectedOAuth2Token) GetIat() int64`
GetIat returns the Iat field if non-nil, zero value otherwise.
### GetIatOk
`func (o *IntrospectedOAuth2Token) GetIatOk() (*int64, bool)`
GetIatOk returns a tuple with the Iat field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIat
`func (o *IntrospectedOAuth2Token) SetIat(v int64)`
SetIat sets Iat field to given value.
### HasIat
`func (o *IntrospectedOAuth2Token) HasIat() bool`
HasIat returns a boolean if a field has been set.
### GetIss
`func (o *IntrospectedOAuth2Token) GetIss() string`
GetIss returns the Iss field if non-nil, zero value otherwise.
### GetIssOk
`func (o *IntrospectedOAuth2Token) GetIssOk() (*string, bool)`
GetIssOk returns a tuple with the Iss field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIss
`func (o *IntrospectedOAuth2Token) SetIss(v string)`
SetIss sets Iss field to given value.
### HasIss
`func (o *IntrospectedOAuth2Token) HasIss() bool`
HasIss returns a boolean if a field has been set.
### GetNbf
`func (o *IntrospectedOAuth2Token) GetNbf() int64`
GetNbf returns the Nbf field if non-nil, zero value otherwise.
### GetNbfOk
`func (o *IntrospectedOAuth2Token) GetNbfOk() (*int64, bool)`
GetNbfOk returns a tuple with the Nbf field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetNbf
`func (o *IntrospectedOAuth2Token) SetNbf(v int64)`
SetNbf sets Nbf field to given value.
### HasNbf
`func (o *IntrospectedOAuth2Token) HasNbf() bool`
HasNbf returns a boolean if a field has been set.
### GetObfuscatedSubject
`func (o *IntrospectedOAuth2Token) GetObfuscatedSubject() string`
GetObfuscatedSubject returns the ObfuscatedSubject field if non-nil, zero value otherwise.
### GetObfuscatedSubjectOk
`func (o *IntrospectedOAuth2Token) GetObfuscatedSubjectOk() (*string, bool)`
GetObfuscatedSubjectOk returns a tuple with the ObfuscatedSubject field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetObfuscatedSubject
`func (o *IntrospectedOAuth2Token) SetObfuscatedSubject(v string)`
SetObfuscatedSubject sets ObfuscatedSubject field to given value.
### HasObfuscatedSubject
`func (o *IntrospectedOAuth2Token) HasObfuscatedSubject() bool`
HasObfuscatedSubject returns a boolean if a field has been set.
### GetScope
`func (o *IntrospectedOAuth2Token) GetScope() string`
GetScope returns the Scope field if non-nil, zero value otherwise.
### GetScopeOk
`func (o *IntrospectedOAuth2Token) GetScopeOk() (*string, bool)`
GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetScope
`func (o *IntrospectedOAuth2Token) SetScope(v string)`
SetScope sets Scope field to given value.
### HasScope
`func (o *IntrospectedOAuth2Token) HasScope() bool`
HasScope returns a boolean if a field has been set.
### GetSub
`func (o *IntrospectedOAuth2Token) GetSub() string`
GetSub returns the Sub field if non-nil, zero value otherwise.
### GetSubOk
`func (o *IntrospectedOAuth2Token) GetSubOk() (*string, bool)`
GetSubOk returns a tuple with the Sub field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSub
`func (o *IntrospectedOAuth2Token) SetSub(v string)`
SetSub sets Sub field to given value.
### HasSub
`func (o *IntrospectedOAuth2Token) HasSub() bool`
HasSub returns a boolean if a field has been set.
### GetTokenType
`func (o *IntrospectedOAuth2Token) GetTokenType() string`
GetTokenType returns the TokenType field if non-nil, zero value otherwise.
### GetTokenTypeOk
`func (o *IntrospectedOAuth2Token) GetTokenTypeOk() (*string, bool)`
GetTokenTypeOk returns a tuple with the TokenType field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTokenType
`func (o *IntrospectedOAuth2Token) SetTokenType(v string)`
SetTokenType sets TokenType field to given value.
### HasTokenType
`func (o *IntrospectedOAuth2Token) HasTokenType() bool`
HasTokenType returns a boolean if a field has been set.
### GetTokenUse
`func (o *IntrospectedOAuth2Token) GetTokenUse() string`
GetTokenUse returns the TokenUse field if non-nil, zero value otherwise.
### GetTokenUseOk
`func (o *IntrospectedOAuth2Token) GetTokenUseOk() (*string, bool)`
GetTokenUseOk returns a tuple with the TokenUse field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTokenUse
`func (o *IntrospectedOAuth2Token) SetTokenUse(v string)`
SetTokenUse sets TokenUse field to given value.
### HasTokenUse
`func (o *IntrospectedOAuth2Token) HasTokenUse() bool`
HasTokenUse returns a boolean if a field has been set.
### GetUsername
`func (o *IntrospectedOAuth2Token) GetUsername() string`
GetUsername returns the Username field if non-nil, zero value otherwise.
### GetUsernameOk
`func (o *IntrospectedOAuth2Token) GetUsernameOk() (*string, bool)`
GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUsername
`func (o *IntrospectedOAuth2Token) SetUsername(v string)`
SetUsername sets Username field to given value.
### HasUsername
`func (o *IntrospectedOAuth2Token) HasUsername() bool`
HasUsername returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/IsReady200Response.md | # IsReady200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Status** | Pointer to **string** | Always \"ok\". | [optional]
## Methods
### NewIsReady200Response
`func NewIsReady200Response() *IsReady200Response`
NewIsReady200Response instantiates a new IsReady200Response 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
### NewIsReady200ResponseWithDefaults
`func NewIsReady200ResponseWithDefaults() *IsReady200Response`
NewIsReady200ResponseWithDefaults instantiates a new IsReady200Response 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
### GetStatus
`func (o *IsReady200Response) GetStatus() string`
GetStatus returns the Status field if non-nil, zero value otherwise.
### GetStatusOk
`func (o *IsReady200Response) GetStatusOk() (*string, bool)`
GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetStatus
`func (o *IsReady200Response) SetStatus(v string)`
SetStatus sets Status field to given value.
### HasStatus
`func (o *IsReady200Response) HasStatus() bool`
HasStatus returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/IsReady503Response.md | # IsReady503Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Errors** | Pointer to **map[string]string** | Errors contains a list of errors that caused the not ready status. | [optional]
## Methods
### NewIsReady503Response
`func NewIsReady503Response() *IsReady503Response`
NewIsReady503Response instantiates a new IsReady503Response 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
### NewIsReady503ResponseWithDefaults
`func NewIsReady503ResponseWithDefaults() *IsReady503Response`
NewIsReady503ResponseWithDefaults instantiates a new IsReady503Response 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
### GetErrors
`func (o *IsReady503Response) GetErrors() map[string]string`
GetErrors returns the Errors field if non-nil, zero value otherwise.
### GetErrorsOk
`func (o *IsReady503Response) GetErrorsOk() (*map[string]string, bool)`
GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrors
`func (o *IsReady503Response) SetErrors(v map[string]string)`
SetErrors sets Errors field to given value.
### HasErrors
`func (o *IsReady503Response) HasErrors() bool`
HasErrors returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/JsonPatch.md | # JsonPatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**From** | Pointer to **string** | This field is used together with operation \"move\" and uses JSON Pointer notation. Learn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5). | [optional]
**Op** | **string** | The operation to be performed. One of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". |
**Path** | **string** | The path to the target path. Uses JSON pointer notation. Learn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5). |
**Value** | Pointer to **interface{}** | The value to be used within the operations. Learn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5). | [optional]
## Methods
### NewJsonPatch
`func NewJsonPatch(op string, path string, ) *JsonPatch`
NewJsonPatch instantiates a new JsonPatch 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
### NewJsonPatchWithDefaults
`func NewJsonPatchWithDefaults() *JsonPatch`
NewJsonPatchWithDefaults instantiates a new JsonPatch 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
### GetFrom
`func (o *JsonPatch) GetFrom() string`
GetFrom returns the From field if non-nil, zero value otherwise.
### GetFromOk
`func (o *JsonPatch) GetFromOk() (*string, bool)`
GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFrom
`func (o *JsonPatch) SetFrom(v string)`
SetFrom sets From field to given value.
### HasFrom
`func (o *JsonPatch) HasFrom() bool`
HasFrom returns a boolean if a field has been set.
### GetOp
`func (o *JsonPatch) GetOp() string`
GetOp returns the Op field if non-nil, zero value otherwise.
### GetOpOk
`func (o *JsonPatch) GetOpOk() (*string, bool)`
GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetOp
`func (o *JsonPatch) SetOp(v string)`
SetOp sets Op field to given value.
### GetPath
`func (o *JsonPatch) GetPath() string`
GetPath returns the Path field if non-nil, zero value otherwise.
### GetPathOk
`func (o *JsonPatch) GetPathOk() (*string, bool)`
GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPath
`func (o *JsonPatch) SetPath(v string)`
SetPath sets Path field to given value.
### GetValue
`func (o *JsonPatch) GetValue() interface{}`
GetValue returns the Value field if non-nil, zero value otherwise.
### GetValueOk
`func (o *JsonPatch) GetValueOk() (*interface{}, bool)`
GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetValue
`func (o *JsonPatch) SetValue(v interface{})`
SetValue sets Value field to given value.
### HasValue
`func (o *JsonPatch) HasValue() bool`
HasValue returns a boolean if a field has been set.
### SetValueNil
`func (o *JsonPatch) SetValueNil(b bool)`
SetValueNil sets the value for Value to be an explicit nil
### UnsetValue
`func (o *JsonPatch) UnsetValue()`
UnsetValue ensures that no value is present for Value, not even an explicit nil
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/JsonWebKey.md | # JsonWebKey
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Alg** | **string** | The \"alg\" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA \"JSON Web Signature and Encryption Algorithms\" registry established by [JWA] or be a value that contains a Collision- Resistant Name. |
**Crv** | Pointer to **string** | | [optional]
**D** | Pointer to **string** | | [optional]
**Dp** | Pointer to **string** | | [optional]
**Dq** | Pointer to **string** | | [optional]
**E** | Pointer to **string** | | [optional]
**K** | Pointer to **string** | | [optional]
**Kid** | **string** | The \"kid\" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the \"kid\" value is unspecified. When \"kid\" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct \"kid\" values. (One example in which different keys might use the same \"kid\" value is if they have different \"kty\" (key type) values but are considered to be equivalent alternatives by the application using them.) The \"kid\" value is a case-sensitive string. |
**Kty** | **string** | The \"kty\" (key type) parameter identifies the cryptographic algorithm family used with the key, such as \"RSA\" or \"EC\". \"kty\" values should either be registered in the IANA \"JSON Web Key Types\" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The \"kty\" value is a case-sensitive string. |
**N** | Pointer to **string** | | [optional]
**P** | Pointer to **string** | | [optional]
**Q** | Pointer to **string** | | [optional]
**Qi** | Pointer to **string** | | [optional]
**Use** | **string** | Use (\"public key use\") identifies the intended use of the public key. The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly \"sig\" (signature) or \"enc\" (encryption). |
**X** | Pointer to **string** | | [optional]
**X5c** | Pointer to **[]string** | The \"x5c\" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. | [optional]
**Y** | Pointer to **string** | | [optional]
## Methods
### NewJsonWebKey
`func NewJsonWebKey(alg string, kid string, kty string, use string, ) *JsonWebKey`
NewJsonWebKey instantiates a new JsonWebKey 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
### NewJsonWebKeyWithDefaults
`func NewJsonWebKeyWithDefaults() *JsonWebKey`
NewJsonWebKeyWithDefaults instantiates a new JsonWebKey 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
### GetAlg
`func (o *JsonWebKey) GetAlg() string`
GetAlg returns the Alg field if non-nil, zero value otherwise.
### GetAlgOk
`func (o *JsonWebKey) GetAlgOk() (*string, bool)`
GetAlgOk returns a tuple with the Alg field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAlg
`func (o *JsonWebKey) SetAlg(v string)`
SetAlg sets Alg field to given value.
### GetCrv
`func (o *JsonWebKey) GetCrv() string`
GetCrv returns the Crv field if non-nil, zero value otherwise.
### GetCrvOk
`func (o *JsonWebKey) GetCrvOk() (*string, bool)`
GetCrvOk returns a tuple with the Crv field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCrv
`func (o *JsonWebKey) SetCrv(v string)`
SetCrv sets Crv field to given value.
### HasCrv
`func (o *JsonWebKey) HasCrv() bool`
HasCrv returns a boolean if a field has been set.
### GetD
`func (o *JsonWebKey) GetD() string`
GetD returns the D field if non-nil, zero value otherwise.
### GetDOk
`func (o *JsonWebKey) GetDOk() (*string, bool)`
GetDOk returns a tuple with the D field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetD
`func (o *JsonWebKey) SetD(v string)`
SetD sets D field to given value.
### HasD
`func (o *JsonWebKey) HasD() bool`
HasD returns a boolean if a field has been set.
### GetDp
`func (o *JsonWebKey) GetDp() string`
GetDp returns the Dp field if non-nil, zero value otherwise.
### GetDpOk
`func (o *JsonWebKey) GetDpOk() (*string, bool)`
GetDpOk returns a tuple with the Dp field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDp
`func (o *JsonWebKey) SetDp(v string)`
SetDp sets Dp field to given value.
### HasDp
`func (o *JsonWebKey) HasDp() bool`
HasDp returns a boolean if a field has been set.
### GetDq
`func (o *JsonWebKey) GetDq() string`
GetDq returns the Dq field if non-nil, zero value otherwise.
### GetDqOk
`func (o *JsonWebKey) GetDqOk() (*string, bool)`
GetDqOk returns a tuple with the Dq field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDq
`func (o *JsonWebKey) SetDq(v string)`
SetDq sets Dq field to given value.
### HasDq
`func (o *JsonWebKey) HasDq() bool`
HasDq returns a boolean if a field has been set.
### GetE
`func (o *JsonWebKey) GetE() string`
GetE returns the E field if non-nil, zero value otherwise.
### GetEOk
`func (o *JsonWebKey) GetEOk() (*string, bool)`
GetEOk returns a tuple with the E field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetE
`func (o *JsonWebKey) SetE(v string)`
SetE sets E field to given value.
### HasE
`func (o *JsonWebKey) HasE() bool`
HasE returns a boolean if a field has been set.
### GetK
`func (o *JsonWebKey) GetK() string`
GetK returns the K field if non-nil, zero value otherwise.
### GetKOk
`func (o *JsonWebKey) GetKOk() (*string, bool)`
GetKOk returns a tuple with the K field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetK
`func (o *JsonWebKey) SetK(v string)`
SetK sets K field to given value.
### HasK
`func (o *JsonWebKey) HasK() bool`
HasK returns a boolean if a field has been set.
### GetKid
`func (o *JsonWebKey) GetKid() string`
GetKid returns the Kid field if non-nil, zero value otherwise.
### GetKidOk
`func (o *JsonWebKey) GetKidOk() (*string, bool)`
GetKidOk returns a tuple with the Kid field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetKid
`func (o *JsonWebKey) SetKid(v string)`
SetKid sets Kid field to given value.
### GetKty
`func (o *JsonWebKey) GetKty() string`
GetKty returns the Kty field if non-nil, zero value otherwise.
### GetKtyOk
`func (o *JsonWebKey) GetKtyOk() (*string, bool)`
GetKtyOk returns a tuple with the Kty field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetKty
`func (o *JsonWebKey) SetKty(v string)`
SetKty sets Kty field to given value.
### GetN
`func (o *JsonWebKey) GetN() string`
GetN returns the N field if non-nil, zero value otherwise.
### GetNOk
`func (o *JsonWebKey) GetNOk() (*string, bool)`
GetNOk returns a tuple with the N field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetN
`func (o *JsonWebKey) SetN(v string)`
SetN sets N field to given value.
### HasN
`func (o *JsonWebKey) HasN() bool`
HasN returns a boolean if a field has been set.
### GetP
`func (o *JsonWebKey) GetP() string`
GetP returns the P field if non-nil, zero value otherwise.
### GetPOk
`func (o *JsonWebKey) GetPOk() (*string, bool)`
GetPOk returns a tuple with the P field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetP
`func (o *JsonWebKey) SetP(v string)`
SetP sets P field to given value.
### HasP
`func (o *JsonWebKey) HasP() bool`
HasP returns a boolean if a field has been set.
### GetQ
`func (o *JsonWebKey) GetQ() string`
GetQ returns the Q field if non-nil, zero value otherwise.
### GetQOk
`func (o *JsonWebKey) GetQOk() (*string, bool)`
GetQOk returns a tuple with the Q field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetQ
`func (o *JsonWebKey) SetQ(v string)`
SetQ sets Q field to given value.
### HasQ
`func (o *JsonWebKey) HasQ() bool`
HasQ returns a boolean if a field has been set.
### GetQi
`func (o *JsonWebKey) GetQi() string`
GetQi returns the Qi field if non-nil, zero value otherwise.
### GetQiOk
`func (o *JsonWebKey) GetQiOk() (*string, bool)`
GetQiOk returns a tuple with the Qi field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetQi
`func (o *JsonWebKey) SetQi(v string)`
SetQi sets Qi field to given value.
### HasQi
`func (o *JsonWebKey) HasQi() bool`
HasQi returns a boolean if a field has been set.
### GetUse
`func (o *JsonWebKey) GetUse() string`
GetUse returns the Use field if non-nil, zero value otherwise.
### GetUseOk
`func (o *JsonWebKey) GetUseOk() (*string, bool)`
GetUseOk returns a tuple with the Use field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUse
`func (o *JsonWebKey) SetUse(v string)`
SetUse sets Use field to given value.
### GetX
`func (o *JsonWebKey) GetX() string`
GetX returns the X field if non-nil, zero value otherwise.
### GetXOk
`func (o *JsonWebKey) GetXOk() (*string, bool)`
GetXOk returns a tuple with the X field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetX
`func (o *JsonWebKey) SetX(v string)`
SetX sets X field to given value.
### HasX
`func (o *JsonWebKey) HasX() bool`
HasX returns a boolean if a field has been set.
### GetX5c
`func (o *JsonWebKey) GetX5c() []string`
GetX5c returns the X5c field if non-nil, zero value otherwise.
### GetX5cOk
`func (o *JsonWebKey) GetX5cOk() (*[]string, bool)`
GetX5cOk returns a tuple with the X5c field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetX5c
`func (o *JsonWebKey) SetX5c(v []string)`
SetX5c sets X5c field to given value.
### HasX5c
`func (o *JsonWebKey) HasX5c() bool`
HasX5c returns a boolean if a field has been set.
### GetY
`func (o *JsonWebKey) GetY() string`
GetY returns the Y field if non-nil, zero value otherwise.
### GetYOk
`func (o *JsonWebKey) GetYOk() (*string, bool)`
GetYOk returns a tuple with the Y field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetY
`func (o *JsonWebKey) SetY(v string)`
SetY sets Y field to given value.
### HasY
`func (o *JsonWebKey) HasY() bool`
HasY returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/JsonWebKeySet.md | # JsonWebKeySet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Keys** | Pointer to [**[]JsonWebKey**](JsonWebKey.md) | List of JSON Web Keys The value of the \"keys\" parameter is an array of JSON Web Key (JWK) values. By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. | [optional]
## Methods
### NewJsonWebKeySet
`func NewJsonWebKeySet() *JsonWebKeySet`
NewJsonWebKeySet instantiates a new JsonWebKeySet 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
### NewJsonWebKeySetWithDefaults
`func NewJsonWebKeySetWithDefaults() *JsonWebKeySet`
NewJsonWebKeySetWithDefaults instantiates a new JsonWebKeySet 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
### GetKeys
`func (o *JsonWebKeySet) GetKeys() []JsonWebKey`
GetKeys returns the Keys field if non-nil, zero value otherwise.
### GetKeysOk
`func (o *JsonWebKeySet) GetKeysOk() (*[]JsonWebKey, bool)`
GetKeysOk returns a tuple with the Keys field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetKeys
`func (o *JsonWebKeySet) SetKeys(v []JsonWebKey)`
SetKeys sets Keys field to given value.
### HasKeys
`func (o *JsonWebKeySet) HasKeys() bool`
HasKeys returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/JwkApi.md | # \JwkApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**CreateJsonWebKeySet**](JwkApi.md#CreateJsonWebKeySet) | **Post** /admin/keys/{set} | Create JSON Web Key
[**DeleteJsonWebKey**](JwkApi.md#DeleteJsonWebKey) | **Delete** /admin/keys/{set}/{kid} | Delete JSON Web Key
[**DeleteJsonWebKeySet**](JwkApi.md#DeleteJsonWebKeySet) | **Delete** /admin/keys/{set} | Delete JSON Web Key Set
[**GetJsonWebKey**](JwkApi.md#GetJsonWebKey) | **Get** /admin/keys/{set}/{kid} | Get JSON Web Key
[**GetJsonWebKeySet**](JwkApi.md#GetJsonWebKeySet) | **Get** /admin/keys/{set} | Retrieve a JSON Web Key Set
[**SetJsonWebKey**](JwkApi.md#SetJsonWebKey) | **Put** /admin/keys/{set}/{kid} | Set JSON Web Key
[**SetJsonWebKeySet**](JwkApi.md#SetJsonWebKeySet) | **Put** /admin/keys/{set} | Update a JSON Web Key Set
## CreateJsonWebKeySet
> JsonWebKeySet CreateJsonWebKeySet(ctx, set).CreateJsonWebKeySet(createJsonWebKeySet).Execute()
Create JSON Web Key
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
set := "set_example" // string | The JSON Web Key Set ID
createJsonWebKeySet := *openapiclient.NewCreateJsonWebKeySet("Alg_example", "Kid_example", "Use_example") // CreateJsonWebKeySet |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.JwkApi.CreateJsonWebKeySet(context.Background(), set).CreateJsonWebKeySet(createJsonWebKeySet).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.CreateJsonWebKeySet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateJsonWebKeySet`: JsonWebKeySet
fmt.Fprintf(os.Stdout, "Response from `JwkApi.CreateJsonWebKeySet`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**set** | **string** | The JSON Web Key Set ID |
### Other Parameters
Other parameters are passed through a pointer to a apiCreateJsonWebKeySetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**createJsonWebKeySet** | [**CreateJsonWebKeySet**](CreateJsonWebKeySet.md) | |
### Return type
[**JsonWebKeySet**](JsonWebKeySet.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## DeleteJsonWebKey
> DeleteJsonWebKey(ctx, set, kid).Execute()
Delete JSON Web Key
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
set := "set_example" // string | The JSON Web Key Set
kid := "kid_example" // string | The JSON Web Key ID (kid)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.JwkApi.DeleteJsonWebKey(context.Background(), set, kid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.DeleteJsonWebKey``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**set** | **string** | The JSON Web Key Set |
**kid** | **string** | The JSON Web Key ID (kid) |
### Other Parameters
Other parameters are passed through a pointer to a apiDeleteJsonWebKeyRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## DeleteJsonWebKeySet
> DeleteJsonWebKeySet(ctx, set).Execute()
Delete JSON Web Key Set
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
set := "set_example" // string | The JSON Web Key Set
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.JwkApi.DeleteJsonWebKeySet(context.Background(), set).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.DeleteJsonWebKeySet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**set** | **string** | The JSON Web Key Set |
### Other Parameters
Other parameters are passed through a pointer to a apiDeleteJsonWebKeySetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetJsonWebKey
> JsonWebKeySet GetJsonWebKey(ctx, set, kid).Execute()
Get JSON Web Key
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
set := "set_example" // string | JSON Web Key Set ID
kid := "kid_example" // string | JSON Web Key ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.JwkApi.GetJsonWebKey(context.Background(), set, kid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.GetJsonWebKey``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetJsonWebKey`: JsonWebKeySet
fmt.Fprintf(os.Stdout, "Response from `JwkApi.GetJsonWebKey`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**set** | **string** | JSON Web Key Set ID |
**kid** | **string** | JSON Web Key ID |
### Other Parameters
Other parameters are passed through a pointer to a apiGetJsonWebKeyRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
[**JsonWebKeySet**](JsonWebKeySet.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetJsonWebKeySet
> JsonWebKeySet GetJsonWebKeySet(ctx, set).Execute()
Retrieve a JSON Web Key Set
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
set := "set_example" // string | JSON Web Key Set ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.JwkApi.GetJsonWebKeySet(context.Background(), set).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.GetJsonWebKeySet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetJsonWebKeySet`: JsonWebKeySet
fmt.Fprintf(os.Stdout, "Response from `JwkApi.GetJsonWebKeySet`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**set** | **string** | JSON Web Key Set ID |
### Other Parameters
Other parameters are passed through a pointer to a apiGetJsonWebKeySetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
[**JsonWebKeySet**](JsonWebKeySet.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## SetJsonWebKey
> JsonWebKey SetJsonWebKey(ctx, set, kid).JsonWebKey(jsonWebKey).Execute()
Set JSON Web Key
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
set := "set_example" // string | The JSON Web Key Set ID
kid := "kid_example" // string | JSON Web Key ID
jsonWebKey := *openapiclient.NewJsonWebKey("RS256", "1603dfe0af8f4596", "RSA", "sig") // JsonWebKey | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.JwkApi.SetJsonWebKey(context.Background(), set, kid).JsonWebKey(jsonWebKey).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.SetJsonWebKey``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SetJsonWebKey`: JsonWebKey
fmt.Fprintf(os.Stdout, "Response from `JwkApi.SetJsonWebKey`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**set** | **string** | The JSON Web Key Set ID |
**kid** | **string** | JSON Web Key ID |
### Other Parameters
Other parameters are passed through a pointer to a apiSetJsonWebKeyRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**jsonWebKey** | [**JsonWebKey**](JsonWebKey.md) | |
### Return type
[**JsonWebKey**](JsonWebKey.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## SetJsonWebKeySet
> JsonWebKeySet SetJsonWebKeySet(ctx, set).JsonWebKeySet(jsonWebKeySet).Execute()
Update a JSON Web Key Set
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
set := "set_example" // string | The JSON Web Key Set ID
jsonWebKeySet := *openapiclient.NewJsonWebKeySet() // JsonWebKeySet | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.JwkApi.SetJsonWebKeySet(context.Background(), set).JsonWebKeySet(jsonWebKeySet).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.SetJsonWebKeySet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SetJsonWebKeySet`: JsonWebKeySet
fmt.Fprintf(os.Stdout, "Response from `JwkApi.SetJsonWebKeySet`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**set** | **string** | The JSON Web Key Set ID |
### Other Parameters
Other parameters are passed through a pointer to a apiSetJsonWebKeySetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**jsonWebKeySet** | [**JsonWebKeySet**](JsonWebKeySet.md) | |
### Return type
[**JsonWebKeySet**](JsonWebKeySet.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/MetadataApi.md | # \MetadataApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**GetVersion**](MetadataApi.md#GetVersion) | **Get** /version | Return Running Software Version.
[**IsAlive**](MetadataApi.md#IsAlive) | **Get** /health/alive | Check HTTP Server Status
[**IsReady**](MetadataApi.md#IsReady) | **Get** /health/ready | Check HTTP Server and Database Status
## GetVersion
> GetVersion200Response GetVersion(ctx).Execute()
Return Running Software Version.
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetadataApi.GetVersion(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.GetVersion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetVersion`: GetVersion200Response
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.GetVersion`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiGetVersionRequest struct via the builder pattern
### Return type
[**GetVersion200Response**](GetVersion200Response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## IsAlive
> HealthStatus IsAlive(ctx).Execute()
Check HTTP Server Status
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetadataApi.IsAlive(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.IsAlive``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `IsAlive`: HealthStatus
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.IsAlive`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiIsAliveRequest struct via the builder pattern
### Return type
[**HealthStatus**](HealthStatus.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## IsReady
> IsReady200Response IsReady(ctx).Execute()
Check HTTP Server and Database Status
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MetadataApi.IsReady(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.IsReady``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `IsReady`: IsReady200Response
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.IsReady`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiIsReadyRequest struct via the builder pattern
### Return type
[**IsReady200Response**](IsReady200Response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2Api.md | # \OAuth2Api
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**AcceptOAuth2ConsentRequest**](OAuth2Api.md#AcceptOAuth2ConsentRequest) | **Put** /admin/oauth2/auth/requests/consent/accept | Accept OAuth 2.0 Consent Request
[**AcceptOAuth2LoginRequest**](OAuth2Api.md#AcceptOAuth2LoginRequest) | **Put** /admin/oauth2/auth/requests/login/accept | Accept OAuth 2.0 Login Request
[**AcceptOAuth2LogoutRequest**](OAuth2Api.md#AcceptOAuth2LogoutRequest) | **Put** /admin/oauth2/auth/requests/logout/accept | Accept OAuth 2.0 Session Logout Request
[**CreateOAuth2Client**](OAuth2Api.md#CreateOAuth2Client) | **Post** /admin/clients | Create OAuth 2.0 Client
[**DeleteOAuth2Client**](OAuth2Api.md#DeleteOAuth2Client) | **Delete** /admin/clients/{id} | Delete OAuth 2.0 Client
[**DeleteOAuth2Token**](OAuth2Api.md#DeleteOAuth2Token) | **Delete** /admin/oauth2/tokens | Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
[**DeleteTrustedOAuth2JwtGrantIssuer**](OAuth2Api.md#DeleteTrustedOAuth2JwtGrantIssuer) | **Delete** /admin/trust/grants/jwt-bearer/issuers/{id} | Delete Trusted OAuth2 JWT Bearer Grant Type Issuer
[**GetOAuth2Client**](OAuth2Api.md#GetOAuth2Client) | **Get** /admin/clients/{id} | Get an OAuth 2.0 Client
[**GetOAuth2ConsentRequest**](OAuth2Api.md#GetOAuth2ConsentRequest) | **Get** /admin/oauth2/auth/requests/consent | Get OAuth 2.0 Consent Request
[**GetOAuth2LoginRequest**](OAuth2Api.md#GetOAuth2LoginRequest) | **Get** /admin/oauth2/auth/requests/login | Get OAuth 2.0 Login Request
[**GetOAuth2LogoutRequest**](OAuth2Api.md#GetOAuth2LogoutRequest) | **Get** /admin/oauth2/auth/requests/logout | Get OAuth 2.0 Session Logout Request
[**GetTrustedOAuth2JwtGrantIssuer**](OAuth2Api.md#GetTrustedOAuth2JwtGrantIssuer) | **Get** /admin/trust/grants/jwt-bearer/issuers/{id} | Get Trusted OAuth2 JWT Bearer Grant Type Issuer
[**IntrospectOAuth2Token**](OAuth2Api.md#IntrospectOAuth2Token) | **Post** /admin/oauth2/introspect | Introspect OAuth2 Access and Refresh Tokens
[**ListOAuth2Clients**](OAuth2Api.md#ListOAuth2Clients) | **Get** /admin/clients | List OAuth 2.0 Clients
[**ListOAuth2ConsentSessions**](OAuth2Api.md#ListOAuth2ConsentSessions) | **Get** /admin/oauth2/auth/sessions/consent | List OAuth 2.0 Consent Sessions of a Subject
[**ListTrustedOAuth2JwtGrantIssuers**](OAuth2Api.md#ListTrustedOAuth2JwtGrantIssuers) | **Get** /admin/trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers
[**OAuth2Authorize**](OAuth2Api.md#OAuth2Authorize) | **Get** /oauth2/auth | OAuth 2.0 Authorize Endpoint
[**Oauth2TokenExchange**](OAuth2Api.md#Oauth2TokenExchange) | **Post** /oauth2/token | The OAuth 2.0 Token Endpoint
[**PatchOAuth2Client**](OAuth2Api.md#PatchOAuth2Client) | **Patch** /admin/clients/{id} | Patch OAuth 2.0 Client
[**RejectOAuth2ConsentRequest**](OAuth2Api.md#RejectOAuth2ConsentRequest) | **Put** /admin/oauth2/auth/requests/consent/reject | Reject OAuth 2.0 Consent Request
[**RejectOAuth2LoginRequest**](OAuth2Api.md#RejectOAuth2LoginRequest) | **Put** /admin/oauth2/auth/requests/login/reject | Reject OAuth 2.0 Login Request
[**RejectOAuth2LogoutRequest**](OAuth2Api.md#RejectOAuth2LogoutRequest) | **Put** /admin/oauth2/auth/requests/logout/reject | Reject OAuth 2.0 Session Logout Request
[**RevokeOAuth2ConsentSessions**](OAuth2Api.md#RevokeOAuth2ConsentSessions) | **Delete** /admin/oauth2/auth/sessions/consent | Revoke OAuth 2.0 Consent Sessions of a Subject
[**RevokeOAuth2LoginSessions**](OAuth2Api.md#RevokeOAuth2LoginSessions) | **Delete** /admin/oauth2/auth/sessions/login | Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
[**RevokeOAuth2Token**](OAuth2Api.md#RevokeOAuth2Token) | **Post** /oauth2/revoke | Revoke OAuth 2.0 Access or Refresh Token
[**SetOAuth2Client**](OAuth2Api.md#SetOAuth2Client) | **Put** /admin/clients/{id} | Set OAuth 2.0 Client
[**SetOAuth2ClientLifespans**](OAuth2Api.md#SetOAuth2ClientLifespans) | **Put** /admin/clients/{id}/lifespans | Set OAuth2 Client Token Lifespans
[**TrustOAuth2JwtGrantIssuer**](OAuth2Api.md#TrustOAuth2JwtGrantIssuer) | **Post** /admin/trust/grants/jwt-bearer/issuers | Trust OAuth2 JWT Bearer Grant Type Issuer
## AcceptOAuth2ConsentRequest
> OAuth2RedirectTo AcceptOAuth2ConsentRequest(ctx).ConsentChallenge(consentChallenge).AcceptOAuth2ConsentRequest(acceptOAuth2ConsentRequest).Execute()
Accept OAuth 2.0 Consent Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
consentChallenge := "consentChallenge_example" // string | OAuth 2.0 Consent Request Challenge
acceptOAuth2ConsentRequest := *openapiclient.NewAcceptOAuth2ConsentRequest() // AcceptOAuth2ConsentRequest | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.AcceptOAuth2ConsentRequest(context.Background()).ConsentChallenge(consentChallenge).AcceptOAuth2ConsentRequest(acceptOAuth2ConsentRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.AcceptOAuth2ConsentRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AcceptOAuth2ConsentRequest`: OAuth2RedirectTo
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.AcceptOAuth2ConsentRequest`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAcceptOAuth2ConsentRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**consentChallenge** | **string** | OAuth 2.0 Consent Request Challenge |
**acceptOAuth2ConsentRequest** | [**AcceptOAuth2ConsentRequest**](AcceptOAuth2ConsentRequest.md) | |
### Return type
[**OAuth2RedirectTo**](OAuth2RedirectTo.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## AcceptOAuth2LoginRequest
> OAuth2RedirectTo AcceptOAuth2LoginRequest(ctx).LoginChallenge(loginChallenge).AcceptOAuth2LoginRequest(acceptOAuth2LoginRequest).Execute()
Accept OAuth 2.0 Login Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
loginChallenge := "loginChallenge_example" // string | OAuth 2.0 Login Request Challenge
acceptOAuth2LoginRequest := *openapiclient.NewAcceptOAuth2LoginRequest("Subject_example") // AcceptOAuth2LoginRequest | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.AcceptOAuth2LoginRequest(context.Background()).LoginChallenge(loginChallenge).AcceptOAuth2LoginRequest(acceptOAuth2LoginRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.AcceptOAuth2LoginRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AcceptOAuth2LoginRequest`: OAuth2RedirectTo
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.AcceptOAuth2LoginRequest`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAcceptOAuth2LoginRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**loginChallenge** | **string** | OAuth 2.0 Login Request Challenge |
**acceptOAuth2LoginRequest** | [**AcceptOAuth2LoginRequest**](AcceptOAuth2LoginRequest.md) | |
### Return type
[**OAuth2RedirectTo**](OAuth2RedirectTo.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## AcceptOAuth2LogoutRequest
> OAuth2RedirectTo AcceptOAuth2LogoutRequest(ctx).LogoutChallenge(logoutChallenge).Execute()
Accept OAuth 2.0 Session Logout Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
logoutChallenge := "logoutChallenge_example" // string | OAuth 2.0 Logout Request Challenge
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.AcceptOAuth2LogoutRequest(context.Background()).LogoutChallenge(logoutChallenge).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.AcceptOAuth2LogoutRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AcceptOAuth2LogoutRequest`: OAuth2RedirectTo
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.AcceptOAuth2LogoutRequest`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAcceptOAuth2LogoutRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**logoutChallenge** | **string** | OAuth 2.0 Logout Request Challenge |
### Return type
[**OAuth2RedirectTo**](OAuth2RedirectTo.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## CreateOAuth2Client
> OAuth2Client CreateOAuth2Client(ctx).OAuth2Client(oAuth2Client).Execute()
Create OAuth 2.0 Client
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
oAuth2Client := *openapiclient.NewOAuth2Client() // OAuth2Client | OAuth 2.0 Client Request Body
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.CreateOAuth2Client(context.Background()).OAuth2Client(oAuth2Client).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.CreateOAuth2Client``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateOAuth2Client`: OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.CreateOAuth2Client`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiCreateOAuth2ClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**oAuth2Client** | [**OAuth2Client**](OAuth2Client.md) | OAuth 2.0 Client Request Body |
### Return type
[**OAuth2Client**](OAuth2Client.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## DeleteOAuth2Client
> DeleteOAuth2Client(ctx, id).Execute()
Delete OAuth 2.0 Client
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The id of the OAuth 2.0 Client.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.DeleteOAuth2Client(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.DeleteOAuth2Client``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | The id of the OAuth 2.0 Client. |
### Other Parameters
Other parameters are passed through a pointer to a apiDeleteOAuth2ClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## DeleteOAuth2Token
> DeleteOAuth2Token(ctx).ClientId(clientId).Execute()
Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
clientId := "clientId_example" // string | OAuth 2.0 Client ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.DeleteOAuth2Token(context.Background()).ClientId(clientId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.DeleteOAuth2Token``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiDeleteOAuth2TokenRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**clientId** | **string** | OAuth 2.0 Client ID |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## DeleteTrustedOAuth2JwtGrantIssuer
> DeleteTrustedOAuth2JwtGrantIssuer(ctx, id).Execute()
Delete Trusted OAuth2 JWT Bearer Grant Type Issuer
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The id of the desired grant
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.DeleteTrustedOAuth2JwtGrantIssuer(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.DeleteTrustedOAuth2JwtGrantIssuer``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | The id of the desired grant |
### Other Parameters
Other parameters are passed through a pointer to a apiDeleteTrustedOAuth2JwtGrantIssuerRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetOAuth2Client
> OAuth2Client GetOAuth2Client(ctx, id).Execute()
Get an OAuth 2.0 Client
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The id of the OAuth 2.0 Client.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.GetOAuth2Client(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.GetOAuth2Client``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOAuth2Client`: OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.GetOAuth2Client`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | The id of the OAuth 2.0 Client. |
### Other Parameters
Other parameters are passed through a pointer to a apiGetOAuth2ClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
[**OAuth2Client**](OAuth2Client.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetOAuth2ConsentRequest
> OAuth2ConsentRequest GetOAuth2ConsentRequest(ctx).ConsentChallenge(consentChallenge).Execute()
Get OAuth 2.0 Consent Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
consentChallenge := "consentChallenge_example" // string | OAuth 2.0 Consent Request Challenge
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.GetOAuth2ConsentRequest(context.Background()).ConsentChallenge(consentChallenge).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.GetOAuth2ConsentRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOAuth2ConsentRequest`: OAuth2ConsentRequest
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.GetOAuth2ConsentRequest`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiGetOAuth2ConsentRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**consentChallenge** | **string** | OAuth 2.0 Consent Request Challenge |
### Return type
[**OAuth2ConsentRequest**](OAuth2ConsentRequest.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetOAuth2LoginRequest
> OAuth2LoginRequest GetOAuth2LoginRequest(ctx).LoginChallenge(loginChallenge).Execute()
Get OAuth 2.0 Login Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
loginChallenge := "loginChallenge_example" // string | OAuth 2.0 Login Request Challenge
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.GetOAuth2LoginRequest(context.Background()).LoginChallenge(loginChallenge).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.GetOAuth2LoginRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOAuth2LoginRequest`: OAuth2LoginRequest
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.GetOAuth2LoginRequest`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiGetOAuth2LoginRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**loginChallenge** | **string** | OAuth 2.0 Login Request Challenge |
### Return type
[**OAuth2LoginRequest**](OAuth2LoginRequest.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetOAuth2LogoutRequest
> OAuth2LogoutRequest GetOAuth2LogoutRequest(ctx).LogoutChallenge(logoutChallenge).Execute()
Get OAuth 2.0 Session Logout Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
logoutChallenge := "logoutChallenge_example" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.GetOAuth2LogoutRequest(context.Background()).LogoutChallenge(logoutChallenge).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.GetOAuth2LogoutRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOAuth2LogoutRequest`: OAuth2LogoutRequest
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.GetOAuth2LogoutRequest`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiGetOAuth2LogoutRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**logoutChallenge** | **string** | |
### Return type
[**OAuth2LogoutRequest**](OAuth2LogoutRequest.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetTrustedOAuth2JwtGrantIssuer
> TrustedOAuth2JwtGrantIssuer GetTrustedOAuth2JwtGrantIssuer(ctx, id).Execute()
Get Trusted OAuth2 JWT Bearer Grant Type Issuer
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The id of the desired grant
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.GetTrustedOAuth2JwtGrantIssuer(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.GetTrustedOAuth2JwtGrantIssuer``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetTrustedOAuth2JwtGrantIssuer`: TrustedOAuth2JwtGrantIssuer
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.GetTrustedOAuth2JwtGrantIssuer`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | The id of the desired grant |
### Other Parameters
Other parameters are passed through a pointer to a apiGetTrustedOAuth2JwtGrantIssuerRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
[**TrustedOAuth2JwtGrantIssuer**](TrustedOAuth2JwtGrantIssuer.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## IntrospectOAuth2Token
> IntrospectedOAuth2Token IntrospectOAuth2Token(ctx).Token(token).Scope(scope).Execute()
Introspect OAuth2 Access and Refresh Tokens
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
token := "token_example" // string | The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned.
scope := "scope_example" // string | An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.IntrospectOAuth2Token(context.Background()).Token(token).Scope(scope).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.IntrospectOAuth2Token``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `IntrospectOAuth2Token`: IntrospectedOAuth2Token
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.IntrospectOAuth2Token`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiIntrospectOAuth2TokenRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token** | **string** | The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned. |
**scope** | **string** | An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false. |
### Return type
[**IntrospectedOAuth2Token**](IntrospectedOAuth2Token.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## ListOAuth2Clients
> []OAuth2Client ListOAuth2Clients(ctx).PageSize(pageSize).PageToken(pageToken).ClientName(clientName).Owner(owner).Execute()
List OAuth 2.0 Clients
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
pageSize := int64(789) // int64 | Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). (optional) (default to 250)
pageToken := "pageToken_example" // string | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). (optional) (default to "1")
clientName := "clientName_example" // string | The name of the clients to filter by. (optional)
owner := "owner_example" // string | The owner of the clients to filter by. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.ListOAuth2Clients(context.Background()).PageSize(pageSize).PageToken(pageToken).ClientName(clientName).Owner(owner).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.ListOAuth2Clients``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListOAuth2Clients`: []OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.ListOAuth2Clients`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiListOAuth2ClientsRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pageSize** | **int64** | Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [default to 250]
**pageToken** | **string** | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [default to "1"]
**clientName** | **string** | The name of the clients to filter by. |
**owner** | **string** | The owner of the clients to filter by. |
### Return type
[**[]OAuth2Client**](OAuth2Client.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## ListOAuth2ConsentSessions
> []OAuth2ConsentSession ListOAuth2ConsentSessions(ctx).Subject(subject).PageSize(pageSize).PageToken(pageToken).LoginSessionId(loginSessionId).Execute()
List OAuth 2.0 Consent Sessions of a Subject
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
subject := "subject_example" // string | The subject to list the consent sessions for.
pageSize := int64(789) // int64 | Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). (optional) (default to 250)
pageToken := "pageToken_example" // string | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). (optional) (default to "1")
loginSessionId := "loginSessionId_example" // string | The login session id to list the consent sessions for. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.ListOAuth2ConsentSessions(context.Background()).Subject(subject).PageSize(pageSize).PageToken(pageToken).LoginSessionId(loginSessionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.ListOAuth2ConsentSessions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListOAuth2ConsentSessions`: []OAuth2ConsentSession
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.ListOAuth2ConsentSessions`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiListOAuth2ConsentSessionsRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**subject** | **string** | The subject to list the consent sessions for. |
**pageSize** | **int64** | Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [default to 250]
**pageToken** | **string** | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [default to "1"]
**loginSessionId** | **string** | The login session id to list the consent sessions for. |
### Return type
[**[]OAuth2ConsentSession**](OAuth2ConsentSession.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## ListTrustedOAuth2JwtGrantIssuers
> []TrustedOAuth2JwtGrantIssuer ListTrustedOAuth2JwtGrantIssuers(ctx).MaxItems(maxItems).DefaultItems(defaultItems).Issuer(issuer).Execute()
List Trusted OAuth2 JWT Bearer Grant Type Issuers
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
maxItems := int64(789) // int64 | (optional)
defaultItems := int64(789) // int64 | (optional)
issuer := "issuer_example" // string | If optional \"issuer\" is supplied, only jwt-bearer grants with this issuer will be returned. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.ListTrustedOAuth2JwtGrantIssuers(context.Background()).MaxItems(maxItems).DefaultItems(defaultItems).Issuer(issuer).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.ListTrustedOAuth2JwtGrantIssuers``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListTrustedOAuth2JwtGrantIssuers`: []TrustedOAuth2JwtGrantIssuer
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.ListTrustedOAuth2JwtGrantIssuers`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiListTrustedOAuth2JwtGrantIssuersRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**maxItems** | **int64** | |
**defaultItems** | **int64** | |
**issuer** | **string** | If optional \"issuer\" is supplied, only jwt-bearer grants with this issuer will be returned. |
### Return type
[**[]TrustedOAuth2JwtGrantIssuer**](TrustedOAuth2JwtGrantIssuer.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## OAuth2Authorize
> ErrorOAuth2 OAuth2Authorize(ctx).Execute()
OAuth 2.0 Authorize Endpoint
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.OAuth2Authorize(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.OAuth2Authorize``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `OAuth2Authorize`: ErrorOAuth2
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.OAuth2Authorize`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiOAuth2AuthorizeRequest struct via the builder pattern
### Return type
[**ErrorOAuth2**](ErrorOAuth2.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## Oauth2TokenExchange
> OAuth2TokenExchange Oauth2TokenExchange(ctx).GrantType(grantType).ClientId(clientId).Code(code).RedirectUri(redirectUri).RefreshToken(refreshToken).Execute()
The OAuth 2.0 Token Endpoint
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
grantType := "grantType_example" // string |
clientId := "clientId_example" // string | (optional)
code := "code_example" // string | (optional)
redirectUri := "redirectUri_example" // string | (optional)
refreshToken := "refreshToken_example" // string | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.Oauth2TokenExchange(context.Background()).GrantType(grantType).ClientId(clientId).Code(code).RedirectUri(redirectUri).RefreshToken(refreshToken).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.Oauth2TokenExchange``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `Oauth2TokenExchange`: OAuth2TokenExchange
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.Oauth2TokenExchange`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiOauth2TokenExchangeRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**grantType** | **string** | |
**clientId** | **string** | |
**code** | **string** | |
**redirectUri** | **string** | |
**refreshToken** | **string** | |
### Return type
[**OAuth2TokenExchange**](OAuth2TokenExchange.md)
### Authorization
[basic](../README.md#basic), [oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## PatchOAuth2Client
> OAuth2Client PatchOAuth2Client(ctx, id).JsonPatch(jsonPatch).Execute()
Patch OAuth 2.0 Client
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The id of the OAuth 2.0 Client.
jsonPatch := []openapiclient.JsonPatch{*openapiclient.NewJsonPatch("replace", "/name")} // []JsonPatch | OAuth 2.0 Client JSON Patch Body
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.PatchOAuth2Client(context.Background(), id).JsonPatch(jsonPatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.PatchOAuth2Client``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PatchOAuth2Client`: OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.PatchOAuth2Client`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | The id of the OAuth 2.0 Client. |
### Other Parameters
Other parameters are passed through a pointer to a apiPatchOAuth2ClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**jsonPatch** | [**[]JsonPatch**](JsonPatch.md) | OAuth 2.0 Client JSON Patch Body |
### Return type
[**OAuth2Client**](OAuth2Client.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## RejectOAuth2ConsentRequest
> OAuth2RedirectTo RejectOAuth2ConsentRequest(ctx).ConsentChallenge(consentChallenge).RejectOAuth2Request(rejectOAuth2Request).Execute()
Reject OAuth 2.0 Consent Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
consentChallenge := "consentChallenge_example" // string | OAuth 2.0 Consent Request Challenge
rejectOAuth2Request := *openapiclient.NewRejectOAuth2Request() // RejectOAuth2Request | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.RejectOAuth2ConsentRequest(context.Background()).ConsentChallenge(consentChallenge).RejectOAuth2Request(rejectOAuth2Request).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.RejectOAuth2ConsentRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RejectOAuth2ConsentRequest`: OAuth2RedirectTo
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.RejectOAuth2ConsentRequest`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiRejectOAuth2ConsentRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**consentChallenge** | **string** | OAuth 2.0 Consent Request Challenge |
**rejectOAuth2Request** | [**RejectOAuth2Request**](RejectOAuth2Request.md) | |
### Return type
[**OAuth2RedirectTo**](OAuth2RedirectTo.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## RejectOAuth2LoginRequest
> OAuth2RedirectTo RejectOAuth2LoginRequest(ctx).LoginChallenge(loginChallenge).RejectOAuth2Request(rejectOAuth2Request).Execute()
Reject OAuth 2.0 Login Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
loginChallenge := "loginChallenge_example" // string | OAuth 2.0 Login Request Challenge
rejectOAuth2Request := *openapiclient.NewRejectOAuth2Request() // RejectOAuth2Request | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.RejectOAuth2LoginRequest(context.Background()).LoginChallenge(loginChallenge).RejectOAuth2Request(rejectOAuth2Request).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.RejectOAuth2LoginRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RejectOAuth2LoginRequest`: OAuth2RedirectTo
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.RejectOAuth2LoginRequest`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiRejectOAuth2LoginRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**loginChallenge** | **string** | OAuth 2.0 Login Request Challenge |
**rejectOAuth2Request** | [**RejectOAuth2Request**](RejectOAuth2Request.md) | |
### Return type
[**OAuth2RedirectTo**](OAuth2RedirectTo.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## RejectOAuth2LogoutRequest
> RejectOAuth2LogoutRequest(ctx).LogoutChallenge(logoutChallenge).Execute()
Reject OAuth 2.0 Session Logout Request
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
logoutChallenge := "logoutChallenge_example" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.RejectOAuth2LogoutRequest(context.Background()).LogoutChallenge(logoutChallenge).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.RejectOAuth2LogoutRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiRejectOAuth2LogoutRequestRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**logoutChallenge** | **string** | |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## RevokeOAuth2ConsentSessions
> RevokeOAuth2ConsentSessions(ctx).Subject(subject).Client(client).All(all).Execute()
Revoke OAuth 2.0 Consent Sessions of a Subject
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
subject := "subject_example" // string | OAuth 2.0 Consent Subject The subject whose consent sessions should be deleted.
client := "client_example" // string | OAuth 2.0 Client ID If set, deletes only those consent sessions that have been granted to the specified OAuth 2.0 Client ID. (optional)
all := true // bool | Revoke All Consent Sessions If set to `true` deletes all consent sessions by the Subject that have been granted. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.RevokeOAuth2ConsentSessions(context.Background()).Subject(subject).Client(client).All(all).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.RevokeOAuth2ConsentSessions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiRevokeOAuth2ConsentSessionsRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**subject** | **string** | OAuth 2.0 Consent Subject The subject whose consent sessions should be deleted. |
**client** | **string** | OAuth 2.0 Client ID If set, deletes only those consent sessions that have been granted to the specified OAuth 2.0 Client ID. |
**all** | **bool** | Revoke All Consent Sessions If set to `true` deletes all consent sessions by the Subject that have been granted. |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## RevokeOAuth2LoginSessions
> RevokeOAuth2LoginSessions(ctx).Subject(subject).Sid(sid).Execute()
Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
subject := "subject_example" // string | OAuth 2.0 Subject The subject to revoke authentication sessions for. (optional)
sid := "sid_example" // string | OAuth 2.0 Subject The subject to revoke authentication sessions for. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.RevokeOAuth2LoginSessions(context.Background()).Subject(subject).Sid(sid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.RevokeOAuth2LoginSessions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiRevokeOAuth2LoginSessionsRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**subject** | **string** | OAuth 2.0 Subject The subject to revoke authentication sessions for. |
**sid** | **string** | OAuth 2.0 Subject The subject to revoke authentication sessions for. |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## RevokeOAuth2Token
> RevokeOAuth2Token(ctx).Token(token).ClientId(clientId).ClientSecret(clientSecret).Execute()
Revoke OAuth 2.0 Access or Refresh Token
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
token := "token_example" // string |
clientId := "clientId_example" // string | (optional)
clientSecret := "clientSecret_example" // string | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.RevokeOAuth2Token(context.Background()).Token(token).ClientId(clientId).ClientSecret(clientSecret).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.RevokeOAuth2Token``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiRevokeOAuth2TokenRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token** | **string** | |
**clientId** | **string** | |
**clientSecret** | **string** | |
### Return type
(empty response body)
### Authorization
[basic](../README.md#basic), [oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## SetOAuth2Client
> OAuth2Client SetOAuth2Client(ctx, id).OAuth2Client(oAuth2Client).Execute()
Set OAuth 2.0 Client
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | OAuth 2.0 Client ID
oAuth2Client := *openapiclient.NewOAuth2Client() // OAuth2Client | OAuth 2.0 Client Request Body
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.SetOAuth2Client(context.Background(), id).OAuth2Client(oAuth2Client).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.SetOAuth2Client``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SetOAuth2Client`: OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.SetOAuth2Client`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | OAuth 2.0 Client ID |
### Other Parameters
Other parameters are passed through a pointer to a apiSetOAuth2ClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**oAuth2Client** | [**OAuth2Client**](OAuth2Client.md) | OAuth 2.0 Client Request Body |
### Return type
[**OAuth2Client**](OAuth2Client.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## SetOAuth2ClientLifespans
> OAuth2Client SetOAuth2ClientLifespans(ctx, id).OAuth2ClientTokenLifespans(oAuth2ClientTokenLifespans).Execute()
Set OAuth2 Client Token Lifespans
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | OAuth 2.0 Client ID
oAuth2ClientTokenLifespans := *openapiclient.NewOAuth2ClientTokenLifespans() // OAuth2ClientTokenLifespans | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.SetOAuth2ClientLifespans(context.Background(), id).OAuth2ClientTokenLifespans(oAuth2ClientTokenLifespans).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.SetOAuth2ClientLifespans``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SetOAuth2ClientLifespans`: OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.SetOAuth2ClientLifespans`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | OAuth 2.0 Client ID |
### Other Parameters
Other parameters are passed through a pointer to a apiSetOAuth2ClientLifespansRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**oAuth2ClientTokenLifespans** | [**OAuth2ClientTokenLifespans**](OAuth2ClientTokenLifespans.md) | |
### Return type
[**OAuth2Client**](OAuth2Client.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## TrustOAuth2JwtGrantIssuer
> TrustedOAuth2JwtGrantIssuer TrustOAuth2JwtGrantIssuer(ctx).TrustOAuth2JwtGrantIssuer(trustOAuth2JwtGrantIssuer).Execute()
Trust OAuth2 JWT Bearer Grant Type Issuer
### Example
```go
package main
import (
"context"
"fmt"
"os"
"time"
openapiclient "./openapi"
)
func main() {
trustOAuth2JwtGrantIssuer := *openapiclient.NewTrustOAuth2JwtGrantIssuer(time.Now(), "https://jwt-idp.example.com", *openapiclient.NewJsonWebKey("RS256", "1603dfe0af8f4596", "RSA", "sig"), []string{"Scope_example"}) // TrustOAuth2JwtGrantIssuer | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OAuth2Api.TrustOAuth2JwtGrantIssuer(context.Background()).TrustOAuth2JwtGrantIssuer(trustOAuth2JwtGrantIssuer).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OAuth2Api.TrustOAuth2JwtGrantIssuer``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TrustOAuth2JwtGrantIssuer`: TrustedOAuth2JwtGrantIssuer
fmt.Fprintf(os.Stdout, "Response from `OAuth2Api.TrustOAuth2JwtGrantIssuer`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiTrustOAuth2JwtGrantIssuerRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**trustOAuth2JwtGrantIssuer** | [**TrustOAuth2JwtGrantIssuer**](TrustOAuth2JwtGrantIssuer.md) | |
### Return type
[**TrustedOAuth2JwtGrantIssuer**](TrustedOAuth2JwtGrantIssuer.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2Client.md | # OAuth2Client
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessTokenStrategy** | Pointer to **string** | OAuth 2.0 Access Token Strategy AccessTokenStrategy is the strategy used to generate access tokens. Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens Setting the stragegy here overrides the global setting in `strategies.access_token`. | [optional]
**AllowedCorsOrigins** | Pointer to **[]string** | | [optional]
**Audience** | Pointer to **[]string** | | [optional]
**AuthorizationCodeGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**AuthorizationCodeGrantIdTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**AuthorizationCodeGrantRefreshTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**BackchannelLogoutSessionRequired** | Pointer to **bool** | OpenID Connect Back-Channel Logout Session Required Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false. | [optional]
**BackchannelLogoutUri** | Pointer to **string** | OpenID Connect Back-Channel Logout URI RP URL that will cause the RP to log itself out when sent a Logout Token by the OP. | [optional]
**ClientCredentialsGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**ClientId** | Pointer to **string** | OAuth 2.0 Client ID The ID is autogenerated and immutable. | [optional]
**ClientName** | Pointer to **string** | OAuth 2.0 Client Name The human-readable name of the client to be presented to the end-user during authorization. | [optional]
**ClientSecret** | Pointer to **string** | OAuth 2.0 Client Secret The secret will be included in the create request as cleartext, and then never again. The secret is kept in hashed format and is not recoverable once lost. | [optional]
**ClientSecretExpiresAt** | Pointer to **int64** | OAuth 2.0 Client Secret Expires At The field is currently not supported and its value is always 0. | [optional]
**ClientUri** | Pointer to **string** | OAuth 2.0 Client URI ClientURI is a URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion. | [optional]
**Contacts** | Pointer to **[]string** | | [optional]
**CreatedAt** | Pointer to **time.Time** | OAuth 2.0 Client Creation Date CreatedAt returns the timestamp of the client's creation. | [optional]
**FrontchannelLogoutSessionRequired** | Pointer to **bool** | OpenID Connect Front-Channel Logout Session Required Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false. | [optional]
**FrontchannelLogoutUri** | Pointer to **string** | OpenID Connect Front-Channel Logout URI RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be. | [optional]
**GrantTypes** | Pointer to **[]string** | | [optional]
**ImplicitGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**ImplicitGrantIdTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**Jwks** | Pointer to **interface{}** | OAuth 2.0 Client JSON Web Key Set Client's JSON Web Key Set [JWK] document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it MUST NOT use jwks. One significant downside of jwks is that it does not enable key rotation (which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri and jwks parameters MUST NOT be used together. | [optional]
**JwksUri** | Pointer to **string** | OAuth 2.0 Client JSON Web Key Set URL URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. | [optional]
**JwtBearerGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**LogoUri** | Pointer to **string** | OAuth 2.0 Client Logo URI A URL string referencing the client's logo. | [optional]
**Metadata** | Pointer to **interface{}** | | [optional]
**Owner** | Pointer to **string** | OAuth 2.0 Client Owner Owner is a string identifying the owner of the OAuth 2.0 Client. | [optional]
**PolicyUri** | Pointer to **string** | OAuth 2.0 Client Policy URI PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data. | [optional]
**PostLogoutRedirectUris** | Pointer to **[]string** | | [optional]
**RedirectUris** | Pointer to **[]string** | | [optional]
**RefreshTokenGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**RefreshTokenGrantIdTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**RefreshTokenGrantRefreshTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**RegistrationAccessToken** | Pointer to **string** | OpenID Connect Dynamic Client Registration Access Token RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration. | [optional]
**RegistrationClientUri** | Pointer to **string** | OpenID Connect Dynamic Client Registration URL RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client. | [optional]
**RequestObjectSigningAlg** | Pointer to **string** | OpenID Connect Request Object Signing Algorithm JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm. | [optional]
**RequestUris** | Pointer to **[]string** | | [optional]
**ResponseTypes** | Pointer to **[]string** | | [optional]
**Scope** | Pointer to **string** | OAuth 2.0 Client Scope Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens. | [optional]
**SectorIdentifierUri** | Pointer to **string** | OpenID Connect Sector Identifier URI URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values. | [optional]
**SkipConsent** | Pointer to **bool** | SkipConsent skips the consent screen for this client. This field can only be set from the admin API. | [optional]
**SubjectType** | Pointer to **string** | OpenID Connect Subject Type The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`. | [optional]
**TokenEndpointAuthMethod** | Pointer to **string** | OAuth 2.0 Token Endpoint Authentication Method Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `none`: Used for public clients (native apps, mobile apps) which can not have secrets. | [optional] [default to "client_secret_basic"]
**TokenEndpointAuthSigningAlg** | Pointer to **string** | OAuth 2.0 Token Endpoint Signing Algorithm Requested Client Authentication signing algorithm for the Token Endpoint. | [optional]
**TosUri** | Pointer to **string** | OAuth 2.0 Client Terms of Service URI A URL string pointing to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client. | [optional]
**UpdatedAt** | Pointer to **time.Time** | OAuth 2.0 Client Last Update Date UpdatedAt returns the timestamp of the last update. | [optional]
**UserinfoSignedResponseAlg** | Pointer to **string** | OpenID Connect Request Userinfo Signed Response Algorithm JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type. | [optional]
## Methods
### NewOAuth2Client
`func NewOAuth2Client() *OAuth2Client`
NewOAuth2Client instantiates a new OAuth2Client 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
### NewOAuth2ClientWithDefaults
`func NewOAuth2ClientWithDefaults() *OAuth2Client`
NewOAuth2ClientWithDefaults instantiates a new OAuth2Client 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
### GetAccessTokenStrategy
`func (o *OAuth2Client) GetAccessTokenStrategy() string`
GetAccessTokenStrategy returns the AccessTokenStrategy field if non-nil, zero value otherwise.
### GetAccessTokenStrategyOk
`func (o *OAuth2Client) GetAccessTokenStrategyOk() (*string, bool)`
GetAccessTokenStrategyOk returns a tuple with the AccessTokenStrategy field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAccessTokenStrategy
`func (o *OAuth2Client) SetAccessTokenStrategy(v string)`
SetAccessTokenStrategy sets AccessTokenStrategy field to given value.
### HasAccessTokenStrategy
`func (o *OAuth2Client) HasAccessTokenStrategy() bool`
HasAccessTokenStrategy returns a boolean if a field has been set.
### GetAllowedCorsOrigins
`func (o *OAuth2Client) GetAllowedCorsOrigins() []string`
GetAllowedCorsOrigins returns the AllowedCorsOrigins field if non-nil, zero value otherwise.
### GetAllowedCorsOriginsOk
`func (o *OAuth2Client) GetAllowedCorsOriginsOk() (*[]string, bool)`
GetAllowedCorsOriginsOk returns a tuple with the AllowedCorsOrigins field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAllowedCorsOrigins
`func (o *OAuth2Client) SetAllowedCorsOrigins(v []string)`
SetAllowedCorsOrigins sets AllowedCorsOrigins field to given value.
### HasAllowedCorsOrigins
`func (o *OAuth2Client) HasAllowedCorsOrigins() bool`
HasAllowedCorsOrigins returns a boolean if a field has been set.
### GetAudience
`func (o *OAuth2Client) GetAudience() []string`
GetAudience returns the Audience field if non-nil, zero value otherwise.
### GetAudienceOk
`func (o *OAuth2Client) GetAudienceOk() (*[]string, bool)`
GetAudienceOk returns a tuple with the Audience field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAudience
`func (o *OAuth2Client) SetAudience(v []string)`
SetAudience sets Audience field to given value.
### HasAudience
`func (o *OAuth2Client) HasAudience() bool`
HasAudience returns a boolean if a field has been set.
### GetAuthorizationCodeGrantAccessTokenLifespan
`func (o *OAuth2Client) GetAuthorizationCodeGrantAccessTokenLifespan() string`
GetAuthorizationCodeGrantAccessTokenLifespan returns the AuthorizationCodeGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetAuthorizationCodeGrantAccessTokenLifespanOk
`func (o *OAuth2Client) GetAuthorizationCodeGrantAccessTokenLifespanOk() (*string, bool)`
GetAuthorizationCodeGrantAccessTokenLifespanOk returns a tuple with the AuthorizationCodeGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAuthorizationCodeGrantAccessTokenLifespan
`func (o *OAuth2Client) SetAuthorizationCodeGrantAccessTokenLifespan(v string)`
SetAuthorizationCodeGrantAccessTokenLifespan sets AuthorizationCodeGrantAccessTokenLifespan field to given value.
### HasAuthorizationCodeGrantAccessTokenLifespan
`func (o *OAuth2Client) HasAuthorizationCodeGrantAccessTokenLifespan() bool`
HasAuthorizationCodeGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetAuthorizationCodeGrantIdTokenLifespan
`func (o *OAuth2Client) GetAuthorizationCodeGrantIdTokenLifespan() string`
GetAuthorizationCodeGrantIdTokenLifespan returns the AuthorizationCodeGrantIdTokenLifespan field if non-nil, zero value otherwise.
### GetAuthorizationCodeGrantIdTokenLifespanOk
`func (o *OAuth2Client) GetAuthorizationCodeGrantIdTokenLifespanOk() (*string, bool)`
GetAuthorizationCodeGrantIdTokenLifespanOk returns a tuple with the AuthorizationCodeGrantIdTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAuthorizationCodeGrantIdTokenLifespan
`func (o *OAuth2Client) SetAuthorizationCodeGrantIdTokenLifespan(v string)`
SetAuthorizationCodeGrantIdTokenLifespan sets AuthorizationCodeGrantIdTokenLifespan field to given value.
### HasAuthorizationCodeGrantIdTokenLifespan
`func (o *OAuth2Client) HasAuthorizationCodeGrantIdTokenLifespan() bool`
HasAuthorizationCodeGrantIdTokenLifespan returns a boolean if a field has been set.
### GetAuthorizationCodeGrantRefreshTokenLifespan
`func (o *OAuth2Client) GetAuthorizationCodeGrantRefreshTokenLifespan() string`
GetAuthorizationCodeGrantRefreshTokenLifespan returns the AuthorizationCodeGrantRefreshTokenLifespan field if non-nil, zero value otherwise.
### GetAuthorizationCodeGrantRefreshTokenLifespanOk
`func (o *OAuth2Client) GetAuthorizationCodeGrantRefreshTokenLifespanOk() (*string, bool)`
GetAuthorizationCodeGrantRefreshTokenLifespanOk returns a tuple with the AuthorizationCodeGrantRefreshTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAuthorizationCodeGrantRefreshTokenLifespan
`func (o *OAuth2Client) SetAuthorizationCodeGrantRefreshTokenLifespan(v string)`
SetAuthorizationCodeGrantRefreshTokenLifespan sets AuthorizationCodeGrantRefreshTokenLifespan field to given value.
### HasAuthorizationCodeGrantRefreshTokenLifespan
`func (o *OAuth2Client) HasAuthorizationCodeGrantRefreshTokenLifespan() bool`
HasAuthorizationCodeGrantRefreshTokenLifespan returns a boolean if a field has been set.
### GetBackchannelLogoutSessionRequired
`func (o *OAuth2Client) GetBackchannelLogoutSessionRequired() bool`
GetBackchannelLogoutSessionRequired returns the BackchannelLogoutSessionRequired field if non-nil, zero value otherwise.
### GetBackchannelLogoutSessionRequiredOk
`func (o *OAuth2Client) GetBackchannelLogoutSessionRequiredOk() (*bool, bool)`
GetBackchannelLogoutSessionRequiredOk returns a tuple with the BackchannelLogoutSessionRequired field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetBackchannelLogoutSessionRequired
`func (o *OAuth2Client) SetBackchannelLogoutSessionRequired(v bool)`
SetBackchannelLogoutSessionRequired sets BackchannelLogoutSessionRequired field to given value.
### HasBackchannelLogoutSessionRequired
`func (o *OAuth2Client) HasBackchannelLogoutSessionRequired() bool`
HasBackchannelLogoutSessionRequired returns a boolean if a field has been set.
### GetBackchannelLogoutUri
`func (o *OAuth2Client) GetBackchannelLogoutUri() string`
GetBackchannelLogoutUri returns the BackchannelLogoutUri field if non-nil, zero value otherwise.
### GetBackchannelLogoutUriOk
`func (o *OAuth2Client) GetBackchannelLogoutUriOk() (*string, bool)`
GetBackchannelLogoutUriOk returns a tuple with the BackchannelLogoutUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetBackchannelLogoutUri
`func (o *OAuth2Client) SetBackchannelLogoutUri(v string)`
SetBackchannelLogoutUri sets BackchannelLogoutUri field to given value.
### HasBackchannelLogoutUri
`func (o *OAuth2Client) HasBackchannelLogoutUri() bool`
HasBackchannelLogoutUri returns a boolean if a field has been set.
### GetClientCredentialsGrantAccessTokenLifespan
`func (o *OAuth2Client) GetClientCredentialsGrantAccessTokenLifespan() string`
GetClientCredentialsGrantAccessTokenLifespan returns the ClientCredentialsGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetClientCredentialsGrantAccessTokenLifespanOk
`func (o *OAuth2Client) GetClientCredentialsGrantAccessTokenLifespanOk() (*string, bool)`
GetClientCredentialsGrantAccessTokenLifespanOk returns a tuple with the ClientCredentialsGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClientCredentialsGrantAccessTokenLifespan
`func (o *OAuth2Client) SetClientCredentialsGrantAccessTokenLifespan(v string)`
SetClientCredentialsGrantAccessTokenLifespan sets ClientCredentialsGrantAccessTokenLifespan field to given value.
### HasClientCredentialsGrantAccessTokenLifespan
`func (o *OAuth2Client) HasClientCredentialsGrantAccessTokenLifespan() bool`
HasClientCredentialsGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetClientId
`func (o *OAuth2Client) GetClientId() string`
GetClientId returns the ClientId field if non-nil, zero value otherwise.
### GetClientIdOk
`func (o *OAuth2Client) GetClientIdOk() (*string, bool)`
GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClientId
`func (o *OAuth2Client) SetClientId(v string)`
SetClientId sets ClientId field to given value.
### HasClientId
`func (o *OAuth2Client) HasClientId() bool`
HasClientId returns a boolean if a field has been set.
### GetClientName
`func (o *OAuth2Client) GetClientName() string`
GetClientName returns the ClientName field if non-nil, zero value otherwise.
### GetClientNameOk
`func (o *OAuth2Client) GetClientNameOk() (*string, bool)`
GetClientNameOk returns a tuple with the ClientName field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClientName
`func (o *OAuth2Client) SetClientName(v string)`
SetClientName sets ClientName field to given value.
### HasClientName
`func (o *OAuth2Client) HasClientName() bool`
HasClientName returns a boolean if a field has been set.
### GetClientSecret
`func (o *OAuth2Client) GetClientSecret() string`
GetClientSecret returns the ClientSecret field if non-nil, zero value otherwise.
### GetClientSecretOk
`func (o *OAuth2Client) GetClientSecretOk() (*string, bool)`
GetClientSecretOk returns a tuple with the ClientSecret field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClientSecret
`func (o *OAuth2Client) SetClientSecret(v string)`
SetClientSecret sets ClientSecret field to given value.
### HasClientSecret
`func (o *OAuth2Client) HasClientSecret() bool`
HasClientSecret returns a boolean if a field has been set.
### GetClientSecretExpiresAt
`func (o *OAuth2Client) GetClientSecretExpiresAt() int64`
GetClientSecretExpiresAt returns the ClientSecretExpiresAt field if non-nil, zero value otherwise.
### GetClientSecretExpiresAtOk
`func (o *OAuth2Client) GetClientSecretExpiresAtOk() (*int64, bool)`
GetClientSecretExpiresAtOk returns a tuple with the ClientSecretExpiresAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClientSecretExpiresAt
`func (o *OAuth2Client) SetClientSecretExpiresAt(v int64)`
SetClientSecretExpiresAt sets ClientSecretExpiresAt field to given value.
### HasClientSecretExpiresAt
`func (o *OAuth2Client) HasClientSecretExpiresAt() bool`
HasClientSecretExpiresAt returns a boolean if a field has been set.
### GetClientUri
`func (o *OAuth2Client) GetClientUri() string`
GetClientUri returns the ClientUri field if non-nil, zero value otherwise.
### GetClientUriOk
`func (o *OAuth2Client) GetClientUriOk() (*string, bool)`
GetClientUriOk returns a tuple with the ClientUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClientUri
`func (o *OAuth2Client) SetClientUri(v string)`
SetClientUri sets ClientUri field to given value.
### HasClientUri
`func (o *OAuth2Client) HasClientUri() bool`
HasClientUri returns a boolean if a field has been set.
### GetContacts
`func (o *OAuth2Client) GetContacts() []string`
GetContacts returns the Contacts field if non-nil, zero value otherwise.
### GetContactsOk
`func (o *OAuth2Client) GetContactsOk() (*[]string, bool)`
GetContactsOk returns a tuple with the Contacts field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetContacts
`func (o *OAuth2Client) SetContacts(v []string)`
SetContacts sets Contacts field to given value.
### HasContacts
`func (o *OAuth2Client) HasContacts() bool`
HasContacts returns a boolean if a field has been set.
### GetCreatedAt
`func (o *OAuth2Client) GetCreatedAt() time.Time`
GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise.
### GetCreatedAtOk
`func (o *OAuth2Client) GetCreatedAtOk() (*time.Time, bool)`
GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCreatedAt
`func (o *OAuth2Client) SetCreatedAt(v time.Time)`
SetCreatedAt sets CreatedAt field to given value.
### HasCreatedAt
`func (o *OAuth2Client) HasCreatedAt() bool`
HasCreatedAt returns a boolean if a field has been set.
### GetFrontchannelLogoutSessionRequired
`func (o *OAuth2Client) GetFrontchannelLogoutSessionRequired() bool`
GetFrontchannelLogoutSessionRequired returns the FrontchannelLogoutSessionRequired field if non-nil, zero value otherwise.
### GetFrontchannelLogoutSessionRequiredOk
`func (o *OAuth2Client) GetFrontchannelLogoutSessionRequiredOk() (*bool, bool)`
GetFrontchannelLogoutSessionRequiredOk returns a tuple with the FrontchannelLogoutSessionRequired field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFrontchannelLogoutSessionRequired
`func (o *OAuth2Client) SetFrontchannelLogoutSessionRequired(v bool)`
SetFrontchannelLogoutSessionRequired sets FrontchannelLogoutSessionRequired field to given value.
### HasFrontchannelLogoutSessionRequired
`func (o *OAuth2Client) HasFrontchannelLogoutSessionRequired() bool`
HasFrontchannelLogoutSessionRequired returns a boolean if a field has been set.
### GetFrontchannelLogoutUri
`func (o *OAuth2Client) GetFrontchannelLogoutUri() string`
GetFrontchannelLogoutUri returns the FrontchannelLogoutUri field if non-nil, zero value otherwise.
### GetFrontchannelLogoutUriOk
`func (o *OAuth2Client) GetFrontchannelLogoutUriOk() (*string, bool)`
GetFrontchannelLogoutUriOk returns a tuple with the FrontchannelLogoutUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFrontchannelLogoutUri
`func (o *OAuth2Client) SetFrontchannelLogoutUri(v string)`
SetFrontchannelLogoutUri sets FrontchannelLogoutUri field to given value.
### HasFrontchannelLogoutUri
`func (o *OAuth2Client) HasFrontchannelLogoutUri() bool`
HasFrontchannelLogoutUri returns a boolean if a field has been set.
### GetGrantTypes
`func (o *OAuth2Client) GetGrantTypes() []string`
GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise.
### GetGrantTypesOk
`func (o *OAuth2Client) GetGrantTypesOk() (*[]string, bool)`
GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetGrantTypes
`func (o *OAuth2Client) SetGrantTypes(v []string)`
SetGrantTypes sets GrantTypes field to given value.
### HasGrantTypes
`func (o *OAuth2Client) HasGrantTypes() bool`
HasGrantTypes returns a boolean if a field has been set.
### GetImplicitGrantAccessTokenLifespan
`func (o *OAuth2Client) GetImplicitGrantAccessTokenLifespan() string`
GetImplicitGrantAccessTokenLifespan returns the ImplicitGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetImplicitGrantAccessTokenLifespanOk
`func (o *OAuth2Client) GetImplicitGrantAccessTokenLifespanOk() (*string, bool)`
GetImplicitGrantAccessTokenLifespanOk returns a tuple with the ImplicitGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetImplicitGrantAccessTokenLifespan
`func (o *OAuth2Client) SetImplicitGrantAccessTokenLifespan(v string)`
SetImplicitGrantAccessTokenLifespan sets ImplicitGrantAccessTokenLifespan field to given value.
### HasImplicitGrantAccessTokenLifespan
`func (o *OAuth2Client) HasImplicitGrantAccessTokenLifespan() bool`
HasImplicitGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetImplicitGrantIdTokenLifespan
`func (o *OAuth2Client) GetImplicitGrantIdTokenLifespan() string`
GetImplicitGrantIdTokenLifespan returns the ImplicitGrantIdTokenLifespan field if non-nil, zero value otherwise.
### GetImplicitGrantIdTokenLifespanOk
`func (o *OAuth2Client) GetImplicitGrantIdTokenLifespanOk() (*string, bool)`
GetImplicitGrantIdTokenLifespanOk returns a tuple with the ImplicitGrantIdTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetImplicitGrantIdTokenLifespan
`func (o *OAuth2Client) SetImplicitGrantIdTokenLifespan(v string)`
SetImplicitGrantIdTokenLifespan sets ImplicitGrantIdTokenLifespan field to given value.
### HasImplicitGrantIdTokenLifespan
`func (o *OAuth2Client) HasImplicitGrantIdTokenLifespan() bool`
HasImplicitGrantIdTokenLifespan returns a boolean if a field has been set.
### GetJwks
`func (o *OAuth2Client) GetJwks() interface{}`
GetJwks returns the Jwks field if non-nil, zero value otherwise.
### GetJwksOk
`func (o *OAuth2Client) GetJwksOk() (*interface{}, bool)`
GetJwksOk returns a tuple with the Jwks field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetJwks
`func (o *OAuth2Client) SetJwks(v interface{})`
SetJwks sets Jwks field to given value.
### HasJwks
`func (o *OAuth2Client) HasJwks() bool`
HasJwks returns a boolean if a field has been set.
### SetJwksNil
`func (o *OAuth2Client) SetJwksNil(b bool)`
SetJwksNil sets the value for Jwks to be an explicit nil
### UnsetJwks
`func (o *OAuth2Client) UnsetJwks()`
UnsetJwks ensures that no value is present for Jwks, not even an explicit nil
### GetJwksUri
`func (o *OAuth2Client) GetJwksUri() string`
GetJwksUri returns the JwksUri field if non-nil, zero value otherwise.
### GetJwksUriOk
`func (o *OAuth2Client) GetJwksUriOk() (*string, bool)`
GetJwksUriOk returns a tuple with the JwksUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetJwksUri
`func (o *OAuth2Client) SetJwksUri(v string)`
SetJwksUri sets JwksUri field to given value.
### HasJwksUri
`func (o *OAuth2Client) HasJwksUri() bool`
HasJwksUri returns a boolean if a field has been set.
### GetJwtBearerGrantAccessTokenLifespan
`func (o *OAuth2Client) GetJwtBearerGrantAccessTokenLifespan() string`
GetJwtBearerGrantAccessTokenLifespan returns the JwtBearerGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetJwtBearerGrantAccessTokenLifespanOk
`func (o *OAuth2Client) GetJwtBearerGrantAccessTokenLifespanOk() (*string, bool)`
GetJwtBearerGrantAccessTokenLifespanOk returns a tuple with the JwtBearerGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetJwtBearerGrantAccessTokenLifespan
`func (o *OAuth2Client) SetJwtBearerGrantAccessTokenLifespan(v string)`
SetJwtBearerGrantAccessTokenLifespan sets JwtBearerGrantAccessTokenLifespan field to given value.
### HasJwtBearerGrantAccessTokenLifespan
`func (o *OAuth2Client) HasJwtBearerGrantAccessTokenLifespan() bool`
HasJwtBearerGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetLogoUri
`func (o *OAuth2Client) GetLogoUri() string`
GetLogoUri returns the LogoUri field if non-nil, zero value otherwise.
### GetLogoUriOk
`func (o *OAuth2Client) GetLogoUriOk() (*string, bool)`
GetLogoUriOk returns a tuple with the LogoUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetLogoUri
`func (o *OAuth2Client) SetLogoUri(v string)`
SetLogoUri sets LogoUri field to given value.
### HasLogoUri
`func (o *OAuth2Client) HasLogoUri() bool`
HasLogoUri returns a boolean if a field has been set.
### GetMetadata
`func (o *OAuth2Client) GetMetadata() interface{}`
GetMetadata returns the Metadata field if non-nil, zero value otherwise.
### GetMetadataOk
`func (o *OAuth2Client) GetMetadataOk() (*interface{}, bool)`
GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetMetadata
`func (o *OAuth2Client) SetMetadata(v interface{})`
SetMetadata sets Metadata field to given value.
### HasMetadata
`func (o *OAuth2Client) HasMetadata() bool`
HasMetadata returns a boolean if a field has been set.
### SetMetadataNil
`func (o *OAuth2Client) SetMetadataNil(b bool)`
SetMetadataNil sets the value for Metadata to be an explicit nil
### UnsetMetadata
`func (o *OAuth2Client) UnsetMetadata()`
UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil
### GetOwner
`func (o *OAuth2Client) GetOwner() string`
GetOwner returns the Owner field if non-nil, zero value otherwise.
### GetOwnerOk
`func (o *OAuth2Client) GetOwnerOk() (*string, bool)`
GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetOwner
`func (o *OAuth2Client) SetOwner(v string)`
SetOwner sets Owner field to given value.
### HasOwner
`func (o *OAuth2Client) HasOwner() bool`
HasOwner returns a boolean if a field has been set.
### GetPolicyUri
`func (o *OAuth2Client) GetPolicyUri() string`
GetPolicyUri returns the PolicyUri field if non-nil, zero value otherwise.
### GetPolicyUriOk
`func (o *OAuth2Client) GetPolicyUriOk() (*string, bool)`
GetPolicyUriOk returns a tuple with the PolicyUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPolicyUri
`func (o *OAuth2Client) SetPolicyUri(v string)`
SetPolicyUri sets PolicyUri field to given value.
### HasPolicyUri
`func (o *OAuth2Client) HasPolicyUri() bool`
HasPolicyUri returns a boolean if a field has been set.
### GetPostLogoutRedirectUris
`func (o *OAuth2Client) GetPostLogoutRedirectUris() []string`
GetPostLogoutRedirectUris returns the PostLogoutRedirectUris field if non-nil, zero value otherwise.
### GetPostLogoutRedirectUrisOk
`func (o *OAuth2Client) GetPostLogoutRedirectUrisOk() (*[]string, bool)`
GetPostLogoutRedirectUrisOk returns a tuple with the PostLogoutRedirectUris field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPostLogoutRedirectUris
`func (o *OAuth2Client) SetPostLogoutRedirectUris(v []string)`
SetPostLogoutRedirectUris sets PostLogoutRedirectUris field to given value.
### HasPostLogoutRedirectUris
`func (o *OAuth2Client) HasPostLogoutRedirectUris() bool`
HasPostLogoutRedirectUris returns a boolean if a field has been set.
### GetRedirectUris
`func (o *OAuth2Client) GetRedirectUris() []string`
GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise.
### GetRedirectUrisOk
`func (o *OAuth2Client) GetRedirectUrisOk() (*[]string, bool)`
GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRedirectUris
`func (o *OAuth2Client) SetRedirectUris(v []string)`
SetRedirectUris sets RedirectUris field to given value.
### HasRedirectUris
`func (o *OAuth2Client) HasRedirectUris() bool`
HasRedirectUris returns a boolean if a field has been set.
### GetRefreshTokenGrantAccessTokenLifespan
`func (o *OAuth2Client) GetRefreshTokenGrantAccessTokenLifespan() string`
GetRefreshTokenGrantAccessTokenLifespan returns the RefreshTokenGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetRefreshTokenGrantAccessTokenLifespanOk
`func (o *OAuth2Client) GetRefreshTokenGrantAccessTokenLifespanOk() (*string, bool)`
GetRefreshTokenGrantAccessTokenLifespanOk returns a tuple with the RefreshTokenGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRefreshTokenGrantAccessTokenLifespan
`func (o *OAuth2Client) SetRefreshTokenGrantAccessTokenLifespan(v string)`
SetRefreshTokenGrantAccessTokenLifespan sets RefreshTokenGrantAccessTokenLifespan field to given value.
### HasRefreshTokenGrantAccessTokenLifespan
`func (o *OAuth2Client) HasRefreshTokenGrantAccessTokenLifespan() bool`
HasRefreshTokenGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetRefreshTokenGrantIdTokenLifespan
`func (o *OAuth2Client) GetRefreshTokenGrantIdTokenLifespan() string`
GetRefreshTokenGrantIdTokenLifespan returns the RefreshTokenGrantIdTokenLifespan field if non-nil, zero value otherwise.
### GetRefreshTokenGrantIdTokenLifespanOk
`func (o *OAuth2Client) GetRefreshTokenGrantIdTokenLifespanOk() (*string, bool)`
GetRefreshTokenGrantIdTokenLifespanOk returns a tuple with the RefreshTokenGrantIdTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRefreshTokenGrantIdTokenLifespan
`func (o *OAuth2Client) SetRefreshTokenGrantIdTokenLifespan(v string)`
SetRefreshTokenGrantIdTokenLifespan sets RefreshTokenGrantIdTokenLifespan field to given value.
### HasRefreshTokenGrantIdTokenLifespan
`func (o *OAuth2Client) HasRefreshTokenGrantIdTokenLifespan() bool`
HasRefreshTokenGrantIdTokenLifespan returns a boolean if a field has been set.
### GetRefreshTokenGrantRefreshTokenLifespan
`func (o *OAuth2Client) GetRefreshTokenGrantRefreshTokenLifespan() string`
GetRefreshTokenGrantRefreshTokenLifespan returns the RefreshTokenGrantRefreshTokenLifespan field if non-nil, zero value otherwise.
### GetRefreshTokenGrantRefreshTokenLifespanOk
`func (o *OAuth2Client) GetRefreshTokenGrantRefreshTokenLifespanOk() (*string, bool)`
GetRefreshTokenGrantRefreshTokenLifespanOk returns a tuple with the RefreshTokenGrantRefreshTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRefreshTokenGrantRefreshTokenLifespan
`func (o *OAuth2Client) SetRefreshTokenGrantRefreshTokenLifespan(v string)`
SetRefreshTokenGrantRefreshTokenLifespan sets RefreshTokenGrantRefreshTokenLifespan field to given value.
### HasRefreshTokenGrantRefreshTokenLifespan
`func (o *OAuth2Client) HasRefreshTokenGrantRefreshTokenLifespan() bool`
HasRefreshTokenGrantRefreshTokenLifespan returns a boolean if a field has been set.
### GetRegistrationAccessToken
`func (o *OAuth2Client) GetRegistrationAccessToken() string`
GetRegistrationAccessToken returns the RegistrationAccessToken field if non-nil, zero value otherwise.
### GetRegistrationAccessTokenOk
`func (o *OAuth2Client) GetRegistrationAccessTokenOk() (*string, bool)`
GetRegistrationAccessTokenOk returns a tuple with the RegistrationAccessToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRegistrationAccessToken
`func (o *OAuth2Client) SetRegistrationAccessToken(v string)`
SetRegistrationAccessToken sets RegistrationAccessToken field to given value.
### HasRegistrationAccessToken
`func (o *OAuth2Client) HasRegistrationAccessToken() bool`
HasRegistrationAccessToken returns a boolean if a field has been set.
### GetRegistrationClientUri
`func (o *OAuth2Client) GetRegistrationClientUri() string`
GetRegistrationClientUri returns the RegistrationClientUri field if non-nil, zero value otherwise.
### GetRegistrationClientUriOk
`func (o *OAuth2Client) GetRegistrationClientUriOk() (*string, bool)`
GetRegistrationClientUriOk returns a tuple with the RegistrationClientUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRegistrationClientUri
`func (o *OAuth2Client) SetRegistrationClientUri(v string)`
SetRegistrationClientUri sets RegistrationClientUri field to given value.
### HasRegistrationClientUri
`func (o *OAuth2Client) HasRegistrationClientUri() bool`
HasRegistrationClientUri returns a boolean if a field has been set.
### GetRequestObjectSigningAlg
`func (o *OAuth2Client) GetRequestObjectSigningAlg() string`
GetRequestObjectSigningAlg returns the RequestObjectSigningAlg field if non-nil, zero value otherwise.
### GetRequestObjectSigningAlgOk
`func (o *OAuth2Client) GetRequestObjectSigningAlgOk() (*string, bool)`
GetRequestObjectSigningAlgOk returns a tuple with the RequestObjectSigningAlg field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRequestObjectSigningAlg
`func (o *OAuth2Client) SetRequestObjectSigningAlg(v string)`
SetRequestObjectSigningAlg sets RequestObjectSigningAlg field to given value.
### HasRequestObjectSigningAlg
`func (o *OAuth2Client) HasRequestObjectSigningAlg() bool`
HasRequestObjectSigningAlg returns a boolean if a field has been set.
### GetRequestUris
`func (o *OAuth2Client) GetRequestUris() []string`
GetRequestUris returns the RequestUris field if non-nil, zero value otherwise.
### GetRequestUrisOk
`func (o *OAuth2Client) GetRequestUrisOk() (*[]string, bool)`
GetRequestUrisOk returns a tuple with the RequestUris field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRequestUris
`func (o *OAuth2Client) SetRequestUris(v []string)`
SetRequestUris sets RequestUris field to given value.
### HasRequestUris
`func (o *OAuth2Client) HasRequestUris() bool`
HasRequestUris returns a boolean if a field has been set.
### GetResponseTypes
`func (o *OAuth2Client) GetResponseTypes() []string`
GetResponseTypes returns the ResponseTypes field if non-nil, zero value otherwise.
### GetResponseTypesOk
`func (o *OAuth2Client) GetResponseTypesOk() (*[]string, bool)`
GetResponseTypesOk returns a tuple with the ResponseTypes field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetResponseTypes
`func (o *OAuth2Client) SetResponseTypes(v []string)`
SetResponseTypes sets ResponseTypes field to given value.
### HasResponseTypes
`func (o *OAuth2Client) HasResponseTypes() bool`
HasResponseTypes returns a boolean if a field has been set.
### GetScope
`func (o *OAuth2Client) GetScope() string`
GetScope returns the Scope field if non-nil, zero value otherwise.
### GetScopeOk
`func (o *OAuth2Client) GetScopeOk() (*string, bool)`
GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetScope
`func (o *OAuth2Client) SetScope(v string)`
SetScope sets Scope field to given value.
### HasScope
`func (o *OAuth2Client) HasScope() bool`
HasScope returns a boolean if a field has been set.
### GetSectorIdentifierUri
`func (o *OAuth2Client) GetSectorIdentifierUri() string`
GetSectorIdentifierUri returns the SectorIdentifierUri field if non-nil, zero value otherwise.
### GetSectorIdentifierUriOk
`func (o *OAuth2Client) GetSectorIdentifierUriOk() (*string, bool)`
GetSectorIdentifierUriOk returns a tuple with the SectorIdentifierUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSectorIdentifierUri
`func (o *OAuth2Client) SetSectorIdentifierUri(v string)`
SetSectorIdentifierUri sets SectorIdentifierUri field to given value.
### HasSectorIdentifierUri
`func (o *OAuth2Client) HasSectorIdentifierUri() bool`
HasSectorIdentifierUri returns a boolean if a field has been set.
### GetSkipConsent
`func (o *OAuth2Client) GetSkipConsent() bool`
GetSkipConsent returns the SkipConsent field if non-nil, zero value otherwise.
### GetSkipConsentOk
`func (o *OAuth2Client) GetSkipConsentOk() (*bool, bool)`
GetSkipConsentOk returns a tuple with the SkipConsent field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSkipConsent
`func (o *OAuth2Client) SetSkipConsent(v bool)`
SetSkipConsent sets SkipConsent field to given value.
### HasSkipConsent
`func (o *OAuth2Client) HasSkipConsent() bool`
HasSkipConsent returns a boolean if a field has been set.
### GetSubjectType
`func (o *OAuth2Client) GetSubjectType() string`
GetSubjectType returns the SubjectType field if non-nil, zero value otherwise.
### GetSubjectTypeOk
`func (o *OAuth2Client) GetSubjectTypeOk() (*string, bool)`
GetSubjectTypeOk returns a tuple with the SubjectType field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSubjectType
`func (o *OAuth2Client) SetSubjectType(v string)`
SetSubjectType sets SubjectType field to given value.
### HasSubjectType
`func (o *OAuth2Client) HasSubjectType() bool`
HasSubjectType returns a boolean if a field has been set.
### GetTokenEndpointAuthMethod
`func (o *OAuth2Client) GetTokenEndpointAuthMethod() string`
GetTokenEndpointAuthMethod returns the TokenEndpointAuthMethod field if non-nil, zero value otherwise.
### GetTokenEndpointAuthMethodOk
`func (o *OAuth2Client) GetTokenEndpointAuthMethodOk() (*string, bool)`
GetTokenEndpointAuthMethodOk returns a tuple with the TokenEndpointAuthMethod field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTokenEndpointAuthMethod
`func (o *OAuth2Client) SetTokenEndpointAuthMethod(v string)`
SetTokenEndpointAuthMethod sets TokenEndpointAuthMethod field to given value.
### HasTokenEndpointAuthMethod
`func (o *OAuth2Client) HasTokenEndpointAuthMethod() bool`
HasTokenEndpointAuthMethod returns a boolean if a field has been set.
### GetTokenEndpointAuthSigningAlg
`func (o *OAuth2Client) GetTokenEndpointAuthSigningAlg() string`
GetTokenEndpointAuthSigningAlg returns the TokenEndpointAuthSigningAlg field if non-nil, zero value otherwise.
### GetTokenEndpointAuthSigningAlgOk
`func (o *OAuth2Client) GetTokenEndpointAuthSigningAlgOk() (*string, bool)`
GetTokenEndpointAuthSigningAlgOk returns a tuple with the TokenEndpointAuthSigningAlg field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTokenEndpointAuthSigningAlg
`func (o *OAuth2Client) SetTokenEndpointAuthSigningAlg(v string)`
SetTokenEndpointAuthSigningAlg sets TokenEndpointAuthSigningAlg field to given value.
### HasTokenEndpointAuthSigningAlg
`func (o *OAuth2Client) HasTokenEndpointAuthSigningAlg() bool`
HasTokenEndpointAuthSigningAlg returns a boolean if a field has been set.
### GetTosUri
`func (o *OAuth2Client) GetTosUri() string`
GetTosUri returns the TosUri field if non-nil, zero value otherwise.
### GetTosUriOk
`func (o *OAuth2Client) GetTosUriOk() (*string, bool)`
GetTosUriOk returns a tuple with the TosUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTosUri
`func (o *OAuth2Client) SetTosUri(v string)`
SetTosUri sets TosUri field to given value.
### HasTosUri
`func (o *OAuth2Client) HasTosUri() bool`
HasTosUri returns a boolean if a field has been set.
### GetUpdatedAt
`func (o *OAuth2Client) GetUpdatedAt() time.Time`
GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.
### GetUpdatedAtOk
`func (o *OAuth2Client) GetUpdatedAtOk() (*time.Time, bool)`
GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUpdatedAt
`func (o *OAuth2Client) SetUpdatedAt(v time.Time)`
SetUpdatedAt sets UpdatedAt field to given value.
### HasUpdatedAt
`func (o *OAuth2Client) HasUpdatedAt() bool`
HasUpdatedAt returns a boolean if a field has been set.
### GetUserinfoSignedResponseAlg
`func (o *OAuth2Client) GetUserinfoSignedResponseAlg() string`
GetUserinfoSignedResponseAlg returns the UserinfoSignedResponseAlg field if non-nil, zero value otherwise.
### GetUserinfoSignedResponseAlgOk
`func (o *OAuth2Client) GetUserinfoSignedResponseAlgOk() (*string, bool)`
GetUserinfoSignedResponseAlgOk returns a tuple with the UserinfoSignedResponseAlg field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUserinfoSignedResponseAlg
`func (o *OAuth2Client) SetUserinfoSignedResponseAlg(v string)`
SetUserinfoSignedResponseAlg sets UserinfoSignedResponseAlg field to given value.
### HasUserinfoSignedResponseAlg
`func (o *OAuth2Client) HasUserinfoSignedResponseAlg() bool`
HasUserinfoSignedResponseAlg returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2ClientTokenLifespans.md | # OAuth2ClientTokenLifespans
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AuthorizationCodeGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**AuthorizationCodeGrantIdTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**AuthorizationCodeGrantRefreshTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**ClientCredentialsGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**ImplicitGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**ImplicitGrantIdTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**JwtBearerGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**RefreshTokenGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**RefreshTokenGrantIdTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
**RefreshTokenGrantRefreshTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]
## Methods
### NewOAuth2ClientTokenLifespans
`func NewOAuth2ClientTokenLifespans() *OAuth2ClientTokenLifespans`
NewOAuth2ClientTokenLifespans instantiates a new OAuth2ClientTokenLifespans 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
### NewOAuth2ClientTokenLifespansWithDefaults
`func NewOAuth2ClientTokenLifespansWithDefaults() *OAuth2ClientTokenLifespans`
NewOAuth2ClientTokenLifespansWithDefaults instantiates a new OAuth2ClientTokenLifespans 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
### GetAuthorizationCodeGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetAuthorizationCodeGrantAccessTokenLifespan() string`
GetAuthorizationCodeGrantAccessTokenLifespan returns the AuthorizationCodeGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetAuthorizationCodeGrantAccessTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetAuthorizationCodeGrantAccessTokenLifespanOk() (*string, bool)`
GetAuthorizationCodeGrantAccessTokenLifespanOk returns a tuple with the AuthorizationCodeGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAuthorizationCodeGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetAuthorizationCodeGrantAccessTokenLifespan(v string)`
SetAuthorizationCodeGrantAccessTokenLifespan sets AuthorizationCodeGrantAccessTokenLifespan field to given value.
### HasAuthorizationCodeGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasAuthorizationCodeGrantAccessTokenLifespan() bool`
HasAuthorizationCodeGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetAuthorizationCodeGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetAuthorizationCodeGrantIdTokenLifespan() string`
GetAuthorizationCodeGrantIdTokenLifespan returns the AuthorizationCodeGrantIdTokenLifespan field if non-nil, zero value otherwise.
### GetAuthorizationCodeGrantIdTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetAuthorizationCodeGrantIdTokenLifespanOk() (*string, bool)`
GetAuthorizationCodeGrantIdTokenLifespanOk returns a tuple with the AuthorizationCodeGrantIdTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAuthorizationCodeGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetAuthorizationCodeGrantIdTokenLifespan(v string)`
SetAuthorizationCodeGrantIdTokenLifespan sets AuthorizationCodeGrantIdTokenLifespan field to given value.
### HasAuthorizationCodeGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasAuthorizationCodeGrantIdTokenLifespan() bool`
HasAuthorizationCodeGrantIdTokenLifespan returns a boolean if a field has been set.
### GetAuthorizationCodeGrantRefreshTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetAuthorizationCodeGrantRefreshTokenLifespan() string`
GetAuthorizationCodeGrantRefreshTokenLifespan returns the AuthorizationCodeGrantRefreshTokenLifespan field if non-nil, zero value otherwise.
### GetAuthorizationCodeGrantRefreshTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetAuthorizationCodeGrantRefreshTokenLifespanOk() (*string, bool)`
GetAuthorizationCodeGrantRefreshTokenLifespanOk returns a tuple with the AuthorizationCodeGrantRefreshTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAuthorizationCodeGrantRefreshTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetAuthorizationCodeGrantRefreshTokenLifespan(v string)`
SetAuthorizationCodeGrantRefreshTokenLifespan sets AuthorizationCodeGrantRefreshTokenLifespan field to given value.
### HasAuthorizationCodeGrantRefreshTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasAuthorizationCodeGrantRefreshTokenLifespan() bool`
HasAuthorizationCodeGrantRefreshTokenLifespan returns a boolean if a field has been set.
### GetClientCredentialsGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetClientCredentialsGrantAccessTokenLifespan() string`
GetClientCredentialsGrantAccessTokenLifespan returns the ClientCredentialsGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetClientCredentialsGrantAccessTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetClientCredentialsGrantAccessTokenLifespanOk() (*string, bool)`
GetClientCredentialsGrantAccessTokenLifespanOk returns a tuple with the ClientCredentialsGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClientCredentialsGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetClientCredentialsGrantAccessTokenLifespan(v string)`
SetClientCredentialsGrantAccessTokenLifespan sets ClientCredentialsGrantAccessTokenLifespan field to given value.
### HasClientCredentialsGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasClientCredentialsGrantAccessTokenLifespan() bool`
HasClientCredentialsGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetImplicitGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetImplicitGrantAccessTokenLifespan() string`
GetImplicitGrantAccessTokenLifespan returns the ImplicitGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetImplicitGrantAccessTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetImplicitGrantAccessTokenLifespanOk() (*string, bool)`
GetImplicitGrantAccessTokenLifespanOk returns a tuple with the ImplicitGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetImplicitGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetImplicitGrantAccessTokenLifespan(v string)`
SetImplicitGrantAccessTokenLifespan sets ImplicitGrantAccessTokenLifespan field to given value.
### HasImplicitGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasImplicitGrantAccessTokenLifespan() bool`
HasImplicitGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetImplicitGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetImplicitGrantIdTokenLifespan() string`
GetImplicitGrantIdTokenLifespan returns the ImplicitGrantIdTokenLifespan field if non-nil, zero value otherwise.
### GetImplicitGrantIdTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetImplicitGrantIdTokenLifespanOk() (*string, bool)`
GetImplicitGrantIdTokenLifespanOk returns a tuple with the ImplicitGrantIdTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetImplicitGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetImplicitGrantIdTokenLifespan(v string)`
SetImplicitGrantIdTokenLifespan sets ImplicitGrantIdTokenLifespan field to given value.
### HasImplicitGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasImplicitGrantIdTokenLifespan() bool`
HasImplicitGrantIdTokenLifespan returns a boolean if a field has been set.
### GetJwtBearerGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetJwtBearerGrantAccessTokenLifespan() string`
GetJwtBearerGrantAccessTokenLifespan returns the JwtBearerGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetJwtBearerGrantAccessTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetJwtBearerGrantAccessTokenLifespanOk() (*string, bool)`
GetJwtBearerGrantAccessTokenLifespanOk returns a tuple with the JwtBearerGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetJwtBearerGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetJwtBearerGrantAccessTokenLifespan(v string)`
SetJwtBearerGrantAccessTokenLifespan sets JwtBearerGrantAccessTokenLifespan field to given value.
### HasJwtBearerGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasJwtBearerGrantAccessTokenLifespan() bool`
HasJwtBearerGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetRefreshTokenGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetRefreshTokenGrantAccessTokenLifespan() string`
GetRefreshTokenGrantAccessTokenLifespan returns the RefreshTokenGrantAccessTokenLifespan field if non-nil, zero value otherwise.
### GetRefreshTokenGrantAccessTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetRefreshTokenGrantAccessTokenLifespanOk() (*string, bool)`
GetRefreshTokenGrantAccessTokenLifespanOk returns a tuple with the RefreshTokenGrantAccessTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRefreshTokenGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetRefreshTokenGrantAccessTokenLifespan(v string)`
SetRefreshTokenGrantAccessTokenLifespan sets RefreshTokenGrantAccessTokenLifespan field to given value.
### HasRefreshTokenGrantAccessTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasRefreshTokenGrantAccessTokenLifespan() bool`
HasRefreshTokenGrantAccessTokenLifespan returns a boolean if a field has been set.
### GetRefreshTokenGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetRefreshTokenGrantIdTokenLifespan() string`
GetRefreshTokenGrantIdTokenLifespan returns the RefreshTokenGrantIdTokenLifespan field if non-nil, zero value otherwise.
### GetRefreshTokenGrantIdTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetRefreshTokenGrantIdTokenLifespanOk() (*string, bool)`
GetRefreshTokenGrantIdTokenLifespanOk returns a tuple with the RefreshTokenGrantIdTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRefreshTokenGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetRefreshTokenGrantIdTokenLifespan(v string)`
SetRefreshTokenGrantIdTokenLifespan sets RefreshTokenGrantIdTokenLifespan field to given value.
### HasRefreshTokenGrantIdTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasRefreshTokenGrantIdTokenLifespan() bool`
HasRefreshTokenGrantIdTokenLifespan returns a boolean if a field has been set.
### GetRefreshTokenGrantRefreshTokenLifespan
`func (o *OAuth2ClientTokenLifespans) GetRefreshTokenGrantRefreshTokenLifespan() string`
GetRefreshTokenGrantRefreshTokenLifespan returns the RefreshTokenGrantRefreshTokenLifespan field if non-nil, zero value otherwise.
### GetRefreshTokenGrantRefreshTokenLifespanOk
`func (o *OAuth2ClientTokenLifespans) GetRefreshTokenGrantRefreshTokenLifespanOk() (*string, bool)`
GetRefreshTokenGrantRefreshTokenLifespanOk returns a tuple with the RefreshTokenGrantRefreshTokenLifespan field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRefreshTokenGrantRefreshTokenLifespan
`func (o *OAuth2ClientTokenLifespans) SetRefreshTokenGrantRefreshTokenLifespan(v string)`
SetRefreshTokenGrantRefreshTokenLifespan sets RefreshTokenGrantRefreshTokenLifespan field to given value.
### HasRefreshTokenGrantRefreshTokenLifespan
`func (o *OAuth2ClientTokenLifespans) HasRefreshTokenGrantRefreshTokenLifespan() bool`
HasRefreshTokenGrantRefreshTokenLifespan returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2ConsentRequest.md | # OAuth2ConsentRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Acr** | Pointer to **string** | ACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication. | [optional]
**Amr** | Pointer to **[]string** | | [optional]
**Challenge** | **string** | ID is the identifier (\"authorization challenge\") of the consent authorization request. It is used to identify the session. |
**Client** | Pointer to [**OAuth2Client**](OAuth2Client.md) | | [optional]
**Context** | Pointer to **interface{}** | | [optional]
**LoginChallenge** | Pointer to **string** | LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app. | [optional]
**LoginSessionId** | Pointer to **string** | LoginSessionID 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]
**OidcContext** | Pointer to [**OAuth2ConsentRequestOpenIDConnectContext**](OAuth2ConsentRequestOpenIDConnectContext.md) | | [optional]
**RequestUrl** | Pointer to **string** | RequestURL 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. | [optional]
**RequestedAccessTokenAudience** | Pointer to **[]string** | | [optional]
**RequestedScope** | Pointer to **[]string** | | [optional]
**Skip** | Pointer to **bool** | Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call. | [optional]
**Subject** | Pointer to **string** | Subject 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. | [optional]
## Methods
### NewOAuth2ConsentRequest
`func NewOAuth2ConsentRequest(challenge string, ) *OAuth2ConsentRequest`
NewOAuth2ConsentRequest instantiates a new OAuth2ConsentRequest 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
### NewOAuth2ConsentRequestWithDefaults
`func NewOAuth2ConsentRequestWithDefaults() *OAuth2ConsentRequest`
NewOAuth2ConsentRequestWithDefaults instantiates a new OAuth2ConsentRequest 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
### GetAcr
`func (o *OAuth2ConsentRequest) GetAcr() string`
GetAcr returns the Acr field if non-nil, zero value otherwise.
### GetAcrOk
`func (o *OAuth2ConsentRequest) GetAcrOk() (*string, bool)`
GetAcrOk returns a tuple with the Acr field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAcr
`func (o *OAuth2ConsentRequest) SetAcr(v string)`
SetAcr sets Acr field to given value.
### HasAcr
`func (o *OAuth2ConsentRequest) HasAcr() bool`
HasAcr returns a boolean if a field has been set.
### GetAmr
`func (o *OAuth2ConsentRequest) GetAmr() []string`
GetAmr returns the Amr field if non-nil, zero value otherwise.
### GetAmrOk
`func (o *OAuth2ConsentRequest) GetAmrOk() (*[]string, bool)`
GetAmrOk returns a tuple with the Amr field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAmr
`func (o *OAuth2ConsentRequest) SetAmr(v []string)`
SetAmr sets Amr field to given value.
### HasAmr
`func (o *OAuth2ConsentRequest) HasAmr() bool`
HasAmr returns a boolean if a field has been set.
### GetChallenge
`func (o *OAuth2ConsentRequest) GetChallenge() string`
GetChallenge returns the Challenge field if non-nil, zero value otherwise.
### GetChallengeOk
`func (o *OAuth2ConsentRequest) 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 *OAuth2ConsentRequest) SetChallenge(v string)`
SetChallenge sets Challenge field to given value.
### GetClient
`func (o *OAuth2ConsentRequest) GetClient() OAuth2Client`
GetClient returns the Client field if non-nil, zero value otherwise.
### GetClientOk
`func (o *OAuth2ConsentRequest) 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 *OAuth2ConsentRequest) SetClient(v OAuth2Client)`
SetClient sets Client field to given value.
### HasClient
`func (o *OAuth2ConsentRequest) HasClient() bool`
HasClient returns a boolean if a field has been set.
### GetContext
`func (o *OAuth2ConsentRequest) GetContext() interface{}`
GetContext returns the Context field if non-nil, zero value otherwise.
### GetContextOk
`func (o *OAuth2ConsentRequest) GetContextOk() (*interface{}, bool)`
GetContextOk returns a tuple with the Context field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetContext
`func (o *OAuth2ConsentRequest) SetContext(v interface{})`
SetContext sets Context field to given value.
### HasContext
`func (o *OAuth2ConsentRequest) HasContext() bool`
HasContext returns a boolean if a field has been set.
### SetContextNil
`func (o *OAuth2ConsentRequest) SetContextNil(b bool)`
SetContextNil sets the value for Context to be an explicit nil
### UnsetContext
`func (o *OAuth2ConsentRequest) UnsetContext()`
UnsetContext ensures that no value is present for Context, not even an explicit nil
### GetLoginChallenge
`func (o *OAuth2ConsentRequest) GetLoginChallenge() string`
GetLoginChallenge returns the LoginChallenge field if non-nil, zero value otherwise.
### GetLoginChallengeOk
`func (o *OAuth2ConsentRequest) GetLoginChallengeOk() (*string, bool)`
GetLoginChallengeOk returns a tuple with the LoginChallenge field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetLoginChallenge
`func (o *OAuth2ConsentRequest) SetLoginChallenge(v string)`
SetLoginChallenge sets LoginChallenge field to given value.
### HasLoginChallenge
`func (o *OAuth2ConsentRequest) HasLoginChallenge() bool`
HasLoginChallenge returns a boolean if a field has been set.
### GetLoginSessionId
`func (o *OAuth2ConsentRequest) GetLoginSessionId() string`
GetLoginSessionId returns the LoginSessionId field if non-nil, zero value otherwise.
### GetLoginSessionIdOk
`func (o *OAuth2ConsentRequest) GetLoginSessionIdOk() (*string, bool)`
GetLoginSessionIdOk returns a tuple with the LoginSessionId field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetLoginSessionId
`func (o *OAuth2ConsentRequest) SetLoginSessionId(v string)`
SetLoginSessionId sets LoginSessionId field to given value.
### HasLoginSessionId
`func (o *OAuth2ConsentRequest) HasLoginSessionId() bool`
HasLoginSessionId returns a boolean if a field has been set.
### GetOidcContext
`func (o *OAuth2ConsentRequest) GetOidcContext() OAuth2ConsentRequestOpenIDConnectContext`
GetOidcContext returns the OidcContext field if non-nil, zero value otherwise.
### GetOidcContextOk
`func (o *OAuth2ConsentRequest) 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 *OAuth2ConsentRequest) SetOidcContext(v OAuth2ConsentRequestOpenIDConnectContext)`
SetOidcContext sets OidcContext field to given value.
### HasOidcContext
`func (o *OAuth2ConsentRequest) HasOidcContext() bool`
HasOidcContext returns a boolean if a field has been set.
### GetRequestUrl
`func (o *OAuth2ConsentRequest) GetRequestUrl() string`
GetRequestUrl returns the RequestUrl field if non-nil, zero value otherwise.
### GetRequestUrlOk
`func (o *OAuth2ConsentRequest) 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 *OAuth2ConsentRequest) SetRequestUrl(v string)`
SetRequestUrl sets RequestUrl field to given value.
### HasRequestUrl
`func (o *OAuth2ConsentRequest) HasRequestUrl() bool`
HasRequestUrl returns a boolean if a field has been set.
### GetRequestedAccessTokenAudience
`func (o *OAuth2ConsentRequest) GetRequestedAccessTokenAudience() []string`
GetRequestedAccessTokenAudience returns the RequestedAccessTokenAudience field if non-nil, zero value otherwise.
### GetRequestedAccessTokenAudienceOk
`func (o *OAuth2ConsentRequest) 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 *OAuth2ConsentRequest) SetRequestedAccessTokenAudience(v []string)`
SetRequestedAccessTokenAudience sets RequestedAccessTokenAudience field to given value.
### HasRequestedAccessTokenAudience
`func (o *OAuth2ConsentRequest) HasRequestedAccessTokenAudience() bool`
HasRequestedAccessTokenAudience returns a boolean if a field has been set.
### GetRequestedScope
`func (o *OAuth2ConsentRequest) GetRequestedScope() []string`
GetRequestedScope returns the RequestedScope field if non-nil, zero value otherwise.
### GetRequestedScopeOk
`func (o *OAuth2ConsentRequest) 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 *OAuth2ConsentRequest) SetRequestedScope(v []string)`
SetRequestedScope sets RequestedScope field to given value.
### HasRequestedScope
`func (o *OAuth2ConsentRequest) HasRequestedScope() bool`
HasRequestedScope returns a boolean if a field has been set.
### GetSkip
`func (o *OAuth2ConsentRequest) GetSkip() bool`
GetSkip returns the Skip field if non-nil, zero value otherwise.
### GetSkipOk
`func (o *OAuth2ConsentRequest) 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 *OAuth2ConsentRequest) SetSkip(v bool)`
SetSkip sets Skip field to given value.
### HasSkip
`func (o *OAuth2ConsentRequest) HasSkip() bool`
HasSkip returns a boolean if a field has been set.
### GetSubject
`func (o *OAuth2ConsentRequest) GetSubject() string`
GetSubject returns the Subject field if non-nil, zero value otherwise.
### GetSubjectOk
`func (o *OAuth2ConsentRequest) 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 *OAuth2ConsentRequest) SetSubject(v string)`
SetSubject sets Subject field to given value.
### HasSubject
`func (o *OAuth2ConsentRequest) HasSubject() bool`
HasSubject returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2ConsentRequestOpenIDConnectContext.md | # OAuth2ConsentRequestOpenIDConnectContext
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AcrValues** | Pointer to **[]string** | ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required. OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter. | [optional]
**Display** | Pointer to **string** | Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. The defined values are: page: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. popup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display. The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display. | [optional]
**IdTokenHintClaims** | Pointer to **map[string]interface{}** | IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client. | [optional]
**LoginHint** | Pointer to **string** | LoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone number in the format specified for the phone_number Claim. The use of this parameter is optional. | [optional]
**UiLocales** | Pointer to **[]string** | UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value \"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider. | [optional]
## Methods
### NewOAuth2ConsentRequestOpenIDConnectContext
`func NewOAuth2ConsentRequestOpenIDConnectContext() *OAuth2ConsentRequestOpenIDConnectContext`
NewOAuth2ConsentRequestOpenIDConnectContext instantiates a new OAuth2ConsentRequestOpenIDConnectContext 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
### NewOAuth2ConsentRequestOpenIDConnectContextWithDefaults
`func NewOAuth2ConsentRequestOpenIDConnectContextWithDefaults() *OAuth2ConsentRequestOpenIDConnectContext`
NewOAuth2ConsentRequestOpenIDConnectContextWithDefaults instantiates a new OAuth2ConsentRequestOpenIDConnectContext 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
### GetAcrValues
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetAcrValues() []string`
GetAcrValues returns the AcrValues field if non-nil, zero value otherwise.
### GetAcrValuesOk
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetAcrValuesOk() (*[]string, bool)`
GetAcrValuesOk returns a tuple with the AcrValues field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAcrValues
`func (o *OAuth2ConsentRequestOpenIDConnectContext) SetAcrValues(v []string)`
SetAcrValues sets AcrValues field to given value.
### HasAcrValues
`func (o *OAuth2ConsentRequestOpenIDConnectContext) HasAcrValues() bool`
HasAcrValues returns a boolean if a field has been set.
### GetDisplay
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetDisplay() string`
GetDisplay returns the Display field if non-nil, zero value otherwise.
### GetDisplayOk
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetDisplayOk() (*string, bool)`
GetDisplayOk returns a tuple with the Display field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDisplay
`func (o *OAuth2ConsentRequestOpenIDConnectContext) SetDisplay(v string)`
SetDisplay sets Display field to given value.
### HasDisplay
`func (o *OAuth2ConsentRequestOpenIDConnectContext) HasDisplay() bool`
HasDisplay returns a boolean if a field has been set.
### GetIdTokenHintClaims
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetIdTokenHintClaims() map[string]interface{}`
GetIdTokenHintClaims returns the IdTokenHintClaims field if non-nil, zero value otherwise.
### GetIdTokenHintClaimsOk
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetIdTokenHintClaimsOk() (*map[string]interface{}, bool)`
GetIdTokenHintClaimsOk returns a tuple with the IdTokenHintClaims field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIdTokenHintClaims
`func (o *OAuth2ConsentRequestOpenIDConnectContext) SetIdTokenHintClaims(v map[string]interface{})`
SetIdTokenHintClaims sets IdTokenHintClaims field to given value.
### HasIdTokenHintClaims
`func (o *OAuth2ConsentRequestOpenIDConnectContext) HasIdTokenHintClaims() bool`
HasIdTokenHintClaims returns a boolean if a field has been set.
### GetLoginHint
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetLoginHint() string`
GetLoginHint returns the LoginHint field if non-nil, zero value otherwise.
### GetLoginHintOk
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetLoginHintOk() (*string, bool)`
GetLoginHintOk returns a tuple with the LoginHint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetLoginHint
`func (o *OAuth2ConsentRequestOpenIDConnectContext) SetLoginHint(v string)`
SetLoginHint sets LoginHint field to given value.
### HasLoginHint
`func (o *OAuth2ConsentRequestOpenIDConnectContext) HasLoginHint() bool`
HasLoginHint returns a boolean if a field has been set.
### GetUiLocales
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetUiLocales() []string`
GetUiLocales returns the UiLocales field if non-nil, zero value otherwise.
### GetUiLocalesOk
`func (o *OAuth2ConsentRequestOpenIDConnectContext) GetUiLocalesOk() (*[]string, bool)`
GetUiLocalesOk returns a tuple with the UiLocales field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUiLocales
`func (o *OAuth2ConsentRequestOpenIDConnectContext) SetUiLocales(v []string)`
SetUiLocales sets UiLocales field to given value.
### HasUiLocales
`func (o *OAuth2ConsentRequestOpenIDConnectContext) HasUiLocales() bool`
HasUiLocales returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2ConsentSession.md | # OAuth2ConsentSession
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ConsentRequest** | Pointer to [**OAuth2ConsentRequest**](OAuth2ConsentRequest.md) | | [optional]
**ExpiresAt** | Pointer to [**OAuth2ConsentSessionExpiresAt**](OAuth2ConsentSessionExpiresAt.md) | | [optional]
**GrantAccessTokenAudience** | Pointer to **[]string** | | [optional]
**GrantScope** | Pointer to **[]string** | | [optional]
**HandledAt** | Pointer to **time.Time** | | [optional]
**Remember** | Pointer to **bool** | Remember Consent Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope. | [optional]
**RememberFor** | Pointer to **int64** | Remember Consent For RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. | [optional]
**Session** | Pointer to [**AcceptOAuth2ConsentRequestSession**](AcceptOAuth2ConsentRequestSession.md) | | [optional]
## Methods
### NewOAuth2ConsentSession
`func NewOAuth2ConsentSession() *OAuth2ConsentSession`
NewOAuth2ConsentSession instantiates a new OAuth2ConsentSession 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
### NewOAuth2ConsentSessionWithDefaults
`func NewOAuth2ConsentSessionWithDefaults() *OAuth2ConsentSession`
NewOAuth2ConsentSessionWithDefaults instantiates a new OAuth2ConsentSession 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
### GetConsentRequest
`func (o *OAuth2ConsentSession) GetConsentRequest() OAuth2ConsentRequest`
GetConsentRequest returns the ConsentRequest field if non-nil, zero value otherwise.
### GetConsentRequestOk
`func (o *OAuth2ConsentSession) GetConsentRequestOk() (*OAuth2ConsentRequest, bool)`
GetConsentRequestOk returns a tuple with the ConsentRequest field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetConsentRequest
`func (o *OAuth2ConsentSession) SetConsentRequest(v OAuth2ConsentRequest)`
SetConsentRequest sets ConsentRequest field to given value.
### HasConsentRequest
`func (o *OAuth2ConsentSession) HasConsentRequest() bool`
HasConsentRequest returns a boolean if a field has been set.
### GetExpiresAt
`func (o *OAuth2ConsentSession) GetExpiresAt() OAuth2ConsentSessionExpiresAt`
GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise.
### GetExpiresAtOk
`func (o *OAuth2ConsentSession) GetExpiresAtOk() (*OAuth2ConsentSessionExpiresAt, bool)`
GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetExpiresAt
`func (o *OAuth2ConsentSession) SetExpiresAt(v OAuth2ConsentSessionExpiresAt)`
SetExpiresAt sets ExpiresAt field to given value.
### HasExpiresAt
`func (o *OAuth2ConsentSession) HasExpiresAt() bool`
HasExpiresAt returns a boolean if a field has been set.
### GetGrantAccessTokenAudience
`func (o *OAuth2ConsentSession) GetGrantAccessTokenAudience() []string`
GetGrantAccessTokenAudience returns the GrantAccessTokenAudience field if non-nil, zero value otherwise.
### GetGrantAccessTokenAudienceOk
`func (o *OAuth2ConsentSession) GetGrantAccessTokenAudienceOk() (*[]string, bool)`
GetGrantAccessTokenAudienceOk returns a tuple with the GrantAccessTokenAudience field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetGrantAccessTokenAudience
`func (o *OAuth2ConsentSession) SetGrantAccessTokenAudience(v []string)`
SetGrantAccessTokenAudience sets GrantAccessTokenAudience field to given value.
### HasGrantAccessTokenAudience
`func (o *OAuth2ConsentSession) HasGrantAccessTokenAudience() bool`
HasGrantAccessTokenAudience returns a boolean if a field has been set.
### GetGrantScope
`func (o *OAuth2ConsentSession) GetGrantScope() []string`
GetGrantScope returns the GrantScope field if non-nil, zero value otherwise.
### GetGrantScopeOk
`func (o *OAuth2ConsentSession) GetGrantScopeOk() (*[]string, bool)`
GetGrantScopeOk returns a tuple with the GrantScope field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetGrantScope
`func (o *OAuth2ConsentSession) SetGrantScope(v []string)`
SetGrantScope sets GrantScope field to given value.
### HasGrantScope
`func (o *OAuth2ConsentSession) HasGrantScope() bool`
HasGrantScope returns a boolean if a field has been set.
### GetHandledAt
`func (o *OAuth2ConsentSession) GetHandledAt() time.Time`
GetHandledAt returns the HandledAt field if non-nil, zero value otherwise.
### GetHandledAtOk
`func (o *OAuth2ConsentSession) GetHandledAtOk() (*time.Time, bool)`
GetHandledAtOk returns a tuple with the HandledAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetHandledAt
`func (o *OAuth2ConsentSession) SetHandledAt(v time.Time)`
SetHandledAt sets HandledAt field to given value.
### HasHandledAt
`func (o *OAuth2ConsentSession) HasHandledAt() bool`
HasHandledAt returns a boolean if a field has been set.
### GetRemember
`func (o *OAuth2ConsentSession) GetRemember() bool`
GetRemember returns the Remember field if non-nil, zero value otherwise.
### GetRememberOk
`func (o *OAuth2ConsentSession) GetRememberOk() (*bool, bool)`
GetRememberOk returns a tuple with the Remember field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRemember
`func (o *OAuth2ConsentSession) SetRemember(v bool)`
SetRemember sets Remember field to given value.
### HasRemember
`func (o *OAuth2ConsentSession) HasRemember() bool`
HasRemember returns a boolean if a field has been set.
### GetRememberFor
`func (o *OAuth2ConsentSession) GetRememberFor() int64`
GetRememberFor returns the RememberFor field if non-nil, zero value otherwise.
### GetRememberForOk
`func (o *OAuth2ConsentSession) GetRememberForOk() (*int64, bool)`
GetRememberForOk returns a tuple with the RememberFor field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRememberFor
`func (o *OAuth2ConsentSession) SetRememberFor(v int64)`
SetRememberFor sets RememberFor field to given value.
### HasRememberFor
`func (o *OAuth2ConsentSession) HasRememberFor() bool`
HasRememberFor returns a boolean if a field has been set.
### GetSession
`func (o *OAuth2ConsentSession) GetSession() AcceptOAuth2ConsentRequestSession`
GetSession returns the Session field if non-nil, zero value otherwise.
### GetSessionOk
`func (o *OAuth2ConsentSession) GetSessionOk() (*AcceptOAuth2ConsentRequestSession, bool)`
GetSessionOk returns a tuple with the Session field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSession
`func (o *OAuth2ConsentSession) SetSession(v AcceptOAuth2ConsentRequestSession)`
SetSession sets Session field to given value.
### HasSession
`func (o *OAuth2ConsentSession) HasSession() bool`
HasSession returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2ConsentSessionExpiresAt.md | # OAuth2ConsentSessionExpiresAt
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessToken** | Pointer to **time.Time** | | [optional]
**AuthorizeCode** | Pointer to **time.Time** | | [optional]
**IdToken** | Pointer to **time.Time** | | [optional]
**ParContext** | Pointer to **time.Time** | | [optional]
**RefreshToken** | Pointer to **time.Time** | | [optional]
## Methods
### NewOAuth2ConsentSessionExpiresAt
`func NewOAuth2ConsentSessionExpiresAt() *OAuth2ConsentSessionExpiresAt`
NewOAuth2ConsentSessionExpiresAt instantiates a new OAuth2ConsentSessionExpiresAt 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
### NewOAuth2ConsentSessionExpiresAtWithDefaults
`func NewOAuth2ConsentSessionExpiresAtWithDefaults() *OAuth2ConsentSessionExpiresAt`
NewOAuth2ConsentSessionExpiresAtWithDefaults instantiates a new OAuth2ConsentSessionExpiresAt 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
### GetAccessToken
`func (o *OAuth2ConsentSessionExpiresAt) GetAccessToken() time.Time`
GetAccessToken returns the AccessToken field if non-nil, zero value otherwise.
### GetAccessTokenOk
`func (o *OAuth2ConsentSessionExpiresAt) GetAccessTokenOk() (*time.Time, bool)`
GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAccessToken
`func (o *OAuth2ConsentSessionExpiresAt) SetAccessToken(v time.Time)`
SetAccessToken sets AccessToken field to given value.
### HasAccessToken
`func (o *OAuth2ConsentSessionExpiresAt) HasAccessToken() bool`
HasAccessToken returns a boolean if a field has been set.
### GetAuthorizeCode
`func (o *OAuth2ConsentSessionExpiresAt) GetAuthorizeCode() time.Time`
GetAuthorizeCode returns the AuthorizeCode field if non-nil, zero value otherwise.
### GetAuthorizeCodeOk
`func (o *OAuth2ConsentSessionExpiresAt) GetAuthorizeCodeOk() (*time.Time, bool)`
GetAuthorizeCodeOk returns a tuple with the AuthorizeCode field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAuthorizeCode
`func (o *OAuth2ConsentSessionExpiresAt) SetAuthorizeCode(v time.Time)`
SetAuthorizeCode sets AuthorizeCode field to given value.
### HasAuthorizeCode
`func (o *OAuth2ConsentSessionExpiresAt) HasAuthorizeCode() bool`
HasAuthorizeCode returns a boolean if a field has been set.
### GetIdToken
`func (o *OAuth2ConsentSessionExpiresAt) GetIdToken() time.Time`
GetIdToken returns the IdToken field if non-nil, zero value otherwise.
### GetIdTokenOk
`func (o *OAuth2ConsentSessionExpiresAt) GetIdTokenOk() (*time.Time, bool)`
GetIdTokenOk returns a tuple with the IdToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIdToken
`func (o *OAuth2ConsentSessionExpiresAt) SetIdToken(v time.Time)`
SetIdToken sets IdToken field to given value.
### HasIdToken
`func (o *OAuth2ConsentSessionExpiresAt) HasIdToken() bool`
HasIdToken returns a boolean if a field has been set.
### GetParContext
`func (o *OAuth2ConsentSessionExpiresAt) GetParContext() time.Time`
GetParContext returns the ParContext field if non-nil, zero value otherwise.
### GetParContextOk
`func (o *OAuth2ConsentSessionExpiresAt) GetParContextOk() (*time.Time, bool)`
GetParContextOk returns a tuple with the ParContext field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetParContext
`func (o *OAuth2ConsentSessionExpiresAt) SetParContext(v time.Time)`
SetParContext sets ParContext field to given value.
### HasParContext
`func (o *OAuth2ConsentSessionExpiresAt) HasParContext() bool`
HasParContext returns a boolean if a field has been set.
### GetRefreshToken
`func (o *OAuth2ConsentSessionExpiresAt) GetRefreshToken() time.Time`
GetRefreshToken returns the RefreshToken field if non-nil, zero value otherwise.
### GetRefreshTokenOk
`func (o *OAuth2ConsentSessionExpiresAt) GetRefreshTokenOk() (*time.Time, bool)`
GetRefreshTokenOk returns a tuple with the RefreshToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRefreshToken
`func (o *OAuth2ConsentSessionExpiresAt) SetRefreshToken(v time.Time)`
SetRefreshToken sets RefreshToken field to given value.
### HasRefreshToken
`func (o *OAuth2ConsentSessionExpiresAt) HasRefreshToken() bool`
HasRefreshToken returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2LoginRequest.md | # OAuth2LoginRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Challenge** | **string** | ID is the identifier (\"login challenge\") of the login request. It is used to identify the session. |
**Client** | [**OAuth2Client**](OAuth2Client.md) | |
**OidcContext** | Pointer to [**OAuth2ConsentRequestOpenIDConnectContext**](OAuth2ConsentRequestOpenIDConnectContext.md) | | [optional]
**RequestUrl** | **string** | RequestURL 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. |
**RequestedAccessTokenAudience** | **[]string** | |
**RequestedScope** | **[]string** | |
**SessionId** | Pointer to **string** | SessionID 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]
**Skip** | **bool** | Skip, 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. |
**Subject** | **string** | Subject 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, requestedAccessTokenAudience []string, requestedScope []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.
### 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.
### 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]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2LogoutRequest.md | # OAuth2LogoutRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Challenge** | Pointer to **string** | Challenge is the identifier (\"logout challenge\") of the logout authentication request. It is used to identify the session. | [optional]
**Client** | Pointer to [**OAuth2Client**](OAuth2Client.md) | | [optional]
**RequestUrl** | Pointer to **string** | RequestURL is the original Logout URL requested. | [optional]
**RpInitiated** | Pointer to **bool** | RPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client. | [optional]
**Sid** | Pointer to **string** | SessionID is the login session ID that was requested to log out. | [optional]
**Subject** | Pointer to **string** | Subject is the user for whom the logout was request. | [optional]
## Methods
### NewOAuth2LogoutRequest
`func NewOAuth2LogoutRequest() *OAuth2LogoutRequest`
NewOAuth2LogoutRequest instantiates a new OAuth2LogoutRequest 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
### NewOAuth2LogoutRequestWithDefaults
`func NewOAuth2LogoutRequestWithDefaults() *OAuth2LogoutRequest`
NewOAuth2LogoutRequestWithDefaults instantiates a new OAuth2LogoutRequest 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 *OAuth2LogoutRequest) GetChallenge() string`
GetChallenge returns the Challenge field if non-nil, zero value otherwise.
### GetChallengeOk
`func (o *OAuth2LogoutRequest) 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 *OAuth2LogoutRequest) SetChallenge(v string)`
SetChallenge sets Challenge field to given value.
### HasChallenge
`func (o *OAuth2LogoutRequest) HasChallenge() bool`
HasChallenge returns a boolean if a field has been set.
### GetClient
`func (o *OAuth2LogoutRequest) GetClient() OAuth2Client`
GetClient returns the Client field if non-nil, zero value otherwise.
### GetClientOk
`func (o *OAuth2LogoutRequest) 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 *OAuth2LogoutRequest) SetClient(v OAuth2Client)`
SetClient sets Client field to given value.
### HasClient
`func (o *OAuth2LogoutRequest) HasClient() bool`
HasClient returns a boolean if a field has been set.
### GetRequestUrl
`func (o *OAuth2LogoutRequest) GetRequestUrl() string`
GetRequestUrl returns the RequestUrl field if non-nil, zero value otherwise.
### GetRequestUrlOk
`func (o *OAuth2LogoutRequest) 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 *OAuth2LogoutRequest) SetRequestUrl(v string)`
SetRequestUrl sets RequestUrl field to given value.
### HasRequestUrl
`func (o *OAuth2LogoutRequest) HasRequestUrl() bool`
HasRequestUrl returns a boolean if a field has been set.
### GetRpInitiated
`func (o *OAuth2LogoutRequest) GetRpInitiated() bool`
GetRpInitiated returns the RpInitiated field if non-nil, zero value otherwise.
### GetRpInitiatedOk
`func (o *OAuth2LogoutRequest) GetRpInitiatedOk() (*bool, bool)`
GetRpInitiatedOk returns a tuple with the RpInitiated field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRpInitiated
`func (o *OAuth2LogoutRequest) SetRpInitiated(v bool)`
SetRpInitiated sets RpInitiated field to given value.
### HasRpInitiated
`func (o *OAuth2LogoutRequest) HasRpInitiated() bool`
HasRpInitiated returns a boolean if a field has been set.
### GetSid
`func (o *OAuth2LogoutRequest) GetSid() string`
GetSid returns the Sid field if non-nil, zero value otherwise.
### GetSidOk
`func (o *OAuth2LogoutRequest) GetSidOk() (*string, bool)`
GetSidOk returns a tuple with the Sid field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSid
`func (o *OAuth2LogoutRequest) SetSid(v string)`
SetSid sets Sid field to given value.
### HasSid
`func (o *OAuth2LogoutRequest) HasSid() bool`
HasSid returns a boolean if a field has been set.
### GetSubject
`func (o *OAuth2LogoutRequest) GetSubject() string`
GetSubject returns the Subject field if non-nil, zero value otherwise.
### GetSubjectOk
`func (o *OAuth2LogoutRequest) 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 *OAuth2LogoutRequest) SetSubject(v string)`
SetSubject sets Subject field to given value.
### HasSubject
`func (o *OAuth2LogoutRequest) HasSubject() bool`
HasSubject returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2RedirectTo.md | # OAuth2RedirectTo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RedirectTo** | **string** | RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed. |
## Methods
### NewOAuth2RedirectTo
`func NewOAuth2RedirectTo(redirectTo string, ) *OAuth2RedirectTo`
NewOAuth2RedirectTo instantiates a new OAuth2RedirectTo 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
### NewOAuth2RedirectToWithDefaults
`func NewOAuth2RedirectToWithDefaults() *OAuth2RedirectTo`
NewOAuth2RedirectToWithDefaults instantiates a new OAuth2RedirectTo 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
### GetRedirectTo
`func (o *OAuth2RedirectTo) GetRedirectTo() string`
GetRedirectTo returns the RedirectTo field if non-nil, zero value otherwise.
### GetRedirectToOk
`func (o *OAuth2RedirectTo) GetRedirectToOk() (*string, bool)`
GetRedirectToOk returns a tuple with the RedirectTo field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRedirectTo
`func (o *OAuth2RedirectTo) SetRedirectTo(v string)`
SetRedirectTo sets RedirectTo field to given value.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OAuth2TokenExchange.md | # OAuth2TokenExchange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessToken** | Pointer to **string** | The access token issued by the authorization server. | [optional]
**ExpiresIn** | Pointer to **int64** | The lifetime in seconds of the access token. For example, the value \"3600\" denotes that the access token will expire in one hour from the time the response was generated. | [optional]
**IdToken** | Pointer to **int64** | To retrieve a refresh token request the id_token scope. | [optional]
**RefreshToken** | Pointer to **string** | The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope \"offline\" to your access token request. | [optional]
**Scope** | Pointer to **string** | The scope of the access token | [optional]
**TokenType** | Pointer to **string** | The type of the token issued | [optional]
## Methods
### NewOAuth2TokenExchange
`func NewOAuth2TokenExchange() *OAuth2TokenExchange`
NewOAuth2TokenExchange instantiates a new OAuth2TokenExchange 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
### NewOAuth2TokenExchangeWithDefaults
`func NewOAuth2TokenExchangeWithDefaults() *OAuth2TokenExchange`
NewOAuth2TokenExchangeWithDefaults instantiates a new OAuth2TokenExchange 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
### GetAccessToken
`func (o *OAuth2TokenExchange) GetAccessToken() string`
GetAccessToken returns the AccessToken field if non-nil, zero value otherwise.
### GetAccessTokenOk
`func (o *OAuth2TokenExchange) GetAccessTokenOk() (*string, bool)`
GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAccessToken
`func (o *OAuth2TokenExchange) SetAccessToken(v string)`
SetAccessToken sets AccessToken field to given value.
### HasAccessToken
`func (o *OAuth2TokenExchange) HasAccessToken() bool`
HasAccessToken returns a boolean if a field has been set.
### GetExpiresIn
`func (o *OAuth2TokenExchange) GetExpiresIn() int64`
GetExpiresIn returns the ExpiresIn field if non-nil, zero value otherwise.
### GetExpiresInOk
`func (o *OAuth2TokenExchange) GetExpiresInOk() (*int64, bool)`
GetExpiresInOk returns a tuple with the ExpiresIn field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetExpiresIn
`func (o *OAuth2TokenExchange) SetExpiresIn(v int64)`
SetExpiresIn sets ExpiresIn field to given value.
### HasExpiresIn
`func (o *OAuth2TokenExchange) HasExpiresIn() bool`
HasExpiresIn returns a boolean if a field has been set.
### GetIdToken
`func (o *OAuth2TokenExchange) GetIdToken() int64`
GetIdToken returns the IdToken field if non-nil, zero value otherwise.
### GetIdTokenOk
`func (o *OAuth2TokenExchange) GetIdTokenOk() (*int64, bool)`
GetIdTokenOk returns a tuple with the IdToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIdToken
`func (o *OAuth2TokenExchange) SetIdToken(v int64)`
SetIdToken sets IdToken field to given value.
### HasIdToken
`func (o *OAuth2TokenExchange) HasIdToken() bool`
HasIdToken returns a boolean if a field has been set.
### GetRefreshToken
`func (o *OAuth2TokenExchange) GetRefreshToken() string`
GetRefreshToken returns the RefreshToken field if non-nil, zero value otherwise.
### GetRefreshTokenOk
`func (o *OAuth2TokenExchange) GetRefreshTokenOk() (*string, bool)`
GetRefreshTokenOk returns a tuple with the RefreshToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRefreshToken
`func (o *OAuth2TokenExchange) SetRefreshToken(v string)`
SetRefreshToken sets RefreshToken field to given value.
### HasRefreshToken
`func (o *OAuth2TokenExchange) HasRefreshToken() bool`
HasRefreshToken returns a boolean if a field has been set.
### GetScope
`func (o *OAuth2TokenExchange) GetScope() string`
GetScope returns the Scope field if non-nil, zero value otherwise.
### GetScopeOk
`func (o *OAuth2TokenExchange) GetScopeOk() (*string, bool)`
GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetScope
`func (o *OAuth2TokenExchange) SetScope(v string)`
SetScope sets Scope field to given value.
### HasScope
`func (o *OAuth2TokenExchange) HasScope() bool`
HasScope returns a boolean if a field has been set.
### GetTokenType
`func (o *OAuth2TokenExchange) GetTokenType() string`
GetTokenType returns the TokenType field if non-nil, zero value otherwise.
### GetTokenTypeOk
`func (o *OAuth2TokenExchange) GetTokenTypeOk() (*string, bool)`
GetTokenTypeOk returns a tuple with the TokenType field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTokenType
`func (o *OAuth2TokenExchange) SetTokenType(v string)`
SetTokenType sets TokenType field to given value.
### HasTokenType
`func (o *OAuth2TokenExchange) HasTokenType() bool`
HasTokenType returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OidcApi.md | # \OidcApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**CreateOidcDynamicClient**](OidcApi.md#CreateOidcDynamicClient) | **Post** /oauth2/register | Register OAuth2 Client using OpenID Dynamic Client Registration
[**CreateVerifiableCredential**](OidcApi.md#CreateVerifiableCredential) | **Post** /credentials | Issues a Verifiable Credential
[**DeleteOidcDynamicClient**](OidcApi.md#DeleteOidcDynamicClient) | **Delete** /oauth2/register/{id} | Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
[**DiscoverOidcConfiguration**](OidcApi.md#DiscoverOidcConfiguration) | **Get** /.well-known/openid-configuration | OpenID Connect Discovery
[**GetOidcDynamicClient**](OidcApi.md#GetOidcDynamicClient) | **Get** /oauth2/register/{id} | Get OAuth2 Client using OpenID Dynamic Client Registration
[**GetOidcUserInfo**](OidcApi.md#GetOidcUserInfo) | **Get** /userinfo | OpenID Connect Userinfo
[**RevokeOidcSession**](OidcApi.md#RevokeOidcSession) | **Get** /oauth2/sessions/logout | OpenID Connect Front- and Back-channel Enabled Logout
[**SetOidcDynamicClient**](OidcApi.md#SetOidcDynamicClient) | **Put** /oauth2/register/{id} | Set OAuth2 Client using OpenID Dynamic Client Registration
## CreateOidcDynamicClient
> OAuth2Client CreateOidcDynamicClient(ctx).OAuth2Client(oAuth2Client).Execute()
Register OAuth2 Client using OpenID Dynamic Client Registration
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
oAuth2Client := *openapiclient.NewOAuth2Client() // OAuth2Client | Dynamic Client Registration Request Body
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OidcApi.CreateOidcDynamicClient(context.Background()).OAuth2Client(oAuth2Client).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OidcApi.CreateOidcDynamicClient``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateOidcDynamicClient`: OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OidcApi.CreateOidcDynamicClient`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiCreateOidcDynamicClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**oAuth2Client** | [**OAuth2Client**](OAuth2Client.md) | Dynamic Client Registration Request Body |
### Return type
[**OAuth2Client**](OAuth2Client.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## CreateVerifiableCredential
> VerifiableCredentialResponse CreateVerifiableCredential(ctx).CreateVerifiableCredentialRequestBody(createVerifiableCredentialRequestBody).Execute()
Issues a Verifiable Credential
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
createVerifiableCredentialRequestBody := *openapiclient.NewCreateVerifiableCredentialRequestBody() // CreateVerifiableCredentialRequestBody | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OidcApi.CreateVerifiableCredential(context.Background()).CreateVerifiableCredentialRequestBody(createVerifiableCredentialRequestBody).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OidcApi.CreateVerifiableCredential``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateVerifiableCredential`: VerifiableCredentialResponse
fmt.Fprintf(os.Stdout, "Response from `OidcApi.CreateVerifiableCredential`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiCreateVerifiableCredentialRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**createVerifiableCredentialRequestBody** | [**CreateVerifiableCredentialRequestBody**](CreateVerifiableCredentialRequestBody.md) | |
### Return type
[**VerifiableCredentialResponse**](VerifiableCredentialResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## DeleteOidcDynamicClient
> DeleteOidcDynamicClient(ctx, id).Execute()
Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The id of the OAuth 2.0 Client.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OidcApi.DeleteOidcDynamicClient(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OidcApi.DeleteOidcDynamicClient``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | The id of the OAuth 2.0 Client. |
### Other Parameters
Other parameters are passed through a pointer to a apiDeleteOidcDynamicClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
(empty response body)
### Authorization
[bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## DiscoverOidcConfiguration
> OidcConfiguration DiscoverOidcConfiguration(ctx).Execute()
OpenID Connect Discovery
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OidcApi.DiscoverOidcConfiguration(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OidcApi.DiscoverOidcConfiguration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DiscoverOidcConfiguration`: OidcConfiguration
fmt.Fprintf(os.Stdout, "Response from `OidcApi.DiscoverOidcConfiguration`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiDiscoverOidcConfigurationRequest struct via the builder pattern
### Return type
[**OidcConfiguration**](OidcConfiguration.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetOidcDynamicClient
> OAuth2Client GetOidcDynamicClient(ctx, id).Execute()
Get OAuth2 Client using OpenID Dynamic Client Registration
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The id of the OAuth 2.0 Client.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OidcApi.GetOidcDynamicClient(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OidcApi.GetOidcDynamicClient``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOidcDynamicClient`: OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OidcApi.GetOidcDynamicClient`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | The id of the OAuth 2.0 Client. |
### Other Parameters
Other parameters are passed through a pointer to a apiGetOidcDynamicClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
[**OAuth2Client**](OAuth2Client.md)
### Authorization
[bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetOidcUserInfo
> OidcUserInfo GetOidcUserInfo(ctx).Execute()
OpenID Connect Userinfo
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OidcApi.GetOidcUserInfo(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OidcApi.GetOidcUserInfo``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOidcUserInfo`: OidcUserInfo
fmt.Fprintf(os.Stdout, "Response from `OidcApi.GetOidcUserInfo`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiGetOidcUserInfoRequest struct via the builder pattern
### Return type
[**OidcUserInfo**](OidcUserInfo.md)
### Authorization
[oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## RevokeOidcSession
> RevokeOidcSession(ctx).Execute()
OpenID Connect Front- and Back-channel Enabled Logout
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OidcApi.RevokeOidcSession(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OidcApi.RevokeOidcSession``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiRevokeOidcSessionRequest struct via the builder pattern
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## SetOidcDynamicClient
> OAuth2Client SetOidcDynamicClient(ctx, id).OAuth2Client(oAuth2Client).Execute()
Set OAuth2 Client using OpenID Dynamic Client Registration
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | OAuth 2.0 Client ID
oAuth2Client := *openapiclient.NewOAuth2Client() // OAuth2Client | OAuth 2.0 Client Request Body
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OidcApi.SetOidcDynamicClient(context.Background(), id).OAuth2Client(oAuth2Client).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OidcApi.SetOidcDynamicClient``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SetOidcDynamicClient`: OAuth2Client
fmt.Fprintf(os.Stdout, "Response from `OidcApi.SetOidcDynamicClient`: %v\n", resp)
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**id** | **string** | OAuth 2.0 Client ID |
### Other Parameters
Other parameters are passed through a pointer to a apiSetOidcDynamicClientRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**oAuth2Client** | [**OAuth2Client**](OAuth2Client.md) | OAuth 2.0 Client Request Body |
### Return type
[**OAuth2Client**](OAuth2Client.md)
### Authorization
[bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OidcConfiguration.md | # OidcConfiguration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AuthorizationEndpoint** | **string** | OAuth 2.0 Authorization Endpoint URL |
**BackchannelLogoutSessionSupported** | Pointer to **bool** | OpenID Connect Back-Channel Logout Session Required Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP | [optional]
**BackchannelLogoutSupported** | Pointer to **bool** | OpenID Connect Back-Channel Logout Supported Boolean value specifying whether the OP supports back-channel logout, with true indicating support. | [optional]
**ClaimsParameterSupported** | Pointer to **bool** | OpenID Connect Claims Parameter Parameter Supported Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. | [optional]
**ClaimsSupported** | Pointer to **[]string** | OpenID Connect Supported Claims JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. | [optional]
**CodeChallengeMethodsSupported** | Pointer to **[]string** | OAuth 2.0 PKCE Supported Code Challenge Methods JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server. | [optional]
**CredentialsEndpointDraft00** | Pointer to **string** | OpenID Connect Verifiable Credentials Endpoint Contains the URL of the Verifiable Credentials Endpoint. | [optional]
**CredentialsSupportedDraft00** | Pointer to [**[]CredentialSupportedDraft00**](CredentialSupportedDraft00.md) | OpenID Connect Verifiable Credentials Supported JSON array containing a list of the Verifiable Credentials supported by this authorization server. | [optional]
**EndSessionEndpoint** | Pointer to **string** | OpenID Connect End-Session Endpoint URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP. | [optional]
**FrontchannelLogoutSessionSupported** | Pointer to **bool** | OpenID Connect Front-Channel Logout Session Required Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP. | [optional]
**FrontchannelLogoutSupported** | Pointer to **bool** | OpenID Connect Front-Channel Logout Supported Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support. | [optional]
**GrantTypesSupported** | Pointer to **[]string** | OAuth 2.0 Supported Grant Types JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. | [optional]
**IdTokenSignedResponseAlg** | **[]string** | OpenID Connect Default ID Token Signing Algorithms Algorithm used to sign OpenID Connect ID Tokens. |
**IdTokenSigningAlgValuesSupported** | **[]string** | OpenID Connect Supported ID Token Signing Algorithms JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT. |
**Issuer** | **string** | OpenID Connect Issuer URL An URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL. |
**JwksUri** | **string** | OpenID Connect Well-Known JSON Web Keys URL URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. |
**RegistrationEndpoint** | Pointer to **string** | OpenID Connect Dynamic Client Registration Endpoint URL | [optional]
**RequestObjectSigningAlgValuesSupported** | Pointer to **[]string** | OpenID Connect Supported Request Object Signing Algorithms JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter). | [optional]
**RequestParameterSupported** | Pointer to **bool** | OpenID Connect Request Parameter Supported Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. | [optional]
**RequestUriParameterSupported** | Pointer to **bool** | OpenID Connect Request URI Parameter Supported Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. | [optional]
**RequireRequestUriRegistration** | Pointer to **bool** | OpenID Connect Requires Request URI Registration Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter. | [optional]
**ResponseModesSupported** | Pointer to **[]string** | OAuth 2.0 Supported Response Modes JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports. | [optional]
**ResponseTypesSupported** | **[]string** | OAuth 2.0 Supported Response Types JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values. |
**RevocationEndpoint** | Pointer to **string** | OAuth 2.0 Token Revocation URL URL of the authorization server's OAuth 2.0 revocation endpoint. | [optional]
**ScopesSupported** | Pointer to **[]string** | OAuth 2.0 Supported Scope Values JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used | [optional]
**SubjectTypesSupported** | **[]string** | OpenID Connect Supported Subject Types JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public. |
**TokenEndpoint** | **string** | OAuth 2.0 Token Endpoint URL |
**TokenEndpointAuthMethodsSupported** | Pointer to **[]string** | OAuth 2.0 Supported Client Authentication Methods JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0 | [optional]
**UserinfoEndpoint** | Pointer to **string** | OpenID Connect Userinfo URL URL of the OP's UserInfo Endpoint. | [optional]
**UserinfoSignedResponseAlg** | **[]string** | OpenID Connect User Userinfo Signing Algorithm Algorithm used to sign OpenID Connect Userinfo Responses. |
**UserinfoSigningAlgValuesSupported** | Pointer to **[]string** | OpenID Connect Supported Userinfo Signing Algorithm JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. | [optional]
## Methods
### NewOidcConfiguration
`func NewOidcConfiguration(authorizationEndpoint string, idTokenSignedResponseAlg []string, idTokenSigningAlgValuesSupported []string, issuer string, jwksUri string, responseTypesSupported []string, subjectTypesSupported []string, tokenEndpoint string, userinfoSignedResponseAlg []string, ) *OidcConfiguration`
NewOidcConfiguration instantiates a new OidcConfiguration 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
### NewOidcConfigurationWithDefaults
`func NewOidcConfigurationWithDefaults() *OidcConfiguration`
NewOidcConfigurationWithDefaults instantiates a new OidcConfiguration 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
### GetAuthorizationEndpoint
`func (o *OidcConfiguration) GetAuthorizationEndpoint() string`
GetAuthorizationEndpoint returns the AuthorizationEndpoint field if non-nil, zero value otherwise.
### GetAuthorizationEndpointOk
`func (o *OidcConfiguration) GetAuthorizationEndpointOk() (*string, bool)`
GetAuthorizationEndpointOk returns a tuple with the AuthorizationEndpoint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAuthorizationEndpoint
`func (o *OidcConfiguration) SetAuthorizationEndpoint(v string)`
SetAuthorizationEndpoint sets AuthorizationEndpoint field to given value.
### GetBackchannelLogoutSessionSupported
`func (o *OidcConfiguration) GetBackchannelLogoutSessionSupported() bool`
GetBackchannelLogoutSessionSupported returns the BackchannelLogoutSessionSupported field if non-nil, zero value otherwise.
### GetBackchannelLogoutSessionSupportedOk
`func (o *OidcConfiguration) GetBackchannelLogoutSessionSupportedOk() (*bool, bool)`
GetBackchannelLogoutSessionSupportedOk returns a tuple with the BackchannelLogoutSessionSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetBackchannelLogoutSessionSupported
`func (o *OidcConfiguration) SetBackchannelLogoutSessionSupported(v bool)`
SetBackchannelLogoutSessionSupported sets BackchannelLogoutSessionSupported field to given value.
### HasBackchannelLogoutSessionSupported
`func (o *OidcConfiguration) HasBackchannelLogoutSessionSupported() bool`
HasBackchannelLogoutSessionSupported returns a boolean if a field has been set.
### GetBackchannelLogoutSupported
`func (o *OidcConfiguration) GetBackchannelLogoutSupported() bool`
GetBackchannelLogoutSupported returns the BackchannelLogoutSupported field if non-nil, zero value otherwise.
### GetBackchannelLogoutSupportedOk
`func (o *OidcConfiguration) GetBackchannelLogoutSupportedOk() (*bool, bool)`
GetBackchannelLogoutSupportedOk returns a tuple with the BackchannelLogoutSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetBackchannelLogoutSupported
`func (o *OidcConfiguration) SetBackchannelLogoutSupported(v bool)`
SetBackchannelLogoutSupported sets BackchannelLogoutSupported field to given value.
### HasBackchannelLogoutSupported
`func (o *OidcConfiguration) HasBackchannelLogoutSupported() bool`
HasBackchannelLogoutSupported returns a boolean if a field has been set.
### GetClaimsParameterSupported
`func (o *OidcConfiguration) GetClaimsParameterSupported() bool`
GetClaimsParameterSupported returns the ClaimsParameterSupported field if non-nil, zero value otherwise.
### GetClaimsParameterSupportedOk
`func (o *OidcConfiguration) GetClaimsParameterSupportedOk() (*bool, bool)`
GetClaimsParameterSupportedOk returns a tuple with the ClaimsParameterSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClaimsParameterSupported
`func (o *OidcConfiguration) SetClaimsParameterSupported(v bool)`
SetClaimsParameterSupported sets ClaimsParameterSupported field to given value.
### HasClaimsParameterSupported
`func (o *OidcConfiguration) HasClaimsParameterSupported() bool`
HasClaimsParameterSupported returns a boolean if a field has been set.
### GetClaimsSupported
`func (o *OidcConfiguration) GetClaimsSupported() []string`
GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise.
### GetClaimsSupportedOk
`func (o *OidcConfiguration) GetClaimsSupportedOk() (*[]string, bool)`
GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetClaimsSupported
`func (o *OidcConfiguration) SetClaimsSupported(v []string)`
SetClaimsSupported sets ClaimsSupported field to given value.
### HasClaimsSupported
`func (o *OidcConfiguration) HasClaimsSupported() bool`
HasClaimsSupported returns a boolean if a field has been set.
### GetCodeChallengeMethodsSupported
`func (o *OidcConfiguration) GetCodeChallengeMethodsSupported() []string`
GetCodeChallengeMethodsSupported returns the CodeChallengeMethodsSupported field if non-nil, zero value otherwise.
### GetCodeChallengeMethodsSupportedOk
`func (o *OidcConfiguration) GetCodeChallengeMethodsSupportedOk() (*[]string, bool)`
GetCodeChallengeMethodsSupportedOk returns a tuple with the CodeChallengeMethodsSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCodeChallengeMethodsSupported
`func (o *OidcConfiguration) SetCodeChallengeMethodsSupported(v []string)`
SetCodeChallengeMethodsSupported sets CodeChallengeMethodsSupported field to given value.
### HasCodeChallengeMethodsSupported
`func (o *OidcConfiguration) HasCodeChallengeMethodsSupported() bool`
HasCodeChallengeMethodsSupported returns a boolean if a field has been set.
### GetCredentialsEndpointDraft00
`func (o *OidcConfiguration) GetCredentialsEndpointDraft00() string`
GetCredentialsEndpointDraft00 returns the CredentialsEndpointDraft00 field if non-nil, zero value otherwise.
### GetCredentialsEndpointDraft00Ok
`func (o *OidcConfiguration) GetCredentialsEndpointDraft00Ok() (*string, bool)`
GetCredentialsEndpointDraft00Ok returns a tuple with the CredentialsEndpointDraft00 field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCredentialsEndpointDraft00
`func (o *OidcConfiguration) SetCredentialsEndpointDraft00(v string)`
SetCredentialsEndpointDraft00 sets CredentialsEndpointDraft00 field to given value.
### HasCredentialsEndpointDraft00
`func (o *OidcConfiguration) HasCredentialsEndpointDraft00() bool`
HasCredentialsEndpointDraft00 returns a boolean if a field has been set.
### GetCredentialsSupportedDraft00
`func (o *OidcConfiguration) GetCredentialsSupportedDraft00() []CredentialSupportedDraft00`
GetCredentialsSupportedDraft00 returns the CredentialsSupportedDraft00 field if non-nil, zero value otherwise.
### GetCredentialsSupportedDraft00Ok
`func (o *OidcConfiguration) GetCredentialsSupportedDraft00Ok() (*[]CredentialSupportedDraft00, bool)`
GetCredentialsSupportedDraft00Ok returns a tuple with the CredentialsSupportedDraft00 field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCredentialsSupportedDraft00
`func (o *OidcConfiguration) SetCredentialsSupportedDraft00(v []CredentialSupportedDraft00)`
SetCredentialsSupportedDraft00 sets CredentialsSupportedDraft00 field to given value.
### HasCredentialsSupportedDraft00
`func (o *OidcConfiguration) HasCredentialsSupportedDraft00() bool`
HasCredentialsSupportedDraft00 returns a boolean if a field has been set.
### GetEndSessionEndpoint
`func (o *OidcConfiguration) GetEndSessionEndpoint() string`
GetEndSessionEndpoint returns the EndSessionEndpoint field if non-nil, zero value otherwise.
### GetEndSessionEndpointOk
`func (o *OidcConfiguration) GetEndSessionEndpointOk() (*string, bool)`
GetEndSessionEndpointOk returns a tuple with the EndSessionEndpoint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetEndSessionEndpoint
`func (o *OidcConfiguration) SetEndSessionEndpoint(v string)`
SetEndSessionEndpoint sets EndSessionEndpoint field to given value.
### HasEndSessionEndpoint
`func (o *OidcConfiguration) HasEndSessionEndpoint() bool`
HasEndSessionEndpoint returns a boolean if a field has been set.
### GetFrontchannelLogoutSessionSupported
`func (o *OidcConfiguration) GetFrontchannelLogoutSessionSupported() bool`
GetFrontchannelLogoutSessionSupported returns the FrontchannelLogoutSessionSupported field if non-nil, zero value otherwise.
### GetFrontchannelLogoutSessionSupportedOk
`func (o *OidcConfiguration) GetFrontchannelLogoutSessionSupportedOk() (*bool, bool)`
GetFrontchannelLogoutSessionSupportedOk returns a tuple with the FrontchannelLogoutSessionSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFrontchannelLogoutSessionSupported
`func (o *OidcConfiguration) SetFrontchannelLogoutSessionSupported(v bool)`
SetFrontchannelLogoutSessionSupported sets FrontchannelLogoutSessionSupported field to given value.
### HasFrontchannelLogoutSessionSupported
`func (o *OidcConfiguration) HasFrontchannelLogoutSessionSupported() bool`
HasFrontchannelLogoutSessionSupported returns a boolean if a field has been set.
### GetFrontchannelLogoutSupported
`func (o *OidcConfiguration) GetFrontchannelLogoutSupported() bool`
GetFrontchannelLogoutSupported returns the FrontchannelLogoutSupported field if non-nil, zero value otherwise.
### GetFrontchannelLogoutSupportedOk
`func (o *OidcConfiguration) GetFrontchannelLogoutSupportedOk() (*bool, bool)`
GetFrontchannelLogoutSupportedOk returns a tuple with the FrontchannelLogoutSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFrontchannelLogoutSupported
`func (o *OidcConfiguration) SetFrontchannelLogoutSupported(v bool)`
SetFrontchannelLogoutSupported sets FrontchannelLogoutSupported field to given value.
### HasFrontchannelLogoutSupported
`func (o *OidcConfiguration) HasFrontchannelLogoutSupported() bool`
HasFrontchannelLogoutSupported returns a boolean if a field has been set.
### GetGrantTypesSupported
`func (o *OidcConfiguration) GetGrantTypesSupported() []string`
GetGrantTypesSupported returns the GrantTypesSupported field if non-nil, zero value otherwise.
### GetGrantTypesSupportedOk
`func (o *OidcConfiguration) GetGrantTypesSupportedOk() (*[]string, bool)`
GetGrantTypesSupportedOk returns a tuple with the GrantTypesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetGrantTypesSupported
`func (o *OidcConfiguration) SetGrantTypesSupported(v []string)`
SetGrantTypesSupported sets GrantTypesSupported field to given value.
### HasGrantTypesSupported
`func (o *OidcConfiguration) HasGrantTypesSupported() bool`
HasGrantTypesSupported returns a boolean if a field has been set.
### GetIdTokenSignedResponseAlg
`func (o *OidcConfiguration) GetIdTokenSignedResponseAlg() []string`
GetIdTokenSignedResponseAlg returns the IdTokenSignedResponseAlg field if non-nil, zero value otherwise.
### GetIdTokenSignedResponseAlgOk
`func (o *OidcConfiguration) GetIdTokenSignedResponseAlgOk() (*[]string, bool)`
GetIdTokenSignedResponseAlgOk returns a tuple with the IdTokenSignedResponseAlg field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIdTokenSignedResponseAlg
`func (o *OidcConfiguration) SetIdTokenSignedResponseAlg(v []string)`
SetIdTokenSignedResponseAlg sets IdTokenSignedResponseAlg field to given value.
### GetIdTokenSigningAlgValuesSupported
`func (o *OidcConfiguration) GetIdTokenSigningAlgValuesSupported() []string`
GetIdTokenSigningAlgValuesSupported returns the IdTokenSigningAlgValuesSupported field if non-nil, zero value otherwise.
### GetIdTokenSigningAlgValuesSupportedOk
`func (o *OidcConfiguration) GetIdTokenSigningAlgValuesSupportedOk() (*[]string, bool)`
GetIdTokenSigningAlgValuesSupportedOk returns a tuple with the IdTokenSigningAlgValuesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIdTokenSigningAlgValuesSupported
`func (o *OidcConfiguration) SetIdTokenSigningAlgValuesSupported(v []string)`
SetIdTokenSigningAlgValuesSupported sets IdTokenSigningAlgValuesSupported field to given value.
### GetIssuer
`func (o *OidcConfiguration) GetIssuer() string`
GetIssuer returns the Issuer field if non-nil, zero value otherwise.
### GetIssuerOk
`func (o *OidcConfiguration) GetIssuerOk() (*string, bool)`
GetIssuerOk returns a tuple with the Issuer field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIssuer
`func (o *OidcConfiguration) SetIssuer(v string)`
SetIssuer sets Issuer field to given value.
### GetJwksUri
`func (o *OidcConfiguration) GetJwksUri() string`
GetJwksUri returns the JwksUri field if non-nil, zero value otherwise.
### GetJwksUriOk
`func (o *OidcConfiguration) GetJwksUriOk() (*string, bool)`
GetJwksUriOk returns a tuple with the JwksUri field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetJwksUri
`func (o *OidcConfiguration) SetJwksUri(v string)`
SetJwksUri sets JwksUri field to given value.
### GetRegistrationEndpoint
`func (o *OidcConfiguration) GetRegistrationEndpoint() string`
GetRegistrationEndpoint returns the RegistrationEndpoint field if non-nil, zero value otherwise.
### GetRegistrationEndpointOk
`func (o *OidcConfiguration) GetRegistrationEndpointOk() (*string, bool)`
GetRegistrationEndpointOk returns a tuple with the RegistrationEndpoint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRegistrationEndpoint
`func (o *OidcConfiguration) SetRegistrationEndpoint(v string)`
SetRegistrationEndpoint sets RegistrationEndpoint field to given value.
### HasRegistrationEndpoint
`func (o *OidcConfiguration) HasRegistrationEndpoint() bool`
HasRegistrationEndpoint returns a boolean if a field has been set.
### GetRequestObjectSigningAlgValuesSupported
`func (o *OidcConfiguration) GetRequestObjectSigningAlgValuesSupported() []string`
GetRequestObjectSigningAlgValuesSupported returns the RequestObjectSigningAlgValuesSupported field if non-nil, zero value otherwise.
### GetRequestObjectSigningAlgValuesSupportedOk
`func (o *OidcConfiguration) GetRequestObjectSigningAlgValuesSupportedOk() (*[]string, bool)`
GetRequestObjectSigningAlgValuesSupportedOk returns a tuple with the RequestObjectSigningAlgValuesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRequestObjectSigningAlgValuesSupported
`func (o *OidcConfiguration) SetRequestObjectSigningAlgValuesSupported(v []string)`
SetRequestObjectSigningAlgValuesSupported sets RequestObjectSigningAlgValuesSupported field to given value.
### HasRequestObjectSigningAlgValuesSupported
`func (o *OidcConfiguration) HasRequestObjectSigningAlgValuesSupported() bool`
HasRequestObjectSigningAlgValuesSupported returns a boolean if a field has been set.
### GetRequestParameterSupported
`func (o *OidcConfiguration) GetRequestParameterSupported() bool`
GetRequestParameterSupported returns the RequestParameterSupported field if non-nil, zero value otherwise.
### GetRequestParameterSupportedOk
`func (o *OidcConfiguration) GetRequestParameterSupportedOk() (*bool, bool)`
GetRequestParameterSupportedOk returns a tuple with the RequestParameterSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRequestParameterSupported
`func (o *OidcConfiguration) SetRequestParameterSupported(v bool)`
SetRequestParameterSupported sets RequestParameterSupported field to given value.
### HasRequestParameterSupported
`func (o *OidcConfiguration) HasRequestParameterSupported() bool`
HasRequestParameterSupported returns a boolean if a field has been set.
### GetRequestUriParameterSupported
`func (o *OidcConfiguration) GetRequestUriParameterSupported() bool`
GetRequestUriParameterSupported returns the RequestUriParameterSupported field if non-nil, zero value otherwise.
### GetRequestUriParameterSupportedOk
`func (o *OidcConfiguration) GetRequestUriParameterSupportedOk() (*bool, bool)`
GetRequestUriParameterSupportedOk returns a tuple with the RequestUriParameterSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRequestUriParameterSupported
`func (o *OidcConfiguration) SetRequestUriParameterSupported(v bool)`
SetRequestUriParameterSupported sets RequestUriParameterSupported field to given value.
### HasRequestUriParameterSupported
`func (o *OidcConfiguration) HasRequestUriParameterSupported() bool`
HasRequestUriParameterSupported returns a boolean if a field has been set.
### GetRequireRequestUriRegistration
`func (o *OidcConfiguration) GetRequireRequestUriRegistration() bool`
GetRequireRequestUriRegistration returns the RequireRequestUriRegistration field if non-nil, zero value otherwise.
### GetRequireRequestUriRegistrationOk
`func (o *OidcConfiguration) GetRequireRequestUriRegistrationOk() (*bool, bool)`
GetRequireRequestUriRegistrationOk returns a tuple with the RequireRequestUriRegistration field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRequireRequestUriRegistration
`func (o *OidcConfiguration) SetRequireRequestUriRegistration(v bool)`
SetRequireRequestUriRegistration sets RequireRequestUriRegistration field to given value.
### HasRequireRequestUriRegistration
`func (o *OidcConfiguration) HasRequireRequestUriRegistration() bool`
HasRequireRequestUriRegistration returns a boolean if a field has been set.
### GetResponseModesSupported
`func (o *OidcConfiguration) GetResponseModesSupported() []string`
GetResponseModesSupported returns the ResponseModesSupported field if non-nil, zero value otherwise.
### GetResponseModesSupportedOk
`func (o *OidcConfiguration) GetResponseModesSupportedOk() (*[]string, bool)`
GetResponseModesSupportedOk returns a tuple with the ResponseModesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetResponseModesSupported
`func (o *OidcConfiguration) SetResponseModesSupported(v []string)`
SetResponseModesSupported sets ResponseModesSupported field to given value.
### HasResponseModesSupported
`func (o *OidcConfiguration) HasResponseModesSupported() bool`
HasResponseModesSupported returns a boolean if a field has been set.
### GetResponseTypesSupported
`func (o *OidcConfiguration) GetResponseTypesSupported() []string`
GetResponseTypesSupported returns the ResponseTypesSupported field if non-nil, zero value otherwise.
### GetResponseTypesSupportedOk
`func (o *OidcConfiguration) GetResponseTypesSupportedOk() (*[]string, bool)`
GetResponseTypesSupportedOk returns a tuple with the ResponseTypesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetResponseTypesSupported
`func (o *OidcConfiguration) SetResponseTypesSupported(v []string)`
SetResponseTypesSupported sets ResponseTypesSupported field to given value.
### GetRevocationEndpoint
`func (o *OidcConfiguration) GetRevocationEndpoint() string`
GetRevocationEndpoint returns the RevocationEndpoint field if non-nil, zero value otherwise.
### GetRevocationEndpointOk
`func (o *OidcConfiguration) GetRevocationEndpointOk() (*string, bool)`
GetRevocationEndpointOk returns a tuple with the RevocationEndpoint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRevocationEndpoint
`func (o *OidcConfiguration) SetRevocationEndpoint(v string)`
SetRevocationEndpoint sets RevocationEndpoint field to given value.
### HasRevocationEndpoint
`func (o *OidcConfiguration) HasRevocationEndpoint() bool`
HasRevocationEndpoint returns a boolean if a field has been set.
### GetScopesSupported
`func (o *OidcConfiguration) GetScopesSupported() []string`
GetScopesSupported returns the ScopesSupported field if non-nil, zero value otherwise.
### GetScopesSupportedOk
`func (o *OidcConfiguration) GetScopesSupportedOk() (*[]string, bool)`
GetScopesSupportedOk returns a tuple with the ScopesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetScopesSupported
`func (o *OidcConfiguration) SetScopesSupported(v []string)`
SetScopesSupported sets ScopesSupported field to given value.
### HasScopesSupported
`func (o *OidcConfiguration) HasScopesSupported() bool`
HasScopesSupported returns a boolean if a field has been set.
### GetSubjectTypesSupported
`func (o *OidcConfiguration) GetSubjectTypesSupported() []string`
GetSubjectTypesSupported returns the SubjectTypesSupported field if non-nil, zero value otherwise.
### GetSubjectTypesSupportedOk
`func (o *OidcConfiguration) GetSubjectTypesSupportedOk() (*[]string, bool)`
GetSubjectTypesSupportedOk returns a tuple with the SubjectTypesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSubjectTypesSupported
`func (o *OidcConfiguration) SetSubjectTypesSupported(v []string)`
SetSubjectTypesSupported sets SubjectTypesSupported field to given value.
### GetTokenEndpoint
`func (o *OidcConfiguration) GetTokenEndpoint() string`
GetTokenEndpoint returns the TokenEndpoint field if non-nil, zero value otherwise.
### GetTokenEndpointOk
`func (o *OidcConfiguration) GetTokenEndpointOk() (*string, bool)`
GetTokenEndpointOk returns a tuple with the TokenEndpoint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTokenEndpoint
`func (o *OidcConfiguration) SetTokenEndpoint(v string)`
SetTokenEndpoint sets TokenEndpoint field to given value.
### GetTokenEndpointAuthMethodsSupported
`func (o *OidcConfiguration) GetTokenEndpointAuthMethodsSupported() []string`
GetTokenEndpointAuthMethodsSupported returns the TokenEndpointAuthMethodsSupported field if non-nil, zero value otherwise.
### GetTokenEndpointAuthMethodsSupportedOk
`func (o *OidcConfiguration) GetTokenEndpointAuthMethodsSupportedOk() (*[]string, bool)`
GetTokenEndpointAuthMethodsSupportedOk returns a tuple with the TokenEndpointAuthMethodsSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTokenEndpointAuthMethodsSupported
`func (o *OidcConfiguration) SetTokenEndpointAuthMethodsSupported(v []string)`
SetTokenEndpointAuthMethodsSupported sets TokenEndpointAuthMethodsSupported field to given value.
### HasTokenEndpointAuthMethodsSupported
`func (o *OidcConfiguration) HasTokenEndpointAuthMethodsSupported() bool`
HasTokenEndpointAuthMethodsSupported returns a boolean if a field has been set.
### GetUserinfoEndpoint
`func (o *OidcConfiguration) GetUserinfoEndpoint() string`
GetUserinfoEndpoint returns the UserinfoEndpoint field if non-nil, zero value otherwise.
### GetUserinfoEndpointOk
`func (o *OidcConfiguration) GetUserinfoEndpointOk() (*string, bool)`
GetUserinfoEndpointOk returns a tuple with the UserinfoEndpoint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUserinfoEndpoint
`func (o *OidcConfiguration) SetUserinfoEndpoint(v string)`
SetUserinfoEndpoint sets UserinfoEndpoint field to given value.
### HasUserinfoEndpoint
`func (o *OidcConfiguration) HasUserinfoEndpoint() bool`
HasUserinfoEndpoint returns a boolean if a field has been set.
### GetUserinfoSignedResponseAlg
`func (o *OidcConfiguration) GetUserinfoSignedResponseAlg() []string`
GetUserinfoSignedResponseAlg returns the UserinfoSignedResponseAlg field if non-nil, zero value otherwise.
### GetUserinfoSignedResponseAlgOk
`func (o *OidcConfiguration) GetUserinfoSignedResponseAlgOk() (*[]string, bool)`
GetUserinfoSignedResponseAlgOk returns a tuple with the UserinfoSignedResponseAlg field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUserinfoSignedResponseAlg
`func (o *OidcConfiguration) SetUserinfoSignedResponseAlg(v []string)`
SetUserinfoSignedResponseAlg sets UserinfoSignedResponseAlg field to given value.
### GetUserinfoSigningAlgValuesSupported
`func (o *OidcConfiguration) GetUserinfoSigningAlgValuesSupported() []string`
GetUserinfoSigningAlgValuesSupported returns the UserinfoSigningAlgValuesSupported field if non-nil, zero value otherwise.
### GetUserinfoSigningAlgValuesSupportedOk
`func (o *OidcConfiguration) GetUserinfoSigningAlgValuesSupportedOk() (*[]string, bool)`
GetUserinfoSigningAlgValuesSupportedOk returns a tuple with the UserinfoSigningAlgValuesSupported field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUserinfoSigningAlgValuesSupported
`func (o *OidcConfiguration) SetUserinfoSigningAlgValuesSupported(v []string)`
SetUserinfoSigningAlgValuesSupported sets UserinfoSigningAlgValuesSupported field to given value.
### HasUserinfoSigningAlgValuesSupported
`func (o *OidcConfiguration) HasUserinfoSigningAlgValuesSupported() bool`
HasUserinfoSigningAlgValuesSupported returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/OidcUserInfo.md | # OidcUserInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Birthdate** | Pointer to **string** | End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates. | [optional]
**Email** | Pointer to **string** | End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. | [optional]
**EmailVerified** | Pointer to **bool** | True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. | [optional]
**FamilyName** | Pointer to **string** | Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters. | [optional]
**Gender** | Pointer to **string** | End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable. | [optional]
**GivenName** | Pointer to **string** | Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters. | [optional]
**Locale** | Pointer to **string** | End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well. | [optional]
**MiddleName** | Pointer to **string** | Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used. | [optional]
**Name** | Pointer to **string** | End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. | [optional]
**Nickname** | Pointer to **string** | Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael. | [optional]
**PhoneNumber** | Pointer to **string** | End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678. | [optional]
**PhoneNumberVerified** | Pointer to **bool** | True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format. | [optional]
**Picture** | Pointer to **string** | URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User. | [optional]
**PreferredUsername** | Pointer to **string** | Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. | [optional]
**Profile** | Pointer to **string** | URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. | [optional]
**Sub** | Pointer to **string** | Subject - Identifier for the End-User at the IssuerURL. | [optional]
**UpdatedAt** | Pointer to **int64** | Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. | [optional]
**Website** | Pointer to **string** | URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with. | [optional]
**Zoneinfo** | Pointer to **string** | String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. | [optional]
## Methods
### NewOidcUserInfo
`func NewOidcUserInfo() *OidcUserInfo`
NewOidcUserInfo instantiates a new OidcUserInfo 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
### NewOidcUserInfoWithDefaults
`func NewOidcUserInfoWithDefaults() *OidcUserInfo`
NewOidcUserInfoWithDefaults instantiates a new OidcUserInfo 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
### GetBirthdate
`func (o *OidcUserInfo) GetBirthdate() string`
GetBirthdate returns the Birthdate field if non-nil, zero value otherwise.
### GetBirthdateOk
`func (o *OidcUserInfo) GetBirthdateOk() (*string, bool)`
GetBirthdateOk returns a tuple with the Birthdate field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetBirthdate
`func (o *OidcUserInfo) SetBirthdate(v string)`
SetBirthdate sets Birthdate field to given value.
### HasBirthdate
`func (o *OidcUserInfo) HasBirthdate() bool`
HasBirthdate returns a boolean if a field has been set.
### GetEmail
`func (o *OidcUserInfo) GetEmail() string`
GetEmail returns the Email field if non-nil, zero value otherwise.
### GetEmailOk
`func (o *OidcUserInfo) GetEmailOk() (*string, bool)`
GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetEmail
`func (o *OidcUserInfo) SetEmail(v string)`
SetEmail sets Email field to given value.
### HasEmail
`func (o *OidcUserInfo) HasEmail() bool`
HasEmail returns a boolean if a field has been set.
### GetEmailVerified
`func (o *OidcUserInfo) GetEmailVerified() bool`
GetEmailVerified returns the EmailVerified field if non-nil, zero value otherwise.
### GetEmailVerifiedOk
`func (o *OidcUserInfo) GetEmailVerifiedOk() (*bool, bool)`
GetEmailVerifiedOk returns a tuple with the EmailVerified field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetEmailVerified
`func (o *OidcUserInfo) SetEmailVerified(v bool)`
SetEmailVerified sets EmailVerified field to given value.
### HasEmailVerified
`func (o *OidcUserInfo) HasEmailVerified() bool`
HasEmailVerified returns a boolean if a field has been set.
### GetFamilyName
`func (o *OidcUserInfo) GetFamilyName() string`
GetFamilyName returns the FamilyName field if non-nil, zero value otherwise.
### GetFamilyNameOk
`func (o *OidcUserInfo) GetFamilyNameOk() (*string, bool)`
GetFamilyNameOk returns a tuple with the FamilyName field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFamilyName
`func (o *OidcUserInfo) SetFamilyName(v string)`
SetFamilyName sets FamilyName field to given value.
### HasFamilyName
`func (o *OidcUserInfo) HasFamilyName() bool`
HasFamilyName returns a boolean if a field has been set.
### GetGender
`func (o *OidcUserInfo) GetGender() string`
GetGender returns the Gender field if non-nil, zero value otherwise.
### GetGenderOk
`func (o *OidcUserInfo) GetGenderOk() (*string, bool)`
GetGenderOk returns a tuple with the Gender field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetGender
`func (o *OidcUserInfo) SetGender(v string)`
SetGender sets Gender field to given value.
### HasGender
`func (o *OidcUserInfo) HasGender() bool`
HasGender returns a boolean if a field has been set.
### GetGivenName
`func (o *OidcUserInfo) GetGivenName() string`
GetGivenName returns the GivenName field if non-nil, zero value otherwise.
### GetGivenNameOk
`func (o *OidcUserInfo) GetGivenNameOk() (*string, bool)`
GetGivenNameOk returns a tuple with the GivenName field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetGivenName
`func (o *OidcUserInfo) SetGivenName(v string)`
SetGivenName sets GivenName field to given value.
### HasGivenName
`func (o *OidcUserInfo) HasGivenName() bool`
HasGivenName returns a boolean if a field has been set.
### GetLocale
`func (o *OidcUserInfo) GetLocale() string`
GetLocale returns the Locale field if non-nil, zero value otherwise.
### GetLocaleOk
`func (o *OidcUserInfo) GetLocaleOk() (*string, bool)`
GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetLocale
`func (o *OidcUserInfo) SetLocale(v string)`
SetLocale sets Locale field to given value.
### HasLocale
`func (o *OidcUserInfo) HasLocale() bool`
HasLocale returns a boolean if a field has been set.
### GetMiddleName
`func (o *OidcUserInfo) GetMiddleName() string`
GetMiddleName returns the MiddleName field if non-nil, zero value otherwise.
### GetMiddleNameOk
`func (o *OidcUserInfo) GetMiddleNameOk() (*string, bool)`
GetMiddleNameOk returns a tuple with the MiddleName field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetMiddleName
`func (o *OidcUserInfo) SetMiddleName(v string)`
SetMiddleName sets MiddleName field to given value.
### HasMiddleName
`func (o *OidcUserInfo) HasMiddleName() bool`
HasMiddleName returns a boolean if a field has been set.
### GetName
`func (o *OidcUserInfo) GetName() string`
GetName returns the Name field if non-nil, zero value otherwise.
### GetNameOk
`func (o *OidcUserInfo) GetNameOk() (*string, bool)`
GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetName
`func (o *OidcUserInfo) SetName(v string)`
SetName sets Name field to given value.
### HasName
`func (o *OidcUserInfo) HasName() bool`
HasName returns a boolean if a field has been set.
### GetNickname
`func (o *OidcUserInfo) GetNickname() string`
GetNickname returns the Nickname field if non-nil, zero value otherwise.
### GetNicknameOk
`func (o *OidcUserInfo) GetNicknameOk() (*string, bool)`
GetNicknameOk returns a tuple with the Nickname field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetNickname
`func (o *OidcUserInfo) SetNickname(v string)`
SetNickname sets Nickname field to given value.
### HasNickname
`func (o *OidcUserInfo) HasNickname() bool`
HasNickname returns a boolean if a field has been set.
### GetPhoneNumber
`func (o *OidcUserInfo) GetPhoneNumber() string`
GetPhoneNumber returns the PhoneNumber field if non-nil, zero value otherwise.
### GetPhoneNumberOk
`func (o *OidcUserInfo) GetPhoneNumberOk() (*string, bool)`
GetPhoneNumberOk returns a tuple with the PhoneNumber field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPhoneNumber
`func (o *OidcUserInfo) SetPhoneNumber(v string)`
SetPhoneNumber sets PhoneNumber field to given value.
### HasPhoneNumber
`func (o *OidcUserInfo) HasPhoneNumber() bool`
HasPhoneNumber returns a boolean if a field has been set.
### GetPhoneNumberVerified
`func (o *OidcUserInfo) GetPhoneNumberVerified() bool`
GetPhoneNumberVerified returns the PhoneNumberVerified field if non-nil, zero value otherwise.
### GetPhoneNumberVerifiedOk
`func (o *OidcUserInfo) GetPhoneNumberVerifiedOk() (*bool, bool)`
GetPhoneNumberVerifiedOk returns a tuple with the PhoneNumberVerified field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPhoneNumberVerified
`func (o *OidcUserInfo) SetPhoneNumberVerified(v bool)`
SetPhoneNumberVerified sets PhoneNumberVerified field to given value.
### HasPhoneNumberVerified
`func (o *OidcUserInfo) HasPhoneNumberVerified() bool`
HasPhoneNumberVerified returns a boolean if a field has been set.
### GetPicture
`func (o *OidcUserInfo) GetPicture() string`
GetPicture returns the Picture field if non-nil, zero value otherwise.
### GetPictureOk
`func (o *OidcUserInfo) GetPictureOk() (*string, bool)`
GetPictureOk returns a tuple with the Picture field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPicture
`func (o *OidcUserInfo) SetPicture(v string)`
SetPicture sets Picture field to given value.
### HasPicture
`func (o *OidcUserInfo) HasPicture() bool`
HasPicture returns a boolean if a field has been set.
### GetPreferredUsername
`func (o *OidcUserInfo) GetPreferredUsername() string`
GetPreferredUsername returns the PreferredUsername field if non-nil, zero value otherwise.
### GetPreferredUsernameOk
`func (o *OidcUserInfo) GetPreferredUsernameOk() (*string, bool)`
GetPreferredUsernameOk returns a tuple with the PreferredUsername field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPreferredUsername
`func (o *OidcUserInfo) SetPreferredUsername(v string)`
SetPreferredUsername sets PreferredUsername field to given value.
### HasPreferredUsername
`func (o *OidcUserInfo) HasPreferredUsername() bool`
HasPreferredUsername returns a boolean if a field has been set.
### GetProfile
`func (o *OidcUserInfo) GetProfile() string`
GetProfile returns the Profile field if non-nil, zero value otherwise.
### GetProfileOk
`func (o *OidcUserInfo) GetProfileOk() (*string, bool)`
GetProfileOk returns a tuple with the Profile field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetProfile
`func (o *OidcUserInfo) SetProfile(v string)`
SetProfile sets Profile field to given value.
### HasProfile
`func (o *OidcUserInfo) HasProfile() bool`
HasProfile returns a boolean if a field has been set.
### GetSub
`func (o *OidcUserInfo) GetSub() string`
GetSub returns the Sub field if non-nil, zero value otherwise.
### GetSubOk
`func (o *OidcUserInfo) GetSubOk() (*string, bool)`
GetSubOk returns a tuple with the Sub field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSub
`func (o *OidcUserInfo) SetSub(v string)`
SetSub sets Sub field to given value.
### HasSub
`func (o *OidcUserInfo) HasSub() bool`
HasSub returns a boolean if a field has been set.
### GetUpdatedAt
`func (o *OidcUserInfo) GetUpdatedAt() int64`
GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.
### GetUpdatedAtOk
`func (o *OidcUserInfo) GetUpdatedAtOk() (*int64, bool)`
GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetUpdatedAt
`func (o *OidcUserInfo) SetUpdatedAt(v int64)`
SetUpdatedAt sets UpdatedAt field to given value.
### HasUpdatedAt
`func (o *OidcUserInfo) HasUpdatedAt() bool`
HasUpdatedAt returns a boolean if a field has been set.
### GetWebsite
`func (o *OidcUserInfo) GetWebsite() string`
GetWebsite returns the Website field if non-nil, zero value otherwise.
### GetWebsiteOk
`func (o *OidcUserInfo) GetWebsiteOk() (*string, bool)`
GetWebsiteOk returns a tuple with the Website field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetWebsite
`func (o *OidcUserInfo) SetWebsite(v string)`
SetWebsite sets Website field to given value.
### HasWebsite
`func (o *OidcUserInfo) HasWebsite() bool`
HasWebsite returns a boolean if a field has been set.
### GetZoneinfo
`func (o *OidcUserInfo) GetZoneinfo() string`
GetZoneinfo returns the Zoneinfo field if non-nil, zero value otherwise.
### GetZoneinfoOk
`func (o *OidcUserInfo) GetZoneinfoOk() (*string, bool)`
GetZoneinfoOk returns a tuple with the Zoneinfo field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetZoneinfo
`func (o *OidcUserInfo) SetZoneinfo(v string)`
SetZoneinfo sets Zoneinfo field to given value.
### HasZoneinfo
`func (o *OidcUserInfo) HasZoneinfo() bool`
HasZoneinfo returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/Pagination.md | # Pagination
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**PageSize** | Pointer to **int64** | Items per page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional] [default to 250]
**PageToken** | Pointer to **string** | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional] [default to "1"]
## Methods
### NewPagination
`func NewPagination() *Pagination`
NewPagination instantiates a new Pagination 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
### NewPaginationWithDefaults
`func NewPaginationWithDefaults() *Pagination`
NewPaginationWithDefaults instantiates a new Pagination 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
### GetPageSize
`func (o *Pagination) GetPageSize() int64`
GetPageSize returns the PageSize field if non-nil, zero value otherwise.
### GetPageSizeOk
`func (o *Pagination) GetPageSizeOk() (*int64, bool)`
GetPageSizeOk returns a tuple with the PageSize field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPageSize
`func (o *Pagination) SetPageSize(v int64)`
SetPageSize sets PageSize field to given value.
### HasPageSize
`func (o *Pagination) HasPageSize() bool`
HasPageSize returns a boolean if a field has been set.
### GetPageToken
`func (o *Pagination) GetPageToken() string`
GetPageToken returns the PageToken field if non-nil, zero value otherwise.
### GetPageTokenOk
`func (o *Pagination) GetPageTokenOk() (*string, bool)`
GetPageTokenOk returns a tuple with the PageToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPageToken
`func (o *Pagination) SetPageToken(v string)`
SetPageToken sets PageToken field to given value.
### HasPageToken
`func (o *Pagination) HasPageToken() bool`
HasPageToken returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/PaginationHeaders.md | # PaginationHeaders
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Link** | Pointer to **string** | The link header contains pagination links. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). in: header | [optional]
**XTotalCount** | Pointer to **string** | The total number of clients. in: header | [optional]
## Methods
### NewPaginationHeaders
`func NewPaginationHeaders() *PaginationHeaders`
NewPaginationHeaders instantiates a new PaginationHeaders 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
### NewPaginationHeadersWithDefaults
`func NewPaginationHeadersWithDefaults() *PaginationHeaders`
NewPaginationHeadersWithDefaults instantiates a new PaginationHeaders 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
### GetLink
`func (o *PaginationHeaders) GetLink() string`
GetLink returns the Link field if non-nil, zero value otherwise.
### GetLinkOk
`func (o *PaginationHeaders) GetLinkOk() (*string, bool)`
GetLinkOk returns a tuple with the Link field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetLink
`func (o *PaginationHeaders) SetLink(v string)`
SetLink sets Link field to given value.
### HasLink
`func (o *PaginationHeaders) HasLink() bool`
HasLink returns a boolean if a field has been set.
### GetXTotalCount
`func (o *PaginationHeaders) GetXTotalCount() string`
GetXTotalCount returns the XTotalCount field if non-nil, zero value otherwise.
### GetXTotalCountOk
`func (o *PaginationHeaders) GetXTotalCountOk() (*string, bool)`
GetXTotalCountOk returns a tuple with the XTotalCount field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetXTotalCount
`func (o *PaginationHeaders) SetXTotalCount(v string)`
SetXTotalCount sets XTotalCount field to given value.
### HasXTotalCount
`func (o *PaginationHeaders) HasXTotalCount() bool`
HasXTotalCount returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/RejectOAuth2Request.md | # RejectOAuth2Request
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Error** | Pointer to **string** | The error should follow the OAuth2 error format (e.g. `invalid_request`, `login_required`). Defaults to `request_denied`. | [optional]
**ErrorDebug** | Pointer to **string** | Debug contains information to help resolve the problem as a developer. Usually not exposed to the public but only in the server logs. | [optional]
**ErrorDescription** | Pointer to **string** | Description of the error in a human readable format. | [optional]
**ErrorHint** | Pointer to **string** | Hint to help resolve the error. | [optional]
**StatusCode** | Pointer to **int64** | Represents the HTTP status code of the error (e.g. 401 or 403) Defaults to 400 | [optional]
## Methods
### NewRejectOAuth2Request
`func NewRejectOAuth2Request() *RejectOAuth2Request`
NewRejectOAuth2Request instantiates a new RejectOAuth2Request 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
### NewRejectOAuth2RequestWithDefaults
`func NewRejectOAuth2RequestWithDefaults() *RejectOAuth2Request`
NewRejectOAuth2RequestWithDefaults instantiates a new RejectOAuth2Request 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
### GetError
`func (o *RejectOAuth2Request) GetError() string`
GetError returns the Error field if non-nil, zero value otherwise.
### GetErrorOk
`func (o *RejectOAuth2Request) GetErrorOk() (*string, bool)`
GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetError
`func (o *RejectOAuth2Request) SetError(v string)`
SetError sets Error field to given value.
### HasError
`func (o *RejectOAuth2Request) HasError() bool`
HasError returns a boolean if a field has been set.
### GetErrorDebug
`func (o *RejectOAuth2Request) GetErrorDebug() string`
GetErrorDebug returns the ErrorDebug field if non-nil, zero value otherwise.
### GetErrorDebugOk
`func (o *RejectOAuth2Request) GetErrorDebugOk() (*string, bool)`
GetErrorDebugOk returns a tuple with the ErrorDebug field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorDebug
`func (o *RejectOAuth2Request) SetErrorDebug(v string)`
SetErrorDebug sets ErrorDebug field to given value.
### HasErrorDebug
`func (o *RejectOAuth2Request) HasErrorDebug() bool`
HasErrorDebug returns a boolean if a field has been set.
### GetErrorDescription
`func (o *RejectOAuth2Request) GetErrorDescription() string`
GetErrorDescription returns the ErrorDescription field if non-nil, zero value otherwise.
### GetErrorDescriptionOk
`func (o *RejectOAuth2Request) GetErrorDescriptionOk() (*string, bool)`
GetErrorDescriptionOk returns a tuple with the ErrorDescription field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorDescription
`func (o *RejectOAuth2Request) SetErrorDescription(v string)`
SetErrorDescription sets ErrorDescription field to given value.
### HasErrorDescription
`func (o *RejectOAuth2Request) HasErrorDescription() bool`
HasErrorDescription returns a boolean if a field has been set.
### GetErrorHint
`func (o *RejectOAuth2Request) GetErrorHint() string`
GetErrorHint returns the ErrorHint field if non-nil, zero value otherwise.
### GetErrorHintOk
`func (o *RejectOAuth2Request) GetErrorHintOk() (*string, bool)`
GetErrorHintOk returns a tuple with the ErrorHint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorHint
`func (o *RejectOAuth2Request) SetErrorHint(v string)`
SetErrorHint sets ErrorHint field to given value.
### HasErrorHint
`func (o *RejectOAuth2Request) HasErrorHint() bool`
HasErrorHint returns a boolean if a field has been set.
### GetStatusCode
`func (o *RejectOAuth2Request) GetStatusCode() int64`
GetStatusCode returns the StatusCode field if non-nil, zero value otherwise.
### GetStatusCodeOk
`func (o *RejectOAuth2Request) GetStatusCodeOk() (*int64, bool)`
GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetStatusCode
`func (o *RejectOAuth2Request) SetStatusCode(v int64)`
SetStatusCode sets StatusCode field to given value.
### HasStatusCode
`func (o *RejectOAuth2Request) HasStatusCode() bool`
HasStatusCode returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/RFC6749ErrorJson.md | # RFC6749ErrorJson
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Error** | Pointer to **string** | | [optional]
**ErrorDebug** | Pointer to **string** | | [optional]
**ErrorDescription** | Pointer to **string** | | [optional]
**ErrorHint** | Pointer to **string** | | [optional]
**StatusCode** | Pointer to **int64** | | [optional]
## Methods
### NewRFC6749ErrorJson
`func NewRFC6749ErrorJson() *RFC6749ErrorJson`
NewRFC6749ErrorJson instantiates a new RFC6749ErrorJson 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
### NewRFC6749ErrorJsonWithDefaults
`func NewRFC6749ErrorJsonWithDefaults() *RFC6749ErrorJson`
NewRFC6749ErrorJsonWithDefaults instantiates a new RFC6749ErrorJson 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
### GetError
`func (o *RFC6749ErrorJson) GetError() string`
GetError returns the Error field if non-nil, zero value otherwise.
### GetErrorOk
`func (o *RFC6749ErrorJson) GetErrorOk() (*string, bool)`
GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetError
`func (o *RFC6749ErrorJson) SetError(v string)`
SetError sets Error field to given value.
### HasError
`func (o *RFC6749ErrorJson) HasError() bool`
HasError returns a boolean if a field has been set.
### GetErrorDebug
`func (o *RFC6749ErrorJson) GetErrorDebug() string`
GetErrorDebug returns the ErrorDebug field if non-nil, zero value otherwise.
### GetErrorDebugOk
`func (o *RFC6749ErrorJson) GetErrorDebugOk() (*string, bool)`
GetErrorDebugOk returns a tuple with the ErrorDebug field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorDebug
`func (o *RFC6749ErrorJson) SetErrorDebug(v string)`
SetErrorDebug sets ErrorDebug field to given value.
### HasErrorDebug
`func (o *RFC6749ErrorJson) HasErrorDebug() bool`
HasErrorDebug returns a boolean if a field has been set.
### GetErrorDescription
`func (o *RFC6749ErrorJson) GetErrorDescription() string`
GetErrorDescription returns the ErrorDescription field if non-nil, zero value otherwise.
### GetErrorDescriptionOk
`func (o *RFC6749ErrorJson) GetErrorDescriptionOk() (*string, bool)`
GetErrorDescriptionOk returns a tuple with the ErrorDescription field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorDescription
`func (o *RFC6749ErrorJson) SetErrorDescription(v string)`
SetErrorDescription sets ErrorDescription field to given value.
### HasErrorDescription
`func (o *RFC6749ErrorJson) HasErrorDescription() bool`
HasErrorDescription returns a boolean if a field has been set.
### GetErrorHint
`func (o *RFC6749ErrorJson) GetErrorHint() string`
GetErrorHint returns the ErrorHint field if non-nil, zero value otherwise.
### GetErrorHintOk
`func (o *RFC6749ErrorJson) GetErrorHintOk() (*string, bool)`
GetErrorHintOk returns a tuple with the ErrorHint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorHint
`func (o *RFC6749ErrorJson) SetErrorHint(v string)`
SetErrorHint sets ErrorHint field to given value.
### HasErrorHint
`func (o *RFC6749ErrorJson) HasErrorHint() bool`
HasErrorHint returns a boolean if a field has been set.
### GetStatusCode
`func (o *RFC6749ErrorJson) GetStatusCode() int64`
GetStatusCode returns the StatusCode field if non-nil, zero value otherwise.
### GetStatusCodeOk
`func (o *RFC6749ErrorJson) GetStatusCodeOk() (*int64, bool)`
GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetStatusCode
`func (o *RFC6749ErrorJson) SetStatusCode(v int64)`
SetStatusCode sets StatusCode field to given value.
### HasStatusCode
`func (o *RFC6749ErrorJson) HasStatusCode() bool`
HasStatusCode returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/TokenPagination.md | # TokenPagination
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**PageSize** | Pointer to **int64** | Items per page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional] [default to 250]
**PageToken** | Pointer to **string** | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional] [default to "1"]
## Methods
### NewTokenPagination
`func NewTokenPagination() *TokenPagination`
NewTokenPagination instantiates a new TokenPagination 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
### NewTokenPaginationWithDefaults
`func NewTokenPaginationWithDefaults() *TokenPagination`
NewTokenPaginationWithDefaults instantiates a new TokenPagination 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
### GetPageSize
`func (o *TokenPagination) GetPageSize() int64`
GetPageSize returns the PageSize field if non-nil, zero value otherwise.
### GetPageSizeOk
`func (o *TokenPagination) GetPageSizeOk() (*int64, bool)`
GetPageSizeOk returns a tuple with the PageSize field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPageSize
`func (o *TokenPagination) SetPageSize(v int64)`
SetPageSize sets PageSize field to given value.
### HasPageSize
`func (o *TokenPagination) HasPageSize() bool`
HasPageSize returns a boolean if a field has been set.
### GetPageToken
`func (o *TokenPagination) GetPageToken() string`
GetPageToken returns the PageToken field if non-nil, zero value otherwise.
### GetPageTokenOk
`func (o *TokenPagination) GetPageTokenOk() (*string, bool)`
GetPageTokenOk returns a tuple with the PageToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPageToken
`func (o *TokenPagination) SetPageToken(v string)`
SetPageToken sets PageToken field to given value.
### HasPageToken
`func (o *TokenPagination) HasPageToken() bool`
HasPageToken returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/TokenPaginationHeaders.md | # TokenPaginationHeaders
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Link** | Pointer to **string** | The link header contains pagination links. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). in: header | [optional]
**XTotalCount** | Pointer to **string** | The total number of clients. in: header | [optional]
## Methods
### NewTokenPaginationHeaders
`func NewTokenPaginationHeaders() *TokenPaginationHeaders`
NewTokenPaginationHeaders instantiates a new TokenPaginationHeaders 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
### NewTokenPaginationHeadersWithDefaults
`func NewTokenPaginationHeadersWithDefaults() *TokenPaginationHeaders`
NewTokenPaginationHeadersWithDefaults instantiates a new TokenPaginationHeaders 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
### GetLink
`func (o *TokenPaginationHeaders) GetLink() string`
GetLink returns the Link field if non-nil, zero value otherwise.
### GetLinkOk
`func (o *TokenPaginationHeaders) GetLinkOk() (*string, bool)`
GetLinkOk returns a tuple with the Link field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetLink
`func (o *TokenPaginationHeaders) SetLink(v string)`
SetLink sets Link field to given value.
### HasLink
`func (o *TokenPaginationHeaders) HasLink() bool`
HasLink returns a boolean if a field has been set.
### GetXTotalCount
`func (o *TokenPaginationHeaders) GetXTotalCount() string`
GetXTotalCount returns the XTotalCount field if non-nil, zero value otherwise.
### GetXTotalCountOk
`func (o *TokenPaginationHeaders) GetXTotalCountOk() (*string, bool)`
GetXTotalCountOk returns a tuple with the XTotalCount field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetXTotalCount
`func (o *TokenPaginationHeaders) SetXTotalCount(v string)`
SetXTotalCount sets XTotalCount field to given value.
### HasXTotalCount
`func (o *TokenPaginationHeaders) HasXTotalCount() bool`
HasXTotalCount returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/TokenPaginationRequestParameters.md | # TokenPaginationRequestParameters
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**PageSize** | Pointer to **int64** | Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional] [default to 250]
**PageToken** | Pointer to **string** | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional] [default to "1"]
## Methods
### NewTokenPaginationRequestParameters
`func NewTokenPaginationRequestParameters() *TokenPaginationRequestParameters`
NewTokenPaginationRequestParameters instantiates a new TokenPaginationRequestParameters 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
### NewTokenPaginationRequestParametersWithDefaults
`func NewTokenPaginationRequestParametersWithDefaults() *TokenPaginationRequestParameters`
NewTokenPaginationRequestParametersWithDefaults instantiates a new TokenPaginationRequestParameters 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
### GetPageSize
`func (o *TokenPaginationRequestParameters) GetPageSize() int64`
GetPageSize returns the PageSize field if non-nil, zero value otherwise.
### GetPageSizeOk
`func (o *TokenPaginationRequestParameters) GetPageSizeOk() (*int64, bool)`
GetPageSizeOk returns a tuple with the PageSize field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPageSize
`func (o *TokenPaginationRequestParameters) SetPageSize(v int64)`
SetPageSize sets PageSize field to given value.
### HasPageSize
`func (o *TokenPaginationRequestParameters) HasPageSize() bool`
HasPageSize returns a boolean if a field has been set.
### GetPageToken
`func (o *TokenPaginationRequestParameters) GetPageToken() string`
GetPageToken returns the PageToken field if non-nil, zero value otherwise.
### GetPageTokenOk
`func (o *TokenPaginationRequestParameters) GetPageTokenOk() (*string, bool)`
GetPageTokenOk returns a tuple with the PageToken field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPageToken
`func (o *TokenPaginationRequestParameters) SetPageToken(v string)`
SetPageToken sets PageToken field to given value.
### HasPageToken
`func (o *TokenPaginationRequestParameters) HasPageToken() bool`
HasPageToken returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/TokenPaginationResponseHeaders.md | # TokenPaginationResponseHeaders
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Link** | Pointer to **string** | The Link HTTP Header The `Link` header contains a comma-delimited list of links to the following pages: first: The first page of results. next: The next page of results. prev: The previous page of results. last: The last page of results. Pages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted. Examples: </clients?page_size=5&page_token=0>; rel=\"first\",</clients?page_size=5&page_token=15>; rel=\"next\",</clients?page_size=5&page_token=5>; rel=\"prev\",</clients?page_size=5&page_token=20>; rel=\"last\" | [optional]
**XTotalCount** | Pointer to **int64** | The X-Total-Count HTTP Header The `X-Total-Count` header contains the total number of items in the collection. | [optional]
## Methods
### NewTokenPaginationResponseHeaders
`func NewTokenPaginationResponseHeaders() *TokenPaginationResponseHeaders`
NewTokenPaginationResponseHeaders instantiates a new TokenPaginationResponseHeaders 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
### NewTokenPaginationResponseHeadersWithDefaults
`func NewTokenPaginationResponseHeadersWithDefaults() *TokenPaginationResponseHeaders`
NewTokenPaginationResponseHeadersWithDefaults instantiates a new TokenPaginationResponseHeaders 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
### GetLink
`func (o *TokenPaginationResponseHeaders) GetLink() string`
GetLink returns the Link field if non-nil, zero value otherwise.
### GetLinkOk
`func (o *TokenPaginationResponseHeaders) GetLinkOk() (*string, bool)`
GetLinkOk returns a tuple with the Link field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetLink
`func (o *TokenPaginationResponseHeaders) SetLink(v string)`
SetLink sets Link field to given value.
### HasLink
`func (o *TokenPaginationResponseHeaders) HasLink() bool`
HasLink returns a boolean if a field has been set.
### GetXTotalCount
`func (o *TokenPaginationResponseHeaders) GetXTotalCount() int64`
GetXTotalCount returns the XTotalCount field if non-nil, zero value otherwise.
### GetXTotalCountOk
`func (o *TokenPaginationResponseHeaders) GetXTotalCountOk() (*int64, bool)`
GetXTotalCountOk returns a tuple with the XTotalCount field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetXTotalCount
`func (o *TokenPaginationResponseHeaders) SetXTotalCount(v int64)`
SetXTotalCount sets XTotalCount field to given value.
### HasXTotalCount
`func (o *TokenPaginationResponseHeaders) HasXTotalCount() bool`
HasXTotalCount returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/TrustedOAuth2JwtGrantIssuer.md | # TrustedOAuth2JwtGrantIssuer
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AllowAnySubject** | Pointer to **bool** | The \"allow_any_subject\" indicates that the issuer is allowed to have any principal as the subject of the JWT. | [optional]
**CreatedAt** | Pointer to **time.Time** | The \"created_at\" indicates, when grant was created. | [optional]
**ExpiresAt** | Pointer to **time.Time** | The \"expires_at\" indicates, when grant will expire, so we will reject assertion from \"issuer\" targeting \"subject\". | [optional]
**Id** | Pointer to **string** | | [optional]
**Issuer** | Pointer to **string** | The \"issuer\" identifies the principal that issued the JWT assertion (same as \"iss\" claim in JWT). | [optional]
**PublicKey** | Pointer to [**TrustedOAuth2JwtGrantJsonWebKey**](TrustedOAuth2JwtGrantJsonWebKey.md) | | [optional]
**Scope** | Pointer to **[]string** | The \"scope\" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) | [optional]
**Subject** | Pointer to **string** | The \"subject\" identifies the principal that is the subject of the JWT. | [optional]
## Methods
### NewTrustedOAuth2JwtGrantIssuer
`func NewTrustedOAuth2JwtGrantIssuer() *TrustedOAuth2JwtGrantIssuer`
NewTrustedOAuth2JwtGrantIssuer instantiates a new TrustedOAuth2JwtGrantIssuer 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
### NewTrustedOAuth2JwtGrantIssuerWithDefaults
`func NewTrustedOAuth2JwtGrantIssuerWithDefaults() *TrustedOAuth2JwtGrantIssuer`
NewTrustedOAuth2JwtGrantIssuerWithDefaults instantiates a new TrustedOAuth2JwtGrantIssuer 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
### GetAllowAnySubject
`func (o *TrustedOAuth2JwtGrantIssuer) GetAllowAnySubject() bool`
GetAllowAnySubject returns the AllowAnySubject field if non-nil, zero value otherwise.
### GetAllowAnySubjectOk
`func (o *TrustedOAuth2JwtGrantIssuer) GetAllowAnySubjectOk() (*bool, bool)`
GetAllowAnySubjectOk returns a tuple with the AllowAnySubject field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAllowAnySubject
`func (o *TrustedOAuth2JwtGrantIssuer) SetAllowAnySubject(v bool)`
SetAllowAnySubject sets AllowAnySubject field to given value.
### HasAllowAnySubject
`func (o *TrustedOAuth2JwtGrantIssuer) HasAllowAnySubject() bool`
HasAllowAnySubject returns a boolean if a field has been set.
### GetCreatedAt
`func (o *TrustedOAuth2JwtGrantIssuer) GetCreatedAt() time.Time`
GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise.
### GetCreatedAtOk
`func (o *TrustedOAuth2JwtGrantIssuer) GetCreatedAtOk() (*time.Time, bool)`
GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCreatedAt
`func (o *TrustedOAuth2JwtGrantIssuer) SetCreatedAt(v time.Time)`
SetCreatedAt sets CreatedAt field to given value.
### HasCreatedAt
`func (o *TrustedOAuth2JwtGrantIssuer) HasCreatedAt() bool`
HasCreatedAt returns a boolean if a field has been set.
### GetExpiresAt
`func (o *TrustedOAuth2JwtGrantIssuer) GetExpiresAt() time.Time`
GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise.
### GetExpiresAtOk
`func (o *TrustedOAuth2JwtGrantIssuer) GetExpiresAtOk() (*time.Time, bool)`
GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetExpiresAt
`func (o *TrustedOAuth2JwtGrantIssuer) SetExpiresAt(v time.Time)`
SetExpiresAt sets ExpiresAt field to given value.
### HasExpiresAt
`func (o *TrustedOAuth2JwtGrantIssuer) HasExpiresAt() bool`
HasExpiresAt returns a boolean if a field has been set.
### GetId
`func (o *TrustedOAuth2JwtGrantIssuer) GetId() string`
GetId returns the Id field if non-nil, zero value otherwise.
### GetIdOk
`func (o *TrustedOAuth2JwtGrantIssuer) GetIdOk() (*string, bool)`
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetId
`func (o *TrustedOAuth2JwtGrantIssuer) SetId(v string)`
SetId sets Id field to given value.
### HasId
`func (o *TrustedOAuth2JwtGrantIssuer) HasId() bool`
HasId returns a boolean if a field has been set.
### GetIssuer
`func (o *TrustedOAuth2JwtGrantIssuer) GetIssuer() string`
GetIssuer returns the Issuer field if non-nil, zero value otherwise.
### GetIssuerOk
`func (o *TrustedOAuth2JwtGrantIssuer) GetIssuerOk() (*string, bool)`
GetIssuerOk returns a tuple with the Issuer field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIssuer
`func (o *TrustedOAuth2JwtGrantIssuer) SetIssuer(v string)`
SetIssuer sets Issuer field to given value.
### HasIssuer
`func (o *TrustedOAuth2JwtGrantIssuer) HasIssuer() bool`
HasIssuer returns a boolean if a field has been set.
### GetPublicKey
`func (o *TrustedOAuth2JwtGrantIssuer) GetPublicKey() TrustedOAuth2JwtGrantJsonWebKey`
GetPublicKey returns the PublicKey field if non-nil, zero value otherwise.
### GetPublicKeyOk
`func (o *TrustedOAuth2JwtGrantIssuer) GetPublicKeyOk() (*TrustedOAuth2JwtGrantJsonWebKey, bool)`
GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetPublicKey
`func (o *TrustedOAuth2JwtGrantIssuer) SetPublicKey(v TrustedOAuth2JwtGrantJsonWebKey)`
SetPublicKey sets PublicKey field to given value.
### HasPublicKey
`func (o *TrustedOAuth2JwtGrantIssuer) HasPublicKey() bool`
HasPublicKey returns a boolean if a field has been set.
### GetScope
`func (o *TrustedOAuth2JwtGrantIssuer) GetScope() []string`
GetScope returns the Scope field if non-nil, zero value otherwise.
### GetScopeOk
`func (o *TrustedOAuth2JwtGrantIssuer) GetScopeOk() (*[]string, bool)`
GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetScope
`func (o *TrustedOAuth2JwtGrantIssuer) SetScope(v []string)`
SetScope sets Scope field to given value.
### HasScope
`func (o *TrustedOAuth2JwtGrantIssuer) HasScope() bool`
HasScope returns a boolean if a field has been set.
### GetSubject
`func (o *TrustedOAuth2JwtGrantIssuer) GetSubject() string`
GetSubject returns the Subject field if non-nil, zero value otherwise.
### GetSubjectOk
`func (o *TrustedOAuth2JwtGrantIssuer) 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 *TrustedOAuth2JwtGrantIssuer) SetSubject(v string)`
SetSubject sets Subject field to given value.
### HasSubject
`func (o *TrustedOAuth2JwtGrantIssuer) HasSubject() bool`
HasSubject returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/TrustedOAuth2JwtGrantJsonWebKey.md | # TrustedOAuth2JwtGrantJsonWebKey
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Kid** | Pointer to **string** | The \"key_id\" is key unique identifier (same as kid header in jws/jwt). | [optional]
**Set** | Pointer to **string** | The \"set\" is basically a name for a group(set) of keys. Will be the same as \"issuer\" in grant. | [optional]
## Methods
### NewTrustedOAuth2JwtGrantJsonWebKey
`func NewTrustedOAuth2JwtGrantJsonWebKey() *TrustedOAuth2JwtGrantJsonWebKey`
NewTrustedOAuth2JwtGrantJsonWebKey instantiates a new TrustedOAuth2JwtGrantJsonWebKey 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
### NewTrustedOAuth2JwtGrantJsonWebKeyWithDefaults
`func NewTrustedOAuth2JwtGrantJsonWebKeyWithDefaults() *TrustedOAuth2JwtGrantJsonWebKey`
NewTrustedOAuth2JwtGrantJsonWebKeyWithDefaults instantiates a new TrustedOAuth2JwtGrantJsonWebKey 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
### GetKid
`func (o *TrustedOAuth2JwtGrantJsonWebKey) GetKid() string`
GetKid returns the Kid field if non-nil, zero value otherwise.
### GetKidOk
`func (o *TrustedOAuth2JwtGrantJsonWebKey) GetKidOk() (*string, bool)`
GetKidOk returns a tuple with the Kid field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetKid
`func (o *TrustedOAuth2JwtGrantJsonWebKey) SetKid(v string)`
SetKid sets Kid field to given value.
### HasKid
`func (o *TrustedOAuth2JwtGrantJsonWebKey) HasKid() bool`
HasKid returns a boolean if a field has been set.
### GetSet
`func (o *TrustedOAuth2JwtGrantJsonWebKey) GetSet() string`
GetSet returns the Set field if non-nil, zero value otherwise.
### GetSetOk
`func (o *TrustedOAuth2JwtGrantJsonWebKey) GetSetOk() (*string, bool)`
GetSetOk returns a tuple with the Set field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSet
`func (o *TrustedOAuth2JwtGrantJsonWebKey) SetSet(v string)`
SetSet sets Set field to given value.
### HasSet
`func (o *TrustedOAuth2JwtGrantJsonWebKey) HasSet() bool`
HasSet returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/TrustOAuth2JwtGrantIssuer.md | # TrustOAuth2JwtGrantIssuer
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AllowAnySubject** | Pointer to **bool** | The \"allow_any_subject\" indicates that the issuer is allowed to have any principal as the subject of the JWT. | [optional]
**ExpiresAt** | **time.Time** | The \"expires_at\" indicates, when grant will expire, so we will reject assertion from \"issuer\" targeting \"subject\". |
**Issuer** | **string** | The \"issuer\" identifies the principal that issued the JWT assertion (same as \"iss\" claim in JWT). |
**Jwk** | [**JsonWebKey**](JsonWebKey.md) | |
**Scope** | **[]string** | The \"scope\" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) |
**Subject** | Pointer to **string** | The \"subject\" identifies the principal that is the subject of the JWT. | [optional]
## Methods
### NewTrustOAuth2JwtGrantIssuer
`func NewTrustOAuth2JwtGrantIssuer(expiresAt time.Time, issuer string, jwk JsonWebKey, scope []string, ) *TrustOAuth2JwtGrantIssuer`
NewTrustOAuth2JwtGrantIssuer instantiates a new TrustOAuth2JwtGrantIssuer 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
### NewTrustOAuth2JwtGrantIssuerWithDefaults
`func NewTrustOAuth2JwtGrantIssuerWithDefaults() *TrustOAuth2JwtGrantIssuer`
NewTrustOAuth2JwtGrantIssuerWithDefaults instantiates a new TrustOAuth2JwtGrantIssuer 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
### GetAllowAnySubject
`func (o *TrustOAuth2JwtGrantIssuer) GetAllowAnySubject() bool`
GetAllowAnySubject returns the AllowAnySubject field if non-nil, zero value otherwise.
### GetAllowAnySubjectOk
`func (o *TrustOAuth2JwtGrantIssuer) GetAllowAnySubjectOk() (*bool, bool)`
GetAllowAnySubjectOk returns a tuple with the AllowAnySubject field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetAllowAnySubject
`func (o *TrustOAuth2JwtGrantIssuer) SetAllowAnySubject(v bool)`
SetAllowAnySubject sets AllowAnySubject field to given value.
### HasAllowAnySubject
`func (o *TrustOAuth2JwtGrantIssuer) HasAllowAnySubject() bool`
HasAllowAnySubject returns a boolean if a field has been set.
### GetExpiresAt
`func (o *TrustOAuth2JwtGrantIssuer) GetExpiresAt() time.Time`
GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise.
### GetExpiresAtOk
`func (o *TrustOAuth2JwtGrantIssuer) GetExpiresAtOk() (*time.Time, bool)`
GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetExpiresAt
`func (o *TrustOAuth2JwtGrantIssuer) SetExpiresAt(v time.Time)`
SetExpiresAt sets ExpiresAt field to given value.
### GetIssuer
`func (o *TrustOAuth2JwtGrantIssuer) GetIssuer() string`
GetIssuer returns the Issuer field if non-nil, zero value otherwise.
### GetIssuerOk
`func (o *TrustOAuth2JwtGrantIssuer) GetIssuerOk() (*string, bool)`
GetIssuerOk returns a tuple with the Issuer field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetIssuer
`func (o *TrustOAuth2JwtGrantIssuer) SetIssuer(v string)`
SetIssuer sets Issuer field to given value.
### GetJwk
`func (o *TrustOAuth2JwtGrantIssuer) GetJwk() JsonWebKey`
GetJwk returns the Jwk field if non-nil, zero value otherwise.
### GetJwkOk
`func (o *TrustOAuth2JwtGrantIssuer) GetJwkOk() (*JsonWebKey, bool)`
GetJwkOk returns a tuple with the Jwk field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetJwk
`func (o *TrustOAuth2JwtGrantIssuer) SetJwk(v JsonWebKey)`
SetJwk sets Jwk field to given value.
### GetScope
`func (o *TrustOAuth2JwtGrantIssuer) GetScope() []string`
GetScope returns the Scope field if non-nil, zero value otherwise.
### GetScopeOk
`func (o *TrustOAuth2JwtGrantIssuer) GetScopeOk() (*[]string, bool)`
GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetScope
`func (o *TrustOAuth2JwtGrantIssuer) SetScope(v []string)`
SetScope sets Scope field to given value.
### GetSubject
`func (o *TrustOAuth2JwtGrantIssuer) GetSubject() string`
GetSubject returns the Subject field if non-nil, zero value otherwise.
### GetSubjectOk
`func (o *TrustOAuth2JwtGrantIssuer) 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 *TrustOAuth2JwtGrantIssuer) SetSubject(v string)`
SetSubject sets Subject field to given value.
### HasSubject
`func (o *TrustOAuth2JwtGrantIssuer) HasSubject() bool`
HasSubject returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/VerifiableCredentialPrimingResponse.md | # VerifiableCredentialPrimingResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CNonce** | Pointer to **string** | | [optional]
**CNonceExpiresIn** | Pointer to **int64** | | [optional]
**Error** | Pointer to **string** | | [optional]
**ErrorDebug** | Pointer to **string** | | [optional]
**ErrorDescription** | Pointer to **string** | | [optional]
**ErrorHint** | Pointer to **string** | | [optional]
**Format** | Pointer to **string** | | [optional]
**StatusCode** | Pointer to **int64** | | [optional]
## Methods
### NewVerifiableCredentialPrimingResponse
`func NewVerifiableCredentialPrimingResponse() *VerifiableCredentialPrimingResponse`
NewVerifiableCredentialPrimingResponse instantiates a new VerifiableCredentialPrimingResponse 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
### NewVerifiableCredentialPrimingResponseWithDefaults
`func NewVerifiableCredentialPrimingResponseWithDefaults() *VerifiableCredentialPrimingResponse`
NewVerifiableCredentialPrimingResponseWithDefaults instantiates a new VerifiableCredentialPrimingResponse 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
### GetCNonce
`func (o *VerifiableCredentialPrimingResponse) GetCNonce() string`
GetCNonce returns the CNonce field if non-nil, zero value otherwise.
### GetCNonceOk
`func (o *VerifiableCredentialPrimingResponse) GetCNonceOk() (*string, bool)`
GetCNonceOk returns a tuple with the CNonce field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCNonce
`func (o *VerifiableCredentialPrimingResponse) SetCNonce(v string)`
SetCNonce sets CNonce field to given value.
### HasCNonce
`func (o *VerifiableCredentialPrimingResponse) HasCNonce() bool`
HasCNonce returns a boolean if a field has been set.
### GetCNonceExpiresIn
`func (o *VerifiableCredentialPrimingResponse) GetCNonceExpiresIn() int64`
GetCNonceExpiresIn returns the CNonceExpiresIn field if non-nil, zero value otherwise.
### GetCNonceExpiresInOk
`func (o *VerifiableCredentialPrimingResponse) GetCNonceExpiresInOk() (*int64, bool)`
GetCNonceExpiresInOk returns a tuple with the CNonceExpiresIn field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCNonceExpiresIn
`func (o *VerifiableCredentialPrimingResponse) SetCNonceExpiresIn(v int64)`
SetCNonceExpiresIn sets CNonceExpiresIn field to given value.
### HasCNonceExpiresIn
`func (o *VerifiableCredentialPrimingResponse) HasCNonceExpiresIn() bool`
HasCNonceExpiresIn returns a boolean if a field has been set.
### GetError
`func (o *VerifiableCredentialPrimingResponse) GetError() string`
GetError returns the Error field if non-nil, zero value otherwise.
### GetErrorOk
`func (o *VerifiableCredentialPrimingResponse) GetErrorOk() (*string, bool)`
GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetError
`func (o *VerifiableCredentialPrimingResponse) SetError(v string)`
SetError sets Error field to given value.
### HasError
`func (o *VerifiableCredentialPrimingResponse) HasError() bool`
HasError returns a boolean if a field has been set.
### GetErrorDebug
`func (o *VerifiableCredentialPrimingResponse) GetErrorDebug() string`
GetErrorDebug returns the ErrorDebug field if non-nil, zero value otherwise.
### GetErrorDebugOk
`func (o *VerifiableCredentialPrimingResponse) GetErrorDebugOk() (*string, bool)`
GetErrorDebugOk returns a tuple with the ErrorDebug field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorDebug
`func (o *VerifiableCredentialPrimingResponse) SetErrorDebug(v string)`
SetErrorDebug sets ErrorDebug field to given value.
### HasErrorDebug
`func (o *VerifiableCredentialPrimingResponse) HasErrorDebug() bool`
HasErrorDebug returns a boolean if a field has been set.
### GetErrorDescription
`func (o *VerifiableCredentialPrimingResponse) GetErrorDescription() string`
GetErrorDescription returns the ErrorDescription field if non-nil, zero value otherwise.
### GetErrorDescriptionOk
`func (o *VerifiableCredentialPrimingResponse) GetErrorDescriptionOk() (*string, bool)`
GetErrorDescriptionOk returns a tuple with the ErrorDescription field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorDescription
`func (o *VerifiableCredentialPrimingResponse) SetErrorDescription(v string)`
SetErrorDescription sets ErrorDescription field to given value.
### HasErrorDescription
`func (o *VerifiableCredentialPrimingResponse) HasErrorDescription() bool`
HasErrorDescription returns a boolean if a field has been set.
### GetErrorHint
`func (o *VerifiableCredentialPrimingResponse) GetErrorHint() string`
GetErrorHint returns the ErrorHint field if non-nil, zero value otherwise.
### GetErrorHintOk
`func (o *VerifiableCredentialPrimingResponse) GetErrorHintOk() (*string, bool)`
GetErrorHintOk returns a tuple with the ErrorHint field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetErrorHint
`func (o *VerifiableCredentialPrimingResponse) SetErrorHint(v string)`
SetErrorHint sets ErrorHint field to given value.
### HasErrorHint
`func (o *VerifiableCredentialPrimingResponse) HasErrorHint() bool`
HasErrorHint returns a boolean if a field has been set.
### GetFormat
`func (o *VerifiableCredentialPrimingResponse) GetFormat() string`
GetFormat returns the Format field if non-nil, zero value otherwise.
### GetFormatOk
`func (o *VerifiableCredentialPrimingResponse) GetFormatOk() (*string, bool)`
GetFormatOk returns a tuple with the Format field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFormat
`func (o *VerifiableCredentialPrimingResponse) SetFormat(v string)`
SetFormat sets Format field to given value.
### HasFormat
`func (o *VerifiableCredentialPrimingResponse) HasFormat() bool`
HasFormat returns a boolean if a field has been set.
### GetStatusCode
`func (o *VerifiableCredentialPrimingResponse) GetStatusCode() int64`
GetStatusCode returns the StatusCode field if non-nil, zero value otherwise.
### GetStatusCodeOk
`func (o *VerifiableCredentialPrimingResponse) GetStatusCodeOk() (*int64, bool)`
GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetStatusCode
`func (o *VerifiableCredentialPrimingResponse) SetStatusCode(v int64)`
SetStatusCode sets StatusCode field to given value.
### HasStatusCode
`func (o *VerifiableCredentialPrimingResponse) HasStatusCode() bool`
HasStatusCode returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/VerifiableCredentialProof.md | # VerifiableCredentialProof
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Jwt** | Pointer to **string** | | [optional]
**ProofType** | Pointer to **string** | | [optional]
## Methods
### NewVerifiableCredentialProof
`func NewVerifiableCredentialProof() *VerifiableCredentialProof`
NewVerifiableCredentialProof instantiates a new VerifiableCredentialProof 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
### NewVerifiableCredentialProofWithDefaults
`func NewVerifiableCredentialProofWithDefaults() *VerifiableCredentialProof`
NewVerifiableCredentialProofWithDefaults instantiates a new VerifiableCredentialProof 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
### GetJwt
`func (o *VerifiableCredentialProof) GetJwt() string`
GetJwt returns the Jwt field if non-nil, zero value otherwise.
### GetJwtOk
`func (o *VerifiableCredentialProof) GetJwtOk() (*string, bool)`
GetJwtOk returns a tuple with the Jwt field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetJwt
`func (o *VerifiableCredentialProof) SetJwt(v string)`
SetJwt sets Jwt field to given value.
### HasJwt
`func (o *VerifiableCredentialProof) HasJwt() bool`
HasJwt returns a boolean if a field has been set.
### GetProofType
`func (o *VerifiableCredentialProof) GetProofType() string`
GetProofType returns the ProofType field if non-nil, zero value otherwise.
### GetProofTypeOk
`func (o *VerifiableCredentialProof) GetProofTypeOk() (*string, bool)`
GetProofTypeOk returns a tuple with the ProofType field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetProofType
`func (o *VerifiableCredentialProof) SetProofType(v string)`
SetProofType sets ProofType field to given value.
### HasProofType
`func (o *VerifiableCredentialProof) HasProofType() bool`
HasProofType returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/VerifiableCredentialResponse.md | # VerifiableCredentialResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CredentialDraft00** | Pointer to **string** | | [optional]
**Format** | Pointer to **string** | | [optional]
## Methods
### NewVerifiableCredentialResponse
`func NewVerifiableCredentialResponse() *VerifiableCredentialResponse`
NewVerifiableCredentialResponse instantiates a new VerifiableCredentialResponse 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
### NewVerifiableCredentialResponseWithDefaults
`func NewVerifiableCredentialResponseWithDefaults() *VerifiableCredentialResponse`
NewVerifiableCredentialResponseWithDefaults instantiates a new VerifiableCredentialResponse 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
### GetCredentialDraft00
`func (o *VerifiableCredentialResponse) GetCredentialDraft00() string`
GetCredentialDraft00 returns the CredentialDraft00 field if non-nil, zero value otherwise.
### GetCredentialDraft00Ok
`func (o *VerifiableCredentialResponse) GetCredentialDraft00Ok() (*string, bool)`
GetCredentialDraft00Ok returns a tuple with the CredentialDraft00 field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCredentialDraft00
`func (o *VerifiableCredentialResponse) SetCredentialDraft00(v string)`
SetCredentialDraft00 sets CredentialDraft00 field to given value.
### HasCredentialDraft00
`func (o *VerifiableCredentialResponse) HasCredentialDraft00() bool`
HasCredentialDraft00 returns a boolean if a field has been set.
### GetFormat
`func (o *VerifiableCredentialResponse) GetFormat() string`
GetFormat returns the Format field if non-nil, zero value otherwise.
### GetFormatOk
`func (o *VerifiableCredentialResponse) GetFormatOk() (*string, bool)`
GetFormatOk returns a tuple with the Format field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFormat
`func (o *VerifiableCredentialResponse) SetFormat(v string)`
SetFormat sets Format field to given value.
### HasFormat
`func (o *VerifiableCredentialResponse) HasFormat() bool`
HasFormat returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/Version.md | # Version
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Version** | Pointer to **string** | Version is the service's version. | [optional]
## Methods
### NewVersion
`func NewVersion() *Version`
NewVersion instantiates a new Version 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
### NewVersionWithDefaults
`func NewVersionWithDefaults() *Version`
NewVersionWithDefaults instantiates a new Version 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
### GetVersion
`func (o *Version) GetVersion() string`
GetVersion returns the Version field if non-nil, zero value otherwise.
### GetVersionOk
`func (o *Version) GetVersionOk() (*string, bool)`
GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetVersion
`func (o *Version) SetVersion(v string)`
SetVersion sets Version field to given value.
### HasVersion
`func (o *Version) HasVersion() bool`
HasVersion returns a boolean if a field has been set.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
Markdown | hydra/internal/httpclient/docs/WellknownApi.md | # \WellknownApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**DiscoverJsonWebKeys**](WellknownApi.md#DiscoverJsonWebKeys) | **Get** /.well-known/jwks.json | Discover Well-Known JSON Web Keys
## DiscoverJsonWebKeys
> JsonWebKeySet DiscoverJsonWebKeys(ctx).Execute()
Discover Well-Known JSON Web Keys
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.WellknownApi.DiscoverJsonWebKeys(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `WellknownApi.DiscoverJsonWebKeys``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DiscoverJsonWebKeys`: JsonWebKeySet
fmt.Fprintf(os.Stdout, "Response from `WellknownApi.DiscoverJsonWebKeys`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiDiscoverJsonWebKeysRequest struct via the builder pattern
### Return type
[**JsonWebKeySet**](JsonWebKeySet.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md) |
Go | hydra/internal/kratos/fake_kratos.go | // Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package kratos
import "context"
type (
FakeKratos struct {
DisableSessionWasCalled bool
LastDisabledSession string
}
)
const (
FakeSessionID = "fake-kratos-session-id"
)
var _ Client = new(FakeKratos)
func NewFake() *FakeKratos {
return &FakeKratos{}
}
func (f *FakeKratos) DisableSession(ctx context.Context, identityProviderSessionID string) error {
f.DisableSessionWasCalled = true
f.LastDisabledSession = identityProviderSessionID
return nil
}
func (f *FakeKratos) Reset() {
f.DisableSessionWasCalled = false
f.LastDisabledSession = ""
} |
Go | hydra/internal/kratos/kratos.go | // Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package kratos
import (
"context"
"fmt"
"net/url"
"go.opentelemetry.io/otel/attribute"
"github.com/ory/hydra/v2/driver/config"
"github.com/ory/hydra/v2/x"
client "github.com/ory/kratos-client-go"
"github.com/ory/x/httpx"
"github.com/ory/x/otelx"
)
type (
dependencies interface {
config.Provider
x.HTTPClientProvider
x.TracingProvider
x.RegistryLogger
}
Provider interface {
Kratos() Client
}
Client interface {
DisableSession(ctx context.Context, identityProviderSessionID string) error
}
Default struct {
dependencies
}
)
func New(d dependencies) Client {
return &Default{dependencies: d}
}
func (k *Default) DisableSession(ctx context.Context, identityProviderSessionID string) (err error) {
ctx, span := k.Tracer(ctx).Tracer().Start(ctx, "kratos.DisableSession")
otelx.End(span, &err)
adminURL, ok := k.Config().KratosAdminURL(ctx)
span.SetAttributes(attribute.String("admin_url", fmt.Sprintf("%+v", adminURL)))
if !ok {
span.SetAttributes(attribute.Bool("skipped", true))
span.SetAttributes(attribute.String("reason", "kratos admin url not set"))
return nil
}
if identityProviderSessionID == "" {
span.SetAttributes(attribute.Bool("skipped", true))
span.SetAttributes(attribute.String("reason", "kratos session ID is empty"))
return nil
}
configuration := k.clientConfiguration(ctx, adminURL)
if header := k.Config().KratosRequestHeader(ctx); header != nil {
configuration.HTTPClient.Transport = httpx.WrapTransportWithHeader(configuration.HTTPClient.Transport, header)
}
kratos := client.NewAPIClient(configuration)
_, err = kratos.IdentityApi.DisableSession(ctx, identityProviderSessionID).Execute()
return err
}
func (k *Default) clientConfiguration(ctx context.Context, adminURL *url.URL) *client.Configuration {
configuration := client.NewConfiguration()
configuration.Servers = client.ServerConfigurations{{URL: adminURL.String()}}
configuration.HTTPClient = k.HTTPClient(ctx).StandardClient()
return configuration
} |
Go | hydra/internal/mock/config_cookie.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
// Code generated by MockGen. DO NOT EDIT.
// Source: github.com/ory/hydra/x (interfaces: CookieConfigProvider)
// Package mock is a generated GoMock package.
package mock
import (
context "context"
http "net/http"
reflect "reflect"
gomock "github.com/golang/mock/gomock"
)
// MockCookieConfigProvider is a mock of CookieConfigProvider interface.
type MockCookieConfigProvider struct {
ctrl *gomock.Controller
recorder *MockCookieConfigProviderMockRecorder
}
// MockCookieConfigProviderMockRecorder is the mock recorder for MockCookieConfigProvider.
type MockCookieConfigProviderMockRecorder struct {
mock *MockCookieConfigProvider
}
// NewMockCookieConfigProvider creates a new mock instance.
func NewMockCookieConfigProvider(ctrl *gomock.Controller) *MockCookieConfigProvider {
mock := &MockCookieConfigProvider{ctrl: ctrl}
mock.recorder = &MockCookieConfigProviderMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockCookieConfigProvider) EXPECT() *MockCookieConfigProviderMockRecorder {
return m.recorder
}
// CookieDomain mocks base method.
func (m *MockCookieConfigProvider) CookieDomain(arg0 context.Context) string {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "CookieDomain", arg0)
ret0, _ := ret[0].(string)
return ret0
}
// CookieDomain indicates an expected call of CookieDomain.
func (mr *MockCookieConfigProviderMockRecorder) CookieDomain(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CookieDomain", reflect.TypeOf((*MockCookieConfigProvider)(nil).CookieDomain), arg0)
}
// CookieSameSiteLegacyWorkaround mocks base method.
func (m *MockCookieConfigProvider) CookieSameSiteLegacyWorkaround(arg0 context.Context) bool {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "CookieSameSiteLegacyWorkaround", arg0)
ret0, _ := ret[0].(bool)
return ret0
}
// CookieSameSiteLegacyWorkaround indicates an expected call of CookieSameSiteLegacyWorkaround.
func (mr *MockCookieConfigProviderMockRecorder) CookieSameSiteLegacyWorkaround(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CookieSameSiteLegacyWorkaround", reflect.TypeOf((*MockCookieConfigProvider)(nil).CookieSameSiteLegacyWorkaround), arg0)
}
// CookieSameSiteMode mocks base method.
func (m *MockCookieConfigProvider) CookieSameSiteMode(arg0 context.Context) http.SameSite {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "CookieSameSiteMode", arg0)
ret0, _ := ret[0].(http.SameSite)
return ret0
}
// CookieSameSiteMode indicates an expected call of CookieSameSiteMode.
func (mr *MockCookieConfigProviderMockRecorder) CookieSameSiteMode(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CookieSameSiteMode", reflect.TypeOf((*MockCookieConfigProvider)(nil).CookieSameSiteMode), arg0)
}
// CookieSecure mocks base method.
func (m *MockCookieConfigProvider) CookieSecure(arg0 context.Context) bool {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "CookieSecure", arg0)
ret0, _ := ret[0].(bool)
return ret0
}
// CookieSecure indicates an expected call of CookieSecure.
func (mr *MockCookieConfigProviderMockRecorder) CookieSecure(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CookieSecure", reflect.TypeOf((*MockCookieConfigProvider)(nil).CookieSecure), arg0)
}
// IsDevelopmentMode mocks base method.
func (m *MockCookieConfigProvider) IsDevelopmentMode(arg0 context.Context) bool {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "IsDevelopmentMode", arg0)
ret0, _ := ret[0].(bool)
return ret0
}
// IsDevelopmentMode indicates an expected call of IsDevelopmentMode.
func (mr *MockCookieConfigProviderMockRecorder) IsDevelopmentMode(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "IsDevelopmentMode", reflect.TypeOf((*MockCookieConfigProvider)(nil).IsDevelopmentMode), arg0)
} |
Go | hydra/internal/testhelpers/certs.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package testhelpers
import (
"crypto"
"crypto/rand"
"crypto/rsa"
"crypto/x509"
"encoding/pem"
"os"
"testing"
"github.com/stretchr/testify/require"
"github.com/ory/x/tlsx"
)
// GenerateTLSCertificateFilesForTests writes a new, self-signed TLS
// certificate+key (in PEM format) to a temporary location on disk and returns
// the paths to both. The files are automatically cleaned up when the given
// *testing.T concludes its tests.
func GenerateTLSCertificateFilesForTests(t *testing.T) (
certPath, keyPath string,
cert *x509.Certificate,
privateKey interface {
Public() crypto.PublicKey
Equal(x crypto.PrivateKey) bool
},
) {
tmpDir := t.TempDir()
var err error
privateKey, err = rsa.GenerateKey(rand.Reader, 2048)
require.NoError(t, err)
cert, err = tlsx.CreateSelfSignedCertificate(privateKey)
require.NoError(t, err)
certOut, err := os.CreateTemp(tmpDir, "test-*-cert.pem")
require.NoError(t, err, "Failed to create temp file for certificate: %v", err)
certPath = certOut.Name()
err = pem.Encode(certOut, &pem.Block{Type: "CERTIFICATE", Bytes: cert.Raw})
require.NoError(t, err, "Failed to write data to %q: %v", certPath, err)
err = certOut.Close()
require.NoError(t, err, "Error closing %q: %v", certPath, err)
t.Log("wrote", certPath)
keyOut, err := os.CreateTemp(tmpDir, "test-*-key.pem")
require.NoError(t, err, "Failed to create temp file for key: %v", err)
keyPath = keyOut.Name()
privBytes, err := x509.MarshalPKCS8PrivateKey(privateKey)
require.NoError(t, err, "Failed to marshal private key: %v", err)
err = pem.Encode(keyOut, &pem.Block{Type: "PRIVATE KEY", Bytes: privBytes})
require.NoError(t, err, "Failed to write data to %q: %v", keyPath, err)
err = keyOut.Close()
require.NoError(t, err, "Error closing %q: %v", keyPath, err)
t.Log("wrote", keyPath)
return
} |
Go | hydra/internal/testhelpers/janitor_test_helper.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package testhelpers
import (
"context"
"fmt"
"net/url"
"testing"
"time"
"github.com/go-jose/go-jose/v3"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"github.com/ory/fosite"
"github.com/ory/fosite/handler/openid"
"github.com/ory/hydra/v2/client"
"github.com/ory/hydra/v2/consent"
"github.com/ory/hydra/v2/driver"
"github.com/ory/hydra/v2/driver/config"
"github.com/ory/hydra/v2/flow"
"github.com/ory/hydra/v2/internal"
"github.com/ory/hydra/v2/oauth2"
"github.com/ory/hydra/v2/oauth2/trust"
"github.com/ory/hydra/v2/x"
"github.com/ory/x/contextx"
"github.com/ory/x/logrusx"
"github.com/ory/x/sqlxx"
)
type JanitorConsentTestHelper struct {
uniqueName string
flushLoginRequests []*flow.LoginRequest
flushConsentRequests []*flow.OAuth2ConsentRequest
flushAccessRequests []*fosite.Request
flushRefreshRequests []*fosite.AccessRequest
flushGrants []*createGrantRequest
conf *config.DefaultProvider
Lifespan time.Duration
}
type createGrantRequest struct {
grant trust.Grant
pk jose.JSONWebKey
}
const lifespan = time.Hour
func NewConsentJanitorTestHelper(uniqueName string) *JanitorConsentTestHelper {
conf := internal.NewConfigurationWithDefaults()
conf.MustSet(context.Background(), config.KeyScopeStrategy, "DEPRECATED_HIERARCHICAL_SCOPE_STRATEGY")
conf.MustSet(context.Background(), config.KeyIssuerURL, "http://hydra.localhost")
conf.MustSet(context.Background(), config.KeyAccessTokenLifespan, lifespan)
conf.MustSet(context.Background(), config.KeyRefreshTokenLifespan, lifespan)
conf.MustSet(context.Background(), config.KeyConsentRequestMaxAge, lifespan)
conf.MustSet(context.Background(), config.KeyLogLevel, "trace")
return &JanitorConsentTestHelper{
uniqueName: uniqueName,
conf: conf,
flushLoginRequests: genLoginRequests(uniqueName, lifespan),
flushConsentRequests: genConsentRequests(uniqueName, lifespan),
flushAccessRequests: getAccessRequests(uniqueName, lifespan),
flushRefreshRequests: getRefreshRequests(uniqueName, lifespan),
flushGrants: getGrantRequests(uniqueName, lifespan),
Lifespan: lifespan,
}
}
func (j *JanitorConsentTestHelper) GetDSN() string {
return j.conf.DSN()
}
func (j *JanitorConsentTestHelper) GetConfig() *config.DefaultProvider {
return j.conf
}
func (j *JanitorConsentTestHelper) GetNotAfterTestCycles() map[string]time.Duration {
return map[string]time.Duration{
"notAfter24h": j.Lifespan * 24,
"notAfter1h30m": j.Lifespan + time.Hour/2,
"notAfterNow": 0,
}
}
func (j *JanitorConsentTestHelper) GetRegistry(ctx context.Context, dbname string) (driver.Registry, error) {
j.conf.MustSet(ctx, config.KeyDSN, fmt.Sprintf("sqlite://file:%s?mode=memory&_fk=true&cache=shared", dbname))
return driver.NewRegistryFromDSN(ctx, j.conf, logrusx.New("test_hydra", "master"), false, true, &contextx.Default{})
}
func (j *JanitorConsentTestHelper) AccessTokenNotAfterSetup(ctx context.Context, cl client.Manager, store x.FositeStorer) func(t *testing.T) {
return func(t *testing.T) {
// Create access token clients and session
for _, r := range j.flushAccessRequests {
require.NoError(t, cl.CreateClient(ctx, r.Client.(*client.Client)))
require.NoError(t, store.CreateAccessTokenSession(ctx, r.ID, r))
}
}
}
func (j *JanitorConsentTestHelper) AccessTokenNotAfterValidate(ctx context.Context, notAfter time.Time, store x.FositeStorer) func(t *testing.T) {
return func(t *testing.T) {
var err error
ds := new(oauth2.Session)
accessTokenLifespan := time.Now().Round(time.Second).Add(-j.conf.GetAccessTokenLifespan(ctx))
for _, r := range j.flushAccessRequests {
t.Logf("access flush check: %s", r.ID)
_, err = store.GetAccessTokenSession(ctx, r.ID, ds)
if j.notAfterCheck(notAfter, accessTokenLifespan, r.RequestedAt) {
require.Error(t, err)
} else {
require.NoError(t, err)
}
}
}
}
func (j *JanitorConsentTestHelper) RefreshTokenNotAfterSetup(ctx context.Context, cl client.Manager, store x.FositeStorer) func(t *testing.T) {
return func(t *testing.T) {
// Create refresh token clients and session
for _, fr := range j.flushRefreshRequests {
require.NoError(t, cl.CreateClient(ctx, fr.Client.(*client.Client)))
require.NoError(t, store.CreateRefreshTokenSession(ctx, fr.ID, fr))
}
}
}
func (j *JanitorConsentTestHelper) RefreshTokenNotAfterValidate(ctx context.Context, notAfter time.Time, store x.FositeStorer) func(t *testing.T) {
return func(t *testing.T) {
var err error
ds := new(oauth2.Session)
refreshTokenLifespan := time.Now().Round(time.Second).Add(-j.conf.GetRefreshTokenLifespan(ctx))
for _, r := range j.flushRefreshRequests {
t.Logf("refresh flush check: %s", r.ID)
_, err = store.GetRefreshTokenSession(ctx, r.ID, ds)
if j.notAfterCheck(notAfter, refreshTokenLifespan, r.RequestedAt) {
require.Error(t, err)
} else {
require.NoError(t, err)
}
}
}
}
func (j *JanitorConsentTestHelper) GrantNotAfterSetup(ctx context.Context, gr trust.GrantManager) func(t *testing.T) {
return func(t *testing.T) {
for _, fg := range j.flushGrants {
require.NoError(t, gr.CreateGrant(ctx, fg.grant, fg.pk))
}
}
}
func (j *JanitorConsentTestHelper) GrantNotAfterValidate(ctx context.Context, notAfter time.Time, gr trust.GrantManager) func(t *testing.T) {
return func(t *testing.T) {
var err error
// flush won't delete grants that have not yet expired, so use now to check that
deleteUntil := time.Now().Round(time.Second)
if deleteUntil.After(notAfter) {
deleteUntil = notAfter
}
for _, r := range j.flushGrants {
t.Logf("grant flush check: %s", r.grant.Issuer)
_, err = gr.GetConcreteGrant(ctx, r.grant.ID)
if deleteUntil.After(r.grant.ExpiresAt) {
require.Error(t, err)
} else {
require.NoError(t, err)
}
}
}
}
func (j *JanitorConsentTestHelper) LoginRejectionSetup(ctx context.Context, reg interface {
consent.ManagerProvider
client.ManagerProvider
flow.CipherProvider
}) func(t *testing.T) {
cm := reg.ConsentManager()
cl := reg.ClientManager()
return func(t *testing.T) {
// Create login requests
for _, r := range j.flushLoginRequests {
require.NoError(t, cl.CreateClient(ctx, r.Client))
f, err := cm.CreateLoginRequest(ctx, r)
require.NoError(t, err)
f.RequestedAt = time.Now() // we won't handle expired flows
f.LoginAuthenticatedAt = r.AuthenticatedAt
challenge := x.Must(f.ToLoginChallenge(ctx, reg))
// Explicit rejection
if r.ID == j.flushLoginRequests[0].ID {
// accept this one
_, err = cm.HandleLoginRequest(ctx, f, challenge, consent.NewHandledLoginRequest(
r.ID, false, r.RequestedAt, r.AuthenticatedAt))
require.NoError(t, err)
continue
}
// reject flush-login-2 and 3
_, err = cm.HandleLoginRequest(ctx, f, challenge, consent.NewHandledLoginRequest(
r.ID, true, r.RequestedAt, r.AuthenticatedAt))
require.NoError(t, err)
}
}
}
func (j *JanitorConsentTestHelper) LoginRejectionValidate(ctx context.Context, cm consent.Manager) func(t *testing.T) {
return func(t *testing.T) {
// flush-login-2 and 3 should be cleared now
for _, r := range j.flushLoginRequests {
t.Logf("check login: %s", r.ID)
_, err := cm.GetLoginRequest(ctx, r.ID)
// Login requests should never be persisted.
require.Error(t, err)
}
}
}
func (j *JanitorConsentTestHelper) LimitSetup(ctx context.Context, reg interface {
consent.ManagerProvider
client.ManagerProvider
flow.CipherProvider
}) func(t *testing.T) {
cl := reg.ClientManager()
cm := reg.ConsentManager()
return func(t *testing.T) {
var (
err error
f *flow.Flow
)
// Create login requests
for _, r := range j.flushLoginRequests {
require.NoError(t, cl.CreateClient(ctx, r.Client))
f, err = cm.CreateLoginRequest(ctx, r)
require.NoError(t, err)
// Reject each request
f.RequestedAt = time.Now() // we won't handle expired flows
f.LoginAuthenticatedAt = r.AuthenticatedAt
challenge := x.Must(f.ToLoginChallenge(ctx, reg))
_, err = cm.HandleLoginRequest(ctx, f, challenge, consent.NewHandledLoginRequest(
r.ID, true, r.RequestedAt, r.AuthenticatedAt))
require.NoError(t, err)
}
}
}
func (j *JanitorConsentTestHelper) LimitValidate(ctx context.Context, cm consent.Manager) func(t *testing.T) {
return func(t *testing.T) {
// flush-login-2 and 3 should be cleared now
for _, r := range j.flushLoginRequests {
t.Logf("check login: %s", r.ID)
_, err := cm.GetLoginRequest(ctx, r.ID)
// No Requests should have been persisted.
require.Error(t, err)
}
}
}
func (j *JanitorConsentTestHelper) ConsentRejectionSetup(ctx context.Context, reg interface {
consent.ManagerProvider
client.ManagerProvider
flow.CipherProvider
}) func(t *testing.T) {
cl := reg.ClientManager()
cm := reg.ConsentManager()
return func(t *testing.T) {
var (
err error
f *flow.Flow
)
// Create login requests
for i, loginRequest := range j.flushLoginRequests {
require.NoError(t, cl.CreateClient(ctx, loginRequest.Client))
f, err = cm.CreateLoginRequest(ctx, loginRequest)
require.NoError(t, err)
// Create consent requests
consentRequest := j.flushConsentRequests[i]
err = cm.CreateConsentRequest(ctx, f, consentRequest)
require.NoError(t, err)
f.RequestedAt = time.Now() // we won't handle expired flows
f.LoginAuthenticatedAt = consentRequest.AuthenticatedAt
// Reject the consents
if consentRequest.ID == j.flushConsentRequests[0].ID {
// accept this one
_, err = cm.HandleConsentRequest(ctx, f, consent.NewHandledConsentRequest(
consentRequest.ID, false, consentRequest.RequestedAt, consentRequest.AuthenticatedAt))
require.NoError(t, err)
continue
}
_, err = cm.HandleConsentRequest(ctx, f, consent.NewHandledConsentRequest(
consentRequest.ID, true, consentRequest.RequestedAt, consentRequest.AuthenticatedAt))
require.NoError(t, err)
}
}
}
func (j *JanitorConsentTestHelper) ConsentRejectionValidate(ctx context.Context, cm consent.Manager) func(t *testing.T) {
return func(t *testing.T) {
var err error
for _, r := range j.flushConsentRequests {
t.Logf("check consent: %s", r.ID)
_, err = cm.GetConsentRequest(ctx, r.ID)
// Consent requests should never be persisted.
require.Error(t, err)
}
}
}
func (j *JanitorConsentTestHelper) LoginTimeoutSetup(ctx context.Context, reg interface {
consent.ManagerProvider
client.ManagerProvider
flow.CipherProvider
}) func(t *testing.T) {
cl := reg.ClientManager()
cm := reg.ConsentManager()
return func(t *testing.T) {
var (
err error
f *flow.Flow
)
// Create login requests
for i, loginRequest := range j.flushLoginRequests {
require.NoError(t, cl.CreateClient(ctx, loginRequest.Client))
f, err = cm.CreateLoginRequest(ctx, loginRequest)
require.NoError(t, err)
if i == 0 {
// Creating at least 1 that has not timed out
challenge := x.Must(f.ToLoginChallenge(ctx, reg))
_, err = cm.HandleLoginRequest(ctx, f, challenge, &flow.HandledLoginRequest{
ID: loginRequest.ID,
RequestedAt: loginRequest.RequestedAt,
AuthenticatedAt: loginRequest.AuthenticatedAt,
WasHandled: true,
})
}
}
require.NoError(t, err)
}
}
func (j *JanitorConsentTestHelper) LoginTimeoutValidate(ctx context.Context, cm consent.Manager) func(t *testing.T) {
return func(t *testing.T) {
for _, r := range j.flushLoginRequests {
_, err := cm.GetLoginRequest(ctx, r.ID)
// Login requests should never be persisted.
require.Error(t, err)
}
}
}
func (j *JanitorConsentTestHelper) ConsentTimeoutSetup(ctx context.Context, reg interface {
consent.ManagerProvider
client.ManagerProvider
flow.CipherProvider
}) func(t *testing.T) {
cl := reg.ClientManager()
cm := reg.ConsentManager()
return func(t *testing.T) {
// Let's reset and accept all login requests to test the consent requests
for i, loginRequest := range j.flushLoginRequests {
require.NoError(t, cl.CreateClient(ctx, loginRequest.Client))
f, err := cm.CreateLoginRequest(ctx, loginRequest)
require.NoError(t, err)
f.RequestedAt = time.Now() // we won't handle expired flows
challenge := x.Must(f.ToLoginChallenge(ctx, reg))
_, err = cm.HandleLoginRequest(ctx, f, challenge, &flow.HandledLoginRequest{
ID: loginRequest.ID,
AuthenticatedAt: loginRequest.AuthenticatedAt,
RequestedAt: loginRequest.RequestedAt,
WasHandled: true,
})
require.NoError(t, err)
// Create consent requests
consentRequest := j.flushConsentRequests[i]
err = cm.CreateConsentRequest(ctx, f, consentRequest)
require.NoError(t, err)
if i == 0 {
// Create at least 1 consent request that has been accepted
_, err = cm.HandleConsentRequest(ctx, f, &flow.AcceptOAuth2ConsentRequest{
ID: consentRequest.ID,
WasHandled: true,
HandledAt: sqlxx.NullTime(time.Now()),
RequestedAt: consentRequest.RequestedAt,
AuthenticatedAt: consentRequest.AuthenticatedAt,
})
require.NoError(t, err)
}
}
}
}
func (j *JanitorConsentTestHelper) ConsentTimeoutValidate(ctx context.Context, cm consent.Manager) func(t *testing.T) {
return func(t *testing.T) {
var err error
for _, r := range j.flushConsentRequests {
_, err = cm.GetConsentRequest(ctx, r.ID)
require.Error(t, err, "Unverified consent requests are never pesisted")
}
}
}
func (j *JanitorConsentTestHelper) LoginConsentNotAfterSetup(ctx context.Context, cm consent.Manager, cl client.Manager) func(t *testing.T) {
return func(t *testing.T) {
var (
f *flow.Flow
err error
)
for _, r := range j.flushLoginRequests {
require.NoError(t, cl.CreateClient(ctx, r.Client))
f, err = cm.CreateLoginRequest(ctx, r)
require.NoError(t, err)
}
for _, r := range j.flushConsentRequests {
f.ID = r.LoginChallenge.String()
err = cm.CreateConsentRequest(ctx, f, r)
require.NoError(t, err)
}
}
}
func (j *JanitorConsentTestHelper) LoginConsentNotAfterValidate(
ctx context.Context,
notAfter time.Time,
consentRequestLifespan time.Time,
reg interface {
consent.ManagerProvider
flow.CipherProvider
},
) func(t *testing.T) {
return func(t *testing.T) {
var (
err error
f *flow.Flow
)
for _, r := range j.flushLoginRequests {
isExpired := r.RequestedAt.Before(consentRequestLifespan)
t.Logf("login flush check:\nNotAfter: %s\nLoginRequest: %s\nis expired: %v\n%+v\n",
notAfter.String(), consentRequestLifespan.String(), isExpired, r)
f = x.Must(reg.ConsentManager().CreateLoginRequest(ctx, r))
loginChallenge := x.Must(f.ToLoginChallenge(ctx, reg))
_, err = reg.ConsentManager().GetLoginRequest(ctx, loginChallenge)
// if the lowest between notAfter and consent-request-lifespan is greater than requested_at
// then the it should expect the value to be deleted.
if isExpired {
// value has been deleted here
require.Error(t, err)
} else {
// value has not been deleted here
require.NoError(t, err)
}
}
for _, r := range j.flushConsentRequests {
isExpired := r.RequestedAt.Before(consentRequestLifespan)
t.Logf("consent flush check:\nNotAfter: %s\nConsentRequest: %s\nis expired: %v\n%+v\n",
notAfter.String(), consentRequestLifespan.String(), isExpired, r)
f.ID = r.LoginChallenge.String()
require.NoError(t, reg.ConsentManager().CreateConsentRequest(ctx, f, r))
f.RequestedAt = r.RequestedAt
consentChallenge := x.Must(f.ToConsentChallenge(ctx, reg))
_, err = reg.ConsentManager().GetConsentRequest(ctx, consentChallenge)
// if the lowest between notAfter and consent-request-lifespan is greater than requested_at
// then the it should expect the value to be deleted.
if isExpired {
// value has been deleted here
require.Error(t, err)
} else {
// value has not been deleted here
require.NoError(t, err)
}
}
}
}
func (j *JanitorConsentTestHelper) GetConsentRequestLifespan(ctx context.Context) time.Duration {
return j.conf.ConsentRequestMaxAge(ctx)
}
func (j *JanitorConsentTestHelper) GetAccessTokenLifespan(ctx context.Context) time.Duration {
return j.conf.GetAccessTokenLifespan(ctx)
}
func (j *JanitorConsentTestHelper) GetRefreshTokenLifespan(ctx context.Context) time.Duration {
return j.conf.GetRefreshTokenLifespan(ctx)
}
func (j *JanitorConsentTestHelper) notAfterCheck(notAfter time.Time, lifespan time.Time, requestedAt time.Time) bool {
// The database deletes where requested_at time is smaller than the lowest between notAfter and consent-request-lifespan
// thus we get the lowest value here first to compare later to requested_at
var lesser time.Time
// if the lowest between notAfter and consent-request-lifespan is greater than requested_at
// then the it should expect the value to be deleted.
if notAfter.Unix() < lifespan.Unix() {
lesser = notAfter
} else {
lesser = lifespan
}
// true: value has been deleted
// false: value still exists
return lesser.Unix() > requestedAt.Unix()
}
func JanitorTests(
reg interface {
ConsentManager() consent.Manager
OAuth2Storage() x.FositeStorer
config.Provider
client.ManagerProvider
flow.CipherProvider
},
network string,
parallel bool,
) func(t *testing.T) {
return func(t *testing.T) {
consentManager := reg.ConsentManager()
clientManager := reg.ClientManager()
fositeManager := reg.OAuth2Storage()
if parallel {
t.Parallel()
}
ctx := context.Background()
jt := NewConsentJanitorTestHelper(network + t.Name())
reg.Config().MustSet(context.Background(), config.KeyConsentRequestMaxAge, jt.GetConsentRequestLifespan(ctx))
t.Run("case=flush-consent-request-not-after", func(t *testing.T) {
notAfterTests := jt.GetNotAfterTestCycles()
for k, v := range notAfterTests {
jt := NewConsentJanitorTestHelper(network + k)
t.Run(fmt.Sprintf("case=%s", k), func(t *testing.T) {
notAfter := time.Now().Round(time.Second).Add(-v)
consentRequestLifespan := time.Now().Round(time.Second).Add(-jt.GetConsentRequestLifespan(ctx))
// setup test
t.Run("step=setup", jt.LoginConsentNotAfterSetup(ctx, consentManager, clientManager))
// run the cleanup routine
t.Run("step=cleanup", func(t *testing.T) {
require.NoError(t, fositeManager.FlushInactiveLoginConsentRequests(ctx, notAfter, 1000, 100))
})
// validate test
t.Run("step=validate", jt.LoginConsentNotAfterValidate(ctx, notAfter, consentRequestLifespan, reg))
})
}
})
t.Run("case=flush-consent-request-limit", func(t *testing.T) {
jt := NewConsentJanitorTestHelper(network + "limit")
t.Run("case=limit", func(t *testing.T) {
// setup
t.Run("step=setup", jt.LimitSetup(ctx, reg))
// cleanup
t.Run("step=cleanup", func(t *testing.T) {
require.NoError(t, fositeManager.FlushInactiveLoginConsentRequests(ctx, time.Now().Round(time.Second), 2, 1))
})
// validate
t.Run("step=validate", jt.LimitValidate(ctx, consentManager))
})
})
t.Run("case=flush-consent-request-rejection", func(t *testing.T) {
jt := NewConsentJanitorTestHelper(network + "loginRejection")
t.Run(fmt.Sprintf("case=%s", "loginRejection"), func(t *testing.T) {
// setup
t.Run("step=setup", jt.LoginRejectionSetup(ctx, reg))
// cleanup
t.Run("step=cleanup", func(t *testing.T) {
require.NoError(t, fositeManager.FlushInactiveLoginConsentRequests(ctx, time.Now().Round(time.Second), 1000, 100))
})
// validate
t.Run("step=validate", jt.LoginRejectionValidate(ctx, consentManager))
})
jt = NewConsentJanitorTestHelper(network + "consentRejection")
t.Run(fmt.Sprintf("case=%s", "consentRejection"), func(t *testing.T) {
// setup
t.Run("step=setup", jt.ConsentRejectionSetup(ctx, reg))
// cleanup
t.Run("step=cleanup", func(t *testing.T) {
require.NoError(t, fositeManager.FlushInactiveLoginConsentRequests(ctx, time.Now().Round(time.Second), 1000, 100))
})
// validate
t.Run("step=validate", jt.ConsentRejectionValidate(ctx, consentManager))
})
})
t.Run("case=flush-consent-request-timeout", func(t *testing.T) {
jt := NewConsentJanitorTestHelper(network + "loginTimeout")
t.Run(fmt.Sprintf("case=%s", "login-timeout"), func(t *testing.T) {
// setup
t.Run("step=setup", jt.LoginTimeoutSetup(ctx, reg))
// cleanup
t.Run("step=cleanup", func(t *testing.T) {
require.NoError(t, fositeManager.FlushInactiveLoginConsentRequests(ctx, time.Now().Round(time.Second), 1000, 100))
})
// validate
t.Run("step=validate", jt.LoginTimeoutValidate(ctx, consentManager))
})
jt = NewConsentJanitorTestHelper(network + "consentTimeout")
t.Run(fmt.Sprintf("case=%s", "consent-timeout"), func(t *testing.T) {
// setup
t.Run("step=setup", jt.ConsentTimeoutSetup(ctx, reg))
// cleanup
t.Run("step=cleanup", func(t *testing.T) {
require.NoError(t, fositeManager.FlushInactiveLoginConsentRequests(ctx, time.Now().Round(time.Second), 1000, 100))
})
// validate
t.Run("step=validate", jt.ConsentTimeoutValidate(ctx, consentManager))
})
})
}
}
func getAccessRequests(uniqueName string, lifespan time.Duration) []*fosite.Request {
return []*fosite.Request{
{
ID: fmt.Sprintf("%s_flush-access-1", uniqueName),
RequestedAt: time.Now().Round(time.Second),
Client: &client.Client{LegacyClientID: fmt.Sprintf("%s_flush-access-1", uniqueName)},
RequestedScope: fosite.Arguments{"fa", "ba"},
GrantedScope: fosite.Arguments{"fa", "ba"},
Form: url.Values{"foo": []string{"bar", "baz"}},
Session: &oauth2.Session{DefaultSession: &openid.DefaultSession{Subject: "bar"}},
},
{
ID: fmt.Sprintf("%s_flush-access-2", uniqueName),
RequestedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Minute)),
Client: &client.Client{LegacyClientID: fmt.Sprintf("%s_flush-access-2", uniqueName)},
RequestedScope: fosite.Arguments{"fa", "ba"},
GrantedScope: fosite.Arguments{"fa", "ba"},
Form: url.Values{"foo": []string{"bar", "baz"}},
Session: &oauth2.Session{DefaultSession: &openid.DefaultSession{Subject: "bar"}},
},
{
ID: fmt.Sprintf("%s_flush-access-3", uniqueName),
RequestedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Hour)),
Client: &client.Client{LegacyClientID: fmt.Sprintf("%s_flush-access-3", uniqueName)},
RequestedScope: fosite.Arguments{"fa", "ba"},
GrantedScope: fosite.Arguments{"fa", "ba"},
Form: url.Values{"foo": []string{"bar", "baz"}},
Session: &oauth2.Session{DefaultSession: &openid.DefaultSession{Subject: "bar"}},
},
}
}
func getRefreshRequests(uniqueName string, lifespan time.Duration) []*fosite.AccessRequest {
var tokenSignature = "4c7c7e8b3a77ad0c3ec846a21653c48b45dbfa31" //nolint:gosec
return []*fosite.AccessRequest{
{
GrantTypes: []string{
"refresh_token",
},
Request: fosite.Request{
RequestedAt: time.Now().Round(time.Second),
ID: fmt.Sprintf("%s_flush-refresh-1", uniqueName),
Client: &client.Client{LegacyClientID: fmt.Sprintf("%s_flush-refresh-1", uniqueName)},
RequestedScope: []string{"offline"},
GrantedScope: []string{"offline"},
Session: &oauth2.Session{DefaultSession: &openid.DefaultSession{Subject: "bar"}},
Form: url.Values{
"refresh_token": []string{fmt.Sprintf("%s.%s", fmt.Sprintf("%s_flush-refresh-1", uniqueName), tokenSignature)},
},
},
},
{
GrantTypes: []string{
"refresh_token",
},
Request: fosite.Request{
RequestedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Minute)),
ID: fmt.Sprintf("%s_flush-refresh-2", uniqueName),
Client: &client.Client{LegacyClientID: fmt.Sprintf("%s_flush-refresh-2", uniqueName)},
RequestedScope: []string{"offline"},
GrantedScope: []string{"offline"},
Session: &oauth2.Session{DefaultSession: &openid.DefaultSession{Subject: "bar"}},
Form: url.Values{
"refresh_token": []string{fmt.Sprintf("%s.%s", fmt.Sprintf("%s_flush-refresh-2", uniqueName), tokenSignature)},
},
},
},
{
GrantTypes: []string{
"refresh_token",
},
Request: fosite.Request{
RequestedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Hour)),
ID: fmt.Sprintf("%s_flush-refresh-3", uniqueName),
Client: &client.Client{LegacyClientID: fmt.Sprintf("%s_flush-refresh-3", uniqueName)},
RequestedScope: []string{"offline"},
GrantedScope: []string{"offline"},
Session: &oauth2.Session{DefaultSession: &openid.DefaultSession{Subject: "bar"}},
Form: url.Values{
"refresh_token": []string{fmt.Sprintf("%s.%s", fmt.Sprintf("%s_flush-refresh-3", uniqueName), tokenSignature)},
},
},
},
}
}
func genLoginRequests(uniqueName string, lifespan time.Duration) []*flow.LoginRequest {
return []*flow.LoginRequest{
{
ID: fmt.Sprintf("%s_flush-login-1", uniqueName),
RequestedScope: []string{"foo", "bar"},
Subject: fmt.Sprintf("%s_flush-login-1", uniqueName),
Client: &client.Client{
LegacyClientID: fmt.Sprintf("%s_flush-login-consent-1", uniqueName),
RedirectURIs: []string{"http://redirect"},
},
RequestURL: "http://redirect",
RequestedAt: time.Now().Round(time.Second),
AuthenticatedAt: sqlxx.NullTime(time.Now().Round(time.Second)),
Verifier: fmt.Sprintf("%s_flush-login-1", uniqueName),
},
{
ID: fmt.Sprintf("%s_flush-login-2", uniqueName),
RequestedScope: []string{"foo", "bar"},
Subject: fmt.Sprintf("%s_flush-login-2", uniqueName),
Client: &client.Client{
LegacyClientID: fmt.Sprintf("%s_flush-login-consent-2", uniqueName),
RedirectURIs: []string{"http://redirect"},
},
RequestURL: "http://redirect",
RequestedAt: time.Now().Round(time.Second).Add(-(lifespan + 10*time.Minute)),
AuthenticatedAt: sqlxx.NullTime(time.Now().Round(time.Second).Add(-(lifespan + 10*time.Minute))),
Verifier: fmt.Sprintf("%s_flush-login-2", uniqueName),
},
{
ID: fmt.Sprintf("%s_flush-login-3", uniqueName),
RequestedScope: []string{"foo", "bar"},
Subject: fmt.Sprintf("%s_flush-login-3", uniqueName),
Client: &client.Client{
LegacyClientID: fmt.Sprintf("%s_flush-login-consent-3", uniqueName),
RedirectURIs: []string{"http://redirect"},
},
RequestURL: "http://redirect",
RequestedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Hour)),
AuthenticatedAt: sqlxx.NullTime(time.Now().Round(time.Second).Add(-(lifespan + time.Hour))),
Verifier: fmt.Sprintf("%s_flush-login-3", uniqueName),
},
}
}
func genConsentRequests(uniqueName string, lifespan time.Duration) []*flow.OAuth2ConsentRequest {
return []*flow.OAuth2ConsentRequest{
{
ID: fmt.Sprintf("%s_flush-consent-1", uniqueName),
RequestedScope: []string{"foo", "bar"},
Subject: fmt.Sprintf("%s_flush-consent-1", uniqueName),
OpenIDConnectContext: nil,
ClientID: fmt.Sprintf("%s_flush-login-consent-1", uniqueName),
RequestURL: "http://redirect",
LoginChallenge: sqlxx.NullString(fmt.Sprintf("%s_flush-login-1", uniqueName)),
RequestedAt: time.Now().Round(time.Second),
Verifier: fmt.Sprintf("%s_flush-consent-1", uniqueName),
CSRF: fmt.Sprintf("%s_flush-consent-1", uniqueName),
},
{
ID: fmt.Sprintf("%s_flush-consent-2", uniqueName),
RequestedScope: []string{"foo", "bar"},
Subject: fmt.Sprintf("%s_flush-consent-2", uniqueName),
OpenIDConnectContext: nil,
ClientID: fmt.Sprintf("%s_flush-login-consent-2", uniqueName),
RequestURL: "http://redirect",
LoginChallenge: sqlxx.NullString(fmt.Sprintf("%s_flush-login-2", uniqueName)),
RequestedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Minute)),
Verifier: fmt.Sprintf("%s_flush-consent-2", uniqueName),
CSRF: fmt.Sprintf("%s_flush-consent-2", uniqueName),
},
{
ID: fmt.Sprintf("%s_flush-consent-3", uniqueName),
RequestedScope: []string{"foo", "bar"},
Subject: fmt.Sprintf("%s_flush-consent-3", uniqueName),
OpenIDConnectContext: nil,
ClientID: fmt.Sprintf("%s_flush-login-consent-3", uniqueName),
RequestURL: "http://redirect",
LoginChallenge: sqlxx.NullString(fmt.Sprintf("%s_flush-login-3", uniqueName)),
RequestedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Hour)),
Verifier: fmt.Sprintf("%s_flush-consent-3", uniqueName),
CSRF: fmt.Sprintf("%s_flush-consent-3", uniqueName),
},
}
}
func getGrantRequests(uniqueName string, lifespan time.Duration) []*createGrantRequest {
return []*createGrantRequest{
{
grant: trust.Grant{
ID: uuid.New().String(),
Issuer: fmt.Sprintf("%s_flush-grant-iss-1", uniqueName),
Subject: fmt.Sprintf("%s_flush-grant-sub-1", uniqueName),
Scope: []string{"foo", "bar"},
PublicKey: trust.PublicKey{
Set: fmt.Sprintf("%s_flush-grant-iss-1", uniqueName),
KeyID: fmt.Sprintf("%s_flush-grant-kid-1", uniqueName),
},
CreatedAt: time.Now().Round(time.Second),
ExpiresAt: time.Now().Round(time.Second).Add(lifespan),
},
pk: jose.JSONWebKey{
Key: []byte("asdf"),
KeyID: fmt.Sprintf("%s_flush-grant-kid-1", uniqueName),
},
},
{
grant: trust.Grant{
ID: uuid.New().String(),
Issuer: fmt.Sprintf("%s_flush-grant-iss-2", uniqueName),
Subject: fmt.Sprintf("%s_flush-grant-sub-2", uniqueName),
Scope: []string{"foo", "bar"},
PublicKey: trust.PublicKey{
Set: fmt.Sprintf("%s_flush-grant-iss-2", uniqueName),
KeyID: fmt.Sprintf("%s_flush-grant-kid-2", uniqueName),
},
CreatedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Minute)),
ExpiresAt: time.Now().Round(time.Second).Add(-(lifespan + time.Minute)).Add(lifespan),
},
pk: jose.JSONWebKey{
Key: []byte("asdf"),
KeyID: fmt.Sprintf("%s_flush-grant-kid-2", uniqueName),
},
},
{
grant: trust.Grant{
ID: uuid.New().String(),
Issuer: fmt.Sprintf("%s_flush-grant-iss-3", uniqueName),
Subject: fmt.Sprintf("%s_flush-grant-sub-3", uniqueName),
Scope: []string{"foo", "bar"},
PublicKey: trust.PublicKey{
Set: fmt.Sprintf("%s_flush-grant-iss-3", uniqueName),
KeyID: fmt.Sprintf("%s_flush-grant-kid-3", uniqueName),
},
CreatedAt: time.Now().Round(time.Second).Add(-(lifespan + time.Hour)),
ExpiresAt: time.Now().Round(time.Second).Add(-(lifespan + time.Hour)).Add(lifespan),
},
pk: jose.JSONWebKey{
Key: []byte("asdf"),
KeyID: fmt.Sprintf("%s_flush-grant-kid-3", uniqueName),
},
},
}
} |
Go | hydra/internal/testhelpers/lifespans.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package testhelpers
import (
"time"
"github.com/ory/hydra/v2/client"
"github.com/ory/hydra/v2/x"
)
var TestLifespans = client.Lifespans{
AuthorizationCodeGrantAccessTokenLifespan: x.NullDuration{Duration: 31 * time.Hour, Valid: true},
AuthorizationCodeGrantIDTokenLifespan: x.NullDuration{Duration: 32 * time.Hour, Valid: true},
AuthorizationCodeGrantRefreshTokenLifespan: x.NullDuration{Duration: 33 * time.Hour, Valid: true},
ClientCredentialsGrantAccessTokenLifespan: x.NullDuration{Duration: 34 * time.Hour, Valid: true},
ImplicitGrantAccessTokenLifespan: x.NullDuration{Duration: 35 * time.Hour, Valid: true},
ImplicitGrantIDTokenLifespan: x.NullDuration{Duration: 36 * time.Hour, Valid: true},
JwtBearerGrantAccessTokenLifespan: x.NullDuration{Duration: 37 * time.Hour, Valid: true},
PasswordGrantAccessTokenLifespan: x.NullDuration{Duration: 38 * time.Hour, Valid: true},
PasswordGrantRefreshTokenLifespan: x.NullDuration{Duration: 39 * time.Hour, Valid: true},
RefreshTokenGrantIDTokenLifespan: x.NullDuration{Duration: 40 * time.Hour, Valid: true},
RefreshTokenGrantAccessTokenLifespan: x.NullDuration{Duration: 41 * time.Hour, Valid: true},
RefreshTokenGrantRefreshTokenLifespan: x.NullDuration{Duration: 42 * time.Hour, Valid: true},
} |
Go | hydra/internal/testhelpers/oauth2.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package testhelpers
import (
"bytes"
"context"
"encoding/json"
"errors"
"net/http"
"net/http/cookiejar"
"net/http/httptest"
"net/url"
"strings"
"testing"
"time"
"github.com/stretchr/testify/assert"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
"github.com/ory/fosite/token/jwt"
"github.com/julienschmidt/httprouter"
"github.com/stretchr/testify/require"
"github.com/tidwall/gjson"
"golang.org/x/oauth2"
"github.com/ory/x/httpx"
"github.com/ory/x/ioutilx"
"github.com/ory/hydra/v2/client"
"github.com/ory/hydra/v2/driver"
"github.com/ory/hydra/v2/driver/config"
"github.com/ory/hydra/v2/internal"
"github.com/ory/hydra/v2/x"
)
func NewIDToken(t *testing.T, reg driver.Registry, subject string) string {
return NewIDTokenWithExpiry(t, reg, subject, time.Hour)
}
func NewIDTokenWithExpiry(t *testing.T, reg driver.Registry, subject string, exp time.Duration) string {
token, _, err := reg.OpenIDJWTStrategy().Generate(context.Background(), jwt.IDTokenClaims{
Subject: subject,
ExpiresAt: time.Now().Add(exp),
IssuedAt: time.Now(),
}.ToMapClaims(), jwt.NewHeaders())
require.NoError(t, err)
return token
}
func NewIDTokenWithClaims(t *testing.T, reg driver.Registry, claims jwt.MapClaims) string {
token, _, err := reg.OpenIDJWTStrategy().Generate(context.Background(), claims, jwt.NewHeaders())
require.NoError(t, err)
return token
}
func NewOAuth2Server(ctx context.Context, t testing.TB, reg driver.Registry) (publicTS, adminTS *httptest.Server) {
// Lifespan is two seconds to avoid time synchronization issues with SQL.
reg.Config().MustSet(ctx, config.KeySubjectIdentifierAlgorithmSalt, "76d5d2bf-747f-4592-9fbd-d2b895a54b3a")
reg.Config().MustSet(ctx, config.KeyAccessTokenLifespan, time.Second*2)
reg.Config().MustSet(ctx, config.KeyRefreshTokenLifespan, time.Second*3)
reg.Config().MustSet(ctx, config.PublicInterface.Key(config.KeySuffixTLSEnabled), false)
reg.Config().MustSet(ctx, config.AdminInterface.Key(config.KeySuffixTLSEnabled), false)
reg.Config().MustSet(ctx, config.KeyScopeStrategy, "exact")
public, admin := x.NewRouterPublic(), x.NewRouterAdmin(reg.Config().AdminURL)
internal.MustEnsureRegistryKeys(ctx, reg, x.OpenIDConnectKeyName)
internal.MustEnsureRegistryKeys(ctx, reg, x.OAuth2JWTKeyName)
reg.RegisterRoutes(ctx, admin, public)
publicTS = httptest.NewServer(otelhttp.NewHandler(public, "public", otelhttp.WithSpanNameFormatter(func(_ string, r *http.Request) string {
return r.URL.Path
})))
t.Cleanup(publicTS.Close)
adminTS = httptest.NewServer(otelhttp.NewHandler(admin, "admin", otelhttp.WithSpanNameFormatter(func(_ string, r *http.Request) string {
return r.URL.Path
})))
t.Cleanup(adminTS.Close)
reg.Config().MustSet(ctx, config.KeyIssuerURL, publicTS.URL)
return publicTS, adminTS
}
func DecodeIDToken(t *testing.T, token *oauth2.Token) gjson.Result {
idt, ok := token.Extra("id_token").(string)
require.True(t, ok)
assert.NotEmpty(t, idt)
body, err := x.DecodeSegment(strings.Split(idt, ".")[1])
require.NoError(t, err)
return gjson.ParseBytes(body)
}
func IntrospectToken(t testing.TB, conf *oauth2.Config, token string, adminTS *httptest.Server) gjson.Result {
require.NotEmpty(t, token)
req := httpx.MustNewRequest("POST", adminTS.URL+"/admin/oauth2/introspect",
strings.NewReader((url.Values{"token": {token}}).Encode()),
"application/x-www-form-urlencoded")
req.SetBasicAuth(conf.ClientID, conf.ClientSecret)
res, err := adminTS.Client().Do(req)
require.NoError(t, err)
defer res.Body.Close()
return gjson.ParseBytes(ioutilx.MustReadAll(res.Body))
}
func UpdateClientTokenLifespans(t *testing.T, conf *oauth2.Config, clientID string, lifespans client.Lifespans, adminTS *httptest.Server) {
b, err := json.Marshal(lifespans)
require.NoError(t, err)
req := httpx.MustNewRequest(
"PUT",
adminTS.URL+"/admin"+client.ClientsHandlerPath+"/"+clientID+"/lifespans",
bytes.NewBuffer(b),
"application/json",
)
req.SetBasicAuth(conf.ClientID, conf.ClientSecret)
res, err := adminTS.Client().Do(req)
require.NoError(t, err)
defer res.Body.Close()
require.Equal(t, res.StatusCode, http.StatusOK)
}
func Userinfo(t *testing.T, token *oauth2.Token, publicTS *httptest.Server) gjson.Result {
require.NotEmpty(t, token.AccessToken)
req := httpx.MustNewRequest("GET", publicTS.URL+"/userinfo", nil, "")
req.Header.Set("Authorization", "Bearer "+token.AccessToken)
res, err := publicTS.Client().Do(req)
require.NoError(t, err)
defer res.Body.Close()
return gjson.ParseBytes(ioutilx.MustReadAll(res.Body))
}
func HTTPServerNotImplementedHandler(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNotImplemented)
}
func HTTPServerNoExpectedCallHandler(t testing.TB) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
t.Fatal("This should not have been called")
}
}
func NewLoginConsentUI(t testing.TB, c *config.DefaultProvider, login, consent http.HandlerFunc) {
if login == nil {
login = HTTPServerNotImplementedHandler
}
if consent == nil {
login = HTTPServerNotImplementedHandler
}
lt := httptest.NewServer(login)
ct := httptest.NewServer(consent)
t.Cleanup(lt.Close)
t.Cleanup(ct.Close)
c.MustSet(context.Background(), config.KeyLoginURL, lt.URL)
c.MustSet(context.Background(), config.KeyConsentURL, ct.URL)
}
func NewCallbackURL(t testing.TB, prefix string, h http.HandlerFunc) string {
if h == nil {
h = HTTPServerNotImplementedHandler
}
r := httprouter.New()
r.GET("/"+prefix, func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
h(w, r)
})
ts := httptest.NewServer(r)
t.Cleanup(ts.Close)
return ts.URL + "/" + prefix
}
func NewEmptyCookieJar(t testing.TB) *cookiejar.Jar {
c, err := cookiejar.New(&cookiejar.Options{})
require.NoError(t, err)
return c
}
func NewEmptyJarClient(t testing.TB) *http.Client {
return &http.Client{
Jar: NewEmptyCookieJar(t),
Transport: &loggingTransport{t},
CheckRedirect: func(req *http.Request, via []*http.Request) error {
//t.Logf("Redirect to %s", req.URL.String())
if len(via) >= 20 {
for k, v := range via {
t.Logf("Failed with redirect (%d): %s", k, v.URL.String())
}
return errors.New("stopped after 20 redirects")
}
return nil
},
}
}
type loggingTransport struct{ t testing.TB }
func (s *loggingTransport) RoundTrip(r *http.Request) (*http.Response, error) {
//s.t.Logf("%s %s", r.Method, r.URL.String())
//s.t.Logf("%s %s\nWith Cookies: %v", r.Method, r.URL.String(), r.Cookies())
return otelhttp.DefaultClient.Transport.RoundTrip(r)
} |
Go | hydra/internal/testhelpers/server.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package testhelpers
import (
"net/http"
"net/http/httptest"
"testing"
)
func FlexibleServer(t *testing.T, h *http.HandlerFunc) string {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
(*h)(w, r)
}))
t.Cleanup(ts.Close)
return ts.URL
} |
Go | hydra/internal/testhelpers/uuid/uuid.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package uuid
import (
"testing"
"github.com/gofrs/uuid"
"github.com/stretchr/testify/require"
)
// AssertUUID helper requires that a UUID is non-zero, common version/variant used in Hydra.
func AssertUUID(t *testing.T, id *uuid.UUID) {
require.Equal(t, id.Version(), uuid.V4)
require.Equal(t, id.Variant(), uuid.VariantRFC4122)
} |
Go | hydra/jwk/cast.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"crypto/rsa"
"github.com/ory/x/josex"
jose "github.com/go-jose/go-jose/v3"
"github.com/pkg/errors"
)
func MustRSAPublic(key *jose.JSONWebKey) *rsa.PublicKey {
res, err := ToRSAPublic(key)
if err != nil {
panic(err.Error())
}
return res
}
func ToRSAPublic(key *jose.JSONWebKey) (*rsa.PublicKey, error) {
pk := josex.ToPublicKey(key)
res, ok := pk.Key.(*rsa.PublicKey)
if !ok {
return res, errors.Errorf("Could not convert key to RSA Public Key, got: %T", pk.Key)
}
return res, nil
}
func MustRSAPrivate(key *jose.JSONWebKey) *rsa.PrivateKey {
res, err := ToRSAPrivate(key)
if err != nil {
panic(err.Error())
}
return res
}
func ToRSAPrivate(key *jose.JSONWebKey) (*rsa.PrivateKey, error) {
res, ok := key.Key.(*rsa.PrivateKey)
if !ok {
return res, errors.New("Could not convert key to RSA Private Key.")
}
return res, nil
} |
Go | hydra/jwk/cast_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"context"
"testing"
"github.com/go-jose/go-jose/v3"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/assert"
)
func TestMustRSAPrivate(t *testing.T) {
t.Parallel()
keys, err := GenerateJWK(context.Background(), jose.RS256, "foo", "sig")
require.NoError(t, err)
priv := keys.Key("foo")[0]
_, err = ToRSAPrivate(&priv)
assert.Nil(t, err)
MustRSAPrivate(&priv)
pub := keys.Key("foo")[0].Public()
_, err = ToRSAPublic(&pub)
assert.Nil(t, err)
MustRSAPublic(&pub)
} |
Go | hydra/jwk/generate.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"context"
"crypto/x509"
"github.com/gofrs/uuid"
"github.com/go-jose/go-jose/v3"
"github.com/pkg/errors"
"github.com/ory/x/josex"
)
func GenerateJWK(ctx context.Context, alg jose.SignatureAlgorithm, kid, use string) (*jose.JSONWebKeySet, error) {
bits := 0
if alg == jose.RS256 || alg == jose.RS384 || alg == jose.RS512 {
bits = 4096
}
_, priv, err := josex.NewSigningKey(alg, bits)
if err != nil {
return nil, errors.Wrapf(ErrUnsupportedKeyAlgorithm, "%s", err)
}
if len(kid) == 0 {
kid = uuid.Must(uuid.NewV4()).String()
}
if len(use) == 0 {
use = "sig"
}
return &jose.JSONWebKeySet{
Keys: []jose.JSONWebKey{
{
Algorithm: string(alg),
Key: priv,
Use: use,
KeyID: kid,
Certificates: []*x509.Certificate{},
CertificateThumbprintSHA256: []byte{},
CertificateThumbprintSHA1: []byte{},
},
},
}, nil
} |
Go | hydra/jwk/generate_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"context"
"testing"
"github.com/go-jose/go-jose/v3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestGenerateJWK(t *testing.T) {
t.Parallel()
jwks, err := GenerateJWK(context.Background(), jose.RS256, "", "")
require.NoError(t, err)
assert.NotEmpty(t, jwks.Keys[0].KeyID)
assert.EqualValues(t, jose.RS256, jwks.Keys[0].Algorithm)
assert.EqualValues(t, "sig", jwks.Keys[0].Use)
} |
Go | hydra/jwk/generator.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import jose "github.com/go-jose/go-jose/v3"
type KeyGenerator interface {
Generate(id, use string) (*jose.JSONWebKeySet, error)
} |
Go | hydra/jwk/handler.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"encoding/json"
"net/http"
"golang.org/x/sync/errgroup"
"github.com/ory/herodot"
"github.com/ory/x/httprouterx"
"github.com/gofrs/uuid"
"github.com/pkg/errors"
"github.com/ory/x/urlx"
"github.com/ory/x/errorsx"
"github.com/ory/x/stringslice"
"github.com/ory/hydra/v2/x"
jose "github.com/go-jose/go-jose/v3"
"github.com/julienschmidt/httprouter"
)
const (
KeyHandlerPath = "/keys"
WellKnownKeysPath = "/.well-known/jwks.json"
)
type Handler struct {
r InternalRegistry
}
// JSON Web Key Set
//
// swagger:model jsonWebKeySet
//
//lint:ignore U1000 Used to generate Swagger and OpenAPI definitions
type jsonWebKeySet struct {
// List of JSON Web Keys
//
// The value of the "keys" parameter is an array of JSON Web Key (JWK)
// values. By default, the order of the JWK values within the array does
// not imply an order of preference among them, although applications
// of JWK Sets can choose to assign a meaning to the order for their
// purposes, if desired.
Keys []x.JSONWebKey `json:"keys"`
}
func NewHandler(r InternalRegistry) *Handler {
return &Handler{r: r}
}
func (h *Handler) SetRoutes(admin *httprouterx.RouterAdmin, public *httprouterx.RouterPublic, corsMiddleware func(http.Handler) http.Handler) {
public.Handler("OPTIONS", WellKnownKeysPath, corsMiddleware(http.HandlerFunc(h.handleOptions)))
public.Handler("GET", WellKnownKeysPath, corsMiddleware(http.HandlerFunc(h.discoverJsonWebKeys)))
admin.GET(KeyHandlerPath+"/:set/:key", h.getJsonWebKey)
admin.GET(KeyHandlerPath+"/:set", h.getJsonWebKeySet)
admin.POST(KeyHandlerPath+"/:set", h.createJsonWebKeySet)
admin.PUT(KeyHandlerPath+"/:set/:key", h.adminUpdateJsonWebKey)
admin.PUT(KeyHandlerPath+"/:set", h.setJsonWebKeySet)
admin.DELETE(KeyHandlerPath+"/:set/:key", h.deleteJsonWebKey)
admin.DELETE(KeyHandlerPath+"/:set", h.adminDeleteJsonWebKeySet)
}
// swagger:route GET /.well-known/jwks.json wellknown discoverJsonWebKeys
//
// # Discover Well-Known JSON Web Keys
//
// This endpoint returns JSON Web Keys required to verifying OpenID Connect ID Tokens and,
// if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like
// [node-jwks-rsa](https://github.com/auth0/node-jwks-rsa) among others.
//
// Consumes:
// - application/json
//
// Produces:
// - application/json
//
// Schemes: http, https
//
// Responses:
// 200: jsonWebKeySet
// default: errorOAuth2
func (h *Handler) discoverJsonWebKeys(w http.ResponseWriter, r *http.Request) {
eg, ctx := errgroup.WithContext(r.Context())
wellKnownKeys := stringslice.Unique(h.r.Config().WellKnownKeys(ctx))
keys := make(chan *jose.JSONWebKeySet, len(wellKnownKeys))
for _, set := range wellKnownKeys {
set := set
eg.Go(func() error {
k, err := h.r.KeyManager().GetKeySet(ctx, set)
if errors.Is(err, x.ErrNotFound) {
h.r.Logger().Warnf("JSON Web Key Set %q does not exist yet, generating new key pair...", set)
k, err = h.r.KeyManager().GenerateAndPersistKeySet(ctx, set, uuid.Must(uuid.NewV4()).String(), string(jose.RS256), "sig")
if err != nil {
return err
}
} else if err != nil {
return err
}
keys <- ExcludePrivateKeys(k)
return nil
})
}
if err := eg.Wait(); err != nil {
h.r.Writer().WriteError(w, r, err)
return
}
close(keys)
var jwks jose.JSONWebKeySet
for k := range keys {
jwks.Keys = append(jwks.Keys, k.Keys...)
}
h.r.Writer().Write(w, r, &jwks)
}
// Get JSON Web Key Request
//
// swagger:parameters getJsonWebKey
//
//lint:ignore U1000 Used to generate Swagger and OpenAPI definitions
type getJsonWebKey struct {
// JSON Web Key Set ID
//
// in: path
// required: true
Set string `json:"set"`
// JSON Web Key ID
//
// in: path
// required: true
KID string `json:"kid"`
}
// swagger:route GET /admin/keys/{set}/{kid} jwk getJsonWebKey
//
// # Get JSON Web Key
//
// This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid).
//
// Consumes:
// - application/json
//
// Produces:
// - application/json
//
// Schemes: http, https
//
// Responses:
// 200: jsonWebKeySet
// default: errorOAuth2
func (h *Handler) getJsonWebKey(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
var setName = ps.ByName("set")
var keyName = ps.ByName("key")
keys, err := h.r.KeyManager().GetKey(r.Context(), setName, keyName)
if err != nil {
h.r.Writer().WriteError(w, r, err)
return
}
keys = ExcludeOpaquePrivateKeys(keys)
h.r.Writer().Write(w, r, keys)
}
// Get JSON Web Key Set Parameters
//
// swagger:parameters getJsonWebKeySet
//
//lint:ignore U1000 Used to generate Swagger and OpenAPI definitions
type getJsonWebKeySet struct {
// JSON Web Key Set ID
//
// in: path
// required: true
Set string `json:"set"`
}
// swagger:route GET /admin/keys/{set} jwk getJsonWebKeySet
//
// # Retrieve a JSON Web Key Set
//
// This endpoint can be used to retrieve JWK Sets stored in ORY Hydra.
//
// A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
//
// Consumes:
// - application/json
//
// Produces:
// - application/json
//
// Schemes: http, https
//
// Responses:
// 200: jsonWebKeySet
// default: errorOAuth2
func (h *Handler) getJsonWebKeySet(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
var setName = ps.ByName("set")
keys, err := h.r.KeyManager().GetKeySet(r.Context(), setName)
if err != nil {
h.r.Writer().WriteError(w, r, err)
return
}
keys = ExcludeOpaquePrivateKeys(keys)
h.r.Writer().Write(w, r, keys)
}
// Create JSON Web Key Set Request
//
// swagger:parameters createJsonWebKeySet
//
//lint:ignore U1000 Used to generate Swagger and OpenAPI definitions
type adminCreateJsonWebKeySet struct {
// The JSON Web Key Set ID
//
// in: path
// required: true
Set string `json:"set"`
// in: body
// required: true
Body createJsonWebKeySetBody
}
// Create JSON Web Key Set Request Body
//
// swagger:model createJsonWebKeySet
type createJsonWebKeySetBody struct {
// JSON Web Key Algorithm
//
// The algorithm to be used for creating the key. Supports `RS256`, `ES256`, `ES512`, `HS512`, and `HS256`.
//
// required: true
Algorithm string `json:"alg"`
// JSON Web Key Use
//
// The "use" (public key use) parameter identifies the intended use of
// the public key. The "use" parameter is employed to indicate whether
// a public key is used for encrypting data or verifying the signature
// on data. Valid values are "enc" and "sig".
// required: true
Use string `json:"use"`
// JSON Web Key ID
//
// The Key ID of the key to be created.
//
// required: true
KeyID string `json:"kid"`
}
// swagger:route POST /admin/keys/{set} jwk createJsonWebKeySet
//
// # Create JSON Web Key
//
// This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created.
//
// A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
//
// Consumes:
// - application/json
//
// Produces:
// - application/json
//
// Schemes: http, https
//
// Responses:
// 201: jsonWebKeySet
// default: errorOAuth2
func (h *Handler) createJsonWebKeySet(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
var keyRequest createJsonWebKeySetBody
var set = ps.ByName("set")
if err := json.NewDecoder(r.Body).Decode(&keyRequest); err != nil {
h.r.Writer().WriteError(w, r, errorsx.WithStack(herodot.ErrBadRequest.WithReasonf("Unable to decode the request body: %s", err)))
return
}
if keys, err := h.r.KeyManager().GenerateAndPersistKeySet(r.Context(), set, keyRequest.KeyID, keyRequest.Algorithm, keyRequest.Use); err == nil {
keys = ExcludeOpaquePrivateKeys(keys)
h.r.Writer().WriteCreated(w, r, urlx.AppendPaths(h.r.Config().IssuerURL(r.Context()), "/keys/"+set).String(), keys)
} else {
h.r.Writer().WriteError(w, r, err)
}
}
// Set JSON Web Key Set Request
//
// swagger:parameters setJsonWebKeySet
//
//lint:ignore U1000 Used to generate Swagger and OpenAPI definitions
type setJsonWebKeySet struct {
// The JSON Web Key Set ID
//
// in: path
// required: true
Set string `json:"set"`
// in: body
Body jsonWebKeySet
}
// swagger:route PUT /admin/keys/{set} jwk setJsonWebKeySet
//
// # Update a JSON Web Key Set
//
// Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.
//
// A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
//
// Consumes:
// - application/json
//
// Produces:
// - application/json
//
// Schemes: http, https
//
// Responses:
// 200: jsonWebKeySet
// default: errorOAuth2
func (h *Handler) setJsonWebKeySet(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
var keySet jose.JSONWebKeySet
var set = ps.ByName("set")
if err := json.NewDecoder(r.Body).Decode(&keySet); err != nil {
h.r.Writer().WriteError(w, r, errorsx.WithStack(herodot.ErrBadRequest.WithReasonf("Unable to decode the request body: %s", err)))
return
}
if err := h.r.KeyManager().UpdateKeySet(r.Context(), set, &keySet); err != nil {
h.r.Writer().WriteError(w, r, err)
return
}
h.r.Writer().Write(w, r, &keySet)
}
// Set JSON Web Key Request
//
// swagger:parameters setJsonWebKey
//
//lint:ignore U1000 Used to generate Swagger and OpenAPI definitions
type setJsonWebKey struct {
// The JSON Web Key Set ID
//
// in: path
// required: true
Set string `json:"set"`
// JSON Web Key ID
//
// in: path
// required: true
KID string `json:"kid"`
// in: body
Body x.JSONWebKey
}
// swagger:route PUT /admin/keys/{set}/{kid} jwk setJsonWebKey
//
// # Set JSON Web Key
//
// Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.
//
// A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
//
// Consumes:
// - application/json
//
// Produces:
// - application/json
//
// Schemes: http, https
//
// Responses:
// 200: jsonWebKey
// default: errorOAuth2
func (h *Handler) adminUpdateJsonWebKey(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
var key jose.JSONWebKey
var set = ps.ByName("set")
if err := json.NewDecoder(r.Body).Decode(&key); err != nil {
h.r.Writer().WriteError(w, r, errorsx.WithStack(herodot.ErrBadRequest.WithReasonf("Unable to decode the request body: %s", err)))
return
}
if err := h.r.KeyManager().UpdateKey(r.Context(), set, &key); err != nil {
h.r.Writer().WriteError(w, r, err)
return
}
h.r.Writer().Write(w, r, key)
}
// Delete JSON Web Key Set Parameters
//
// swagger:parameters deleteJsonWebKeySet
//
//lint:ignore U1000 Used to generate Swagger and OpenAPI definitions
type deleteJsonWebKeySet struct {
// The JSON Web Key Set
// in: path
// required: true
Set string `json:"set"`
}
// swagger:route DELETE /admin/keys/{set} jwk deleteJsonWebKeySet
//
// # Delete JSON Web Key Set
//
// Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set.
//
// A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
//
// Consumes:
// - application/json
//
// Produces:
// - application/json
//
// Schemes: http, https
//
// Responses:
// 204: emptyResponse
// default: errorOAuth2
func (h *Handler) adminDeleteJsonWebKeySet(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
var setName = ps.ByName("set")
if err := h.r.KeyManager().DeleteKeySet(r.Context(), setName); err != nil {
h.r.Writer().WriteError(w, r, err)
return
}
w.WriteHeader(http.StatusNoContent)
}
// Delete JSON Web Key Parameters
//
// swagger:parameters deleteJsonWebKey
//
//lint:ignore U1000 Used to generate Swagger and OpenAPI definitions
type deleteJsonWebKey struct {
// The JSON Web Key Set
// in: path
// required: true
Set string `json:"set"`
// The JSON Web Key ID (kid)
//
// in: path
// required: true
KID string `json:"kid"`
}
// swagger:route DELETE /admin/keys/{set}/{kid} jwk deleteJsonWebKey
//
// # Delete JSON Web Key
//
// Use this endpoint to delete a single JSON Web Key.
//
// A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A
// JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses
// this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens),
// and allows storing user-defined keys as well.
//
// Consumes:
// - application/json
//
// Produces:
// - application/json
//
// Schemes: http, https
//
// Responses:
// 204: emptyResponse
// default: errorOAuth2
func (h *Handler) deleteJsonWebKey(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
var setName = ps.ByName("set")
var keyName = ps.ByName("key")
if err := h.r.KeyManager().DeleteKey(r.Context(), setName, keyName); err != nil {
h.r.Writer().WriteError(w, r, err)
return
}
w.WriteHeader(http.StatusNoContent)
}
// This function will not be called, OPTIONS request will be handled by cors
// this is just a placeholder.
func (h *Handler) handleOptions(w http.ResponseWriter, r *http.Request) {} |
Go | hydra/jwk/handler_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk_test
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"github.com/ory/x/httprouterx"
"github.com/ory/hydra/v2/jwk"
"github.com/ory/x/contextx"
"github.com/go-jose/go-jose/v3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/ory/hydra/v2/driver/config"
"github.com/ory/hydra/v2/internal"
"github.com/ory/hydra/v2/x"
)
func TestHandlerWellKnown(t *testing.T) {
t.Parallel()
conf := internal.NewConfigurationWithDefaults()
reg := internal.NewRegistryMemory(t, conf, &contextx.Default{})
conf.MustSet(context.Background(), config.KeyWellKnownKeys, []string{x.OpenIDConnectKeyName, x.OpenIDConnectKeyName})
router := x.NewRouterPublic()
h := reg.KeyHandler()
h.SetRoutes(httprouterx.NewRouterAdminWithPrefixAndRouter(router.Router, "/admin", conf.AdminURL), router, func(h http.Handler) http.Handler {
return h
})
testServer := httptest.NewServer(router)
JWKPath := "/.well-known/jwks.json"
t.Run("Test_Handler_WellKnown/Run_public_key_With_public_prefix", func(t *testing.T) {
t.Parallel()
if conf.HSMEnabled() {
t.Skip("Skipping test. Not applicable when Hardware Security Module is enabled. Public/private keys on HSM are generated with equal key id's and are not using prefixes")
}
IDKS, _ := jwk.GenerateJWK(context.Background(), jose.RS256, "test-id-1", "sig")
require.NoError(t, reg.KeyManager().AddKeySet(context.TODO(), x.OpenIDConnectKeyName, IDKS))
res, err := http.Get(testServer.URL + JWKPath)
require.NoError(t, err, "problem in http request")
defer res.Body.Close()
var known jose.JSONWebKeySet
err = json.NewDecoder(res.Body).Decode(&known)
require.NoError(t, err, "problem in decoding response")
require.GreaterOrEqual(t, len(known.Keys), 1)
knownKey := known.Key("test-id-1")[0].Public()
require.NotNil(t, knownKey, "Could not find key public")
expectedKey, err := jwk.FindPublicKey(IDKS)
require.NoError(t, err)
assert.EqualValues(t, canonicalizeThumbprints(*expectedKey), canonicalizeThumbprints(knownKey))
require.NoError(t, reg.KeyManager().DeleteKeySet(context.TODO(), x.OpenIDConnectKeyName))
})
t.Run("Test_Handler_WellKnown/Run_public_key_Without_public_prefix", func(t *testing.T) {
t.Parallel()
var IDKS *jose.JSONWebKeySet
if conf.HSMEnabled() {
var err error
IDKS, err = reg.KeyManager().GenerateAndPersistKeySet(context.TODO(), x.OpenIDConnectKeyName, "test-id-2", "RS256", "sig")
require.NoError(t, err, "problem in generating keys")
} else {
var err error
IDKS, err = jwk.GenerateJWK(context.Background(), jose.RS256, "test-id-2", "sig")
require.NoError(t, err, "problem in generating keys")
IDKS.Keys[0].KeyID = "test-id-2"
require.NoError(t, reg.KeyManager().AddKeySet(context.TODO(), x.OpenIDConnectKeyName, IDKS))
}
res, err := http.Get(testServer.URL + JWKPath)
require.NoError(t, err, "problem in http request")
defer res.Body.Close()
var known jose.JSONWebKeySet
err = json.NewDecoder(res.Body).Decode(&known)
require.NoError(t, err, "problem in decoding response")
if conf.HSMEnabled() {
require.GreaterOrEqual(t, len(known.Keys), 2)
} else {
require.GreaterOrEqual(t, len(known.Keys), 1)
}
knownKey := known.Key("test-id-2")[0]
require.NotNil(t, knownKey, "Could not find key public")
expectedKey, err := jwk.FindPublicKey(IDKS)
require.NoError(t, err)
assert.EqualValues(t, canonicalizeThumbprints(*expectedKey), canonicalizeThumbprints(knownKey))
})
}
func canonicalizeThumbprints(js jose.JSONWebKey) jose.JSONWebKey {
if len(js.CertificateThumbprintSHA1) == 0 {
js.CertificateThumbprintSHA1 = nil
}
if len(js.CertificateThumbprintSHA256) == 0 {
js.CertificateThumbprintSHA256 = nil
}
return js
} |
Go | hydra/jwk/helper.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"context"
"crypto/ecdsa"
"crypto/ed25519"
"crypto/rsa"
"crypto/x509"
"encoding/pem"
"sync"
"github.com/ory/x/josex"
"github.com/ory/x/errorsx"
"github.com/ory/hydra/v2/x"
jose "github.com/go-jose/go-jose/v3"
"github.com/pkg/errors"
)
var mapLock sync.RWMutex
var locks = map[string]*sync.RWMutex{}
func getLock(set string) *sync.RWMutex {
mapLock.Lock()
defer mapLock.Unlock()
if _, ok := locks[set]; !ok {
locks[set] = new(sync.RWMutex)
}
return locks[set]
}
func EnsureAsymmetricKeypairExists(ctx context.Context, r InternalRegistry, alg, set string) error {
_, err := GetOrGenerateKeys(ctx, r, r.KeyManager(), set, set, alg)
return err
}
func GetOrGenerateKeys(ctx context.Context, r InternalRegistry, m Manager, set, kid, alg string) (private *jose.JSONWebKey, err error) {
getLock(set).Lock()
defer getLock(set).Unlock()
keys, err := m.GetKeySet(ctx, set)
if errors.Is(err, x.ErrNotFound) || keys != nil && len(keys.Keys) == 0 {
r.Logger().Warnf("JSON Web Key Set \"%s\" does not exist yet, generating new key pair...", set)
keys, err = m.GenerateAndPersistKeySet(ctx, set, kid, alg, "sig")
if err != nil {
return nil, err
}
} else if err != nil {
return nil, err
}
privKey, privKeyErr := FindPrivateKey(keys)
if privKeyErr == nil {
return privKey, nil
} else {
r.Logger().WithField("jwks", set).Warnf("JSON Web Key not found in JSON Web Key Set %s, generating new key pair...", set)
keys, err = m.GenerateAndPersistKeySet(ctx, set, kid, alg, "sig")
if err != nil {
return nil, err
}
privKey, err := FindPrivateKey(keys)
if err != nil {
return nil, err
}
return privKey, nil
}
}
func First(keys []jose.JSONWebKey) *jose.JSONWebKey {
if len(keys) == 0 {
return nil
}
return &keys[0]
}
func FindPublicKey(set *jose.JSONWebKeySet) (key *jose.JSONWebKey, err error) {
keys := ExcludePrivateKeys(set)
if len(keys.Keys) == 0 {
return nil, errors.New("key not found")
}
return First(keys.Keys), nil
}
func FindPrivateKey(set *jose.JSONWebKeySet) (key *jose.JSONWebKey, err error) {
keys := ExcludePublicKeys(set)
if len(keys.Keys) == 0 {
return nil, errors.New("key not found")
}
return First(keys.Keys), nil
}
func ExcludePublicKeys(set *jose.JSONWebKeySet) *jose.JSONWebKeySet {
keys := new(jose.JSONWebKeySet)
for _, k := range set.Keys {
if !k.IsPublic() {
keys.Keys = append(keys.Keys, k)
}
}
return keys
}
func ExcludePrivateKeys(set *jose.JSONWebKeySet) *jose.JSONWebKeySet {
keys := new(jose.JSONWebKeySet)
for i := range set.Keys {
keys.Keys = append(keys.Keys, josex.ToPublicKey(&set.Keys[i]))
}
return keys
}
func ExcludeOpaquePrivateKeys(set *jose.JSONWebKeySet) *jose.JSONWebKeySet {
keys := new(jose.JSONWebKeySet)
for i := range set.Keys {
if _, opaque := set.Keys[i].Key.(jose.OpaqueSigner); opaque {
keys.Keys = append(keys.Keys, josex.ToPublicKey(&set.Keys[i]))
} else {
keys.Keys = append(keys.Keys, set.Keys[i])
}
}
return keys
}
func PEMBlockForKey(key interface{}) (*pem.Block, error) {
switch k := key.(type) {
case *rsa.PrivateKey:
return &pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(k)}, nil
case *ecdsa.PrivateKey:
b, err := x509.MarshalECPrivateKey(k)
if err != nil {
return nil, errorsx.WithStack(err)
}
return &pem.Block{Type: "EC PRIVATE KEY", Bytes: b}, nil
case ed25519.PrivateKey:
b, err := x509.MarshalPKCS8PrivateKey(k)
if err != nil {
return nil, errorsx.WithStack(err)
}
return &pem.Block{Type: "PRIVATE KEY", Bytes: b}, nil
default:
return nil, errors.New("Invalid key type")
}
} |
Go | hydra/jwk/helper_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk_test
import (
"context"
"crypto"
"crypto/dsa" //lint:ignore SA1019 used for testing invalid key types
"crypto/ecdsa"
"crypto/ed25519"
"crypto/rsa"
"crypto/x509"
"encoding/pem"
"io"
"strings"
"testing"
"github.com/go-jose/go-jose/v3"
"github.com/go-jose/go-jose/v3/cryptosigner"
"github.com/golang/mock/gomock"
"github.com/pborman/uuid"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/ory/hydra/v2/internal"
"github.com/ory/hydra/v2/jwk"
"github.com/ory/hydra/v2/x"
"github.com/ory/x/contextx"
)
type fakeSigner struct {
pk crypto.PublicKey
}
func (f *fakeSigner) Sign(_ io.Reader, _ []byte, _ crypto.SignerOpts) ([]byte, error) {
return []byte("signature"), nil
}
func (f *fakeSigner) Public() crypto.PublicKey {
return f.pk
}
func TestHandlerFindPublicKey(t *testing.T) {
t.Parallel()
t.Run("Test_Helper/Run_FindPublicKey_With_RSA", func(t *testing.T) {
t.Parallel()
RSIDKS, err := jwk.GenerateJWK(context.Background(), jose.RS256, "test-id-1", "sig")
require.NoError(t, err)
keys, err := jwk.FindPublicKey(RSIDKS)
require.NoError(t, err)
assert.Equal(t, keys.KeyID, "test-id-1")
assert.IsType(t, keys.Key, new(rsa.PublicKey))
})
t.Run("Test_Helper/Run_FindPublicKey_With_Opaque", func(t *testing.T) {
t.Parallel()
key, err := jwk.GenerateJWK(context.Background(), jose.RS256, "test-id-1", "sig")
RSIDKS := &jose.JSONWebKeySet{Keys: []jose.JSONWebKey{{
Algorithm: "RS256",
Use: "sig",
Key: cryptosigner.Opaque(&fakeSigner{pk: key.Keys[0].Public().Key}),
KeyID: "test-id-1",
Certificates: []*x509.Certificate{},
CertificateThumbprintSHA1: []uint8{},
CertificateThumbprintSHA256: []uint8{},
}, {
Algorithm: "RS256",
Use: "sig",
Key: key.Keys[0].Public().Key,
KeyID: "test-id-1",
Certificates: []*x509.Certificate{},
CertificateThumbprintSHA1: []uint8{},
CertificateThumbprintSHA256: []uint8{},
}}}
require.NoError(t, err)
keys, err := jwk.FindPublicKey(RSIDKS)
require.NoError(t, err)
assert.Equal(t, "test-id-1", keys.KeyID)
assert.IsType(t, new(rsa.PublicKey), keys.Key)
})
t.Run("Test_Helper/Run_FindPublicKey_With_ECDSA", func(t *testing.T) {
t.Parallel()
ECDSAIDKS, err := jwk.GenerateJWK(context.Background(), jose.ES256, "test-id-2", "sig")
require.NoError(t, err)
keys, err := jwk.FindPublicKey(ECDSAIDKS)
require.NoError(t, err)
assert.Equal(t, keys.KeyID, "test-id-2")
assert.IsType(t, keys.Key, new(ecdsa.PublicKey))
})
t.Run("Test_Helper/Run_FindPublicKey_With_EdDSA", func(t *testing.T) {
t.Parallel()
EdDSAIDKS, err := jwk.GenerateJWK(context.Background(), jose.EdDSA, "test-id-3", "sig")
require.NoError(t, err)
keys, err := jwk.FindPublicKey(EdDSAIDKS)
require.NoError(t, err)
assert.Equal(t, keys.KeyID, "test-id-3")
assert.IsType(t, keys.Key, ed25519.PublicKey{})
})
t.Run("Test_Helper/Run_FindPublicKey_With_KeyNotFound", func(t *testing.T) {
t.Parallel()
keySet := &jose.JSONWebKeySet{Keys: []jose.JSONWebKey{}}
_, err := jwk.FindPublicKey(keySet)
require.Error(t, err)
assert.True(t, strings.Contains(err.Error(), "key not found"))
})
}
func TestHandlerFindPrivateKey(t *testing.T) {
t.Parallel()
t.Run("Test_Helper/Run_FindPrivateKey_With_RSA", func(t *testing.T) {
RSIDKS, _ := jwk.GenerateJWK(context.Background(), jose.RS256, "test-id-1", "sig")
keys, err := jwk.FindPrivateKey(RSIDKS)
require.NoError(t, err)
assert.Equal(t, keys.KeyID, "test-id-1")
assert.IsType(t, keys.Key, new(rsa.PrivateKey))
})
t.Run("Test_Helper/Run_FindPrivateKey_With_ECDSA", func(t *testing.T) {
ECDSAIDKS, err := jwk.GenerateJWK(context.Background(), jose.ES256, "test-id-2", "sig")
require.NoError(t, err)
keys, err := jwk.FindPrivateKey(ECDSAIDKS)
require.NoError(t, err)
assert.Equal(t, keys.KeyID, "test-id-2")
assert.IsType(t, keys.Key, new(ecdsa.PrivateKey))
})
t.Run("Test_Helper/Run_FindPrivateKey_With_EdDSA", func(t *testing.T) {
EdDSAIDKS, err := jwk.GenerateJWK(context.Background(), jose.EdDSA, "test-id-3", "sig")
require.NoError(t, err)
keys, err := jwk.FindPrivateKey(EdDSAIDKS)
require.NoError(t, err)
assert.Equal(t, keys.KeyID, "test-id-3")
assert.IsType(t, keys.Key, ed25519.PrivateKey{})
})
t.Run("Test_Helper/Run_FindPrivateKey_With_KeyNotFound", func(t *testing.T) {
keySet := &jose.JSONWebKeySet{Keys: []jose.JSONWebKey{}}
_, err := jwk.FindPublicKey(keySet)
require.Error(t, err)
assert.True(t, strings.Contains(err.Error(), "key not found"))
})
}
func TestPEMBlockForKey(t *testing.T) {
t.Parallel()
t.Run("Test_Helper/Run_PEMBlockForKey_With_RSA", func(t *testing.T) {
RSIDKS, err := jwk.GenerateJWK(context.Background(), jose.RS256, "test-id-1", "sig")
require.NoError(t, err)
key, err := jwk.FindPrivateKey(RSIDKS)
require.NoError(t, err)
pemBlock, err := jwk.PEMBlockForKey(key.Key)
require.NoError(t, err)
assert.IsType(t, pem.Block{}, *pemBlock)
assert.Equal(t, "RSA PRIVATE KEY", pemBlock.Type)
})
t.Run("Test_Helper/Run_PEMBlockForKey_With_ECDSA", func(t *testing.T) {
ECDSAIDKS, err := jwk.GenerateJWK(context.Background(), jose.ES256, "test-id-2", "sig")
require.NoError(t, err)
key, err := jwk.FindPrivateKey(ECDSAIDKS)
require.NoError(t, err)
pemBlock, err := jwk.PEMBlockForKey(key.Key)
require.NoError(t, err)
assert.IsType(t, pem.Block{}, *pemBlock)
assert.Equal(t, "EC PRIVATE KEY", pemBlock.Type)
})
t.Run("Test_Helper/Run_PEMBlockForKey_With_EdDSA", func(t *testing.T) {
EdDSAIDKS, err := jwk.GenerateJWK(context.Background(), jose.EdDSA, "test-id-3", "sig")
require.NoError(t, err)
key, err := jwk.FindPrivateKey(EdDSAIDKS)
require.NoError(t, err)
pemBlock, err := jwk.PEMBlockForKey(key.Key)
require.NoError(t, err)
assert.IsType(t, pem.Block{}, *pemBlock)
assert.Equal(t, "PRIVATE KEY", pemBlock.Type)
})
t.Run("Test_Helper/Run_PEMBlockForKey_With_InvalidKeyType", func(t *testing.T) {
key := dsa.PrivateKey{}
_, err := jwk.PEMBlockForKey(key)
require.Error(t, err)
assert.True(t, strings.Contains(err.Error(), "Invalid key type"))
})
}
func TestExcludeOpaquePrivateKeys(t *testing.T) {
t.Parallel()
opaqueKeys, err := jwk.GenerateJWK(context.Background(), jose.RS256, "test-id-1", "sig")
assert.NoError(t, err)
require.Len(t, opaqueKeys.Keys, 1)
opaqueKeys.Keys[0].Key = cryptosigner.Opaque(opaqueKeys.Keys[0].Key.(*rsa.PrivateKey))
keys := jwk.ExcludeOpaquePrivateKeys(opaqueKeys)
require.Len(t, keys.Keys, 1)
k := keys.Keys[0]
_, isPublic := k.Key.(*rsa.PublicKey)
assert.True(t, isPublic)
}
func TestGetOrGenerateKeys(t *testing.T) {
t.Parallel()
reg := internal.NewMockedRegistry(t, &contextx.Default{})
setId := uuid.NewUUID().String()
keyId := uuid.NewUUID().String()
keySet, _ := jwk.GenerateJWK(context.Background(), jose.RS256, keyId, "sig")
keySetWithoutPrivateKey := &jose.JSONWebKeySet{
Keys: []jose.JSONWebKey{keySet.Keys[0].Public()},
}
km := func(t *testing.T) *MockManager {
ctrl := gomock.NewController(t)
t.Cleanup(ctrl.Finish)
return NewMockManager(ctrl)
}
t.Run("Test_Helper/Run_GetOrGenerateKeys_With_GetKeySetError", func(t *testing.T) {
keyManager := km(t)
keyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq(setId)).Return(nil, errors.New("GetKeySetError"))
privKey, err := jwk.GetOrGenerateKeys(context.TODO(), reg, keyManager, setId, keyId, "RS256")
assert.Nil(t, privKey)
assert.EqualError(t, err, "GetKeySetError")
})
t.Run("Test_Helper/Run_GetOrGenerateKeys_With_GenerateAndPersistKeySetError", func(t *testing.T) {
keyManager := km(t)
keyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq(setId)).Return(nil, errors.Wrap(x.ErrNotFound, ""))
keyManager.EXPECT().GenerateAndPersistKeySet(gomock.Any(), gomock.Eq(setId), gomock.Eq(keyId), gomock.Eq("RS256"), gomock.Eq("sig")).Return(nil, errors.New("GetKeySetError"))
privKey, err := jwk.GetOrGenerateKeys(context.TODO(), reg, keyManager, setId, keyId, "RS256")
assert.Nil(t, privKey)
assert.EqualError(t, err, "GetKeySetError")
})
t.Run("Test_Helper/Run_GetOrGenerateKeys_With_GenerateAndPersistKeySetError", func(t *testing.T) {
keyManager := km(t)
keyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq(setId)).Return(keySetWithoutPrivateKey, nil)
keyManager.EXPECT().GenerateAndPersistKeySet(gomock.Any(), gomock.Eq(setId), gomock.Eq(keyId), gomock.Eq("RS256"), gomock.Eq("sig")).Return(nil, errors.New("GetKeySetError"))
privKey, err := jwk.GetOrGenerateKeys(context.TODO(), reg, keyManager, setId, keyId, "RS256")
assert.Nil(t, privKey)
assert.EqualError(t, err, "GetKeySetError")
})
t.Run("Test_Helper/Run_GetOrGenerateKeys_With_GetKeySet_ContainsMissingPrivateKey", func(t *testing.T) {
keyManager := km(t)
keyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq(setId)).Return(keySetWithoutPrivateKey, nil)
keyManager.EXPECT().GenerateAndPersistKeySet(gomock.Any(), gomock.Eq(setId), gomock.Eq(keyId), gomock.Eq("RS256"), gomock.Eq("sig")).Return(keySet, nil)
privKey, err := jwk.GetOrGenerateKeys(context.TODO(), reg, keyManager, setId, keyId, "RS256")
assert.NoError(t, err)
assert.Equal(t, privKey, &keySet.Keys[0])
})
t.Run("Test_Helper/Run_GetOrGenerateKeys_With_GenerateAndPersistKeySet_ContainsMissingPrivateKey", func(t *testing.T) {
keyManager := km(t)
keyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq(setId)).Return(keySetWithoutPrivateKey, nil)
keyManager.EXPECT().GenerateAndPersistKeySet(gomock.Any(), gomock.Eq(setId), gomock.Eq(keyId), gomock.Eq("RS256"), gomock.Eq("sig")).Return(keySetWithoutPrivateKey, nil).Times(1)
privKey, err := jwk.GetOrGenerateKeys(context.TODO(), reg, keyManager, setId, keyId, "RS256")
assert.Nil(t, privKey)
assert.EqualError(t, err, "key not found")
})
} |
Go | hydra/jwk/jwt_strategy.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"context"
"net"
"github.com/ory/x/josex"
"github.com/go-jose/go-jose/v3"
"github.com/gofrs/uuid"
"github.com/ory/fosite"
"github.com/ory/hydra/v2/driver/config"
"github.com/pkg/errors"
"github.com/ory/fosite/token/jwt"
)
type JWTSigner interface {
GetPublicKeyID(ctx context.Context) (string, error)
GetPublicKey(ctx context.Context) (jose.JSONWebKey, error)
jwt.Signer
}
type DefaultJWTSigner struct {
*jwt.DefaultSigner
r InternalRegistry
c *config.DefaultProvider
setID string
}
func NewDefaultJWTSigner(c *config.DefaultProvider, r InternalRegistry, setID string) *DefaultJWTSigner {
j := &DefaultJWTSigner{c: c, r: r, setID: setID, DefaultSigner: &jwt.DefaultSigner{}}
j.DefaultSigner.GetPrivateKey = j.getPrivateKey
return j
}
func (j *DefaultJWTSigner) getKeys(ctx context.Context) (private *jose.JSONWebKey, err error) {
private, err = GetOrGenerateKeys(ctx, j.r, j.r.KeyManager(), j.setID, uuid.Must(uuid.NewV4()).String(), string(jose.RS256))
if err == nil {
return private, nil
}
var netError net.Error
if errors.As(err, &netError) {
return nil, errors.WithStack(fosite.ErrServerError.
WithHintf(`Could not ensure that signing keys for "%s" exists. A network error occurred, see error for specific details.`, j.setID))
}
return nil, errors.WithStack(fosite.ErrServerError.
WithWrap(err).
WithHintf(`Could not ensure that signing keys for "%s" exists. If you are running against a persistent SQL database this is most likely because your "secrets.system" ("SECRETS_SYSTEM" environment variable) is not set or changed. When running with an SQL database backend you need to make sure that the secret is set and stays the same, unless when doing key rotation. This may also happen when you forget to run "hydra migrate sql..`, j.setID))
}
func (j *DefaultJWTSigner) GetPublicKeyID(ctx context.Context) (string, error) {
private, err := j.getKeys(ctx)
if err != nil {
return "", errors.WithStack(err)
}
return josex.ToPublicKey(private).KeyID, nil
}
func (j *DefaultJWTSigner) GetPublicKey(ctx context.Context) (jose.JSONWebKey, error) {
private, err := j.getKeys(ctx)
if err != nil {
return jose.JSONWebKey{}, errors.WithStack(err)
}
return josex.ToPublicKey(private), nil
}
func (j *DefaultJWTSigner) getPrivateKey(ctx context.Context) (interface{}, error) {
private, err := j.getKeys(ctx)
if err != nil {
return nil, err
}
return private, nil
} |
Go | hydra/jwk/jwt_strategy_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk_test
import (
"context"
"encoding/base64"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/tidwall/gjson"
"github.com/ory/fosite/token/jwt"
"github.com/ory/hydra/v2/internal"
. "github.com/ory/hydra/v2/jwk"
"github.com/ory/x/contextx"
)
func TestJWTStrategy(t *testing.T) {
for _, alg := range []string{"RS256", "ES256", "ES512"} {
t.Run("case="+alg, func(t *testing.T) {
conf := internal.NewConfigurationWithDefaults()
reg := internal.NewRegistryMemory(t, conf, &contextx.Default{})
m := reg.KeyManager()
_, err := m.GenerateAndPersistKeySet(context.Background(), "foo-set", "foo", alg, "sig")
require.NoError(t, err)
s := NewDefaultJWTSigner(conf, reg, "foo-set")
a, b, err := s.Generate(context.Background(), jwt.MapClaims{"foo": "bar"}, &jwt.Headers{})
require.NoError(t, err)
assert.NotEmpty(t, a)
assert.NotEmpty(t, b)
token, err := base64.RawStdEncoding.DecodeString(strings.Split(a, ".")[0])
require.NoError(t, err)
assert.Equal(t, alg, gjson.GetBytes(token, "alg").String())
_, err = s.Validate(context.Background(), a)
require.NoError(t, err)
kidFoo, err := s.GetPublicKeyID(context.Background())
assert.NoError(t, err)
_, err = m.GenerateAndPersistKeySet(context.Background(), "foo-set", "bar", alg, "sig")
require.NoError(t, err)
a, b, err = s.Generate(context.Background(), jwt.MapClaims{"foo": "bar"}, &jwt.Headers{})
require.NoError(t, err)
assert.NotEmpty(t, a)
assert.NotEmpty(t, b)
token, err = base64.RawStdEncoding.DecodeString(strings.Split(a, ".")[0])
require.NoError(t, err)
assert.Equal(t, alg, gjson.GetBytes(token, "alg").String())
_, err = s.Validate(context.Background(), a)
require.NoError(t, err)
kidBar, err := s.GetPublicKeyID(context.Background())
assert.NoError(t, err)
assert.Equal(t, "foo", kidFoo)
assert.Equal(t, "bar", kidBar)
})
}
} |
Go | hydra/jwk/manager.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"context"
"net/http"
"time"
jose "github.com/go-jose/go-jose/v3"
"github.com/gofrs/uuid"
"github.com/ory/fosite"
)
var ErrUnsupportedKeyAlgorithm = &fosite.RFC6749Error{
CodeField: http.StatusBadRequest,
ErrorField: http.StatusText(http.StatusBadRequest),
DescriptionField: "Unsupported key algorithm",
}
var ErrUnsupportedEllipticCurve = &fosite.RFC6749Error{
CodeField: http.StatusBadRequest,
ErrorField: http.StatusText(http.StatusBadRequest),
DescriptionField: "Unsupported elliptic curve",
}
var ErrMinimalRsaKeyLength = &fosite.RFC6749Error{
CodeField: http.StatusBadRequest,
ErrorField: http.StatusText(http.StatusBadRequest),
DescriptionField: "Unsupported RSA key length",
}
type (
Manager interface {
GenerateAndPersistKeySet(ctx context.Context, set, kid, alg, use string) (*jose.JSONWebKeySet, error)
AddKey(ctx context.Context, set string, key *jose.JSONWebKey) error
AddKeySet(ctx context.Context, set string, keys *jose.JSONWebKeySet) error
UpdateKey(ctx context.Context, set string, key *jose.JSONWebKey) error
UpdateKeySet(ctx context.Context, set string, keys *jose.JSONWebKeySet) error
GetKey(ctx context.Context, set, kid string) (*jose.JSONWebKeySet, error)
GetKeySet(ctx context.Context, set string) (*jose.JSONWebKeySet, error)
DeleteKey(ctx context.Context, set, kid string) error
DeleteKeySet(ctx context.Context, set string) error
}
SQLData struct {
ID uuid.UUID `db:"pk"`
NID uuid.UUID `json:"-" db:"nid"`
// This field is deprecated and will be removed
PKDeprecated int64 `json:"-" db:"pk_deprecated"`
Set string `db:"sid"`
KID string `db:"kid"`
Version int `db:"version"`
CreatedAt time.Time `db:"created_at"`
Key string `db:"keydata"`
}
)
func (d SQLData) TableName() string {
return "hydra_jwk"
} |
Go | hydra/jwk/manager_mock_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
// Code generated by MockGen. DO NOT EDIT.
// Source: jwk/manager.go
// Package mock_jwk is a generated GoMock package.
package jwk_test
import (
context "context"
reflect "reflect"
jose "github.com/go-jose/go-jose/v3"
gomock "github.com/golang/mock/gomock"
)
// MockManager is a mock of Manager interface.
type MockManager struct {
ctrl *gomock.Controller
recorder *MockManagerMockRecorder
}
// MockManagerMockRecorder is the mock recorder for MockManager.
type MockManagerMockRecorder struct {
mock *MockManager
}
// NewMockManager creates a new mock instance.
func NewMockManager(ctrl *gomock.Controller) *MockManager {
mock := &MockManager{ctrl: ctrl}
mock.recorder = &MockManagerMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockManager) EXPECT() *MockManagerMockRecorder {
return m.recorder
}
// AddKey mocks base method.
func (m *MockManager) AddKey(ctx context.Context, set string, key *jose.JSONWebKey) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "AddKey", ctx, set, key)
ret0, _ := ret[0].(error)
return ret0
}
// AddKey indicates an expected call of AddKey.
func (mr *MockManagerMockRecorder) AddKey(ctx, set, key interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddKey", reflect.TypeOf((*MockManager)(nil).AddKey), ctx, set, key)
}
// AddKeySet mocks base method.
func (m *MockManager) AddKeySet(ctx context.Context, set string, keys *jose.JSONWebKeySet) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "AddKeySet", ctx, set, keys)
ret0, _ := ret[0].(error)
return ret0
}
// AddKeySet indicates an expected call of AddKeySet.
func (mr *MockManagerMockRecorder) AddKeySet(ctx, set, keys interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddKeySet", reflect.TypeOf((*MockManager)(nil).AddKeySet), ctx, set, keys)
}
// DeleteKey mocks base method.
func (m *MockManager) DeleteKey(ctx context.Context, set, kid string) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "DeleteKey", ctx, set, kid)
ret0, _ := ret[0].(error)
return ret0
}
// DeleteKey indicates an expected call of DeleteKey.
func (mr *MockManagerMockRecorder) DeleteKey(ctx, set, kid interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteKey", reflect.TypeOf((*MockManager)(nil).DeleteKey), ctx, set, kid)
}
// DeleteKeySet mocks base method.
func (m *MockManager) DeleteKeySet(ctx context.Context, set string) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "DeleteKeySet", ctx, set)
ret0, _ := ret[0].(error)
return ret0
}
// DeleteKeySet indicates an expected call of DeleteKeySet.
func (mr *MockManagerMockRecorder) DeleteKeySet(ctx, set interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteKeySet", reflect.TypeOf((*MockManager)(nil).DeleteKeySet), ctx, set)
}
// GenerateAndPersistKeySet mocks base method.
func (m *MockManager) GenerateAndPersistKeySet(ctx context.Context, set, kid, alg, use string) (*jose.JSONWebKeySet, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "GenerateAndPersistKeySet", ctx, set, kid, alg, use)
ret0, _ := ret[0].(*jose.JSONWebKeySet)
ret1, _ := ret[1].(error)
return ret0, ret1
}
// GenerateAndPersistKeySet indicates an expected call of GenerateAndPersistKeySet.
func (mr *MockManagerMockRecorder) GenerateAndPersistKeySet(ctx, set, kid, alg, use interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GenerateAndPersistKeySet", reflect.TypeOf((*MockManager)(nil).GenerateAndPersistKeySet), ctx, set, kid, alg, use)
}
// GetKey mocks base method.
func (m *MockManager) GetKey(ctx context.Context, set, kid string) (*jose.JSONWebKeySet, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "GetKey", ctx, set, kid)
ret0, _ := ret[0].(*jose.JSONWebKeySet)
ret1, _ := ret[1].(error)
return ret0, ret1
}
// GetKey indicates an expected call of GetKey.
func (mr *MockManagerMockRecorder) GetKey(ctx, set, kid interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKey", reflect.TypeOf((*MockManager)(nil).GetKey), ctx, set, kid)
}
// GetKeySet mocks base method.
func (m *MockManager) GetKeySet(ctx context.Context, set string) (*jose.JSONWebKeySet, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "GetKeySet", ctx, set)
ret0, _ := ret[0].(*jose.JSONWebKeySet)
ret1, _ := ret[1].(error)
return ret0, ret1
}
// GetKeySet indicates an expected call of GetKeySet.
func (mr *MockManagerMockRecorder) GetKeySet(ctx, set interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKeySet", reflect.TypeOf((*MockManager)(nil).GetKeySet), ctx, set)
}
// UpdateKey mocks base method.
func (m *MockManager) UpdateKey(ctx context.Context, set string, key *jose.JSONWebKey) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "UpdateKey", ctx, set, key)
ret0, _ := ret[0].(error)
return ret0
}
// UpdateKey indicates an expected call of UpdateKey.
func (mr *MockManagerMockRecorder) UpdateKey(ctx, set, key interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateKey", reflect.TypeOf((*MockManager)(nil).UpdateKey), ctx, set, key)
}
// UpdateKeySet mocks base method.
func (m *MockManager) UpdateKeySet(ctx context.Context, set string, keys *jose.JSONWebKeySet) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "UpdateKeySet", ctx, set, keys)
ret0, _ := ret[0].(error)
return ret0
}
// UpdateKeySet indicates an expected call of UpdateKeySet.
func (mr *MockManagerMockRecorder) UpdateKeySet(ctx, set, keys interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateKeySet", reflect.TypeOf((*MockManager)(nil).UpdateKeySet), ctx, set, keys)
} |
Go | hydra/jwk/manager_strategy.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"context"
"github.com/go-jose/go-jose/v3"
"github.com/pkg/errors"
"go.opentelemetry.io/otel"
"github.com/ory/hydra/v2/x"
"github.com/ory/x/otelx"
)
const tracingComponent = "github.com/ory/hydra/v2/jwk"
type ManagerStrategy struct {
hardwareKeyManager Manager
softwareKeyManager Manager
}
func NewManagerStrategy(hardwareKeyManager Manager, softwareKeyManager Manager) *ManagerStrategy {
return &ManagerStrategy{
hardwareKeyManager: hardwareKeyManager,
softwareKeyManager: softwareKeyManager,
}
}
func (m ManagerStrategy) GenerateAndPersistKeySet(ctx context.Context, set, kid, alg, use string) (*jose.JSONWebKeySet, error) {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
"kid": kid,
"alg": alg,
"use": use,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
return m.hardwareKeyManager.GenerateAndPersistKeySet(ctx, set, kid, alg, use)
}
func (m ManagerStrategy) AddKey(ctx context.Context, set string, key *jose.JSONWebKey) error {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
return m.softwareKeyManager.AddKey(ctx, set, key)
}
func (m ManagerStrategy) AddKeySet(ctx context.Context, set string, keys *jose.JSONWebKeySet) error {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
return m.softwareKeyManager.AddKeySet(ctx, set, keys)
}
func (m ManagerStrategy) UpdateKey(ctx context.Context, set string, key *jose.JSONWebKey) error {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
return m.softwareKeyManager.UpdateKey(ctx, set, key)
}
func (m ManagerStrategy) UpdateKeySet(ctx context.Context, set string, keys *jose.JSONWebKeySet) error {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
return m.softwareKeyManager.UpdateKeySet(ctx, set, keys)
}
func (m ManagerStrategy) GetKey(ctx context.Context, set, kid string) (*jose.JSONWebKeySet, error) {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
"kid": kid,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
keySet, err := m.hardwareKeyManager.GetKey(ctx, set, kid)
if err != nil && !errors.Is(err, x.ErrNotFound) {
return nil, err
} else if keySet != nil {
return keySet, nil
} else {
return m.softwareKeyManager.GetKey(ctx, set, kid)
}
}
func (m ManagerStrategy) GetKeySet(ctx context.Context, set string) (*jose.JSONWebKeySet, error) {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
keySet, err := m.hardwareKeyManager.GetKeySet(ctx, set)
if err != nil && !errors.Is(err, x.ErrNotFound) {
return nil, err
} else if keySet != nil {
return keySet, nil
} else {
return m.softwareKeyManager.GetKeySet(ctx, set)
}
}
func (m ManagerStrategy) DeleteKey(ctx context.Context, set, kid string) error {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
"kid": kid,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
err := m.hardwareKeyManager.DeleteKey(ctx, set, kid)
if err != nil && !errors.Is(err, x.ErrNotFound) {
return err
} else if errors.Is(err, x.ErrNotFound) {
return m.softwareKeyManager.DeleteKey(ctx, set, kid)
} else {
return nil
}
}
func (m ManagerStrategy) DeleteKeySet(ctx context.Context, set string) error {
ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
defer span.End()
attrs := map[string]string{
"set": set,
}
span.SetAttributes(otelx.StringAttrs(attrs)...)
err := m.hardwareKeyManager.DeleteKeySet(ctx, set)
if err != nil && !errors.Is(err, x.ErrNotFound) {
return err
} else if errors.Is(err, x.ErrNotFound) {
return m.softwareKeyManager.DeleteKeySet(ctx, set)
} else {
return nil
}
} |
Go | hydra/jwk/manager_strategy_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk_test
import (
"context"
"testing"
"github.com/go-jose/go-jose/v3"
"github.com/golang/mock/gomock"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"github.com/ory/hydra/v2/jwk"
"github.com/ory/hydra/v2/x"
)
func TestKeyManagerStrategy(t *testing.T) {
t.Parallel()
ctrl := gomock.NewController(t)
softwareKeyManager := NewMockManager(ctrl)
hardwareKeyManager := NewMockManager(ctrl)
keyManager := jwk.NewManagerStrategy(hardwareKeyManager, softwareKeyManager)
defer ctrl.Finish()
hwKeySet := &jose.JSONWebKeySet{
Keys: []jose.JSONWebKey{{
KeyID: "hwKeyID",
}},
}
swKeySet := &jose.JSONWebKeySet{
Keys: []jose.JSONWebKey{{
KeyID: "swKeyID",
}},
}
t.Run("GenerateAndPersistKeySet_WithResult", func(t *testing.T) {
hardwareKeyManager.EXPECT().GenerateAndPersistKeySet(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1"), gomock.Any(), gomock.Any()).Return(hwKeySet, nil)
resultKeySet, err := keyManager.GenerateAndPersistKeySet(context.TODO(), "set1", "kid1", "RS256", "sig")
assert.NoError(t, err)
assert.Equal(t, hwKeySet, resultKeySet)
})
t.Run("GenerateAndPersistKeySet_WithError", func(t *testing.T) {
hardwareKeyManager.EXPECT().GenerateAndPersistKeySet(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1"), gomock.Any(), gomock.Any()).Return(nil, errors.New("test"))
resultKeySet, err := keyManager.GenerateAndPersistKeySet(context.TODO(), "set1", "kid1", "RS256", "sig")
assert.Error(t, err, "test")
assert.Nil(t, resultKeySet)
})
t.Run("AddKey", func(t *testing.T) {
softwareKeyManager.EXPECT().AddKey(gomock.Any(), gomock.Eq("set1"), gomock.Any()).Return(nil)
err := keyManager.AddKey(context.TODO(), "set1", nil)
assert.NoError(t, err)
})
t.Run("AddKey_WithError", func(t *testing.T) {
softwareKeyManager.EXPECT().AddKey(gomock.Any(), gomock.Eq("set1"), gomock.Any()).Return(errors.New("test"))
err := keyManager.AddKey(context.TODO(), "set1", nil)
assert.Error(t, err, "test")
})
t.Run("AddKeySet", func(t *testing.T) {
softwareKeyManager.EXPECT().AddKeySet(gomock.Any(), gomock.Eq("set1"), gomock.Any()).Return(nil)
err := keyManager.AddKeySet(context.TODO(), "set1", nil)
assert.NoError(t, err)
})
t.Run("AddKeySet_WithError", func(t *testing.T) {
softwareKeyManager.EXPECT().AddKeySet(gomock.Any(), gomock.Eq("set1"), gomock.Any()).Return(errors.New("test"))
err := keyManager.AddKeySet(context.TODO(), "set1", nil)
assert.Error(t, err, "test")
})
t.Run("UpdateKey", func(t *testing.T) {
softwareKeyManager.EXPECT().UpdateKey(gomock.Any(), gomock.Eq("set1"), gomock.Any()).Return(nil)
err := keyManager.UpdateKey(context.TODO(), "set1", nil)
assert.NoError(t, err)
})
t.Run("UpdateKey_WithError", func(t *testing.T) {
softwareKeyManager.EXPECT().UpdateKey(gomock.Any(), gomock.Eq("set1"), gomock.Any()).Return(errors.New("test"))
err := keyManager.UpdateKey(context.TODO(), "set1", nil)
assert.Error(t, err, "test")
})
t.Run("UpdateKeySet", func(t *testing.T) {
softwareKeyManager.EXPECT().UpdateKeySet(gomock.Any(), gomock.Eq("set1"), gomock.Any()).Return(nil)
err := keyManager.UpdateKeySet(context.TODO(), "set1", nil)
assert.NoError(t, err)
})
t.Run("UpdateKeySet_WithError", func(t *testing.T) {
softwareKeyManager.EXPECT().UpdateKeySet(gomock.Any(), gomock.Eq("set1"), gomock.Any()).Return(errors.New("test"))
err := keyManager.UpdateKeySet(context.TODO(), "set1", nil)
assert.Error(t, err, "test")
})
t.Run("GetKey_WithResultFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().GetKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(hwKeySet, nil)
resultKeySet, err := keyManager.GetKey(context.TODO(), "set1", "kid1")
assert.NoError(t, err)
assert.Equal(t, hwKeySet, resultKeySet)
})
t.Run("GetKey_WithErrorFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().GetKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(nil, errors.New("test"))
resultKeySet, err := keyManager.GetKey(context.TODO(), "set1", "kid1")
assert.Error(t, err, "test")
assert.Nil(t, resultKeySet)
})
t.Run("GetKey_WithErrNotFoundFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().GetKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(nil, errors.WithStack(x.ErrNotFound))
softwareKeyManager.EXPECT().GetKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(swKeySet, nil)
resultKeySet, err := keyManager.GetKey(context.TODO(), "set1", "kid1")
assert.NoError(t, err)
assert.Equal(t, swKeySet, resultKeySet)
})
t.Run("GetKey_WithErrNotFoundFromSoftwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().GetKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(nil, errors.WithStack(x.ErrNotFound))
softwareKeyManager.EXPECT().GetKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(nil, errors.WithStack(x.ErrNotFound))
resultKeySet, err := keyManager.GetKey(context.TODO(), "set1", "kid1")
assert.Error(t, err, "Not Found")
assert.Nil(t, resultKeySet)
})
t.Run("GetKeySet_WithResultFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq("set1")).Return(hwKeySet, nil)
resultKeySet, err := keyManager.GetKeySet(context.TODO(), "set1")
assert.NoError(t, err)
assert.Equal(t, hwKeySet, resultKeySet)
})
t.Run("GetKeySet_WithErrorFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq("set1")).Return(nil, errors.New("test"))
resultKeySet, err := keyManager.GetKeySet(context.TODO(), "set1")
assert.Error(t, err, "test")
assert.Nil(t, resultKeySet)
})
t.Run("GetKeySet_WithErrNotFoundFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq("set1")).Return(nil, errors.WithStack(x.ErrNotFound))
softwareKeyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq("set1")).Return(swKeySet, nil)
resultKeySet, err := keyManager.GetKeySet(context.TODO(), "set1")
assert.NoError(t, err)
assert.Equal(t, swKeySet, resultKeySet)
})
t.Run("GetKeySet_WithErrNotFoundFromSoftwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq("set1")).Return(nil, errors.WithStack(x.ErrNotFound))
softwareKeyManager.EXPECT().GetKeySet(gomock.Any(), gomock.Eq("set1")).Return(nil, errors.WithStack(x.ErrNotFound))
resultKeySet, err := keyManager.GetKeySet(context.TODO(), "set1")
assert.Error(t, err, "Not Found")
assert.Nil(t, resultKeySet)
})
t.Run("DeleteKey_FromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().DeleteKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(nil)
err := keyManager.DeleteKey(context.TODO(), "set1", "kid1")
assert.NoError(t, err)
})
t.Run("DeleteKey_WithErrorFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().DeleteKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(errors.New("test"))
err := keyManager.DeleteKey(context.TODO(), "set1", "kid1")
assert.Error(t, err, "test")
})
t.Run("DeleteKey_WithErrNotFoundFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().DeleteKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(errors.WithStack(x.ErrNotFound))
softwareKeyManager.EXPECT().DeleteKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(nil)
err := keyManager.DeleteKey(context.TODO(), "set1", "kid1")
assert.NoError(t, err)
})
t.Run("DeleteKey_WithErrNotFoundFromSoftwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().DeleteKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(errors.WithStack(x.ErrNotFound))
softwareKeyManager.EXPECT().DeleteKey(gomock.Any(), gomock.Eq("set1"), gomock.Eq("kid1")).Return(errors.WithStack(x.ErrNotFound))
err := keyManager.DeleteKey(context.TODO(), "set1", "kid1")
assert.Error(t, err, "Not Found")
})
t.Run("DeleteKeySet_FromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().DeleteKeySet(gomock.Any(), gomock.Eq("set1")).Return(nil)
err := keyManager.DeleteKeySet(context.TODO(), "set1")
assert.NoError(t, err)
})
t.Run("DeleteKeySet_WithErrorFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().DeleteKeySet(gomock.Any(), gomock.Eq("set1")).Return(errors.New("test"))
err := keyManager.DeleteKeySet(context.TODO(), "set1")
assert.Error(t, err, "test")
})
t.Run("DeleteKeySet_WithErrNotFoundFromHardwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().DeleteKeySet(gomock.Any(), gomock.Eq("set1")).Return(errors.WithStack(x.ErrNotFound))
softwareKeyManager.EXPECT().DeleteKeySet(gomock.Any(), gomock.Eq("set1")).Return(nil)
err := keyManager.DeleteKeySet(context.TODO(), "set1")
assert.NoError(t, err)
})
t.Run("DeleteKeySet_WithErrNotFoundFromSoftwareKeyManager", func(t *testing.T) {
hardwareKeyManager.EXPECT().DeleteKeySet(gomock.Any(), gomock.Eq("set1")).Return(errors.WithStack(x.ErrNotFound))
softwareKeyManager.EXPECT().DeleteKeySet(gomock.Any(), gomock.Eq("set1")).Return(errors.WithStack(x.ErrNotFound))
err := keyManager.DeleteKeySet(context.TODO(), "set1")
assert.Error(t, err, "Not Found")
})
} |
Go | hydra/jwk/manager_test_helpers.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"context"
"crypto/rand"
"io"
"testing"
"time"
"github.com/google/uuid"
"github.com/ory/x/assertx"
"github.com/ory/x/errorsx"
jose "github.com/go-jose/go-jose/v3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func RandomBytes(n int) ([]byte, error) {
bytes := make([]byte, n)
if _, err := io.ReadFull(rand.Reader, bytes); err != nil {
return []byte{}, errorsx.WithStack(err)
}
return bytes, nil
}
func canonicalizeThumbprints(js []jose.JSONWebKey) []jose.JSONWebKey {
for k, v := range js {
js[k] = canonicalizeKeyThumbprints(&v)
}
return js
}
func canonicalizeKeyThumbprints(v *jose.JSONWebKey) jose.JSONWebKey {
if len(v.CertificateThumbprintSHA1) == 0 {
v.CertificateThumbprintSHA1 = nil
}
if len(v.CertificateThumbprintSHA256) == 0 {
v.CertificateThumbprintSHA256 = nil
}
return *v
}
func TestHelperManagerKey(m Manager, algo string, keys *jose.JSONWebKeySet, suffix string) func(t *testing.T) {
priv := canonicalizeThumbprints(keys.Key(suffix))
var pub []jose.JSONWebKey
for _, k := range priv {
pub = append(pub, canonicalizeThumbprints([]jose.JSONWebKey{k.Public()})...)
}
return func(t *testing.T) {
set := algo + uuid.NewString()
_, err := m.GetKey(context.TODO(), set, suffix)
assert.NotNil(t, err)
err = m.AddKey(context.TODO(), set, First(priv))
require.NoError(t, err)
got, err := m.GetKey(context.TODO(), set, suffix)
require.NoError(t, err)
assertx.EqualAsJSON(t, priv, canonicalizeThumbprints(got.Keys))
addKey := First(pub)
addKey.KeyID = uuid.NewString()
err = m.AddKey(context.TODO(), set, addKey)
require.NoError(t, err)
got, err = m.GetKey(context.TODO(), set, suffix)
require.NoError(t, err)
assertx.EqualAsJSON(t, priv, canonicalizeThumbprints(got.Keys))
// Because MySQL
time.Sleep(time.Second * 2)
newKID := "new-key-id:" + suffix
pub[0].KeyID = newKID
pub[0].Use = "sig"
err = m.AddKey(context.TODO(), set, First(pub))
require.NoError(t, err)
got, err = m.GetKey(context.TODO(), set, newKID)
require.NoError(t, err)
newKey := First(got.Keys)
assert.EqualValues(t, "sig", newKey.Use)
newKey.Use = "enc"
err = m.UpdateKey(context.TODO(), set, newKey)
require.NoError(t, err)
updated, err := m.GetKey(context.TODO(), set, newKID)
require.NoError(t, err)
updatedKey := First(updated.Keys)
assert.EqualValues(t, "enc", updatedKey.Use)
keys, err = m.GetKeySet(context.TODO(), set)
require.NoError(t, err)
var found bool
for _, k := range keys.Keys {
if k.KeyID == newKID {
found = true
break
}
}
assert.True(t, found, "Key not found in key set: %s / %s\n%+v", keys, newKID)
beforeDeleteKeysCount := len(keys.Keys)
err = m.DeleteKey(context.TODO(), set, suffix)
require.NoError(t, err)
_, err = m.GetKey(context.TODO(), set, suffix)
require.Error(t, err)
keys, err = m.GetKeySet(context.TODO(), set)
require.NoError(t, err)
assert.EqualValues(t, beforeDeleteKeysCount-1, len(keys.Keys))
}
}
func TestHelperManagerKeySet(m Manager, algo string, keys *jose.JSONWebKeySet, suffix string, parallel bool) func(t *testing.T) {
return func(t *testing.T) {
if parallel {
t.Parallel()
}
set := uuid.NewString()
_, err := m.GetKeySet(context.TODO(), algo+set)
require.Error(t, err)
err = m.AddKeySet(context.TODO(), algo+set, keys)
require.NoError(t, err)
got, err := m.GetKeySet(context.TODO(), algo+set)
require.NoError(t, err)
assertx.EqualAsJSON(t, canonicalizeThumbprints(keys.Key(suffix)), canonicalizeThumbprints(got.Key(suffix)))
assertx.EqualAsJSON(t, canonicalizeThumbprints(keys.Key(suffix)), canonicalizeThumbprints(got.Key(suffix)))
for i := range got.Keys {
got.Keys[i].Use = "enc"
}
err = m.UpdateKeySet(context.TODO(), algo+set, got)
require.NoError(t, err)
updated, err := m.GetKeySet(context.TODO(), algo+set)
require.NoError(t, err)
assert.EqualValues(t, "enc", updated.Key(suffix)[0].Public().Use)
assert.EqualValues(t, "enc", updated.Key(suffix)[0].Use)
err = m.DeleteKeySet(context.TODO(), algo+set)
require.NoError(t, err)
_, err = m.GetKeySet(context.TODO(), algo+set)
require.Error(t, err)
}
}
func TestHelperManagerGenerateAndPersistKeySet(m Manager, alg string, parallel bool) func(t *testing.T) {
return func(t *testing.T) {
if parallel {
t.Parallel()
}
_, err := m.GetKeySet(context.TODO(), "foo")
require.Error(t, err)
keys, err := m.GenerateAndPersistKeySet(context.TODO(), "foo", "bar", alg, "sig")
require.NoError(t, err)
genPub, err := FindPublicKey(keys)
require.NoError(t, err)
require.NotEmpty(t, genPub)
genPriv, err := FindPrivateKey(keys)
require.NoError(t, err)
got, err := m.GetKeySet(context.TODO(), "foo")
require.NoError(t, err)
gotPub, err := FindPublicKey(got)
require.NoError(t, err)
require.NotEmpty(t, gotPub)
gotPriv, err := FindPrivateKey(got)
require.NoError(t, err)
assertx.EqualAsJSON(t, canonicalizeKeyThumbprints(genPub), canonicalizeKeyThumbprints(gotPub))
assert.EqualValues(t, genPriv.KeyID, gotPriv.KeyID)
err = m.DeleteKeySet(context.TODO(), "foo")
require.NoError(t, err)
_, err = m.GetKeySet(context.TODO(), "foo")
require.Error(t, err)
}
}
func TestHelperManagerNIDIsolationKeySet(t1 Manager, t2 Manager, alg string) func(t *testing.T) {
return func(t *testing.T) {
_, err := t1.GetKeySet(context.TODO(), "foo")
require.Error(t, err)
_, err = t2.GetKeySet(context.TODO(), "foo")
require.Error(t, err)
_, err = t1.GenerateAndPersistKeySet(context.TODO(), "foo", "bar", alg, "sig")
require.NoError(t, err)
keys, err := t1.GetKeySet(context.TODO(), "foo")
require.NoError(t, err)
_, err = t2.GetKeySet(context.TODO(), "foo")
require.Error(t, err)
err = t2.DeleteKeySet(context.TODO(), "foo")
require.Error(t, err)
err = t1.DeleteKeySet(context.TODO(), "foo")
require.NoError(t, err)
_, err = t1.GetKeySet(context.TODO(), "foo")
require.Error(t, err)
err = t1.AddKeySet(context.TODO(), "foo", keys)
require.NoError(t, err)
err = t2.DeleteKeySet(context.TODO(), "foo")
require.Error(t, err)
for i := range keys.Keys {
keys.Keys[i].Use = "enc"
}
err = t1.UpdateKeySet(context.TODO(), "foo", keys)
require.Error(t, err)
for i := range keys.Keys {
keys.Keys[i].Use = "err"
}
err = t2.UpdateKeySet(context.TODO(), "foo", keys)
require.Error(t, err)
updated, err := t1.GetKeySet(context.TODO(), "foo")
require.NoError(t, err)
for i := range updated.Keys {
assert.EqualValues(t, "enc", updated.Keys[i].Use)
}
err = t1.DeleteKeySet(context.TODO(), "foo")
require.Error(t, err)
}
}
func TestHelperNID(t1ValidNID Manager, t2InvalidNID Manager) func(t *testing.T) {
return func(t *testing.T) {
ctx := context.Background()
jwks, err := GenerateJWK(ctx, jose.RS256, "2022-03-11-ks-1-kid", "test")
require.NoError(t, err)
require.Error(t, t2InvalidNID.AddKey(ctx, "2022-03-11-k-1", &jwks.Keys[0]))
require.NoError(t, t1ValidNID.AddKey(ctx, "2022-03-11-k-1", &jwks.Keys[0]))
require.Error(t, t2InvalidNID.AddKeySet(ctx, "2022-03-11-ks-1", jwks))
require.NoError(t, t1ValidNID.AddKeySet(ctx, "2022-03-11-ks-1", jwks))
require.NoError(t, t2InvalidNID.DeleteKey(ctx, "2022-03-11-ks-1", jwks.Keys[0].KeyID)) // Delete doesn't report error if key doesn't exist
require.NoError(t, t1ValidNID.DeleteKey(ctx, "2022-03-11-ks-1", jwks.Keys[0].KeyID))
_, err = t2InvalidNID.GenerateAndPersistKeySet(ctx, "2022-03-11-ks-2", "2022-03-11-ks-2-kid", "RS256", "sig")
require.Error(t, err)
gks2, err := t1ValidNID.GenerateAndPersistKeySet(ctx, "2022-03-11-ks-2", "2022-03-11-ks-2-kid", "RS256", "sig")
require.NoError(t, err)
_, err = t1ValidNID.GetKey(ctx, "2022-03-11-ks-2", gks2.Keys[0].KeyID)
require.NoError(t, err)
_, err = t2InvalidNID.GetKey(ctx, "2022-03-11-ks-2", gks2.Keys[0].KeyID)
require.Error(t, err)
_, err = t1ValidNID.GetKeySet(ctx, "2022-03-11-ks-2")
require.NoError(t, err)
_, err = t2InvalidNID.GetKeySet(ctx, "2022-03-11-ks-2")
require.Error(t, err)
updatedKey := &gks2.Keys[0]
updatedKey.Use = "enc"
require.Error(t, t2InvalidNID.UpdateKey(ctx, "2022-03-11-ks-2", updatedKey))
require.NoError(t, t1ValidNID.UpdateKey(ctx, "2022-03-11-ks-2", updatedKey))
gks2.Keys[0].Use = "enc"
require.Error(t, t2InvalidNID.UpdateKeySet(ctx, "2022-03-11-ks-2", gks2))
require.NoError(t, t1ValidNID.UpdateKeySet(ctx, "2022-03-11-ks-2", gks2))
require.NoError(t, t2InvalidNID.DeleteKeySet(ctx, "2022-03-11-ks-2"))
require.NoError(t, t1ValidNID.DeleteKeySet(ctx, "2022-03-11-ks-2"))
}
} |
Go | hydra/jwk/registry.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk
import (
"github.com/ory/hydra/v2/aead"
"github.com/ory/hydra/v2/driver/config"
"github.com/ory/hydra/v2/x"
)
type InternalRegistry interface {
x.RegistryWriter
x.RegistryLogger
Registry
}
type Registry interface {
config.Provider
KeyManager() Manager
SoftwareKeyManager() Manager
KeyCipher() *aead.AESGCM
} |
Go | hydra/jwk/registry_mock_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
// Code generated by MockGen. DO NOT EDIT.
// Source: jwk/registry.go
// Package jwk_test is a generated GoMock package.
package jwk_test
import (
reflect "reflect"
gomock "github.com/golang/mock/gomock"
herodot "github.com/ory/herodot"
"github.com/ory/hydra/v2/aead"
config "github.com/ory/hydra/v2/driver/config"
jwk "github.com/ory/hydra/v2/jwk"
logrusx "github.com/ory/x/logrusx"
)
// MockInternalRegistry is a mock of InternalRegistry interface.
type MockInternalRegistry struct {
ctrl *gomock.Controller
recorder *MockInternalRegistryMockRecorder
}
// MockInternalRegistryMockRecorder is the mock recorder for MockInternalRegistry.
type MockInternalRegistryMockRecorder struct {
mock *MockInternalRegistry
}
// NewMockInternalRegistry creates a new mock instance.
func NewMockInternalRegistry(ctrl *gomock.Controller) *MockInternalRegistry {
mock := &MockInternalRegistry{ctrl: ctrl}
mock.recorder = &MockInternalRegistryMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockInternalRegistry) EXPECT() *MockInternalRegistryMockRecorder {
return m.recorder
}
// AuditLogger mocks base method.
func (m *MockInternalRegistry) AuditLogger() *logrusx.Logger {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "AuditLogger")
ret0, _ := ret[0].(*logrusx.Logger)
return ret0
}
// AuditLogger indicates an expected call of AuditLogger.
func (mr *MockInternalRegistryMockRecorder) AuditLogger() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AuditLogger", reflect.TypeOf((*MockInternalRegistry)(nil).AuditLogger))
}
// Config mocks base method.
func (m *MockInternalRegistry) Config() *config.DefaultProvider {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "Config")
ret0, _ := ret[0].(*config.DefaultProvider)
return ret0
}
// Config indicates an expected call of Config.
func (mr *MockInternalRegistryMockRecorder) Config() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Config", reflect.TypeOf((*MockInternalRegistry)(nil).Config))
}
// KeyCipher mocks base method.
func (m *MockInternalRegistry) KeyCipher() *aead.AESGCM {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "KeyCipher")
ret0, _ := ret[0].(*aead.AESGCM)
return ret0
}
// KeyCipher indicates an expected call of KeyCipher.
func (mr *MockInternalRegistryMockRecorder) KeyCipher() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "KeyCipher", reflect.TypeOf((*MockInternalRegistry)(nil).KeyCipher))
}
// KeyManager mocks base method.
func (m *MockInternalRegistry) KeyManager() jwk.Manager {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "KeyManager")
ret0, _ := ret[0].(jwk.Manager)
return ret0
}
// KeyManager indicates an expected call of KeyManager.
func (mr *MockInternalRegistryMockRecorder) KeyManager() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "KeyManager", reflect.TypeOf((*MockInternalRegistry)(nil).KeyManager))
}
// Logger mocks base method.
func (m *MockInternalRegistry) Logger() *logrusx.Logger {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "Logger")
ret0, _ := ret[0].(*logrusx.Logger)
return ret0
}
// Logger indicates an expected call of Logger.
func (mr *MockInternalRegistryMockRecorder) Logger() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Logger", reflect.TypeOf((*MockInternalRegistry)(nil).Logger))
}
// SoftwareKeyManager mocks base method.
func (m *MockInternalRegistry) SoftwareKeyManager() jwk.Manager {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "SoftwareKeyManager")
ret0, _ := ret[0].(jwk.Manager)
return ret0
}
// SoftwareKeyManager indicates an expected call of SoftwareKeyManager.
func (mr *MockInternalRegistryMockRecorder) SoftwareKeyManager() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SoftwareKeyManager", reflect.TypeOf((*MockInternalRegistry)(nil).SoftwareKeyManager))
}
// Writer mocks base method.
func (m *MockInternalRegistry) Writer() herodot.Writer {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "Writer")
ret0, _ := ret[0].(herodot.Writer)
return ret0
}
// Writer indicates an expected call of Writer.
func (mr *MockInternalRegistryMockRecorder) Writer() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Writer", reflect.TypeOf((*MockInternalRegistry)(nil).Writer))
}
// MockRegistry is a mock of Registry interface.
type MockRegistry struct {
ctrl *gomock.Controller
recorder *MockRegistryMockRecorder
}
// MockRegistryMockRecorder is the mock recorder for MockRegistry.
type MockRegistryMockRecorder struct {
mock *MockRegistry
}
// NewMockRegistry creates a new mock instance.
func NewMockRegistry(ctrl *gomock.Controller) *MockRegistry {
mock := &MockRegistry{ctrl: ctrl}
mock.recorder = &MockRegistryMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockRegistry) EXPECT() *MockRegistryMockRecorder {
return m.recorder
}
// Config mocks base method.
func (m *MockRegistry) Config() *config.DefaultProvider {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "Config")
ret0, _ := ret[0].(*config.DefaultProvider)
return ret0
}
// Config indicates an expected call of Config.
func (mr *MockRegistryMockRecorder) Config() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Config", reflect.TypeOf((*MockRegistry)(nil).Config))
}
// KeyCipher mocks base method.
func (m *MockRegistry) KeyCipher() *aead.AESGCM {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "KeyCipher")
ret0, _ := ret[0].(*aead.AESGCM)
return ret0
}
// KeyCipher indicates an expected call of KeyCipher.
func (mr *MockRegistryMockRecorder) KeyCipher() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "KeyCipher", reflect.TypeOf((*MockRegistry)(nil).KeyCipher))
}
// KeyManager mocks base method.
func (m *MockRegistry) KeyManager() jwk.Manager {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "KeyManager")
ret0, _ := ret[0].(jwk.Manager)
return ret0
}
// KeyManager indicates an expected call of KeyManager.
func (mr *MockRegistryMockRecorder) KeyManager() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "KeyManager", reflect.TypeOf((*MockRegistry)(nil).KeyManager))
}
// SoftwareKeyManager mocks base method.
func (m *MockRegistry) SoftwareKeyManager() jwk.Manager {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "SoftwareKeyManager")
ret0, _ := ret[0].(jwk.Manager)
return ret0
}
// SoftwareKeyManager indicates an expected call of SoftwareKeyManager.
func (mr *MockRegistryMockRecorder) SoftwareKeyManager() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SoftwareKeyManager", reflect.TypeOf((*MockRegistry)(nil).SoftwareKeyManager))
} |
Go | hydra/jwk/sdk_test.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwk_test
import (
"context"
"net/http"
"net/http/httptest"
"testing"
"github.com/ory/hydra/v2/driver/config"
hydra "github.com/ory/hydra-client-go/v2"
"github.com/ory/hydra/v2/internal"
"github.com/ory/hydra/v2/x"
"github.com/ory/x/contextx"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
. "github.com/ory/hydra/v2/jwk"
)
func TestJWKSDK(t *testing.T) {
t.Parallel()
ctx := context.Background()
conf := internal.NewConfigurationWithDefaults()
reg := internal.NewRegistryMemory(t, conf, &contextx.Default{})
router := x.NewRouterAdmin(conf.AdminURL)
h := NewHandler(reg)
h.SetRoutes(router, x.NewRouterPublic(), func(h http.Handler) http.Handler {
return h
})
server := httptest.NewServer(router)
conf.MustSet(ctx, config.KeyAdminURL, server.URL)
sdk := hydra.NewAPIClient(hydra.NewConfiguration())
sdk.GetConfig().Servers = hydra.ServerConfigurations{{URL: server.URL}}
expectedKid := "key-bar"
t.Run("JSON Web Key", func(t *testing.T) {
t.Parallel()
t.Run("CreateJwkSetKey", func(t *testing.T) {
// Create a key called set-foo
resultKeys, _, err := sdk.JwkApi.CreateJsonWebKeySet(context.Background(), "set-foo").CreateJsonWebKeySet(hydra.CreateJsonWebKeySet{
Alg: "RS256",
Kid: "key-bar",
Use: "sig",
}).Execute()
require.NoError(t, err)
require.Len(t, resultKeys.Keys, 1)
assert.Equal(t, "key-bar", resultKeys.Keys[0].Kid)
assert.Equal(t, "RS256", resultKeys.Keys[0].Alg)
assert.Equal(t, "sig", resultKeys.Keys[0].Use)
})
var resultKeys *hydra.JsonWebKeySet
t.Run("GetJwkSetKey after create", func(t *testing.T) {
result, _, err := sdk.JwkApi.GetJsonWebKey(ctx, "set-foo", expectedKid).Execute()
require.NoError(t, err)
require.Len(t, result.Keys, 1)
require.Equal(t, expectedKid, result.Keys[0].Kid)
require.Equal(t, "RS256", result.Keys[0].Alg)
resultKeys = result
})
t.Run("UpdateJwkSetKey", func(t *testing.T) {
if conf.HSMEnabled() {
t.Skip("Skipping test. Keys cannot be updated when Hardware Security Module is enabled")
}
require.Len(t, resultKeys.Keys, 1)
resultKeys.Keys[0].Alg = "ES256"
resultKey, _, err := sdk.JwkApi.SetJsonWebKey(ctx, "set-foo", expectedKid).JsonWebKey(resultKeys.Keys[0]).Execute()
require.NoError(t, err)
assert.Equal(t, expectedKid, resultKey.Kid)
assert.Equal(t, "ES256", resultKey.Alg)
})
t.Run("DeleteJwkSetKey after delete", func(t *testing.T) {
_, err := sdk.JwkApi.DeleteJsonWebKey(ctx, "set-foo", expectedKid).Execute()
require.NoError(t, err)
})
t.Run("GetJwkSetKey after delete", func(t *testing.T) {
_, res, err := sdk.JwkApi.GetJsonWebKey(ctx, "set-foo", expectedKid).Execute()
require.Error(t, err)
assert.Equal(t, http.StatusNotFound, res.StatusCode)
})
})
t.Run("JWK Set", func(t *testing.T) {
t.Parallel()
t.Run("CreateJwkSetKey", func(t *testing.T) {
resultKeys, _, err := sdk.JwkApi.CreateJsonWebKeySet(ctx, "set-foo2").CreateJsonWebKeySet(hydra.CreateJsonWebKeySet{
Alg: "RS256",
Kid: "key-bar",
}).Execute()
require.NoError(t, err)
require.Len(t, resultKeys.Keys, 1)
assert.Equal(t, expectedKid, resultKeys.Keys[0].Kid)
assert.Equal(t, "RS256", resultKeys.Keys[0].Alg)
})
resultKeys, _, err := sdk.JwkApi.GetJsonWebKeySet(ctx, "set-foo2").Execute()
t.Run("GetJwkSet after create", func(t *testing.T) {
require.NoError(t, err)
if conf.HSMEnabled() {
require.Len(t, resultKeys.Keys, 1)
assert.Equal(t, expectedKid, resultKeys.Keys[0].Kid)
assert.Equal(t, "RS256", resultKeys.Keys[0].Alg)
} else {
require.Len(t, resultKeys.Keys, 1)
assert.Equal(t, expectedKid, resultKeys.Keys[0].Kid)
assert.Equal(t, "RS256", resultKeys.Keys[0].Alg)
}
})
t.Run("UpdateJwkSet", func(t *testing.T) {
if conf.HSMEnabled() {
t.Skip("Skipping test. Keys cannot be updated when Hardware Security Module is enabled")
}
require.Len(t, resultKeys.Keys, 1)
resultKeys.Keys[0].Alg = "ES256"
result, _, err := sdk.JwkApi.SetJsonWebKeySet(ctx, "set-foo2").JsonWebKeySet(*resultKeys).Execute()
require.NoError(t, err)
require.Len(t, result.Keys, 1)
assert.Equal(t, expectedKid, result.Keys[0].Kid)
assert.Equal(t, "ES256", result.Keys[0].Alg)
})
t.Run("DeleteJwkSet", func(t *testing.T) {
_, err := sdk.JwkApi.DeleteJsonWebKeySet(ctx, "set-foo2").Execute()
require.NoError(t, err)
})
t.Run("GetJwkSet after delete", func(t *testing.T) {
_, res, err := sdk.JwkApi.GetJsonWebKeySet(ctx, "set-foo2").Execute()
require.Error(t, err)
assert.Equal(t, http.StatusNotFound, res.StatusCode)
})
t.Run("GetJwkSetKey after delete", func(t *testing.T) {
_, res, err := sdk.JwkApi.GetJsonWebKey(ctx, "set-foo2", expectedKid).Execute()
require.Error(t, err)
assert.Equal(t, http.StatusNotFound, res.StatusCode)
})
})
} |
Go | hydra/oauth2/equalKeys.go | // Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package oauth2
import (
"testing"
"github.com/oleiade/reflections"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func AssertObjectKeysEqual(t *testing.T, a, b interface{}, keys ...string) {
assert.True(t, len(keys) > 0, "No keys provided.")
for _, k := range keys {
c, err := reflections.GetField(a, k)
assert.Nil(t, err)
d, err := reflections.GetField(b, k)
assert.Nil(t, err)
assert.Equal(t, c, d, "%s", k)
}
}
func AssertObjectKeysNotEqual(t *testing.T, a, b interface{}, keys ...string) {
assert.True(t, len(keys) > 0, "No keys provided.")
for _, k := range keys {
c, err := reflections.GetField(a, k)
assert.Nil(t, err)
d, err := reflections.GetField(b, k)
assert.Nil(t, err)
assert.NotEqual(t, c, d, "%s", k)
}
}
func RequireObjectKeysEqual(t *testing.T, a, b interface{}, keys ...string) {
assert.True(t, len(keys) > 0, "No keys provided.")
for _, k := range keys {
c, err := reflections.GetField(a, k)
assert.Nil(t, err)
d, err := reflections.GetField(b, k)
assert.Nil(t, err)
require.Equal(t, c, d, "%s", k)
}
}
func RequireObjectKeysNotEqual(t *testing.T, a, b interface{}, keys ...string) {
assert.True(t, len(keys) > 0, "No keys provided.")
for _, k := range keys {
c, err := reflections.GetField(a, k)
assert.Nil(t, err)
d, err := reflections.GetField(b, k)
assert.Nil(t, err)
require.NotEqual(t, c, d, "%s", k)
}
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.