sdkms.v1.apis.users_api 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.apis.users_api.UsersApi(api_client=None)[source]

Bases: object

__init__(api_client=None)[source]
change_password(body, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • body (PasswordChangeRequest) – Password change request (required)

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

confirm_email(user_id, body, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

  • body (ConfirmEmailRequest) – Validate user’s email (required)

Return type:

ConfirmEmailResponse

Returns:

If the method is called asynchronously, returns the request thread.

create_user(body, async_call=False, **kwargs)[source]

Signs up a new user.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • body (SignupRequest) – Email address of user (required)

Return type:

User

Returns:

If the method is called asynchronously, returns the request thread.

delete_user(user_id, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

delete_user_account(async_call=False, **kwargs)[source]

Completely deletes the currently logged in user from the system.

Parameters:

async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

forgot_password(body, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • body (ForgotPasswordRequest) – Initiate forgot password sequrence (required)

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

get_user(user_id, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

Return type:

User

Returns:

If the method is called asynchronously, returns the request thread.

get_user_account(async_call=False, **kwargs)[source]

Obtain the current user’s account information.

Parameters:

async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

Return type:

UserAccountMap

Returns:

If the method is called asynchronously, returns the request thread.

get_users(group_id=None, sort=None, start=None, limit=None, offset=None, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • group_id (str) – Only retrieve users in the specified group.

  • sort (str) – This specifies the property (user_id only, for now) and order (ascending or descending) with which to sort the users. By default, users are sorted by user_id in ascending order. The syntax is “<property>:[asc|desc]” (e.g. “user_id:desc”) or just “<property>” (ascending order by default).

  • start (str) – If provided, this must be a value of the property specified in sort. Returned users will begin just above or just below this value (for asc/desc order resp.).

  • limit (int) – Maximum number of users to return. If not provided, the limit is 100.

  • offset (int) – Number of users past start to skip.

Return type:

list[User]

Returns:

If the method is called asynchronously, returns the request thread.

invite_user(body, async_call=False, **kwargs)[source]

Invite an existing user or new user to join an existing account. Only user email is required for invite API

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • body (UserRequest) – Name of user (required)

Return type:

User

Returns:

If the method is called asynchronously, returns the request thread.

process_invitations(body, async_call=False, **kwargs)[source]

Process a user’s pending invitations. It does both accepts and rejects.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • body (ProcessInviteRequest) – Process account invitation (both accepts and rejects) (required)

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

resend_confirm_email(user_id, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

resend_invitation(user_id, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

reset_password(user_id, body, async_call=False, **kwargs)[source]

Resetting a user’s password. User must have a valid reset token from forgot password step.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

  • body (PasswordResetRequest) – Reset password (required)

Return type:

None

Returns:

If the method is called asynchronously, returns the request thread.

update_user(user_id, body, async_call=False, **kwargs)[source]

Change a user’s properties.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

  • body (UserRequest) – Name of user (required)

Return type:

User

Returns:

If the method is called asynchronously, returns the request thread.

validate_password_reset_token(user_id, body, async_call=False, **kwargs)[source]
Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • user_id (str) – User Identifier (required)

  • body (ValidateTokenRequest) – Validate token (required)

Return type:

ValidateTokenResponse

Returns:

If the method is called asynchronously, returns the request thread.