Skip to content

Latest commit

 

History

History
304 lines (217 loc) · 8.37 KB

UserApi.md

File metadata and controls

304 lines (217 loc) · 8.37 KB
Raw

neurostore_sdk.UserApi

All URIs are relative to https://neurostore.org/api

Method HTTP request Description
users_get GET /users/ Your GET endpoint
users_id_get GET /users/{id} Individual User Profile
users_id_put PUT /users/{id} Update Individual Profile
users_post POST /users/

users_get

UserList users_get()

Your GET endpoint

get list of users

Example

  • Bearer Authentication (JSON-Web-Token):
import time
import os
import neurostore_sdk
from neurostore_sdk.models.user_list import UserList
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/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: JSON-Web-Token
configuration = neurostore_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # Your GET endpoint
        api_response = api_instance.users_get()
        print("The response of UserApi->users_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->users_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UserList

Authorization

JSON-Web-Token

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]

users_id_get

User users_id_get(id)

Individual User Profile

get an individual user

Example

import time
import os
import neurostore_sdk
from neurostore_sdk.models.user import User
from neurostore_sdk.rest import ApiException
from pprint import pprint

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


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

    try:
        # Individual User Profile
        api_response = api_instance.users_id_get(id)
        print("The response of UserApi->users_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->users_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

User

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]

users_id_put

User users_id_put(id, user=user)

Update Individual Profile

update an individual user

Example

  • Bearer Authentication (JSON-Web-Token):
import time
import os
import neurostore_sdk
from neurostore_sdk.models.user import User
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/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: JSON-Web-Token
configuration = neurostore_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # Update Individual Profile
        api_response = api_instance.users_id_put(id, user=user)
        print("The response of UserApi->users_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->users_id_put: %s\n" % e)

Parameters

Name Type Description Notes
id str
user User [optional]

Return type

User

Authorization

JSON-Web-Token

HTTP request headers

  • Content-Type: application/json
  • 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]

users_post

User users_post(user=user)

create a user

Example

  • Bearer Authentication (JSON-Web-Token):
import time
import os
import neurostore_sdk
from neurostore_sdk.models.user import User
from neurostore_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://neurostore.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurostore_sdk.Configuration(
    host = "https://neurostore.org/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: JSON-Web-Token
configuration = neurostore_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

Parameters

Name Type Description Notes
user User [optional]

Return type

User

Authorization

JSON-Web-Token

HTTP request headers

  • Content-Type: application/json
  • 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]