Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Amazon Web Services User API
version: '1.0'
description: 'Operations tagged User across 3 of this provider''s published API definitions: connect-openapi-original.yml, finspace-data-openapi-original.yml, license-manager-user-subscriptions-openapi-original.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: User
paths:
/user/federate/{InstanceId}:
GET:
summary: Amazon Web Services Getfederationtoken
description: 'Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. This API doesn''t support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect'
operationId: amazonWebServicesGetFederationToken
tags:
- User
/user:
GET:
summary: Amazon Web Services Listusers
description: Lists all available users in FinSpace.
operationId: amazonWebServicesListUsers
tags:
- User
/user/{userId}/disable:
POST:
summary: Amazon Web Services Disableuser
description: Denies access to the FinSpace web application and API for the specified user.
operationId: amazonWebServicesDisableUser
tags:
- User
/user/{userId}/enable:
POST:
summary: Amazon Web Services Enableuser
description: Allows the specified user to access the FinSpace web application and API.
operationId: amazonWebServicesEnableUser
tags:
- User
/user/{userId}:
PUT:
summary: Amazon Web Services Updateuser
description: Modifies the details of the specified user. You cannot update the userId for a user.
operationId: amazonWebServicesUpdateUser
tags:
- User
/user/{userId}/permission-groups:
GET:
summary: Amazon Web Services Listpermissiongroupsbyuser
description: Lists all the permission groups that are associated with a specific user.
operationId: amazonWebServicesListPermissionGroupsByUser
tags:
- User
/user/{userId}/password:
POST:
summary: Amazon Web Services Resetuserpassword
description: Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.
operationId: amazonWebServicesResetUserPassword
tags:
- User
/user/AssociateUser:
POST:
summary: Amazon Web Services Associateuser
description: Associates the user to an EC2 instance to utilize user-based subscriptions. Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.
operationId: amazonWebServicesAssociateUser
tags:
- User
/user/DisassociateUser:
POST:
summary: Amazon Web Services Disassociateuser
description: Disassociates the user from an EC2 instance providing user-based subscriptions.
operationId: amazonWebServicesDisassociateUser
tags:
- User
/user/ListProductSubscriptions:
POST:
summary: Amazon Web Services Listproductsubscriptions
description: Lists the user-based subscription products available from an identity provider.
operationId: amazonWebServicesListProductSubscriptions
tags:
- User
/user/ListUserAssociations:
POST:
summary: Amazon Web Services Listuserassociations
description: Lists user associations for an identity provider.
operationId: amazonWebServicesListUserAssociations
tags:
- User
/user/StartProductSubscription:
POST:
summary: Amazon Web Services Startproductsubscription
description: Starts a product subscription for a user with the specified identity provider. Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.
operationId: amazonWebServicesStartProductSubscription
tags:
- User
/user/StopProductSubscription:
POST:
summary: Amazon Web Services Stopproductsubscription
description: Stops a product subscription for a user with the specified identity provider.
operationId: amazonWebServicesStopProductSubscription
tags:
- User
x-refined-from:
- connect-openapi-original.yml
- finspace-data-openapi-original.yml
- license-manager-user-subscriptions-openapi-original.yml