-
Notifications
You must be signed in to change notification settings - Fork 623
/
api_op_StartDeviceAuthorization.go
233 lines (188 loc) · 7.64 KB
/
api_op_StartDeviceAuthorization.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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package ssooidc
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
type StartDeviceAuthorizationInput struct {
_ struct{} `type:"structure"`
// The unique identifier string for the client that is registered with AWS SSO.
// This value should come from the persisted result of the RegisterClient API
// operation.
//
// ClientId is a required field
ClientId *string `locationName:"clientId" type:"string" required:"true"`
// A secret string that is generated for the client. This value should come
// from the persisted result of the RegisterClient API operation.
//
// ClientSecret is a required field
ClientSecret *string `locationName:"clientSecret" type:"string" required:"true"`
// The URL for the AWS SSO user portal. For more information, see Using the
// User Portal (https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html)
// in the AWS Single Sign-On User Guide.
//
// StartUrl is a required field
StartUrl *string `locationName:"startUrl" type:"string" required:"true"`
}
// String returns the string representation
func (s StartDeviceAuthorizationInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *StartDeviceAuthorizationInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "StartDeviceAuthorizationInput"}
if s.ClientId == nil {
invalidParams.Add(aws.NewErrParamRequired("ClientId"))
}
if s.ClientSecret == nil {
invalidParams.Add(aws.NewErrParamRequired("ClientSecret"))
}
if s.StartUrl == nil {
invalidParams.Add(aws.NewErrParamRequired("StartUrl"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s StartDeviceAuthorizationInput) MarshalFields(e protocol.FieldEncoder) error {
e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/json"), protocol.Metadata{})
if s.ClientId != nil {
v := *s.ClientId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "clientId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.ClientSecret != nil {
v := *s.ClientSecret
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "clientSecret", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.StartUrl != nil {
v := *s.StartUrl
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "startUrl", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
type StartDeviceAuthorizationOutput struct {
_ struct{} `type:"structure"`
// The short-lived code that is used by the device when polling for a session
// token.
DeviceCode *string `locationName:"deviceCode" type:"string"`
// Indicates the number of seconds in which the verification code will become
// invalid.
ExpiresIn *int64 `locationName:"expiresIn" type:"integer"`
// Indicates the number of seconds the client must wait between attempts when
// polling for a session.
Interval *int64 `locationName:"interval" type:"integer"`
// A one-time user verification code. This is needed to authorize an in-use
// device.
UserCode *string `locationName:"userCode" type:"string"`
// The URI of the verification page that takes the userCode to authorize the
// device.
VerificationUri *string `locationName:"verificationUri" type:"string"`
// An alternate URL that the client can use to automatically launch a browser.
// This process skips the manual step in which the user visits the verification
// page and enters their code.
VerificationUriComplete *string `locationName:"verificationUriComplete" type:"string"`
}
// String returns the string representation
func (s StartDeviceAuthorizationOutput) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s StartDeviceAuthorizationOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.DeviceCode != nil {
v := *s.DeviceCode
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "deviceCode", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.ExpiresIn != nil {
v := *s.ExpiresIn
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "expiresIn", protocol.Int64Value(v), metadata)
}
if s.Interval != nil {
v := *s.Interval
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "interval", protocol.Int64Value(v), metadata)
}
if s.UserCode != nil {
v := *s.UserCode
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "userCode", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.VerificationUri != nil {
v := *s.VerificationUri
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "verificationUri", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.VerificationUriComplete != nil {
v := *s.VerificationUriComplete
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "verificationUriComplete", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
const opStartDeviceAuthorization = "StartDeviceAuthorization"
// StartDeviceAuthorizationRequest returns a request value for making API operation for
// AWS SSO OIDC.
//
// Initiates device authorization by requesting a pair of verification codes
// from the authorization service.
//
// // Example sending a request using StartDeviceAuthorizationRequest.
// req := client.StartDeviceAuthorizationRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorization
func (c *Client) StartDeviceAuthorizationRequest(input *StartDeviceAuthorizationInput) StartDeviceAuthorizationRequest {
op := &aws.Operation{
Name: opStartDeviceAuthorization,
HTTPMethod: "POST",
HTTPPath: "/device_authorization",
}
if input == nil {
input = &StartDeviceAuthorizationInput{}
}
req := c.newRequest(op, input, &StartDeviceAuthorizationOutput{})
req.Config.Credentials = aws.AnonymousCredentials
return StartDeviceAuthorizationRequest{Request: req, Input: input, Copy: c.StartDeviceAuthorizationRequest}
}
// StartDeviceAuthorizationRequest is the request type for the
// StartDeviceAuthorization API operation.
type StartDeviceAuthorizationRequest struct {
*aws.Request
Input *StartDeviceAuthorizationInput
Copy func(*StartDeviceAuthorizationInput) StartDeviceAuthorizationRequest
}
// Send marshals and sends the StartDeviceAuthorization API request.
func (r StartDeviceAuthorizationRequest) Send(ctx context.Context) (*StartDeviceAuthorizationResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &StartDeviceAuthorizationResponse{
StartDeviceAuthorizationOutput: r.Request.Data.(*StartDeviceAuthorizationOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// StartDeviceAuthorizationResponse is the response type for the
// StartDeviceAuthorization API operation.
type StartDeviceAuthorizationResponse struct {
*StartDeviceAuthorizationOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// StartDeviceAuthorization request.
func (r *StartDeviceAuthorizationResponse) SDKResponseMetdata() *aws.Response {
return r.response
}