com.influxdb.client.service

Interface AuthorizationsService

public interface AuthorizationsService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Void>	deleteAuthorizationsID(String authID, String zapTraceSpan) Delete a 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 authorization to be active or inactive.
retrofit2.Call<Authorization>	postAuthorizations(Authorization authorization, String zapTraceSpan) Create an authorization

Method Detail

deleteAuthorizationsID

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

Delete a authorization

Parameters:

authID - ID of authorization to delete (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getAuthorizations

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

List all authorizations

Parameters:

zapTraceSpan - OpenTracing span context (optional)

userID - filter authorizations belonging to a user id (optional)

user - filter authorizations belonging to a user name (optional)

orgID - filter authorizations belonging to a org id (optional)

org - filter authorizations belonging to a org name (optional)

Returns:

Call<Authorizations>

getAuthorizationsID

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

Retrieve an authorization

Parameters:

authID - ID of authorization to get (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>

patchAuthorizationsID

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

update authorization to be active or inactive. requests using an inactive authorization will be rejected.

Parameters:

authID - ID of authorization to update (required)

authorizationUpdateRequest - authorization to update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>

postAuthorizations

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

Create an authorization

Parameters:

authorization - authorization to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Authorization>