sdkms.v1.models.user_request module

Fortanix DSM REST API

This is a set of REST APIs for accessing the Fortanix Data Security Manager. This includes APIs for managing accounts, and for performing cryptographic and key management operations.

OpenAPI spec version: 1.0.0-20200608 Contact: support@fortanix.com Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class sdkms.v1.models.user_request.UserRequest(user_email=None, user_password=None, first_name=None, last_name=None, account_role=None, add_groups=None, del_groups=None, mod_groups=None, enabled=None, add_u2f_devices=None, del_u2f_devices=None, rename_u2f_devices=None)[source]

Bases: object

swagger_types

The key is attribute name and the value is attribute type.

Type:

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type:

dict

__init__(user_email=None, user_password=None, first_name=None, last_name=None, account_role=None, add_groups=None, del_groups=None, mod_groups=None, enabled=None, add_u2f_devices=None, del_u2f_devices=None, rename_u2f_devices=None)[source]

UserRequest - a model defined in Swagger

property account_role

Gets the account_role of this UserRequest.

Type: list[UserAccountFlags]

Setter:

Sets the account_role of this UserRequest.

property add_groups

Gets the add_groups of this UserRequest. The user will be added to the specified security groups with the specified roles.

Type: UserGroupMap

Setter:

Sets the add_groups of this UserRequest.

property add_u2f_devices

Gets the add_u2f_devices of this UserRequest.

Type: list[U2fAddDeviceRequest]

Setter:

Sets the add_u2f_devices of this UserRequest.

property del_groups

Gets the del_groups of this UserRequest. The user will be removed from the specified security groups.

Type: UserGroupMap

Setter:

Sets the del_groups of this UserRequest.

property del_u2f_devices

Gets the del_u2f_devices of this UserRequest.

Type: list[U2fDelDeviceRequest]

Setter:

Sets the del_u2f_devices of this UserRequest.

property enabled

Gets the enabled of this UserRequest. Whether this user is enabled.

Type: bool

Setter:

Sets the enabled of this UserRequest.

property first_name

Gets the first_name of this UserRequest.

Type: str

Setter:

Sets the first_name of this UserRequest.

property last_name

Gets the last_name of this UserRequest.

Type: str

Setter:

Sets the last_name of this UserRequest.

property mod_groups

Gets the mod_groups of this UserRequest. The user’s role in the specified groups will be updated to the specified roles.

Type: UserGroupMap

Setter:

Sets the mod_groups of this UserRequest.

property rename_u2f_devices

Gets the rename_u2f_devices of this UserRequest.

Type: list[U2fRenameDeviceRequest]

Setter:

Sets the rename_u2f_devices of this UserRequest.

property user_email

Gets the user_email of this UserRequest. User’s email address.

Type: str

Setter:

Sets the user_email of this UserRequest.

property user_password

Gets the user_password of this UserRequest. The password to assign to this user in DSM.

Type: str

Setter:

Sets the user_password of this UserRequest.