Module Values.GetUserResponseSource

Retrieves details for a specific user.

Sourcetype nonrec t = {
  1. userId : UserId.t option;
    (*

    The unique identifier for the user that is retrieved.

    *)
  2. status : UserStatus.t option;
    (*

    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.

    *)
  3. firstName : FirstName.t option;
    (*

    The first name of the user.

    *)
  4. lastName : LastName.t option;
    (*

    The last name of the user.

    *)
  5. emailAddress : Email.t option;
    (*

    The email address that is associated with the user.

    *)
  6. type_ : UserType.t option;
    (*

    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.

    *)
  7. apiAccess : ApiAccess.t option;
    (*

    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.

    *)
  8. apiAccessPrincipalArn : RoleArn.t option;
    (*

    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.

    *)
  9. createTime : TimestampEpoch.t option;
    (*

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

    *)
  10. lastEnabledTime : TimestampEpoch.t option;
    (*

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

    *)
  11. lastDisabledTime : TimestampEpoch.t option;
    (*

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

    *)
  12. lastModifiedTime : TimestampEpoch.t option;
    (*

    Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.

    *)
  13. lastLoginTime : TimestampEpoch.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?userId:??? -> ?status:??? -> ?firstName:??? -> ?lastName:??? -> ?emailAddress:??? -> ?type_:??? -> ?apiAccess:??? -> ?apiAccessPrincipalArn:??? -> ?createTime:??? -> ?lastEnabledTime:??? -> ?lastDisabledTime:??? -> ?lastModifiedTime:??? -> ?lastLoginTime:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of unit | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of unit | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Long of TimestampEpoch.t | `String of UserId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t