Skip to content

UserPermissionsApi.md

Latest commit

 

History

History
315 lines (215 loc) · 10.7 KB

UserPermissionsApi.md

File metadata and controls

315 lines (215 loc) · 10.7 KB

ksapi.UserPermissionsApi

All URIs are relative to http://localhost:8000

Method HTTP request Description
create_user_permission POST /v1/user-permissions Create User Permission Handler
delete_user_permission DELETE /v1/user-permissions/{permission_id} Delete User Permission Handler
list_user_permissions GET /v1/user-permissions List User Permissions Handler
update_user_permission PATCH /v1/user-permissions/{permission_id} Update User Permission Handler

create_user_permission

PermissionResponse create_user_permission(create_permission_request, authorization=authorization, ks_uat=ks_uat)

Create User Permission Handler

Create a path permission for a user in a tenant (admin/owner only).

Example

import ksapi
from ksapi.models.create_permission_request import CreatePermissionRequest
from ksapi.models.permission_response import PermissionResponse
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.UserPermissionsApi(api_client)
    create_permission_request = ksapi.CreatePermissionRequest() # CreatePermissionRequest | 
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Create User Permission Handler
        api_response = api_instance.create_user_permission(create_permission_request, authorization=authorization, ks_uat=ks_uat)
        print("The response of UserPermissionsApi->create_user_permission:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserPermissionsApi->create_user_permission: %s\n" % e)

Parameters

Name Type Description Notes
create_permission_request CreatePermissionRequest
authorization str [optional]
ks_uat str [optional]

Return type

PermissionResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Successful Response -
422 Validation Error -

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

delete_user_permission

delete_user_permission(permission_id, tenant_id, authorization=authorization, ks_uat=ks_uat)

Delete User Permission Handler

Delete a path permission (admin/owner only).

Example

import ksapi
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.UserPermissionsApi(api_client)
    permission_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    tenant_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Tenant ID the permission belongs to
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Delete User Permission Handler
        api_instance.delete_user_permission(permission_id, tenant_id, authorization=authorization, ks_uat=ks_uat)
    except Exception as e:
        print("Exception when calling UserPermissionsApi->delete_user_permission: %s\n" % e)

Parameters

Name Type Description Notes
permission_id UUID
tenant_id UUID Tenant ID the permission belongs to
authorization str [optional]
ks_uat str [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Successful Response -
422 Validation Error -

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

list_user_permissions

PaginatedResponsePermissionResponse list_user_permissions(tenant_id, user_id, limit=limit, offset=offset, authorization=authorization, ks_uat=ks_uat)

List User Permissions Handler

List path permissions for a user in a tenant (admin/owner only).

Example

import ksapi
from ksapi.models.paginated_response_permission_response import PaginatedResponsePermissionResponse
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.UserPermissionsApi(api_client)
    tenant_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Tenant ID to list permissions for
    user_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | User ID to list permissions for
    limit = 20 # int | Number of items per page (optional) (default to 20)
    offset = 0 # int | Number of items to skip (optional) (default to 0)
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # List User Permissions Handler
        api_response = api_instance.list_user_permissions(tenant_id, user_id, limit=limit, offset=offset, authorization=authorization, ks_uat=ks_uat)
        print("The response of UserPermissionsApi->list_user_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserPermissionsApi->list_user_permissions: %s\n" % e)

Parameters

Name Type Description Notes
tenant_id UUID Tenant ID to list permissions for
user_id UUID User ID to list permissions for
limit int Number of items per page [optional] [default to 20]
offset int Number of items to skip [optional] [default to 0]
authorization str [optional]
ks_uat str [optional]

Return type

PaginatedResponsePermissionResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

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

update_user_permission

PermissionResponse update_user_permission(permission_id, tenant_id, update_permission_request, authorization=authorization, ks_uat=ks_uat)

Update User Permission Handler

Update a path permission (admin/owner only).

Example

import ksapi
from ksapi.models.permission_response import PermissionResponse
from ksapi.models.update_permission_request import UpdatePermissionRequest
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.UserPermissionsApi(api_client)
    permission_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    tenant_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Tenant ID the permission belongs to
    update_permission_request = ksapi.UpdatePermissionRequest() # UpdatePermissionRequest | 
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Update User Permission Handler
        api_response = api_instance.update_user_permission(permission_id, tenant_id, update_permission_request, authorization=authorization, ks_uat=ks_uat)
        print("The response of UserPermissionsApi->update_user_permission:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserPermissionsApi->update_user_permission: %s\n" % e)

Parameters

Name Type Description Notes
permission_id UUID
tenant_id UUID Tenant ID the permission belongs to
update_permission_request UpdatePermissionRequest
authorization str [optional]
ks_uat str [optional]

Return type

PermissionResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

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