Package com.influxdb.client.service

Interface AuthorizationsService

public interface AuthorizationsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteAuthorizationsID(String authID, String zapTraceSpan)	Delete an authorization
retrofit2.Call<Authorizations>	getAuthorizations(String zapTraceSpan, String userID, String user, String orgID, String org)	List all authorizations
retrofit2.Call<Authorization>	getAuthorizationsID(String authID, String zapTraceSpan)	Retrieve an authorization
retrofit2.Call<Authorization>	patchAuthorizationsID(String authID, AuthorizationUpdateRequest authorizationUpdateRequest, String zapTraceSpan)	Update an authorization to be active or inactive
retrofit2.Call<Authorization>	postAuthorizations(AuthorizationPostRequest authorizationPostRequest, String zapTraceSpan)	Create an authorization

Method Details

deleteAuthorizationsID

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

Delete an authorization

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getAuthorizations

@GET("api/v2/authorizations")
retrofit2.Call<Authorizations> getAuthorizations(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("userID")
 String userID,
 @Query("user")
 String user,
 @Query("orgID")
 String orgID,
 @Query("org")
 String org)

List all authorizations

Parameters:

zapTraceSpan - OpenTracing span context (optional)

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

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

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

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

Returns:

Call<Authorizations>

getAuthorizationsID

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

Retrieve an authorization

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>

patchAuthorizationsID

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

Update an authorization to be active or inactive

Parameters:

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

authorizationUpdateRequest - Authorization to update (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>

postAuthorizations

@Headers("Content-Type:application/json")
@POST("api/v2/authorizations")
retrofit2.Call<Authorization> postAuthorizations(@Body
 AuthorizationPostRequest authorizationPostRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create an authorization

Parameters:

authorizationPostRequest - Authorization to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>