FinSpace Public API
The FinSpace APIs let you take actions inside the FinSpace.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The FinSpace APIs let you take actions inside the FinSpace.
Endpoints 31
- POSTAssociateUserToPermissionGroup
/permission-group/:permissionGroupId/users/:userIdAdds a user account to a permission group to grant permissions for actions a user can perform in FinSpace. - DELETEDisassociateUserFromPermissionGroup
/permission-group/:permissionGroupId/users/:userId?clientToken=stringRemoves a user account from a permission group. - GETListChangesets
/datasets/:datasetId/changesetsv2?maxResults=1&nextToken=stringLists the FinSpace Changesets for a Dataset. - POSTCreateChangeset
/datasets/:datasetId/changesetsv2Creates a new Changeset in a FinSpace Dataset. - GETListDataViews
/datasets/:datasetId/dataviewsv2?nextToken=string&maxResults=1Lists all available Dataviews for a Dataset. - POSTCreateDataView
/datasets/:datasetId/dataviewsv2Creates a Dataview for a Dataset. - GETListDatasets
/datasetsv2?nextToken=string&maxResults=1Lists all of the active Datasets that a user has access to. - POSTCreateDataset
/datasetsv2Creates a new FinSpace Dataset. - POSTCreatePermissionGroup
/permission-groupCreates a group of permissions for various actions that a user can perform in FinSpace. - POSTCreateUser
/userCreates a new user in FinSpace. - GETGetDataset
/datasetsv2/:datasetIdReturns information about a Dataset. - PUTUpdateDataset
/datasetsv2/:datasetIdUpdates a FinSpace Dataset. - DELETEDeleteDataset
/datasetsv2/:datasetId?clientToken=stringDeletes a FinSpace Dataset. - GETGetPermissionGroup
/permission-group/:permissionGroupIdRetrieves the details of a specific permission group. - PUTUpdatePermissionGroup
/permission-group/:permissionGroupIdModifies the details of a permission group. You cannot modify a <code>permissionGroupID</code>. - DELETEDeletePermissionGroup
/permission-group/:permissionGroupId?clientToken=stringDeletes a permission group. This action is irreversible. - POSTDisableUser
/user/:userId/disableDenies access to the FinSpace web application and API for the specified user. - POSTEnableUser
/user/:userId/enableAllows the specified user to access the FinSpace web application and API. - GETGetChangeset
/datasets/:datasetId/changesetsv2/:changesetIdGet information about a Changeset. - PUTUpdateChangeset
/datasets/:datasetId/changesetsv2/:changesetIdUpdates a FinSpace Changeset. - GETGetDataView
/datasets/:datasetId/dataviewsv2/:dataviewIdGets information about a Dataview. - POSTGetExternalDataViewAccessDetails
/datasets/:datasetId/dataviewsv2/:dataviewId/external-access-details<p>Returns the credentials to access the external Dataview from an S3 location. To call this API:</p> <ul> <li> <p>You must retrieve the programmatic… - GETGetProgrammaticAccessCredentials
/credentials/programmatic#environmentId?durationInMinutes=60&environmentId=stringRequest programmatic credentials to use with FinSpace SDK. - GETGetUser
/user/:userIdRetrieves details for a specific user. - PUTUpdateUser
/user/:userIdModifies the details of the specified user account. You cannot update the <code>userId</code> for a user. - POSTGetWorkingLocation
/workingLocationV1A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook. - GETListPermissionGroups
/permission-group#maxResults?nextToken=string&maxResults=1Lists all available permission groups in FinSpace. - GETListPermissionGroupsByUser
/user/:userId/permission-groups#maxResults?nextToken=string&maxResults=1Lists all the permission groups that are associated with a specific user account. - GETListUsers
/user#maxResults?nextToken=string&maxResults=1Lists all available user accounts in FinSpace. - GETListUsersByPermissionGroup
/permission-group/:permissionGroupId/users#maxResults?nextToken=string&maxResults=1Lists details of all the users in a specific permission group. - POSTResetUserPassword
/user/:userId/passwordResets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password…
API details
- Base URL
http://finspace-api.{region}.amazonaws.comhttps://finspace-api.{region}.amazonaws.comhttp://finspace-api.{region}.amazonaws.com.cnhttps://finspace-api.{region}.amazonaws.com.cn- Authentication
- An API key in the Authorization header
- Operations
- 31 operations on 21 pathsGET 13POST 11PUT 4DELETE 3
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2020-07-13 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the FinSpace Public API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the FinSpace Public API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “AssociateUserToPermissionGroup” (POST /permission-group/:permissionGroupId/users/:userId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the FinSpace Public API?
The FinSpace APIs let you take actions inside the FinSpace. It is listed under Developer tools and has 31 endpoints.
Who publishes the FinSpace Public API?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the FinSpace Public API?
Its description lists 4 base URLs: http://finspace-api.{region}.amazonaws.com, https://finspace-api.{region}.amazonaws.com, http://finspace-api.{region}.amazonaws.com.cn, https://finspace-api.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the FinSpace Public API?
With an API key in the Authorization header.
How many endpoints does the FinSpace Public API have?
31 operations on 21 paths (13 GET, 11 POST, 4 PUT, 3 DELETE).
Is forking the FinSpace Public API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.