Skip to content

Latest commit

 

History

History
411 lines (287 loc) · 13.2 KB

AdminUserManagementApi.md

File metadata and controls

411 lines (287 loc) · 13.2 KB

ibutsu_client.AdminUserManagementApi

All URIs are relative to /api

Method HTTP request Description
admin_add_user POST /admin/user Administration endpoint to manually add a user. Only accessible to superadmins.
admin_delete_user DELETE /admin/user/{id} Administration endpoint to delete a user. Only accessible to superadmins.
admin_get_user GET /admin/user/{id} Administration endpoint to return a user. Only accessible to superadmins.
admin_get_user_list GET /admin/user Administration endpoint to return a list of users. Only accessible to superadmins.
admin_update_user PUT /admin/user/{id} Administration endpoint to update a user. Only accessible to superadmins.

admin_add_user

User admin_add_user(user=user)

Administration endpoint to manually add a user. Only accessible to superadmins.

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.user import User
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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.

# Configure Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.AdminUserManagementApi(api_client)
    user = ibutsu_client.User() # User | A user object (optional)

    try:
        # Administration endpoint to manually add a user. Only accessible to superadmins.
        api_response = api_instance.admin_add_user(user=user)
        print("The response of AdminUserManagementApi->admin_add_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminUserManagementApi->admin_add_user: %s\n" % e)

Parameters

Name Type Description Notes
user User A user object [optional]

Return type

User

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 A user was created -
400 Bad request, JSON required -
401 The user needs to be logged in -
403 The user needs to be a superadmin -

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

admin_delete_user

admin_delete_user(id)

Administration endpoint to delete a user. Only accessible to superadmins.

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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.

# Configure Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.AdminUserManagementApi(api_client)
    id = 'id_example' # str | The ID of the user to delete

    try:
        # Administration endpoint to delete a user. Only accessible to superadmins.
        api_instance.admin_delete_user(id)
    except Exception as e:
        print("Exception when calling AdminUserManagementApi->admin_delete_user: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the user to delete

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 The specified user was deleted -
401 The user needs to be logged in -
403 The user needs to be a superadmin -
404 User not found -

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

admin_get_user

User admin_get_user(id)

Administration endpoint to return a user. Only accessible to superadmins.

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.user import User
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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.

# Configure Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.AdminUserManagementApi(api_client)
    id = 'id_example' # str | The id of a user

    try:
        # Administration endpoint to return a user. Only accessible to superadmins.
        api_response = api_instance.admin_get_user(id)
        print("The response of AdminUserManagementApi->admin_get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminUserManagementApi->admin_get_user: %s\n" % e)

Parameters

Name Type Description Notes
id str The id of a user

Return type

User

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Returns a user -
401 The querying user needs to be logged in -
403 The querying user needs to be a superadmin -
404 The requested user does not exist -

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

admin_get_user_list

UserList admin_get_user_list(filter=filter, page=page, page_size=page_size)

Administration endpoint to return a list of users. Only accessible to superadmins.

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.user_list import UserList
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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.

# Configure Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.AdminUserManagementApi(api_client)
    filter = ['filter_example'] # List[str] | Fields to filter by (optional)
    page = 56 # int | Set the page of items to return, defaults to 1 (optional)
    page_size = 56 # int | Set the number of items per page, defaults to 25 (optional)

    try:
        # Administration endpoint to return a list of users. Only accessible to superadmins.
        api_response = api_instance.admin_get_user_list(filter=filter, page=page, page_size=page_size)
        print("The response of AdminUserManagementApi->admin_get_user_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminUserManagementApi->admin_get_user_list: %s\n" % e)

Parameters

Name Type Description Notes
filter List[str] Fields to filter by [optional]
page int Set the page of items to return, defaults to 1 [optional]
page_size int Set the number of items per page, defaults to 25 [optional]

Return type

UserList

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Returns a list of users -
401 The user needs to be logged in -
403 The user needs to be a superadmin -

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

admin_update_user

User admin_update_user(id, user=user)

Administration endpoint to update a user. Only accessible to superadmins.

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.user import User
from ibutsu_client.rest import ApiException
from pprint import pprint

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

# 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.

# Configure Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.AdminUserManagementApi(api_client)
    id = 'id_example' # str | The ID of the user to update
    user = ibutsu_client.User() # User | A user object (optional)

    try:
        # Administration endpoint to update a user. Only accessible to superadmins.
        api_response = api_instance.admin_update_user(id, user=user)
        print("The response of AdminUserManagementApi->admin_update_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AdminUserManagementApi->admin_update_user: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the user to update
user User A user object [optional]

Return type

User

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request, JSON required or not enough parameters -
401 The user needs to be logged in -
403 The user needs to be a superadmin -
404 User not found -

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