Module Values.CreateUserRequestSource

Creates a new user in FinSpace.

Sourcetype nonrec t = {
  1. emailAddress : Email.t;
    (*

    The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

    *)
  2. type_ : UserType.t;
    (*

    The option to indicate the type of user. Use one of the following options to specify this parameter: 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.

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

    The first name of the user that you want to register.

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

    The last name of the user that you want to register.

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

    The option to indicate 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.

    *)
  6. 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.

    *)
  7. clientToken : ClientToken.t option;
    (*

    A token that ensures idempotency. This token expires in 10 minutes.

    *)
}
Sourceval context_ : string
Sourceval make : ?firstName:??? -> ?lastName:??? -> ?apiAccess:??? -> ?apiAccessPrincipalArn:??? -> ?clientToken:??? -> emailAddress:Email.t -> type_:UserType.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of Email.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