Package com.influxdb.client.service

Interface LegacyAuthorizationsService

public interface LegacyAuthorizationsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteLegacyAuthorizationsID(String authID, String zapTraceSpan)	Delete a legacy authorization
retrofit2.Call<Authorizations>	getLegacyAuthorizations(String zapTraceSpan, String userID, String user, String orgID, String org, String token, String authID)	List all legacy authorizations
retrofit2.Call<Authorization>	getLegacyAuthorizationsID(String authID, String zapTraceSpan)	Retrieve a legacy authorization
retrofit2.Call<Authorization>	patchLegacyAuthorizationsID(String authID, AuthorizationUpdateRequest authorizationUpdateRequest, String zapTraceSpan)	Update a legacy authorization to be active or inactive
retrofit2.Call<Authorization>	postLegacyAuthorizations(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, String zapTraceSpan)	Create a legacy authorization
retrofit2.Call<Void>	postLegacyAuthorizationsIDPassword(String authID, PasswordResetBody passwordResetBody, String zapTraceSpan)	Set a legacy authorization password

Method Details

deleteLegacyAuthorizationsID

@DELETE("private/legacy/authorizations/{authID}")
retrofit2.Call<Void> deleteLegacyAuthorizationsID(@Path("authID")
 String authID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a legacy authorization

Parameters:

authID - The ID of the legacy authorization to delete. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getLegacyAuthorizations

@GET("private/legacy/authorizations")
retrofit2.Call<Authorizations> getLegacyAuthorizations(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("userID")
 String userID,
 @Query("user")
 String user,
 @Query("orgID")
 String orgID,
 @Query("org")
 String org,
 @Query("token")
 String token,
 @Query("authID")
 String authID)

List all legacy authorizations

Parameters:

zapTraceSpan - OpenTracing span context (optional)

userID - Only show legacy authorizations that belong to a user ID. (optional)

user - Only show legacy authorizations that belong to a user name. (optional)

orgID - Only show legacy authorizations that belong to an organization ID. (optional)

org - Only show legacy authorizations that belong to a organization name. (optional)

token - Only show legacy authorizations with a specified token (auth name). (optional)

authID - Only show legacy authorizations with a specified auth ID. (optional)

Returns:

Call<Authorizations>

getLegacyAuthorizationsID

@GET("private/legacy/authorizations/{authID}")
retrofit2.Call<Authorization> getLegacyAuthorizationsID(@Path("authID")
 String authID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a legacy authorization

Parameters:

authID - The ID of the legacy authorization to get. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>

patchLegacyAuthorizationsID

@Headers("Content-Type:application/json")
@PATCH("private/legacy/authorizations/{authID}")
retrofit2.Call<Authorization> patchLegacyAuthorizationsID(@Path("authID")
 String authID,
 @Body
 AuthorizationUpdateRequest authorizationUpdateRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a legacy authorization to be active or inactive

Parameters:

authID - The ID of the legacy authorization to update. (required)

authorizationUpdateRequest - Legacy authorization to update (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>

postLegacyAuthorizations

@Headers("Content-Type:application/json")
@POST("private/legacy/authorizations")
retrofit2.Call<Authorization> postLegacyAuthorizations(@Body
 LegacyAuthorizationPostRequest legacyAuthorizationPostRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create a legacy authorization

Parameters:

legacyAuthorizationPostRequest - Legacy authorization to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>

postLegacyAuthorizationsIDPassword

@Headers("Content-Type:application/json")
@POST("private/legacy/authorizations/{authID}/password")
retrofit2.Call<Void> postLegacyAuthorizationsIDPassword(@Path("authID")
 String authID,
 @Body
 PasswordResetBody passwordResetBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Set a legacy authorization password

Parameters:

authID - The ID of the legacy authorization to update. (required)

passwordResetBody - New password (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>