-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
175 lines (143 loc) · 5.59 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
package oauth2
// ConsentRequest represents a consent request.
// swagger:model oAuth2ConsentRequest
type swaggerConsentRequest struct {
// ID is the id of this consent request.
ID string `json:"id"`
// RequestedScopes represents a list of scopes that have been requested by the OAuth2 request initiator.
RequestedScopes []string `json:"requestedScopes,omitempty"`
// ClientID is the client id that initiated the OAuth2 request.
ClientID string `json:"clientId"`
// ExpiresAt is the time where the access request will expire.
ExpiresAt string `json:"expiresAt"`
// Redirect URL is the URL where the user agent should be redirected to after the consent has been
// accepted or rejected.
RedirectURL string `json:"redirectUrl"`
}
// swagger:parameters revokeOAuth2Token
type swaggerRevokeOAuth2TokenParameters struct {
// in: formData
// required: true
Token string `json:"token"`
}
// swagger:parameters rejectOAuth2ConsentRequest
type swaggerRejectConsentRequest struct {
// in: path
// required: true
ID string `json:"id"`
// in: body
// required: true
Body RejectConsentRequestPayload
}
// swagger:parameters acceptOAuth2ConsentRequest
type swaggerAcceptConsentRequest struct {
// in: path
// required: true
ID string `json:"id"`
// in: body
// required: true
Body AcceptConsentRequestPayload
}
// The consent request response
// swagger:response oAuth2ConsentRequest
type swaggerOAuthConsentRequest struct {
// in: body
Body swaggerConsentRequest
}
// The token response
// swagger:response oauthTokenResponse
type swaggerOAuthTokenResponse struct {
// in: body
Body struct {
// 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 int `json:"expires_in"`
// The scope of the access token
Scope int `json:"scope"`
// To retrieve a refresh token request the id_token scope.
IDToken int `json:"id_token"`
// The access token issued by the authorization server.
AccessToken string `json:"access_token"`
// 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"`
// The type of the token issued
TokenType string `json:"token_type"`
}
}
// The token introspection response
// swagger:response introspectOAuth2TokenResponse
type swaggerOAuthIntrospectionResponse struct {
// in: body
Body swaggerOAuthIntrospectionResponsePayload
}
// swagger:model oAuth2TokenIntrospection
type swaggerOAuthIntrospectionResponsePayload struct {
// 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).
Active bool `json:"active"`
// Scope is a JSON string containing a space-separated list of
// scopes associated with this token.
Scope string `json:"scope,omitempty"`
// ClientID is aclient identifier for the OAuth 2.0 client that
// requested this token.
ClientID string `json:"client_id,omitempty"`
// Subject of the token, as defined in JWT [RFC7519].
// Usually a machine-readable identifier of the resource owner who
// authorized this token.
Subject string `json:"sub,omitempty"`
// Expires at is an integer timestamp, measured in the number of seconds
// since January 1 1970 UTC, indicating when this token will expire.
ExpiresAt int64 `json:"exp,omitempty"`
// Issued at is an integer timestamp, measured in the number of seconds
// since January 1 1970 UTC, indicating when this token was
// originally issued.
IssuedAt int64 `json:"iat,omitempty"`
// 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.
NotBefore int64 `json:"nbf,omitempty"`
// Username is a human-readable identifier for the resource owner who
// authorized this token.
Username string `json:"username,omitempty"`
// ClientID is a service-specific string identifier or list of string
// identifiers representing the intended audience for this token.
Audience string `json:"aud,omitempty"`
// Issuer is a string representing the issuer of this token
Issuer string `json:"iss,omitempty"`
// Extra is arbitrary data set by the session.
Extra map[string]interface{} `json:"ext,omitempty"`
}
// swagger:parameters introspectOAuth2Token
type swaggerOAuthIntrospectionRequest struct {
// 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 [RFC6749], Section 5.1.
// This endpoint DOES NOT accept refresh tokens for validation.
//
// required: true
// in: formData
Token string `json:"token"`
// 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.
//
// in: formData
Scope string `json:"scope"`
}
// swagger:parameters getOAuth2ConsentRequest acceptConsentRequest rejectConsentRequest
type swaggerOAuthConsentRequestPayload struct {
// The id of the OAuth 2.0 Consent Request.
//
// unique: true
// required: true
// in: path
ID string `json:"id"`
}