revengai.AuthenticationUsersApi

All URIs are relative to https://api.reveng.ai

Method	HTTP request	Description
get_user	GET /v2/users/{user_id}	Get a user's public information
get_user_activity	GET /v2/users/activity	Get auth user activity
submit_user_feedback	POST /v2/users/feedback	Submit feedback about the application
v3_get_user	GET /v3/users/{user_id}	Get a user's public information
v3_get_user_activity	GET /v3/users/activity	Get the caller's activity feed
v3_list_principals	GET /v3/principals	Search users and teams
v3_list_teams	GET /v3/teams	Search teams
v3_list_users	GET /v3/users	Search users
v3_submit_user_feedback	POST /v3/users/feedback	Submit feedback

get_user

BaseResponseGetPublicUserResponse get_user(user_id)

Get a user's public information

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.base_response_get_public_user_response import BaseResponseGetPublicUserResponse
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    user_id = 56 # int | 

    try:
        # Get a user's public information
        api_response = api_instance.get_user(user_id)
        print("The response of AuthenticationUsersApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->get_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int

Return type

BaseResponseGetPublicUserResponse

Authorization

APIKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

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

get_user_activity

BaseResponseListUserActivityResponse get_user_activity()

Get auth user activity

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.base_response_list_user_activity_response import BaseResponseListUserActivityResponse
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

Parameters

This endpoint does not need any parameter.

Return type

BaseResponseListUserActivityResponse

Authorization

APIKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

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

submit_user_feedback

BaseResponse submit_user_feedback(submit_user_feedback_request)

Submit feedback about the application

Submits feedback about the application and forwards it to the RevEng.ai project management tool.

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.base_response import BaseResponse
from revengai.models.submit_user_feedback_request import SubmitUserFeedbackRequest
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    submit_user_feedback_request = revengai.SubmitUserFeedbackRequest() # SubmitUserFeedbackRequest | 

    try:
        # Submit feedback about the application
        api_response = api_instance.submit_user_feedback(submit_user_feedback_request)
        print("The response of AuthenticationUsersApi->submit_user_feedback:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->submit_user_feedback: %s\n" % e)

Parameters

Name	Type	Description	Notes
submit_user_feedback_request	SubmitUserFeedbackRequest

Return type

BaseResponse

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Invalid request parameters	-

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

v3_get_user

GetPublicUserOutputBody v3_get_user(user_id)

Get a user's public information

Returns a user's username. Any authenticated caller may look up any user by ID.

Error codes:

404 NOT_FOUND — Not Found

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.get_public_user_output_body import GetPublicUserOutputBody
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    user_id = 56 # int | User ID

    try:
        # Get a user's public information
        api_response = api_instance.v3_get_user(user_id)
        print("The response of AuthenticationUsersApi->v3_get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->v3_get_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	User ID

Return type

GetPublicUserOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-
422	Unprocessable Entity	-
500	Internal Server Error	-

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

v3_get_user_activity

GetUserActivityOutputBody v3_get_user_activity()

Get the caller's activity feed

Returns the caller's own recent activity, their team's, and everyone's public activity, newest first.

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.get_user_activity_output_body import GetUserActivityOutputBody
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # Get the caller's activity feed
        api_response = api_instance.v3_get_user_activity()
        print("The response of AuthenticationUsersApi->v3_get_user_activity:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->v3_get_user_activity: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetUserActivityOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

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

v3_list_principals

ListPrincipalsOutputBody v3_list_principals(search_term)

Search users and teams

Returns up to 5 matching users and up to 5 matching teams whose name contains the search term (case-insensitive), scoped to the caller's organisation using the same rules as the individual user and team search endpoints.

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.list_principals_output_body import ListPrincipalsOutputBody
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    search_term = 'search_term_example' # str | Text the user's username or team's name contains (case-insensitive)

    try:
        # Search users and teams
        api_response = api_instance.v3_list_principals(search_term)
        print("The response of AuthenticationUsersApi->v3_list_principals:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->v3_list_principals: %s\n" % e)

Parameters

Name	Type	Description	Notes
search_term	str	Text the user's username or team's name contains (case-insensitive)

Return type

ListPrincipalsOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

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

v3_list_teams

ListTeamsOutputBody v3_list_teams(search_term)

Search teams

Returns up to 5 teams whose name contains the search term (case-insensitive). Returns every team in the caller's organisation, or — if the organisation is named "Internal" — only the teams the caller belongs to.

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.list_teams_output_body import ListTeamsOutputBody
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    search_term = 'search_term_example' # str | Text the team name contains (case-insensitive)

    try:
        # Search teams
        api_response = api_instance.v3_list_teams(search_term)
        print("The response of AuthenticationUsersApi->v3_list_teams:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->v3_list_teams: %s\n" % e)

Parameters

Name	Type	Description	Notes
search_term	str	Text the team name contains (case-insensitive)

Return type

ListTeamsOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

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

v3_list_users

ListPublicUsersOutputBody v3_list_users(search_term)

Search users

Returns up to 5 active users in the caller's organisation whose username contains the search term (case-insensitive), with their ID and username, ordered by username.

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.list_public_users_output_body import ListPublicUsersOutputBody
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    search_term = 'search_term_example' # str | Text the username contains (case-insensitive)

    try:
        # Search users
        api_response = api_instance.v3_list_users(search_term)
        print("The response of AuthenticationUsersApi->v3_list_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->v3_list_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
search_term	str	Text the username contains (case-insensitive)

Return type

ListPublicUsersOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

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

v3_submit_user_feedback

SubmitFeedbackOutputBody v3_submit_user_feedback(submit_feedback_body)

Submit feedback

Submits feedback about the application to a Slack channel.

Error codes:

404 NOT_FOUND — Not Found

Example

Api Key Authentication (APIKey):
Bearer Authentication (bearerAuth):

import revengai
from revengai.models.submit_feedback_body import SubmitFeedbackBody
from revengai.models.submit_feedback_output_body import SubmitFeedbackOutputBody
from revengai.rest import ApiException
from pprint import pprint

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

# 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: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

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

# Configure Bearer authorization: bearerAuth
configuration = revengai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = revengai.AuthenticationUsersApi(api_client)
    submit_feedback_body = revengai.SubmitFeedbackBody() # SubmitFeedbackBody | 

    try:
        # Submit feedback
        api_response = api_instance.v3_submit_user_feedback(submit_feedback_body)
        print("The response of AuthenticationUsersApi->v3_submit_user_feedback:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthenticationUsersApi->v3_submit_user_feedback: %s\n" % e)

Parameters

Name	Type	Description	Notes
submit_feedback_body	SubmitFeedbackBody

Return type

SubmitFeedbackOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-
422	Unprocessable Entity	-
500	Internal Server Error	-

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

FilesExpand file tree

AuthenticationUsersApi.md

Latest commit

History

AuthenticationUsersApi.md

File metadata and controls

revengai.AuthenticationUsersApi

get_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user_activity

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submit_user_feedback

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_get_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_get_user_activity

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_list_principals

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_list_teams

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_list_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v3_submit_user_feedback

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details