Amazon FinSpace Dataset Browser will be discontinued on November 29,
2024
. Starting November 29, 2023
, FinSpace will no longer accept the creation of new Dataset Browser
environments. Customers using Amazon FinSpace with Managed Kdb Insights
GetUser
Retrieves details for a specific user.
Request Syntax
GET /user/userId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- userId
-
The unique identifier of the user to get data for.
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
.*\S.*
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"apiAccess": "string",
"apiAccessPrincipalArn": "string",
"createTime": number,
"emailAddress": "string",
"firstName": "string",
"lastDisabledTime": number,
"lastEnabledTime": number,
"lastLoginTime": number,
"lastModifiedTime": number,
"lastName": "string",
"status": "string",
"type": "string",
"userId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- apiAccess
-
Indicates whether the user can use the
GetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
Type: String
Valid Values:
ENABLED | DISABLED
-
- apiAccessPrincipalArn
-
The ARN identifier of an AWS user or role that is allowed to call the
GetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
- createTime
-
The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
Type: Long
- emailAddress
-
The email address that is associated with the user.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 320.
Pattern:
[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}
- firstName
-
The first name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
.*\S.*
- lastDisabledTime
-
Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
Type: Long
- lastEnabledTime
-
Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
Type: Long
- lastLoginTime
-
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
Type: Long
- lastModifiedTime
-
Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.
Type: Long
- lastName
-
The last name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
.*\S.*
- status
-
The current status of the user.
-
CREATING
– The creation is in progress. -
ENABLED
– The user is created and is currently active. -
DISABLED
– The user is currently inactive.
Type: String
Valid Values:
CREATING | ENABLED | DISABLED
-
- type
-
Indicates the type of user.
-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace.
-
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
Type: String
Valid Values:
SUPER_USER | APP_USER
-
- userId
-
The unique identifier for the user that is retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: