Method Detail

• create

  @Named(value="user:create")
  @POST
  @Path(value="/users")
  @Consumes(value="application/json")
  void create(Set<User> users)

  Create database users. A user is granted all privileges on the specified databases. The following user name is reserved and cannot be used for creating users: root. This method can be used to create users with access restrictions by host

  Parameters:

  users - List of users to be created.

  See Also:

  User Access Restriction by Host

• create

  @Named(value="user:create")
  @POST
  @Path(value="/users")
  @Consumes(value="application/json")
  void create(String userName,
                                     String password,
                                     String databaseName)

  Create a database user by name, password, and database name. Simpler overload for #create(String, Set).

  Parameters:

  userName - Name of the user for the database.

  password - User password for database access.

  databaseName - Name of the database that the user can access.

• create

  @Named(value="user:create")
  @POST
  @Path(value="/users")
  @Consumes(value="application/json")
  void create(String userName,
                                     String password,
                                     String host,
                                     String databaseName)

  Create a database user by name, password, and database name. Simpler overload for #create(String, Set).

  Parameters:

  userName - Name of the user for the database.

  password - User password for database access.

  host - Specifies the host from which a user is allowed to connect to the database. Possible values are a string containing an IPv4 address or "%" to allow connecting from any host. Refer to Section 3.11.1, “User Access Restriction by Host” for details. If host is not specified, it defaults to "%".

  databaseName - Name of the database that the user can access.

• grant

  @Named(value="user:grant")
  @PUT
  @Path(value="/users/{name}/databases")
  @Consumes(value="application/json")
  void grant(@PathParam(value="name")
                                   String userName,
                                   List<String> databases)

  This operation grants access for the specified user to a database for the specified instance. The user is granted all privileges.

  Parameters:

  userName - The name of the specified user.

  databases - List of the databases that the user should be granted access to.

• grant

  @Named(value="user:grant")
  @PUT
  @Path(value="/users/{name}/databases")
  @Consumes(value="application/json")
  void grant(@PathParam(value="name")
                                   String userName,
                                   String databaseName)

  This operation grants access for the specified user to a database for the specified instance. Simpler overload for #create(String, Set). The user is granted all privileges.

  Parameters:

  userName - Name of the user for the database.

  databaseName - Name of the database that the user can access.

• revoke

  @Named(value="user:revoke")
  @DELETE
  @Path(value="/users/{name}/databases/{databaseName}")
  @Consumes(value="application/json")
  boolean revoke(@PathParam(value="name")
                                          String userName,
                                          @PathParam(value="databaseName")
                                          String databaseName)

  This operation grants access for the specified user to a database for the specified instance. The user is granted all privileges.

  Parameters:

  userName - Name of the user for the database.

  databaseName - Name of the database that the user can access.

  Returns:

  true if successful.

• delete

  @Named(value="users:delete/{name}")
  @DELETE
  @Path(value="/users/{name}")
  @Consumes(value="application/json")
  boolean delete(@PathParam(value="name")
                                          String userName)

  This operation deletes the specified user for the specified database instance.

  Parameters:

  userName - The name for the specified user.

  Returns:

  true if successful.

• list

  @Named(value="user:list")
  @GET
  @Path(value="/users")
  @Consumes(value="application/json")
  com.google.common.collect.FluentIterable<User> list()

  This operation lists the users in the specified database instance. This operation does not return the system users (database administrators that administer the health of the database). Also, this operation returns the "root" user only if "root" user has been enabled.

  Returns:

  The list of Users.

• getDatabaseList

  @Named(value="user:getDatabaseList/{name}")
  @GET
  @Path(value="/users/{name}/databases")
  @Consumes(value="application/json")
  com.google.common.collect.FluentIterable<String> getDatabaseList(@PathParam(value="name")
                                                                                         String userName)

  This operation shows a list of all databases to which a user has access.

  Parameters:

  instanceId - The instance ID for the specified database instance.

  userName - The name for the specified user.

  Returns:

  The list of Users.

• get

  @Named(value="user:get/{name}")
  @GET
  @Path(value="/users/{name}")
  @Consumes(value="application/json")
  @Nullable
  User get(@PathParam(value="name")
                                          String name)

  Returns a User by identifier.

  Parameters:

  name - The name or identifier for the specified user.

  Returns:

  User or Null on not found.

• get

  @Named(value="user:get/{name}@{hostname}")
  @GET
  @Path(value="/users/{name}@{hostname}")
  @Consumes(value="application/json")
  @Nullable
  User get(@PathParam(value="name")
                                          String name,
                                          @PathParam(value="hostname")
                                          String hostname)

  Returns a User by name and allowed host.

  Parameters:

  name - The name for the specified user.

  host - The associated hostname.

  Returns:

  User or Null on not found.