Skip to content

Latest commit

 

History

History
275 lines (172 loc) · 8.69 KB

UsersApi.md

File metadata and controls

275 lines (172 loc) · 8.69 KB
Raw

{{classname}}

All URIs are relative to **

Method HTTP request Description
UsersControllerArchiveUser Post /api/v2/users/{userId}/actions/archive Archive user
UsersControllerChangeUserAccount Post /api/v2/users/{userId}/actions/change-account Change account for user
UsersControllerCreateUser Post /api/v2/users Creates a user
UsersControllerGetUser Get /api/v2/users/{userId} Get user
UsersControllerGetUserLimits Get /api/v2/users/{userId}/limits Get user limits
UsersControllerGetUsers Get /api/v2/users Get users
UsersControllerUnarchiveUser Post /api/v2/users/{userId}/actions/unarchive Unarchive user
UsersControllerUpdateUser Patch /api/v2/users/{userId} Update user
UsersControllerUpdateUserLimits Patch /api/v2/users/{userId}/limits Update user limits

UsersControllerArchiveUser

UserDto UsersControllerArchiveUser(ctx, userId) Archive user

Archives a user

Required Parameters

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

Return type

UserDto

Authorization

JWT, apiKey

HTTP request headers

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

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

UsersControllerChangeUserAccount

UserDto UsersControllerChangeUserAccount(ctx, body, userId) Change account for user

Changes account for user

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ChangeUserAccountDto The new account id
userId float64

Return type

UserDto

Authorization

JWT, apiKey

HTTP request headers

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

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

UsersControllerCreateUser

UserDto UsersControllerCreateUser(ctx, body) Creates a user

Creates a user

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body CreateUserDto The user to create

Return type

UserDto

Authorization

JWT, apiKey

HTTP request headers

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

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

UsersControllerGetUser

UserDto UsersControllerGetUser(ctx, userId, optional) Get user

Returns a user

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float64
optional *UsersApiUsersControllerGetUserOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UsersApiUsersControllerGetUserOpts struct

Name Type Description Notes

recursion | optional.Float64| The recursion level of the displayed details. Default is 0. |

Return type

UserDto

Authorization

JWT, apiKey

HTTP request headers

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

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

UsersControllerGetUserLimits

UserLimitsDto UsersControllerGetUserLimits(ctx, userId) Get user limits

Returns the limits of a user

Required Parameters

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

Return type

UserLimitsDto

Authorization

JWT, apiKey

HTTP request headers

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

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

UsersControllerGetUsers

[]UserDto UsersControllerGetUsers(ctx, ) Get users

Returns a list of users

Required Parameters

This endpoint does not need any parameter.

Return type

[]UserDto

Authorization

JWT, apiKey

HTTP request headers

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

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

UsersControllerUnarchiveUser

UserDto UsersControllerUnarchiveUser(ctx, userId) Unarchive user

Unarchives a user

Required Parameters

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

Return type

UserDto

Authorization

JWT, apiKey

HTTP request headers

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

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

UsersControllerUpdateUser

UserDto UsersControllerUpdateUser(ctx, body, userId) Update user

Updates a user

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body UpdateUserDto The user updates
userId float64

Return type

UserDto

Authorization

JWT, apiKey

HTTP request headers

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

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

UsersControllerUpdateUserLimits

UserLimitsDto UsersControllerUpdateUserLimits(ctx, body, userId) Update user limits

Updates the limits of a user

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body UserLimitsDto The new limits
userId float64

Return type

UserLimitsDto

Authorization

JWT, apiKey

HTTP request headers

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

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