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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package transfer
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/transfer/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// If the IdentityProviderType of a file transfer protocol-enabled server is
// AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is
// set up successfully. We highly recommend that you call this operation to test
// your authentication method as soon as you create your server. By doing so, you
// can troubleshoot issues with the identity provider integration to ensure that
// your users can successfully use the service. The ServerId and UserName
// parameters are required. The ServerProtocol, SourceIp, and UserPassword are all
// optional. You cannot use TestIdentityProvider if the IdentityProviderType of
// your server is SERVICE_MANAGED.
//
// * If you provide any incorrect values for any
// parameters, the Response field is empty.
//
// * If you provide a server ID for a
// server that uses service-managed users, you get an error: An error occurred
// (InvalidRequestException) when calling the TestIdentityProvider operation:
// s-server-ID not configured for external auth
//
// * If you enter a Server ID for the
// --server-id parameter that does not identify an actual Transfer server, you
// receive the following error: An error occurred (ResourceNotFoundException) when
// calling the TestIdentityProvider operation: Unknown server
func (c *Client) TestIdentityProvider(ctx context.Context, params *TestIdentityProviderInput, optFns ...func(*Options)) (*TestIdentityProviderOutput, error) {
if params == nil {
params = &TestIdentityProviderInput{}
}
result, metadata, err := c.invokeOperation(ctx, "TestIdentityProvider", params, optFns, c.addOperationTestIdentityProviderMiddlewares)
if err != nil {
return nil, err
}
out := result.(*TestIdentityProviderOutput)
out.ResultMetadata = metadata
return out, nil
}
type TestIdentityProviderInput struct {
// A system-assigned identifier for a specific server. That server's user
// authentication method is tested with a user name and password.
//
// This member is required.
ServerId *string
// The name of the user account to be tested.
//
// This member is required.
UserName *string
// The type of file transfer protocol to be tested. The available protocols are:
//
// *
// Secure Shell (SSH) File Transfer Protocol (SFTP)
//
// * File Transfer Protocol
// Secure (FTPS)
//
// * File Transfer Protocol (FTP)
ServerProtocol types.Protocol
// The source IP address of the user account to be tested.
SourceIp *string
// The password of the user account to be tested.
UserPassword *string
noSmithyDocumentSerde
}
type TestIdentityProviderOutput struct {
// The HTTP status code that is the response from your API Gateway.
//
// This member is required.
StatusCode int32
// The endpoint of the service used to authenticate a user.
//
// This member is required.
Url *string
// A message that indicates whether the test was successful or not. If an empty
// string is returned, the most likely cause is that the authentication failed due
// to an incorrect username or password.
Message *string
// The response that is returned from your API Gateway.
Response *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationTestIdentityProviderMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpTestIdentityProvider{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpTestIdentityProvider{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpTestIdentityProviderValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opTestIdentityProvider(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opTestIdentityProvider(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "transfer",
OperationName: "TestIdentityProvider",
}
}
|
