Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1431163144.6 KB

Retrieves details for a specific user.

get/user/{userId}

Path parameters

userIdstring required

The unique identifier of the user to get data for.

Response

Success

userIdstring

The unique identifier for the user account that is retrieved.

status'CREATING' | 'ENABLED' | 'DISABLED'
<p>The current status of the user account. </p> <ul> <li> <p> <code>CREATING</code> – The user account creation is in progress.</p> </li> <li> <p> <code>ENABLED</code> – The user account is created and is currently active.</p> </li> <li> <p> <code>DISABLED</code> – The user account is currently inactive.</p> </li> </ul>
firstNamestring password

The first name of the user.

lastNamestring password

The last name of the user.

emailAddressstring password

The email address that is associated with the user.

type'SUPER_USER' | 'APP_USER'
<p>Indicates the type of user. </p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> </ul> <ul> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>
apiAccess'ENABLED' | 'DISABLED'
<p>Indicates whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations. </p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>
apiAccessPrincipalArnstring

The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

createTimeinteger

The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

lastEnabledTimeinteger

Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.

lastDisabledTimeinteger

Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

lastModifiedTimeinteger

Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.

lastLoginTimeinteger

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.