Interface TenantAdminApi


@Beta @Consumes("application/json") @Path("/tenants") public interface TenantAdminApi
Provides access to Tenant Administration actions.
  • Method Details

    • create

      @Named("tenant:create") @POST @Produces("application/json") @Nullable Tenant create(String name)
      Creates a new tenant
      Returns:
      the new tenant
    • create

      @Named("tenant:create") @POST @Nullable Tenant create(String name, CreateTenantOptions options)
      Creates a new tenant
      Returns:
      the new tenant
    • delete

      @Named("tenant:delete") @DELETE @Path("/{id}") boolean delete(@PathParam("id") String userId)
      Deletes a tenant
      Returns:
      true if successful
    • update

      @Named("tenant:updateTenant") @PUT @Path("/{id}") @Nullable Tenant update(@PathParam("id") String id, UpdateTenantOptions options)
      Updates a tenant
      Returns:
      the updated tenant
    • addRoleOnTenant

      @Named("tenant:addRoleOnTenant") @PUT @Path("/{id}/users/{userId}/roles/OS-KSADM/{roleId}") void addRoleOnTenant(@PathParam("id") String tenantId, @PathParam("userId") String userId, @PathParam("roleId") String roleId)
      Adds role to a user on a tenant
    • deleteRoleOnTenant

      @Named("tenant:deleteRoleOnTenant") @DELETE @Path("/{id}/users/{userId}/roles/OS-KSADM/{roleId}") boolean deleteRoleOnTenant(@PathParam("id") String tenantId, @PathParam("userId") String userdId, @PathParam("roleId") String roleId)
      Deletes role to a user on tenant
      Returns:
      true if successful