| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CognitoIdentityProvider.AdminUserGlobalSignOut
Description
Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Calling this action requires developer credentials.
Synopsis
- data AdminUserGlobalSignOut = AdminUserGlobalSignOut' {
- userPoolId :: Text
- username :: Sensitive Text
- newAdminUserGlobalSignOut :: Text -> Text -> AdminUserGlobalSignOut
- adminUserGlobalSignOut_userPoolId :: Lens' AdminUserGlobalSignOut Text
- adminUserGlobalSignOut_username :: Lens' AdminUserGlobalSignOut Text
- data AdminUserGlobalSignOutResponse = AdminUserGlobalSignOutResponse' {
- httpStatus :: Int
- newAdminUserGlobalSignOutResponse :: Int -> AdminUserGlobalSignOutResponse
- adminUserGlobalSignOutResponse_httpStatus :: Lens' AdminUserGlobalSignOutResponse Int
Creating a Request
data AdminUserGlobalSignOut Source #
The request to sign out of all devices, as an administrator.
See: newAdminUserGlobalSignOut smart constructor.
Constructors
| AdminUserGlobalSignOut' | |
Fields
| |
Instances
newAdminUserGlobalSignOut Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminUserGlobalSignOut |
Create a value of AdminUserGlobalSignOut with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminUserGlobalSignOut', adminUserGlobalSignOut_userPoolId - The user pool ID.
$sel:username:AdminUserGlobalSignOut', adminUserGlobalSignOut_username - The user name.
Request Lenses
adminUserGlobalSignOut_userPoolId :: Lens' AdminUserGlobalSignOut Text Source #
The user pool ID.
adminUserGlobalSignOut_username :: Lens' AdminUserGlobalSignOut Text Source #
The user name.
Destructuring the Response
data AdminUserGlobalSignOutResponse Source #
The global sign-out response, as an administrator.
See: newAdminUserGlobalSignOutResponse smart constructor.
Constructors
| AdminUserGlobalSignOutResponse' | |
Fields
| |
Instances
newAdminUserGlobalSignOutResponse Source #
Create a value of AdminUserGlobalSignOutResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminUserGlobalSignOutResponse', adminUserGlobalSignOutResponse_httpStatus - The response's http status code.
Response Lenses
adminUserGlobalSignOutResponse_httpStatus :: Lens' AdminUserGlobalSignOutResponse Int Source #
The response's http status code.