Console
    Contact Us Start free

    REST Resource: projects.locations.clusters.users

    Resource: User

    Message describing User object.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "password" 
 : 
 string 
 , 
 "databaseRoles" 
 : 
 [ 
 string 
 ] 
 , 
 "userType" 
 : 
 enum (  UserType 
 
) 
 , 
 "keepExtraRoles" 
 : 
 boolean 
 }
    Fields
    name

    string

    Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
    password

    string

    Input only. Password for the user.
    databaseRoles[]

    string

    Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.
    userType

    enum ( UserType )

    Optional. Type of this user.
    keepExtraRoles

    boolean

    Input only. If the user already exists and it has additional roles, keep them granted.

    UserType

    Enum that details the user type.

    Enums
    USER_TYPE_UNSPECIFIED Unspecified user type.
    ALLOYDB_BUILT_IN The default user type that authenticates via password-based authentication.
    ALLOYDB_IAM_USER Database user that can authenticate via IAM-Based authentication.

    Methods

    create

    		Creates a new User in a given project, location, and cluster.

    delete

    		Deletes a single User.

    get

    		Gets details of a single User.

    list

    		Lists Users in a given project and location.

    patch

    		Updates the parameters of a single User.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: