public interface OrganizationsService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Void> |
deleteOrgsID(String orgID,
String zapTraceSpan)
Delete an organization
|
retrofit2.Call<Void> |
deleteOrgsIDMembersID(String userID,
String orgID,
String zapTraceSpan)
Remove a member from an organization
|
retrofit2.Call<Void> |
deleteOrgsIDOwnersID(String userID,
String orgID,
String zapTraceSpan)
Remove an owner from an organization
|
retrofit2.Call<Organizations> |
getOrgs(String zapTraceSpan,
Integer offset,
Integer limit,
Boolean descending,
String org,
String orgID,
String userID)
List all organizations
|
retrofit2.Call<Organization> |
getOrgsID(String orgID,
String zapTraceSpan)
Retrieve an organization
|
retrofit2.Call<ResourceMembers> |
getOrgsIDMembers(String orgID,
String zapTraceSpan)
List all members of an organization
|
retrofit2.Call<ResourceOwners> |
getOrgsIDOwners(String orgID,
String zapTraceSpan)
List all owners of an organization
|
retrofit2.Call<Organization> |
patchOrgsID(String orgID,
PatchOrganizationRequest patchOrganizationRequest,
String zapTraceSpan)
Update an organization
|
retrofit2.Call<Organization> |
postOrgs(PostOrganizationRequest postOrganizationRequest,
String zapTraceSpan)
Create an organization
|
retrofit2.Call<ResourceMember> |
postOrgsIDMembers(String orgID,
AddResourceMemberRequestBody addResourceMemberRequestBody,
String zapTraceSpan)
Add a member to an organization
|
retrofit2.Call<ResourceOwner> |
postOrgsIDOwners(String orgID,
AddResourceMemberRequestBody addResourceMemberRequestBody,
String zapTraceSpan)
Add an owner to an organization
|
@DELETE(value="api/v2/orgs/{orgID}")
retrofit2.Call<Void> deleteOrgsID(@Path(value="orgID")
String orgID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
orgID - The ID of the organization to delete. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/orgs/{orgID}/members/{userID}")
retrofit2.Call<Void> deleteOrgsIDMembersID(@Path(value="userID")
String userID,
@Path(value="orgID")
String orgID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of the member to remove. (required)orgID - The organization ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/orgs/{orgID}/owners/{userID}")
retrofit2.Call<Void> deleteOrgsIDOwnersID(@Path(value="userID")
String userID,
@Path(value="orgID")
String orgID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of the owner to remove. (required)orgID - The organization ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/orgs") retrofit2.Call<Organizations> getOrgs(@Header(value="Zap-Trace-Span") String zapTraceSpan, @Query(value="offset") Integer offset, @Query(value="limit") Integer limit, @Query(value="descending") Boolean descending, @Query(value="org") String org, @Query(value="orgID") String orgID, @Query(value="userID") String userID)
zapTraceSpan - OpenTracing span context (optional)offset - (optional)limit - (optional, default to 20)descending - (optional, default to false)org - Filter organizations to a specific organization name. (optional)orgID - Filter organizations to a specific organization ID. (optional)userID - Filter organizations to a specific user ID. (optional)@GET(value="api/v2/orgs/{orgID}")
retrofit2.Call<Organization> getOrgsID(@Path(value="orgID")
String orgID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
orgID - The ID of the organization to get. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/orgs/{orgID}/members")
retrofit2.Call<ResourceMembers> getOrgsIDMembers(@Path(value="orgID")
String orgID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
orgID - The organization ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/orgs/{orgID}/owners")
retrofit2.Call<ResourceOwners> getOrgsIDOwners(@Path(value="orgID")
String orgID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
orgID - The organization ID. (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/orgs/{orgID}")
retrofit2.Call<Organization> patchOrgsID(@Path(value="orgID")
String orgID,
@Body
PatchOrganizationRequest patchOrganizationRequest,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
orgID - The ID of the organization to get. (required)patchOrganizationRequest - Organization update to apply (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json") @POST(value="api/v2/orgs") retrofit2.Call<Organization> postOrgs(@Body PostOrganizationRequest postOrganizationRequest, @Header(value="Zap-Trace-Span") String zapTraceSpan)
postOrganizationRequest - Organization to create (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/orgs/{orgID}/members")
retrofit2.Call<ResourceMember> postOrgsIDMembers(@Path(value="orgID")
String orgID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
orgID - The organization ID. (required)addResourceMemberRequestBody - User to add as member (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/orgs/{orgID}/owners")
retrofit2.Call<ResourceOwner> postOrgsIDOwners(@Path(value="orgID")
String orgID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
orgID - The organization ID. (required)addResourceMemberRequestBody - User to add as owner (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2022 InfluxData, Inc.. All rights reserved.