ibm_gdsc_sdk_saas.JumpboxServiceApi

All URIs are relative to http://localhost

Method	HTTP request	Description
jumpbox_service_authorize	POST /api/v3/authorization	Summary: Authorize Description: Authenticate a user and return a JWT.
jumpbox_service_delete_account	DELETE /api/v3/accounts/{account_id}	Summary: Delete account Description: Delete an account.
jumpbox_service_delete_tenant	DELETE /api/v3/tenants/{tenant_id}	Summary: Delete tenant Description: Delete a tenant.
jumpbox_service_delete_user	DELETE /api/v3/users/{user_id}	Summary: Delete user Description: Delete the user.
jumpbox_service_get_account	GET /api/v3/accounts/{account_id}	Summary: Get account Description: Get an account.
jumpbox_service_get_accounts	GET /api/v3/accounts	Summary: Get accounts Description: Get all accounts based on UID.
jumpbox_service_get_tenant	GET /api/v3/tenants/{tenant_id}	Summary: Get tenant Description: Get a tenant.
jumpbox_service_get_tenants	GET /api/v3/tenants	Summary: Get tenants Description: Get all tenant base on UID.
jumpbox_service_get_users	GET /api/v3/users	Summary: Get users Description: Get all users base on a tenantID.
jumpbox_service_post_account	POST /api/v3/accounts	Summary: Post account Description: Create an Account.
jumpbox_service_post_tenants	POST /api/v3/tenants	Summary: Post tenants Description: Create a tenant.
jumpbox_service_post_users	POST /api/v3/users	Summary: Post users Description: Create users.
jumpbox_service_resume_account	PATCH /api/v3/accounts/{account_id}/resume	Summary: Resume account Description: Resume an account.
jumpbox_service_search_users	POST /api/v3/users/search	Summary: Search users Description: Search for all users matching the provided string.
jumpbox_service_suspend_account	PATCH /api/v3/accounts/{account_id}/suspend	Summary: Suspend Account Description: Suspend an account
jumpbox_service_test_user	POST /api/v3/users/test	Summary: Test user Description: Test a user lookup to a given LDAP.
jumpbox_service_update_account	PATCH /api/v3/accounts/{account_id}	Summary: Update Account Description: Updates an account.
jumpbox_service_update_tenant	PATCH /api/v3/tenants/{tenant_id}	Summary: Update tenant Description: Update a tenant.
jumpbox_service_update_users	PATCH /api/v3/users	Summary: Update users Description: Update an array of users.

jumpbox_service_authorize

Jumpboxv3AuthorizeResponse jumpbox_service_authorize(jumpboxv3_authorize_request)

Summary: Authorize Description: Authenticate a user and return a JWT.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_authorize_request import Jumpboxv3AuthorizeRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_authorize_response import Jumpboxv3AuthorizeResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    jumpboxv3_authorize_request = ibm_gdsc_sdk_saas.Jumpboxv3AuthorizeRequest() # Jumpboxv3AuthorizeRequest | 

    try:
        # Summary: Authorize Description: Authenticate a user and return a JWT.
        api_response = api_instance.jumpbox_service_authorize(jumpboxv3_authorize_request)
        print("The response of JumpboxServiceApi->jumpbox_service_authorize:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_authorize: %s\n" % e)

Parameters

Name	Type	Description	Notes
jumpboxv3_authorize_request	Jumpboxv3AuthorizeRequest

Return type

Jumpboxv3AuthorizeResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_delete_account

Jumpboxv3DeleteAccountResponse jumpbox_service_delete_account(account_id)

Summary: Delete account Description: Delete an account.

