# coding: utf-8
"""
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
http://www.apache.org/licenses/LICENSE-2.0
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.
"""
from __future__ import absolute_import
import sys
import os
import re
# python 2 and python 3 compatibility library
from six import iteritems
from ..api_client import ApiClient
# NOTE: This class is auto generated by the swagger code generator program.
# Do not edit the class manually.
# Ref: https://github.com/swagger-api/swagger-codegen
[docs]class ChildAccountUsersApi(object):
[docs] def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
[docs] def create_child_account_user(self, body, async_call=False, **kwargs):
"""
Create a new user user in a child account.
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type body: `ChildAccountUserRequest`
:param body: User in child account (required)
:rtype: `ChildAccountUser`
:return:
If the method is called asynchronously, returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if async_call:
return self.create_child_account_user_with_http_info(body, async_call=async_call, **kwargs)
else:
(data) = self.create_child_account_user_with_http_info(body, async_call=async_call, **kwargs)
return data
def create_child_account_user_with_http_info(self, body, async_call=False, **kwargs):
"""
Create a new user user in a child account.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_call=True::
>>> thread = api.create_child_account_user_with_http_info(body, async_call=True)
>>> result = thread.get()
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type body: `ChildAccountUserRequest`
:param body: User in child account (required)
:rtype: `ChildAccountUser`
:return:
If the method is called asynchronously, returns the request thread.
"""
all_params = ['body']
all_params.append('async_call')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method create_child_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'body' is set
if ('body' not in params) or (params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `create_child_account_user`")
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
# Authentication setting
auth_settings = ['bearerToken']
return self.api_client.call_api('/sys/v1/users/child_account', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ChildAccountUser',
auth_settings=auth_settings,
async_call=params.get('async_call'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
[docs] def delete_child_account_user(self, user_id, async_call=False, **kwargs):
"""
Completely delete a user in child account.
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type user_id: `str`
:param user_id: User Identifier (required)
:rtype: None
:return:
If the method is called asynchronously, returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if async_call:
return self.delete_child_account_user_with_http_info(user_id, async_call=async_call, **kwargs)
else:
(data) = self.delete_child_account_user_with_http_info(user_id, async_call=async_call, **kwargs)
return data
def delete_child_account_user_with_http_info(self, user_id, async_call=False, **kwargs):
"""
Completely delete a user in child account.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_call=True::
>>> thread = api.delete_child_account_user_with_http_info(user_id, async_call=True)
>>> result = thread.get()
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type user_id: `str`
:param user_id: User Identifier (required)
:rtype: None
:return:
If the method is called asynchronously, returns the request thread.
"""
all_params = ['user_id']
all_params.append('async_call')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_child_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params) or (params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `delete_child_account_user`")
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
# Authentication setting
auth_settings = ['bearerToken']
return self.api_client.call_api('/sys/v1/users/child_account/{user-id}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None,
auth_settings=auth_settings,
async_call=params.get('async_call'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
[docs] def get_all_child_account_users(self, account_id, async_call=False, **kwargs):
"""
Get all users in a child account
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type account_id: `str`
:param account_id: Account Identifier (required)
:rtype: list[`ChildAccountUser`]
:return:
If the method is called asynchronously, returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if async_call:
return self.get_all_child_account_users_with_http_info(account_id, async_call=async_call, **kwargs)
else:
(data) = self.get_all_child_account_users_with_http_info(account_id, async_call=async_call, **kwargs)
return data
def get_all_child_account_users_with_http_info(self, account_id, async_call=False, **kwargs):
"""
Get all users in a child account
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_call=True::
>>> thread = api.get_all_child_account_users_with_http_info(account_id, async_call=True)
>>> result = thread.get()
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type account_id: `str`
:param account_id: Account Identifier (required)
:rtype: list[`ChildAccountUser`]
:return:
If the method is called asynchronously, returns the request thread.
"""
all_params = ['account_id']
all_params.append('async_call')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_all_child_account_users" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'account_id' is set
if ('account_id' not in params) or (params['account_id'] is None):
raise ValueError("Missing the required parameter `account_id` when calling `get_all_child_account_users`")
collection_formats = {}
path_params = {}
if 'account_id' in params:
path_params['account-id'] = params['account_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
# Authentication setting
auth_settings = ['bearerToken']
return self.api_client.call_api('/sys/v1/users/child_account/{account-id}/all', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[ChildAccountUser]',
auth_settings=auth_settings,
async_call=params.get('async_call'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
[docs] def get_child_account_user(self, user_id, async_call=False, **kwargs):
"""
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type user_id: `str`
:param user_id: User Identifier (required)
:rtype: `ChildAccountUser`
:return:
If the method is called asynchronously, returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if async_call:
return self.get_child_account_user_with_http_info(user_id, async_call=async_call, **kwargs)
else:
(data) = self.get_child_account_user_with_http_info(user_id, async_call=async_call, **kwargs)
return data
def get_child_account_user_with_http_info(self, user_id, async_call=False, **kwargs):
"""
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_call=True::
>>> thread = api.get_child_account_user_with_http_info(user_id, async_call=True)
>>> result = thread.get()
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type user_id: `str`
:param user_id: User Identifier (required)
:rtype: `ChildAccountUser`
:return:
If the method is called asynchronously, returns the request thread.
"""
all_params = ['user_id']
all_params.append('async_call')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_child_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params) or (params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `get_child_account_user`")
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
# Authentication setting
auth_settings = ['bearerToken']
return self.api_client.call_api('/sys/v1/users/child_account/{user-id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ChildAccountUser',
auth_settings=auth_settings,
async_call=params.get('async_call'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
[docs] def update_child_account_user(self, user_id, body, async_call=False, **kwargs):
"""
Change a child account user's properties.
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type user_id: `str`
:param user_id: User Identifier (required)
:type body: `ChildAccountUserRequest`
:param body: User in child account (required)
:rtype: `ChildAccountUser`
:return:
If the method is called asynchronously, returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if async_call:
return self.update_child_account_user_with_http_info(user_id, body, async_call=async_call, **kwargs)
else:
(data) = self.update_child_account_user_with_http_info(user_id, body, async_call=async_call, **kwargs)
return data
def update_child_account_user_with_http_info(self, user_id, body, async_call=False, **kwargs):
"""
Change a child account user's properties.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_call=True::
>>> thread = api.update_child_account_user_with_http_info(user_id, body, async_call=True)
>>> result = thread.get()
:type async_call: bool
:param async_call: Whether the call should be performed asynchronously. (Default is False).
:type user_id: `str`
:param user_id: User Identifier (required)
:type body: `ChildAccountUserRequest`
:param body: User in child account (required)
:rtype: `ChildAccountUser`
:return:
If the method is called asynchronously, returns the request thread.
"""
all_params = ['user_id', 'body']
all_params.append('async_call')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_child_account_user" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'user_id' is set
if ('user_id' not in params) or (params['user_id'] is None):
raise ValueError("Missing the required parameter `user_id` when calling `update_child_account_user`")
# verify the required parameter 'body' is set
if ('body' not in params) or (params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling `update_child_account_user`")
collection_formats = {}
path_params = {}
if 'user_id' in params:
path_params['user-id'] = params['user_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
# Authentication setting
auth_settings = ['bearerToken']
return self.api_client.call_api('/sys/v1/users/child_account/{user-id}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ChildAccountUser',
auth_settings=auth_settings,
async_call=params.get('async_call'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)