Users are profiles to which you can attribute database-level permissions. They allow you to define permissions specific to each type of database usage.
Apply user roles
Apply preset roles for a user in a Database Instance.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance the user belongs to.
Apply user roles › Request Body
user_nameName of the database user.
List of roles assigned to the user, along with the corresponding database where each role is granted.
Apply user roles › Responses
nameName of the user (Length must be between 1 and 63 characters. First character must be an alphabet character (a-zA-Z). Only a-zA-Z0-9_$- characters are accepted).
List of roles assigned to the user, along with the corresponding database where each role is granted.
List users of a Database Instance
List all users of a given Database Instance.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance.
query Parameters
nameName of the user.
order_byCriteria to use when requesting user listing.
pagepage_sizeList users of a Database Instance › Responses
List of users in a Database Instance.
total_countTotal count of users present on a Database Instance.
Create an user on a Database Instance
Create an user on a Database Instance. You must define the name, password of the user and instance_id parameters in the request.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance the user belongs to.
Create an user on a Database Instance › Request Body
nameName of the database user.
passwordPassword of the database user.
Create an user on a Database Instance › Responses
nameName of the user (Length must be between 1 and 63 characters. First character must be an alphabet character (a-zA-Z). Only a-zA-Z0-9_$- characters are accepted).
List of roles assigned to the user, along with the corresponding database where each role is granted.
Delete a user on a Database Instance
Delete an existing user on a Database Instance.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance the user belongs to.
nameName of the database user.
Delete a user on a Database Instance › Responses
Update a user on a Database Instance
Update the parameters of a user on a Database Instance. You can update the password parameter, but you cannot change the name of the user.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance the user belongs to.
nameName of the database user.
Update a user on a Database Instance › Responses
nameName of the user (Length must be between 1 and 63 characters. First character must be an alphabet character (a-zA-Z). Only a-zA-Z0-9_$- characters are accepted).
List of roles assigned to the user, along with the corresponding database where each role is granted.