Skip to content

Latest commit

 

History

History
331 lines (194 loc) · 8.68 KB

UserApi.md

File metadata and controls

331 lines (194 loc) · 8.68 KB
Raw

\UserApi

All URIs are relative to http://localhost

Method HTTP request Description
APITokenGet Get /1.0/users/api-key
APITokenRegenerate Post /1.0/users/api-key
ChangePassword Put /1.0/users/password
ResetPassword Post /1.0/users/{email}/password
UserCreate Post /1.0/users
UserDelete Delete /1.0/users
UserGet Get /1.0/users/info
UserQuotaChange Put /1.0/users/{email}/quota
UserQuotaGet Get /1.0/users/{email}/quota
UserTokenDelete Delete /1.0/users/tokens
UsersList Get /1.0/users

APITokenGet

string APITokenGet(ctx, email)

Show the API token of an user.

Required Parameters

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

Return type

string

Authorization

Bearer

HTTP request headers

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

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

APITokenRegenerate

string APITokenRegenerate(ctx, email)

Regenerate the API Token of an user.

Required Parameters

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

Return type

string

Authorization

Bearer

HTTP request headers

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

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

ChangePassword

ChangePassword(ctx, changePasswordData)

Change password of logged user.

Required Parameters

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

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

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

ResetPassword

ResetPassword(ctx, email, body)

Reset password of an user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
email string
body string

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

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

UserCreate

UserCreate(ctx, userData)

Create a new user.

Required Parameters

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

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

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

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

UserDelete

UserDelete(ctx, email)

Delete an user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
email string User e-mail.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

UserGet

User UserGet(ctx, )

Get information on logged user.

Required Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

Bearer

HTTP request headers

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

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

UserQuotaChange

UserQuotaChange(ctx, email, limit)

Change quota of an user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
email string User e-mail.
limit int32 User new quota.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

UserQuotaGet

UserQuotaViewResponse UserQuotaGet(ctx, email)

Get quota of an user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
email string User e-mail.

Return type

UserQuotaViewResponse

Authorization

Bearer

HTTP request headers

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

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

UserTokenDelete

UserTokenDelete(ctx, )

Logout.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

UsersList

[]User UsersList(ctx, userEmail, optional)

List users.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userEmail string
optional *UsersListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UsersListOpts struct

Name Type Description Notes

role | optional.String| | context | optional.String| |

Return type

[]User

Authorization

Bearer

HTTP request headers

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

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