vcell_client.UsersResourceApi

All URIs are relative to https://vcell.cam.uchc.edu

Method	HTTP request	Description
forgot_legacy_password	POST /api/v1/users/forgotLegacyPassword	The end user has forgotten the legacy password they used for VCell, so they will be emailed it.
get_guest_legacy_api_token	POST /api/v1/users/guestBearerToken	Method to get legacy tokens for guest users
get_legacy_api_token	POST /api/v1/users/bearerToken	Get token for legacy API
get_mapped_user	GET /api/v1/users/mappedUser	Get mapped VCell identity
get_me	GET /api/v1/users/me	Get current user
map_new_user	POST /api/v1/users/newUser	create vcell user
map_user	POST /api/v1/users/mapUser	map vcell user
process_magic_link	GET /api/v1/users/processMagicLink	Process the magic link and map the user
request_recovery_email	POST /api/v1/users/requestRecoveryEmail	request a recovery email to link a VCell account.
unmap_user	PUT /api/v1/users/unmapUser/{userName}	remove vcell identity mapping

forgot_legacy_password

forgot_legacy_password(user_id=user_id)

The end user has forgotten the legacy password they used for VCell, so they will be emailed it.

Example

import time
import os
import vcell_client
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)

# 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 vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)
    user_id = 'user_id_example' # str |  (optional)

    try:
        # The end user has forgotten the legacy password they used for VCell, so they will be emailed it.
        api_instance.forgot_legacy_password(user_id=user_id)
    except Exception as e:
        print("Exception when calling UsersResourceApi->forgot_legacy_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str		[optional]

Return type

void (empty response body)

Authorization

openId

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Legacy password sent in email	-
401	Need to login to Auth0	-
403	Not Allowed	-
500	Internal Error	-

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

get_guest_legacy_api_token

AccesTokenRepresentationRecord get_guest_legacy_api_token()

Method to get legacy tokens for guest users

Example

import time
import os
import vcell_client
from vcell_client.models.acces_token_representation_record import AccesTokenRepresentationRecord
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)


# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)

    try:
        # Method to get legacy tokens for guest users
        api_response = api_instance.get_guest_legacy_api_token()
        print("The response of UsersResourceApi->get_guest_legacy_api_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersResourceApi->get_guest_legacy_api_token: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AccesTokenRepresentationRecord

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
500	Data Access Exception	-

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

get_legacy_api_token

AccesTokenRepresentationRecord get_legacy_api_token()

Get token for legacy API

Example

import time
import os
import vcell_client
from vcell_client.models.acces_token_representation_record import AccesTokenRepresentationRecord
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)

# 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 vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)

    try:
        # Get token for legacy API
        api_response = api_instance.get_legacy_api_token()
        print("The response of UsersResourceApi->get_legacy_api_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersResourceApi->get_legacy_api_token: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AccesTokenRepresentationRecord

Authorization

openId

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Not Authenticated	-
403	Not Allowed	-
500	Data Access Exception	-

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

get_mapped_user

UserIdentityJSONSafe get_mapped_user()

Get mapped VCell identity

Example

import time
import os
import vcell_client
from vcell_client.models.user_identity_json_safe import UserIdentityJSONSafe
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)

# 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 vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)

    try:
        # Get mapped VCell identity
        api_response = api_instance.get_mapped_user()
        print("The response of UsersResourceApi->get_mapped_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersResourceApi->get_mapped_user: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UserIdentityJSONSafe

Authorization

openId

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful, returning the identity	-
401	Not Authenticated	-
403	Not Allowed	-
409	Conflict with server state.	-
500	Data Access Exception	-

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

get_me

Identity get_me()

Get current user

Example

import time
import os
import vcell_client
from vcell_client.models.identity import Identity
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)


# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

Identity

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

map_new_user

map_new_user(user_registration_info=user_registration_info)

create vcell user

Example

import time
import os
import vcell_client
from vcell_client.models.user_registration_info import UserRegistrationInfo
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)

# 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 vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)
    user_registration_info = vcell_client.UserRegistrationInfo() # UserRegistrationInfo |  (optional)

    try:
        # create vcell user
        api_instance.map_new_user(user_registration_info=user_registration_info)
    except Exception as e:
        print("Exception when calling UsersResourceApi->map_new_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_registration_info	UserRegistrationInfo		[optional]

Return type

void (empty response body)

Authorization

openId

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful, returning the identity	-
401	Not Authenticated	-
403	Not Allowed	-
409	VCell Identity not mapped, userid already exists	-
500	Data Access Exception	-

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

map_user

bool map_user(user_login_info_for_mapping=user_login_info_for_mapping)

map vcell user

Example

import time
import os
import vcell_client
from vcell_client.models.user_login_info_for_mapping import UserLoginInfoForMapping
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)

# 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 vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)
    user_login_info_for_mapping = vcell_client.UserLoginInfoForMapping() # UserLoginInfoForMapping |  (optional)

    try:
        # map vcell user
        api_response = api_instance.map_user(user_login_info_for_mapping=user_login_info_for_mapping)
        print("The response of UsersResourceApi->map_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersResourceApi->map_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_login_info_for_mapping	UserLoginInfoForMapping		[optional]

Return type

bool

Authorization

openId

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Not Authenticated	-
403	Not Allowed	-
500	Data Access Exception	-

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

process_magic_link

process_magic_link(magic=magic)

Process the magic link and map the user

Example

import time
import os
import vcell_client
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)


# Enter a context with an instance of the API client
with vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)
    magic = 'magic_example' # str |  (optional)

    try:
        # Process the magic link and map the user
        api_instance.process_magic_link(magic=magic)
    except Exception as e:
        print("Exception when calling UsersResourceApi->process_magic_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
magic	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
200	User mapped successfully	-
400	Invalid or expired magic link	-
401	Not Authenticated	-
500	Data Access Exception	-

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

request_recovery_email

request_recovery_email(email=email, user_id=user_id)

request a recovery email to link a VCell account.

Example

import time
import os
import vcell_client
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)

# 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 vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)
    email = 'email_example' # str |  (optional)
    user_id = 'user_id_example' # str |  (optional)

    try:
        # request a recovery email to link a VCell account.
        api_instance.request_recovery_email(email=email, user_id=user_id)
    except Exception as e:
        print("Exception when calling UsersResourceApi->request_recovery_email: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str		[optional]
user_id	str		[optional]

Return type

void (empty response body)

Authorization

openId

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	magic link sent in email if appropriate	-
400	unable to process request	-
401	Not Authenticated	-
403	Not Allowed	-
404	Not found	-
500	Data Access Exception	-

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

unmap_user

bool unmap_user(user_name)

remove vcell identity mapping

Example

import time
import os
import vcell_client
from vcell_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_client.Configuration(
    host = "https://vcell.cam.uchc.edu"
)

# 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 vcell_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_client.UsersResourceApi(api_client)
    user_name = 'user_name_example' # str | 

    try:
        # remove vcell identity mapping
        api_response = api_instance.unmap_user(user_name)
        print("The response of UsersResourceApi->unmap_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersResourceApi->unmap_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_name	str

Return type

bool

Authorization

openId

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Not Authenticated	-
403	Not Allowed	-
500	Data Access Exception	-

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

FilesExpand file tree

UsersResourceApi.md

Latest commit

History

UsersResourceApi.md

File metadata and controls

vcell_client.UsersResourceApi

forgot_legacy_password

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_guest_legacy_api_token

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_legacy_api_token

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_mapped_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_me

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

map_new_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

map_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

process_magic_link

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

request_recovery_email

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

unmap_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details