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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package cognitoidentityprovider
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Gets the specified user by user name in a user pool as an administrator. Works
// on any user.
//
// Amazon Cognito evaluates Identity and Access Management (IAM) policies in
// requests for this API operation. For this operation, you must use IAM
// credentials to authorize requests, and you must grant yourself the corresponding
// IAM permission in a policy.
//
// # Learn more
//
// [Signing Amazon Web Services API Requests]
//
// [Using the Amazon Cognito user pools API and user pool endpoints]
//
// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
func (c *Client) AdminGetUser(ctx context.Context, params *AdminGetUserInput, optFns ...func(*Options)) (*AdminGetUserOutput, error) {
if params == nil {
params = &AdminGetUserInput{}
}
result, metadata, err := c.invokeOperation(ctx, "AdminGetUser", params, optFns, c.addOperationAdminGetUserMiddlewares)
if err != nil {
return nil, err
}
out := result.(*AdminGetUserOutput)
out.ResultMetadata = metadata
return out, nil
}
// Represents the request to get the specified user as an administrator.
type AdminGetUserInput struct {
// The user pool ID for the user pool where you want to get information about the
// user.
//
// This member is required.
UserPoolId *string
// The username of the user that you want to query or modify. The value of this
// parameter is typically your user's username, but it can be any of their alias
// attributes. If username isn't an alias attribute in your user pool, this value
// must be the sub of a local user or the username of a user from a third-party
// IdP.
//
// This member is required.
Username *string
noSmithyDocumentSerde
}
// Represents the response from the server from the request to get the specified
// user as an administrator.
type AdminGetUserOutput struct {
// The username of the user that you requested.
//
// This member is required.
Username *string
// Indicates that the status is enabled .
Enabled bool
// This response parameter is no longer supported. It provides information only
// about SMS MFA configurations. It doesn't provide information about time-based
// one-time password (TOTP) software token MFA configurations. To look up
// information about either type of MFA configuration, use UserMFASettingList
// instead.
MFAOptions []types.MFAOptionType
// The user's preferred MFA setting.
PreferredMfaSetting *string
// An array of name-value pairs representing user attributes.
UserAttributes []types.AttributeType
// The date the user was created.
UserCreateDate *time.Time
// The date and time when the item was modified. Amazon Cognito returns this
// timestamp in UNIX epoch time format. Your SDK might render the output in a
// human-readable format like ISO 8601 or a Java Date object.
UserLastModifiedDate *time.Time
// The MFA options that are activated for the user. The possible values in this
// list are SMS_MFA and SOFTWARE_TOKEN_MFA .
UserMFASettingList []string
// The user status. Can be one of the following:
//
// - UNCONFIRMED - User has been created but not confirmed.
//
// - CONFIRMED - User has been confirmed.
//
// - UNKNOWN - User status isn't known.
//
// - RESET_REQUIRED - User is confirmed, but the user must request a code and
// reset their password before they can sign in.
//
// - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in
// using a temporary password, but on first sign-in, the user must change their
// password to a new value before doing anything else.
UserStatus types.UserStatusType
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationAdminGetUserMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpAdminGetUser{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpAdminGetUser{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "AdminGetUser"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpAdminGetUserValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opAdminGetUser(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opAdminGetUser(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "AdminGetUser",
}
}
|