Skip to content

AuthenticationUsersAPI.md

Latest commit

 

History

History
605 lines (382 loc) · 15.7 KB

AuthenticationUsersAPI.md

File metadata and controls

605 lines (382 loc) · 15.7 KB
Raw

AuthenticationUsersAPI

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

Method HTTP request Description
GetUser Get /v2/users/{user_id} Get a user's public information
GetUserActivity Get /v2/users/activity Get auth user activity
SubmitUserFeedback Post /v2/users/feedback Submit feedback about the application
V3GetUser Get /v3/users/{user_id} Get a user's public information
V3GetUserActivity Get /v3/users/activity Get the caller's activity feed
V3ListPrincipals Get /v3/principals Search users and teams
V3ListTeams Get /v3/teams Search teams
V3ListUsers Get /v3/users Search users
V3SubmitUserFeedback Post /v3/users/feedback Submit feedback

GetUser

BaseResponseGetPublicUserResponse GetUser(ctx, userId).Execute()

Get a user's public information

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {
	userId := int32(56) // int32 | 

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.GetUser(context.Background(), userId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.GetUser``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUser`: BaseResponseGetPublicUserResponse
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.GetUser`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId int32

Other Parameters

Other parameters are passed through a pointer to a apiGetUserRequest struct via the builder pattern

Name Type Description Notes

Return type

BaseResponseGetPublicUserResponse

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserActivity

BaseResponseListUserActivityResponse GetUserActivity(ctx).Execute()

Get auth user activity

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.GetUserActivity(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.GetUserActivity``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUserActivity`: BaseResponseListUserActivityResponse
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.GetUserActivity`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetUserActivityRequest struct via the builder pattern

Return type

BaseResponseListUserActivityResponse

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

SubmitUserFeedback

BaseResponse SubmitUserFeedback(ctx).SubmitUserFeedbackRequest(submitUserFeedbackRequest).Execute()

Submit feedback about the application

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {
	submitUserFeedbackRequest := *revengai.NewSubmitUserFeedbackRequest("CurrentRoute_example", "Feedback_example") // SubmitUserFeedbackRequest | 

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.SubmitUserFeedback(context.Background()).SubmitUserFeedbackRequest(submitUserFeedbackRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.SubmitUserFeedback``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SubmitUserFeedback`: BaseResponse
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.SubmitUserFeedback`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSubmitUserFeedbackRequest struct via the builder pattern

Name Type Description Notes
submitUserFeedbackRequest SubmitUserFeedbackRequest

Return type

BaseResponse

Authorization

APIKey, bearerAuth

HTTP request headers

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

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

V3GetUser

GetPublicUserOutputBody V3GetUser(ctx, userId).Execute()

Get a user's public information

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {
	userId := int64(789) // int64 | User ID

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.V3GetUser(context.Background(), userId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.V3GetUser``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V3GetUser`: GetPublicUserOutputBody
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.V3GetUser`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId int64 User ID

Other Parameters

Other parameters are passed through a pointer to a apiV3GetUserRequest struct via the builder pattern

Name Type Description Notes

Return type

GetPublicUserOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V3GetUserActivity

GetUserActivityOutputBody V3GetUserActivity(ctx).Execute()

Get the caller's activity feed

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.V3GetUserActivity(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.V3GetUserActivity``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V3GetUserActivity`: GetUserActivityOutputBody
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.V3GetUserActivity`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiV3GetUserActivityRequest struct via the builder pattern

Return type

GetUserActivityOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V3ListPrincipals

ListPrincipalsOutputBody V3ListPrincipals(ctx).SearchTerm(searchTerm).Execute()

Search users and teams

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {
	searchTerm := "searchTerm_example" // string | Text the user's username or team's name contains (case-insensitive)

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.V3ListPrincipals(context.Background()).SearchTerm(searchTerm).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.V3ListPrincipals``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V3ListPrincipals`: ListPrincipalsOutputBody
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.V3ListPrincipals`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiV3ListPrincipalsRequest struct via the builder pattern

Name Type Description Notes
searchTerm string 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

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

V3ListTeams

ListTeamsOutputBody V3ListTeams(ctx).SearchTerm(searchTerm).Execute()

Search teams

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {
	searchTerm := "searchTerm_example" // string | Text the team name contains (case-insensitive)

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.V3ListTeams(context.Background()).SearchTerm(searchTerm).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.V3ListTeams``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V3ListTeams`: ListTeamsOutputBody
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.V3ListTeams`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiV3ListTeamsRequest struct via the builder pattern

Name Type Description Notes
searchTerm string Text the team name contains (case-insensitive)

Return type

ListTeamsOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V3ListUsers

ListPublicUsersOutputBody V3ListUsers(ctx).SearchTerm(searchTerm).Execute()

Search users

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {
	searchTerm := "searchTerm_example" // string | Text the username contains (case-insensitive)

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.V3ListUsers(context.Background()).SearchTerm(searchTerm).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.V3ListUsers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V3ListUsers`: ListPublicUsersOutputBody
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.V3ListUsers`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiV3ListUsersRequest struct via the builder pattern

Name Type Description Notes
searchTerm string Text the username contains (case-insensitive)

Return type

ListPublicUsersOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V3SubmitUserFeedback

SubmitFeedbackOutputBody V3SubmitUserFeedback(ctx).SubmitFeedbackBody(submitFeedbackBody).Execute()

Submit feedback

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v4"
)

func main() {
	submitFeedbackBody := *revengai.NewSubmitFeedbackBody("CurrentRoute_example", "Feedback_example") // SubmitFeedbackBody | 

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.AuthenticationUsersAPI.V3SubmitUserFeedback(context.Background()).SubmitFeedbackBody(submitFeedbackBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationUsersAPI.V3SubmitUserFeedback``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V3SubmitUserFeedback`: SubmitFeedbackOutputBody
	fmt.Fprintf(os.Stdout, "Response from `AuthenticationUsersAPI.V3SubmitUserFeedback`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiV3SubmitUserFeedbackRequest struct via the builder pattern

Name Type Description Notes
submitFeedbackBody SubmitFeedbackBody

Return type

SubmitFeedbackOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

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

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