rockset.Users

All URIs are relative to https://api.use1a1.rockset.com or the apiserver provided when initializing RocksetClient

Method	HTTP request	Description
create	POST /v1/orgs/self/users	Create User
delete	DELETE /v1/orgs/self/users/{user}	Delete User
get	GET /v1/orgs/self/users/{user}	Retrieve User
get_current_user	GET /v1/orgs/self/users/self	Retrieve Current User
list	GET /v1/orgs/self/users	List Users
list_unsubscribe_preferences	GET /v1/orgs/self/users/self/preferences	Retrieve Notification Preferences
update	POST /v1/orgs/self/users/{user}	Update User
update_unsubscribe_preferences	POST /v1/orgs/self/users/self/preferences	Update Notification Preferences

create

CreateUserResponse create(create_user_request)

Create User

Create a new user for an organization.

Example

Api Key Authentication (apikey):

from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Create User
api_response = rs.Users.create(
    email="hello@rockset.com",
    roles=["admin","member","read-only"],
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
#     print("Exception when calling Users->create: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Create User
api_response = await rs.Users.create(
    email="hello@rockset.com",
    first_name="John",
    last_name="Doe",
    roles=["admin","member","read-only"],
    async_req=True,
)
if isinstance(api_response, rockset.ApiException):
    print("Exception when calling Users->create: %s\n" % e)
    return
pprint(api_response)

Parameters

Name	Type	Description	Notes
email	str	User email, must be unique.
first_name	str	User first name.	[optional]
last_name	str	User last name.	[optional]
roles	[str]	List of roles for a given user.	[optional]

Return type

CreateUserResponse

Authorization

All requests must use apikeys for authorization.

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	user created successfully	-
400	bad request	-
401	unauthorized	-
403	forbidden	-
404	not found	-
405	not allowed	-
406	not acceptable	-
408	request timeout	-
409	conflict	-
415	not supported	-
429	resource exceeded	-
500	internal error	-
501	not implemented	-
502	bad gateway	-
503	not ready	-

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

delete

DeleteUserResponse delete(user)

Delete User

Delete a user from an organization.

Example

Api Key Authentication (apikey):

from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Delete User
api_response = rs.Users.delete(
    user="user_example",
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
#     print("Exception when calling Users->delete: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Delete User
api_response = await rs.Users.delete(
    user="user_example",
    async_req=True,
)
if isinstance(api_response, rockset.ApiException):
    print("Exception when calling Users->delete: %s\n" % e)
    return
pprint(api_response)

Parameters

Name	Type	Description	Notes
user	str	user email

Return type

DeleteUserResponse

Authorization

All requests must use apikeys for authorization.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	user deleted successfully	-
400	bad request	-
401	unauthorized	-
403	forbidden	-
404	not found	-
405	not allowed	-
406	not acceptable	-
408	request timeout	-
409	conflict	-
415	not supported	-
429	resource exceeded	-
500	internal error	-
501	not implemented	-
502	bad gateway	-
503	not ready	-

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

get

User get(user)

Retrieve User

Retrieve user by email.

Example

Api Key Authentication (apikey):

from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Retrieve User
api_response = rs.Users.get(
    user="user_example",
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
#     print("Exception when calling Users->get: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Retrieve User
api_response = await rs.Users.get(
    user="user_example",
    async_req=True,
)
if isinstance(api_response, rockset.ApiException):
    print("Exception when calling Users->get: %s\n" % e)
    return
pprint(api_response)

Parameters

Name	Type	Description	Notes
user	str	user email

Return type

User

Authorization

All requests must use apikeys for authorization.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	user found	-
400	bad request	-
401	unauthorized	-
403	forbidden	-
404	not found	-
405	not allowed	-
406	not acceptable	-
408	request timeout	-
409	conflict	-
415	not supported	-
429	resource exceeded	-
500	internal error	-
501	not implemented	-
502	bad gateway	-
503	not ready	-

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

get_current_user

User get_current_user()

Retrieve Current User

Retrieve currently authenticated user.

Example

Api Key Authentication (apikey):

from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Retrieve Current User
api_response = rs.Users.get_current_user(
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
#     print("Exception when calling Users->get_current_user: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Retrieve Current User
api_response = await rs.Users.get_current_user(
    async_req=True,
)
if isinstance(api_response, rockset.ApiException):
    print("Exception when calling Users->get_current_user: %s\n" % e)
    return
pprint(api_response)

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

All requests must use apikeys for authorization.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	user retrieved successfully	-
400	bad request	-
401	unauthorized	-
403	forbidden	-
404	not found	-
405	not allowed	-
406	not acceptable	-
408	request timeout	-
409	conflict	-
415	not supported	-
429	resource exceeded	-
500	internal error	-
501	not implemented	-
502	bad gateway	-
503	not ready	-

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

list

ListUsersResponse list()

List Users

Retrieve all users for an organization.

Example

Api Key Authentication (apikey):

from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# List Users
api_response = rs.Users.list(
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
#     print("Exception when calling Users->list: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# List Users
api_response = await rs.Users.list(
    async_req=True,
)
if isinstance(api_response, rockset.ApiException):
    print("Exception when calling Users->list: %s\n" % e)
    return
pprint(api_response)

Parameters

This endpoint does not need any parameter.

Return type

ListUsersResponse

Authorization

All requests must use apikeys for authorization.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	users retrieved successfully	-
400	bad request	-
401	unauthorized	-
403	forbidden	-
404	not found	-
405	not allowed	-
406	not acceptable	-
408	request timeout	-
409	conflict	-
415	not supported	-
429	resource exceeded	-
500	internal error	-
501	not implemented	-
502	bad gateway	-
503	not ready	-

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

list_unsubscribe_preferences

ListUnsubscribePreferencesResponse list_unsubscribe_preferences()

Retrieve Notification Preferences

Get all notification preferences.

Example

Api Key Authentication (apikey):

from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Retrieve Notification Preferences
api_response = rs.Users.list_unsubscribe_preferences(
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
#     print("Exception when calling Users->list_unsubscribe_preferences: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Retrieve Notification Preferences
api_response = await rs.Users.list_unsubscribe_preferences(
    async_req=True,
)
if isinstance(api_response, rockset.ApiException):
    print("Exception when calling Users->list_unsubscribe_preferences: %s\n" % e)
    return
pprint(api_response)

Parameters

This endpoint does not need any parameter.

Return type

ListUnsubscribePreferencesResponse

Authorization

All requests must use apikeys for authorization.

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Notification preferences retrieved successfully	-
400	bad request	-
401	unauthorized	-
403	forbidden	-
404	not found	-
405	not allowed	-
406	not acceptable	-
408	request timeout	-
409	conflict	-
415	not supported	-
429	resource exceeded	-
500	internal error	-
501	not implemented	-
502	bad gateway	-
503	not ready	-

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

update

User update(user, update_user_request)

Update User

Update a user in an organization.

Example

Api Key Authentication (apikey):

from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Update User
api_response = rs.Users.update(
    user="user_example",
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
#     print("Exception when calling Users->update: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Update User
api_response = await rs.Users.update(
    user="user_example",
    first_name="John",
    last_name="Doe",
    roles=["admin","member","read-only"],
    async_req=True,
)
if isinstance(api_response, rockset.ApiException):
    print("Exception when calling Users->update: %s\n" % e)
    return
pprint(api_response)

Parameters

Name	Type	Description	Notes
user	str	email of the user to update
first_name	str	User first name.	[optional]
last_name	str	User last name.	[optional]
roles	[str]	New list of roles for a given user.	[optional]

Return type

User

Authorization

All requests must use apikeys for authorization.

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	user updated successfully	-
400	bad request	-
401	unauthorized	-
403	forbidden	-
404	not found	-
405	not allowed	-
406	not acceptable	-
408	request timeout	-
409	conflict	-
415	not supported	-
429	resource exceeded	-
500	internal error	-
501	not implemented	-
502	bad gateway	-
503	not ready	-

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

update_unsubscribe_preferences

UpdateUnsubscribePreferencesResponse update_unsubscribe_preferences(update_unsubscribe_preferences_request)

Update Notification Preferences

Update notification preference.

Example

Api Key Authentication (apikey):

from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Update Notification Preferences
api_response = rs.Users.update_unsubscribe_preferences(
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
#     print("Exception when calling Users->update_unsubscribe_preferences: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Update Notification Preferences
api_response = await rs.Users.update_unsubscribe_preferences(
    data=[
        UnsubscribePreference(
            notification_type="create_apikey",
        ),
    ],
    async_req=True,
)
if isinstance(api_response, rockset.ApiException):
    print("Exception when calling Users->update_unsubscribe_preferences: %s\n" % e)
    return
pprint(api_response)

Parameters

Name	Type	Description	Notes
data	[UnsubscribePreference]	List of notification preferences.	[optional]

Return type

UpdateUnsubscribePreferencesResponse

Authorization

All requests must use apikeys for authorization.

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Notification preference created successfully	-
400	bad request	-
401	unauthorized	-
403	forbidden	-
404	not found	-
405	not allowed	-
406	not acceptable	-
408	request timeout	-
409	conflict	-
415	not supported	-
429	resource exceeded	-
500	internal error	-
501	not implemented	-
502	bad gateway	-
503	not ready	-

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

Files

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

rockset.Users

create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_current_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_unsubscribe_preferences

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_unsubscribe_preferences

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details