formkiq_client.UserManagementApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_group	POST /groups	Add a group
add_user	POST /users	Add User
add_user_to_group	POST /groups/{groupName}/users	Add User to a group
delete_group	DELETE /groups/{groupName}	Delete Group
delete_username	DELETE /users/{username}	Delete Username
get_group	GET /groups/{groupName}	Get a user group
get_groups	GET /groups	Get list of user group(s)
get_list_of_user_groups	GET /users/{username}/groups	Returns a list of group user belongs to
get_user	GET /users/{username}	Get a user
get_users	GET /users	Get list of user(s)
get_users_in_group	GET /groups/{groupName}/users	Get users in a group
remove_username_from_group	DELETE /groups/{groupName}/users/{username}	Remove Username From Group
set_user_operation	PUT /users/{username}/{userOperation}	Set User Operation

add_group

AddResponse add_group(add_group_request)

Add a group

Add a new group

Example

import formkiq_client
from formkiq_client.models.add_group_request import AddGroupRequest
from formkiq_client.models.add_response import AddResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    add_group_request = formkiq_client.AddGroupRequest() # AddGroupRequest | 

    try:
        # Add a group
        api_response = api_instance.add_group(add_group_request)
        print("The response of UserManagementApi->add_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->add_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_group_request	AddGroupRequest

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_user

AddResponse add_user(add_user_request)

Add User

Adds a user

Example

import formkiq_client
from formkiq_client.models.add_response import AddResponse
from formkiq_client.models.add_user_request import AddUserRequest
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    add_user_request = formkiq_client.AddUserRequest() # AddUserRequest | 

    try:
        # Add User
        api_response = api_instance.add_user(add_user_request)
        print("The response of UserManagementApi->add_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->add_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_user_request	AddUserRequest

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_user_to_group

AddResponse add_user_to_group(group_name, add_user_request)

Add User to a group

Adds a user to a group

Example

import formkiq_client
from formkiq_client.models.add_response import AddResponse
from formkiq_client.models.add_user_request import AddUserRequest
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    group_name = 'group_name_example' # str | Group Name
    add_user_request = formkiq_client.AddUserRequest() # AddUserRequest | 

    try:
        # Add User to a group
        api_response = api_instance.add_user_to_group(group_name, add_user_request)
        print("The response of UserManagementApi->add_user_to_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->add_user_to_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_name	str	Group Name
add_user_request	AddUserRequest

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_group

DeleteResponse delete_group(group_name)

Delete Group

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    group_name = 'group_name_example' # str | Group Name

    try:
        # Delete Group
        api_response = api_instance.delete_group(group_name)
        print("The response of UserManagementApi->delete_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->delete_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_name	str	Group Name

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_username

DeleteResponse delete_username(username)

Delete Username

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    username = 'username_example' # str | Username

    try:
        # Delete Username
        api_response = api_instance.delete_username(username)
        print("The response of UserManagementApi->delete_username:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->delete_username: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	Username

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_group

GetGroupResponse get_group(group_name)

Get a user group

Returns a user group

Example

import formkiq_client
from formkiq_client.models.get_group_response import GetGroupResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    group_name = 'group_name_example' # str | Group Name

    try:
        # Get a user group
        api_response = api_instance.get_group(group_name)
        print("The response of UserManagementApi->get_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->get_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_name	str	Group Name

Return type

GetGroupResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_groups

GetGroupsResponse get_groups(limit=limit, next=next)

Get list of user group(s)

Returns the list of user groups

Example

import formkiq_client
from formkiq_client.models.get_groups_response import GetGroupsResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    limit = '10' # str | Limit Results (optional) (default to '10')
    next = 'next_example' # str | Next page of results token (optional)

    try:
        # Get list of user group(s)
        api_response = api_instance.get_groups(limit=limit, next=next)
        print("The response of UserManagementApi->get_groups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->get_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	str	Limit Results	[optional] [default to '10']
next	str	Next page of results token	[optional]

Return type

GetGroupsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_list_of_user_groups

GetUserGroupsResponse get_list_of_user_groups(username, limit=limit, next=next)

Returns a list of group user belongs to

Example

import formkiq_client
from formkiq_client.models.get_user_groups_response import GetUserGroupsResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    username = 'username_example' # str | Username
    limit = '10' # str | Limit Results (optional) (default to '10')
    next = 'next_example' # str | Next page of results token (optional)

    try:
        # Returns a list of group user belongs to
        api_response = api_instance.get_list_of_user_groups(username, limit=limit, next=next)
        print("The response of UserManagementApi->get_list_of_user_groups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->get_list_of_user_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	Username
limit	str	Limit Results	[optional] [default to '10']
next	str	Next page of results token	[optional]

Return type

GetUserGroupsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user

GetUserResponse get_user(username)

Get a user

Returns a user

Example

import formkiq_client
from formkiq_client.models.get_user_response import GetUserResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    username = 'username_example' # str | Username

    try:
        # Get a user
        api_response = api_instance.get_user(username)
        print("The response of UserManagementApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->get_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	Username

Return type

GetUserResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users

GetUsersResponse get_users(limit=limit, next=next)

Get list of user(s)

Returns the list of users

Example

import formkiq_client
from formkiq_client.models.get_users_response import GetUsersResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    limit = '10' # str | Limit Results (optional) (default to '10')
    next = 'next_example' # str | Next page of results token (optional)

    try:
        # Get list of user(s)
        api_response = api_instance.get_users(limit=limit, next=next)
        print("The response of UserManagementApi->get_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->get_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	str	Limit Results	[optional] [default to '10']
next	str	Next page of results token	[optional]

Return type

GetUsersResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users_in_group

GetUsersInGroupResponse get_users_in_group(group_name, limit=limit, next=next)

Get users in a group

Returns the list of users in a group

Example

import formkiq_client
from formkiq_client.models.get_users_in_group_response import GetUsersInGroupResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    group_name = 'group_name_example' # str | Group Name
    limit = '10' # str | Limit Results (optional) (default to '10')
    next = 'next_example' # str | Next page of results token (optional)

    try:
        # Get users in a group
        api_response = api_instance.get_users_in_group(group_name, limit=limit, next=next)
        print("The response of UserManagementApi->get_users_in_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->get_users_in_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_name	str	Group Name
limit	str	Limit Results	[optional] [default to '10']
next	str	Next page of results token	[optional]

Return type

GetUsersInGroupResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_username_from_group

DeleteResponse remove_username_from_group(group_name, username)

Remove Username From Group

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    group_name = 'group_name_example' # str | Group Name
    username = 'username_example' # str | Username

    try:
        # Remove Username From Group
        api_response = api_instance.remove_username_from_group(group_name, username)
        print("The response of UserManagementApi->remove_username_from_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->remove_username_from_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_name	str	Group Name
username	str	Username

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_user_operation

SetResponse set_user_operation(username, user_operation)

Set User Operation

Set User Operation (disable, enable, reset-password)

Example

import formkiq_client
from formkiq_client.models.set_response import SetResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.UserManagementApi(api_client)
    username = 'username_example' # str | Username
    user_operation = 'user_operation_example' # str | Username Operation

    try:
        # Set User Operation
        api_response = api_instance.set_user_operation(username, user_operation)
        print("The response of UserManagementApi->set_user_operation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserManagementApi->set_user_operation: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	Username
user_operation	str	Username Operation

Return type

SetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

UserManagementApi.md

Latest commit

History

UserManagementApi.md

File metadata and controls

formkiq_client.UserManagementApi

add_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_user_to_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_username

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_groups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_user_groups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_users_in_group

Example

Parameters