Example

Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_delete_account_response import Jumpboxv3DeleteAccountResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    account_id = 'account_id_example' # str | Account id.

    try:
        # Summary: Delete account Description: Delete an account.
        api_response = api_instance.jumpbox_service_delete_account(account_id)
        print("The response of JumpboxServiceApi->jumpbox_service_delete_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_delete_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	Account id.

Return type

Jumpboxv3DeleteAccountResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_delete_tenant

object jumpbox_service_delete_tenant(tenant_id, is_permanent_delete=is_permanent_delete, var_async=var_async)

Summary: Delete tenant Description: Delete a tenant.

Example

Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    tenant_id = 'tenant_id_example' # str | Tenant id.
    is_permanent_delete = True # bool | Delete tenant permanently if true. (optional)
    var_async = True # bool | Async. (optional)

    try:
        # Summary: Delete tenant Description: Delete a tenant.
        api_response = api_instance.jumpbox_service_delete_tenant(tenant_id, is_permanent_delete=is_permanent_delete, var_async=var_async)
        print("The response of JumpboxServiceApi->jumpbox_service_delete_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_delete_tenant: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_id	str	Tenant id.
is_permanent_delete	bool	Delete tenant permanently if true.	[optional]
var_async	bool	Async.	[optional]

Return type

object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_delete_user

object jumpbox_service_delete_user(user_id)

Summary: Delete user Description: Delete the user.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

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

    try:
        # Summary: Delete user Description: Delete the user.
        api_response = api_instance.jumpbox_service_delete_user(user_id)
        print("The response of JumpboxServiceApi->jumpbox_service_delete_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_delete_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	The user id.

Return type

object

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_get_account

Jumpboxv3GetAccountResponse jumpbox_service_get_account(account_id, include_inactive=include_inactive, include_not_ready=include_not_ready)

Summary: Get account Description: Get an account.

Example

Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_get_account_response import Jumpboxv3GetAccountResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    account_id = 'account_id_example' # str | Account id.
    include_inactive = True # bool | Include inactive. (optional)
    include_not_ready = True # bool | Include tenants that are not ready(are in state of being created or deleted). (optional)

    try:
        # Summary: Get account Description: Get an account.
        api_response = api_instance.jumpbox_service_get_account(account_id, include_inactive=include_inactive, include_not_ready=include_not_ready)
        print("The response of JumpboxServiceApi->jumpbox_service_get_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_get_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	Account id.
include_inactive	bool	Include inactive.	[optional]
include_not_ready	bool	Include tenants that are not ready(are in state of being created or deleted).	[optional]

Return type

Jumpboxv3GetAccountResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_get_accounts

Jumpboxv3GetAccountsResponse jumpbox_service_get_accounts(uid=uid, external_id=external_id, include_inactive=include_inactive, include_not_ready=include_not_ready)

Summary: Get accounts Description: Get all accounts based on UID.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_get_accounts_response import Jumpboxv3GetAccountsResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    uid = 'uid_example' # str | Email. (optional)
    external_id = 'external_id_example' # str | External id. (optional)
    include_inactive = True # bool | Include inactive. (optional)
    include_not_ready = True # bool | Include tenants that are not ready(are in state of being created or deleted). (optional)

    try:
        # Summary: Get accounts Description: Get all accounts based on UID.
        api_response = api_instance.jumpbox_service_get_accounts(uid=uid, external_id=external_id, include_inactive=include_inactive, include_not_ready=include_not_ready)
        print("The response of JumpboxServiceApi->jumpbox_service_get_accounts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_get_accounts: %s\n" % e)

Parameters

Name	Type	Description	Notes
uid	str	Email.	[optional]
external_id	str	External id.	[optional]
include_inactive	bool	Include inactive.	[optional]
include_not_ready	bool	Include tenants that are not ready(are in state of being created or deleted).	[optional]

Return type

Jumpboxv3GetAccountsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_get_tenant

Jumpboxv3GetTenantResponse jumpbox_service_get_tenant(tenant_id, include_inactive=include_inactive, include_not_ready=include_not_ready)

Summary: Get tenant Description: Get a tenant.

Example

Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_get_tenant_response import Jumpboxv3GetTenantResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    tenant_id = 'tenant_id_example' # str | Tenant id.
    include_inactive = True # bool | Include inactive. (optional)
    include_not_ready = True # bool | Include tenants that are not ready(are in state of being created or deleted). (optional)

    try:
        # Summary: Get tenant Description: Get a tenant.
        api_response = api_instance.jumpbox_service_get_tenant(tenant_id, include_inactive=include_inactive, include_not_ready=include_not_ready)
        print("The response of JumpboxServiceApi->jumpbox_service_get_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_get_tenant: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_id	str	Tenant id.
include_inactive	bool	Include inactive.	[optional]
include_not_ready	bool	Include tenants that are not ready(are in state of being created or deleted).	[optional]

Return type

Jumpboxv3GetTenantResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_get_tenants

Jumpboxv3GetTenantsResponse jumpbox_service_get_tenants(uid=uid, external_id=external_id, include_inactive=include_inactive, include_not_ready=include_not_ready)

Summary: Get tenants Description: Get all tenant base on UID.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_get_tenants_response import Jumpboxv3GetTenantsResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    uid = 'uid_example' # str | Email. (optional)
    external_id = 'external_id_example' # str | External id. (optional)
    include_inactive = True # bool | Include inactive. (optional)
    include_not_ready = True # bool | Include tenants that are not ready(are in state of being created or deleted). (optional)

    try:
        # Summary: Get tenants Description: Get all tenant base on UID.
        api_response = api_instance.jumpbox_service_get_tenants(uid=uid, external_id=external_id, include_inactive=include_inactive, include_not_ready=include_not_ready)
        print("The response of JumpboxServiceApi->jumpbox_service_get_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_get_tenants: %s\n" % e)

Parameters

Name	Type	Description	Notes
uid	str	Email.	[optional]
external_id	str	External id.	[optional]
include_inactive	bool	Include inactive.	[optional]
include_not_ready	bool	Include tenants that are not ready(are in state of being created or deleted).	[optional]

Return type

Jumpboxv3GetTenantsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_get_users

Tenantuserv3GetUsersResponse jumpbox_service_get_users(uid=uid)

Summary: Get users Description: Get all users base on a tenantID.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.tenantuserv3_get_users_response import Tenantuserv3GetUsersResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    uid = 'uid_example' # str | Email. (optional)

    try:
        # Summary: Get users Description: Get all users base on a tenantID.
        api_response = api_instance.jumpbox_service_get_users(uid=uid)
        print("The response of JumpboxServiceApi->jumpbox_service_get_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_get_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
uid	str	Email.	[optional]

Return type

Tenantuserv3GetUsersResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_post_account

Jumpboxv3PostAccountResponse jumpbox_service_post_account(jumpboxv3_post_account_request)

Summary: Post account Description: Create an Account.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_post_account_request import Jumpboxv3PostAccountRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_post_account_response import Jumpboxv3PostAccountResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    jumpboxv3_post_account_request = ibm_gdsc_sdk_saas.Jumpboxv3PostAccountRequest() # Jumpboxv3PostAccountRequest | 

    try:
        # Summary: Post account Description: Create an Account.
        api_response = api_instance.jumpbox_service_post_account(jumpboxv3_post_account_request)
        print("The response of JumpboxServiceApi->jumpbox_service_post_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_post_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
jumpboxv3_post_account_request	Jumpboxv3PostAccountRequest

Return type

Jumpboxv3PostAccountResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_post_tenants

Jumpboxv3PostTenantsResponse jumpbox_service_post_tenants(jumpboxv3_post_tenants_request)

Summary: Post tenants Description: Create a tenant.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_post_tenants_request import Jumpboxv3PostTenantsRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_post_tenants_response import Jumpboxv3PostTenantsResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    jumpboxv3_post_tenants_request = ibm_gdsc_sdk_saas.Jumpboxv3PostTenantsRequest() # Jumpboxv3PostTenantsRequest | 

    try:
        # Summary: Post tenants Description: Create a tenant.
        api_response = api_instance.jumpbox_service_post_tenants(jumpboxv3_post_tenants_request)
        print("The response of JumpboxServiceApi->jumpbox_service_post_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_post_tenants: %s\n" % e)

Parameters

Name	Type	Description	Notes
jumpboxv3_post_tenants_request	Jumpboxv3PostTenantsRequest

Return type

Jumpboxv3PostTenantsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_post_users

Jumpboxv3PostUsersBulkResponse jumpbox_service_post_users(jumpboxv3_post_users_bulk_request)

Summary: Post users Description: Create users.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_post_users_bulk_request import Jumpboxv3PostUsersBulkRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_post_users_bulk_response import Jumpboxv3PostUsersBulkResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    jumpboxv3_post_users_bulk_request = ibm_gdsc_sdk_saas.Jumpboxv3PostUsersBulkRequest() # Jumpboxv3PostUsersBulkRequest | 

    try:
        # Summary: Post users Description: Create users.
        api_response = api_instance.jumpbox_service_post_users(jumpboxv3_post_users_bulk_request)
        print("The response of JumpboxServiceApi->jumpbox_service_post_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_post_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
jumpboxv3_post_users_bulk_request	Jumpboxv3PostUsersBulkRequest

Return type

Jumpboxv3PostUsersBulkResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_resume_account

Jumpboxv3ResumeAccountResponse jumpbox_service_resume_account(account_id)

Summary: Resume account Description: Resume an account.

Example

Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_resume_account_response import Jumpboxv3ResumeAccountResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    account_id = 'account_id_example' # str | account_id represents the user's account ID

    try:
        # Summary: Resume account Description: Resume an account.
        api_response = api_instance.jumpbox_service_resume_account(account_id)
        print("The response of JumpboxServiceApi->jumpbox_service_resume_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_resume_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	account_id represents the user's account ID

Return type

Jumpboxv3ResumeAccountResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_search_users

Jumpboxv3SearchUsersResponse jumpbox_service_search_users(jumpboxv3_search_users_request)

Summary: Search users Description: Search for all users matching the provided string.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_search_users_request import Jumpboxv3SearchUsersRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_search_users_response import Jumpboxv3SearchUsersResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    jumpboxv3_search_users_request = ibm_gdsc_sdk_saas.Jumpboxv3SearchUsersRequest() # Jumpboxv3SearchUsersRequest | 

    try:
        # Summary: Search users Description: Search for all users matching the provided string.
        api_response = api_instance.jumpbox_service_search_users(jumpboxv3_search_users_request)
        print("The response of JumpboxServiceApi->jumpbox_service_search_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_search_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
jumpboxv3_search_users_request	Jumpboxv3SearchUsersRequest

Return type

Jumpboxv3SearchUsersResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_suspend_account

Jumpboxv3SuspendAccountResponse jumpbox_service_suspend_account(account_id)

Summary: Suspend Account Description: Suspend an account

Example

Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_suspend_account_response import Jumpboxv3SuspendAccountResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    account_id = 'account_id_example' # str | account_id represents the user's account ID

    try:
        # Summary: Suspend Account Description: Suspend an account
        api_response = api_instance.jumpbox_service_suspend_account(account_id)
        print("The response of JumpboxServiceApi->jumpbox_service_suspend_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_suspend_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	account_id represents the user's account ID

Return type

Jumpboxv3SuspendAccountResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_test_user

Jumpboxv3TestUserResponse jumpbox_service_test_user(jumpboxv3_test_user_request)

Summary: Test user Description: Test a user lookup to a given LDAP.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_test_user_request import Jumpboxv3TestUserRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_test_user_response import Jumpboxv3TestUserResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    jumpboxv3_test_user_request = ibm_gdsc_sdk_saas.Jumpboxv3TestUserRequest() # Jumpboxv3TestUserRequest | 

    try:
        # Summary: Test user Description: Test a user lookup to a given LDAP.
        api_response = api_instance.jumpbox_service_test_user(jumpboxv3_test_user_request)
        print("The response of JumpboxServiceApi->jumpbox_service_test_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_test_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
jumpboxv3_test_user_request	Jumpboxv3TestUserRequest

Return type

Jumpboxv3TestUserResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_update_account

Jumpboxv3UpdateAccountResponse jumpbox_service_update_account(account_id, jumpboxv3_update_account_request)

Summary: Update Account Description: Updates an account.

Example

Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_update_account_request import Jumpboxv3UpdateAccountRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_update_account_response import Jumpboxv3UpdateAccountResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    account_id = 'account_id_example' # str | Account id.
    jumpboxv3_update_account_request = ibm_gdsc_sdk_saas.Jumpboxv3UpdateAccountRequest() # Jumpboxv3UpdateAccountRequest | 

    try:
        # Summary: Update Account Description: Updates an account.
        api_response = api_instance.jumpbox_service_update_account(account_id, jumpboxv3_update_account_request)
        print("The response of JumpboxServiceApi->jumpbox_service_update_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_update_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	Account id.
jumpboxv3_update_account_request	Jumpboxv3UpdateAccountRequest

Return type

Jumpboxv3UpdateAccountResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_update_tenant

Jumpboxv3UpdateTenantResponse jumpbox_service_update_tenant(tenant_id, jumpboxv3_update_tenant_request)

Summary: Update tenant Description: Update a tenant.

Example

Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_update_tenant_request import Jumpboxv3UpdateTenantRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_update_tenant_response import Jumpboxv3UpdateTenantResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    tenant_id = 'tenant_id_example' # str | Tenant id.
    jumpboxv3_update_tenant_request = ibm_gdsc_sdk_saas.Jumpboxv3UpdateTenantRequest() # Jumpboxv3UpdateTenantRequest | 

    try:
        # Summary: Update tenant Description: Update a tenant.
        api_response = api_instance.jumpbox_service_update_tenant(tenant_id, jumpboxv3_update_tenant_request)
        print("The response of JumpboxServiceApi->jumpbox_service_update_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_update_tenant: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_id	str	Tenant id.
jumpboxv3_update_tenant_request	Jumpboxv3UpdateTenantRequest

Return type

Jumpboxv3UpdateTenantResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

jumpbox_service_update_users

Jumpboxv3UpdateUsersBulkResponse jumpbox_service_update_users(jumpboxv3_update_users_bulk_request)

Summary: Update users Description: Update an array of users.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.jumpboxv3_update_users_bulk_request import Jumpboxv3UpdateUsersBulkRequest
from ibm_gdsc_sdk_saas.models.jumpboxv3_update_users_bulk_response import Jumpboxv3UpdateUsersBulkResponse
from ibm_gdsc_sdk_saas.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 = ibm_gdsc_sdk_saas.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.

# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    jumpboxv3_update_users_bulk_request = ibm_gdsc_sdk_saas.Jumpboxv3UpdateUsersBulkRequest() # Jumpboxv3UpdateUsersBulkRequest | 

    try:
        # Summary: Update users Description: Update an array of users.
        api_response = api_instance.jumpbox_service_update_users(jumpboxv3_update_users_bulk_request)
        print("The response of JumpboxServiceApi->jumpbox_service_update_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_update_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
jumpboxv3_update_users_bulk_request	Jumpboxv3UpdateUsersBulkRequest

Return type

Jumpboxv3UpdateUsersBulkResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

FilesExpand file tree

JumpboxServiceApi.md

Latest commit

History

JumpboxServiceApi.md

File metadata and controls

ibm_gdsc_sdk_saas.JumpboxServiceApi

jumpbox_service_authorize

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_delete_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_delete_tenant

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_delete_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_get_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_get_accounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_get_tenant

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_get_tenants

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_get_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_post_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jumpbox_service_post_tenants

Example

Parameters