Package com.influxdb.client.service

Interface UsersService

public interface UsersService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteUsersID(String userID, String zapTraceSpan)	Delete a user
retrofit2.Call<Map<String,Object>>	getFlags(String zapTraceSpan)	Return the feature flags for the currently authenticated user
retrofit2.Call<User>	getMe(String zapTraceSpan)	Retrieve the currently authenticated user
retrofit2.Call<Users>	getUsers(String zapTraceSpan, Integer offset, Integer limit, String after, String name, String id)	List all users
retrofit2.Call<User>	getUsersID(String userID, String zapTraceSpan)	Retrieve a user
retrofit2.Call<User>	patchUsersID(String userID, PostUser postUser, String zapTraceSpan)	Update a user
retrofit2.Call<User>	postUsers(PostUser postUser, String zapTraceSpan)	Create a user
retrofit2.Call<Void>	postUsersIDPassword(String userID, PasswordResetBody passwordResetBody, String zapTraceSpan, String authorization)	Update a password
retrofit2.Call<Void>	putMePassword(PasswordResetBody passwordResetBody, String zapTraceSpan, String authorization)	Update a password

Method Details

deleteUsersID

@DELETE("api/v2/users/{userID}")
retrofit2.Call<Void> deleteUsersID(@Path("userID")
 String userID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a user

Parameters:

userID - The ID of the user to delete. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getFlags

@GET("api/v2/flags")
retrofit2.Call<Map<String,Object>> getFlags(@Header("Zap-Trace-Span")
 String zapTraceSpan)

Return the feature flags for the currently authenticated user

Parameters:

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Map<String, Object>>

getMe

@GET("api/v2/me")
retrofit2.Call<User> getMe(@Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve the currently authenticated user

Parameters:

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<User>

getUsers

@GET("api/v2/users")
retrofit2.Call<Users> getUsers(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("after")
 String after,
 @Query("name")
 String name,
 @Query("id")
 String id)

List all users

Parameters:

zapTraceSpan - OpenTracing span context (optional)

offset - (optional)

limit - (optional, default to 20)

after - Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)

name - (optional)

id - (optional)

Returns:

Call<Users>

getUsersID

@GET("api/v2/users/{userID}")
retrofit2.Call<User> getUsersID(@Path("userID")
 String userID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a user

Parameters:

userID - The user ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<User>

patchUsersID

@Headers("Content-Type:application/json")
@PATCH("api/v2/users/{userID}")
retrofit2.Call<User> patchUsersID(@Path("userID")
 String userID,
 @Body
 PostUser postUser,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a user

Parameters:

userID - The ID of the user to update. (required)

postUser - User update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<User>

postUsers

@Headers("Content-Type:application/json")
@POST("api/v2/users")
retrofit2.Call<User> postUsers(@Body
 PostUser postUser,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create a user

Parameters:

postUser - User to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<User>

postUsersIDPassword

@Headers("Content-Type:application/json")
@POST("api/v2/users/{userID}/password")
retrofit2.Call<Void> postUsersIDPassword(@Path("userID")
 String userID,
 @Body
 PasswordResetBody passwordResetBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Authorization")
 String authorization)

Update a password

Parameters:

userID - The user ID. (required)

passwordResetBody - New password (required)

zapTraceSpan - OpenTracing span context (optional)

authorization - An auth credential for the Basic scheme (optional)

Returns:

Call<Void>

putMePassword

@Headers("Content-Type:application/json")
@PUT("api/v2/me/password")
retrofit2.Call<Void> putMePassword(@Body
 PasswordResetBody passwordResetBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Authorization")
 String authorization)

Update a password

Parameters:

passwordResetBody - New password (required)

zapTraceSpan - OpenTracing span context (optional)

authorization - An auth credential for the Basic scheme (optional)

Returns:

Call<Void>