Class User

The User provides an entry point for managing etcd users. The user can be added to Roles to manage permissions.

Index

Constructors

Properties

Methods

addRole create delete removeRole roles setPassword

Constructors

constructor

new User(client: AuthClient, name: string): User
Parameters
- client: AuthClient
- name: string
Returns User
- Defined in src/auth.ts:148

Properties

`Readonly`name

name: string

Methods

addRole

addRole(role: string | Role, options?: CallOptions): Promise<User>
Adds the user to a role.
Parameters
- role: string | Role
- Optionaloptions: CallOptions
Returns Promise<User>
- Defined in src/auth.ts:186

create

create(password: string, options?: CallOptions): Promise<User>
Creates the user, with the provided password.
Parameters
- password: string
- Optionaloptions: CallOptions
Returns Promise<User>
- Defined in src/auth.ts:156

delete

delete(options?: CallOptions): Promise<User>
Deletes the user from etcd.
Parameters
- Optionaloptions: CallOptions
Returns Promise<User>
- Defined in src/auth.ts:170

removeRole

removeRole(role: string | Role, options?: CallOptions): Promise<User>
Removes the user's access to a role.
Parameters
- role: string | Role
- Optionaloptions: CallOptions
Returns Promise<User>
- Defined in src/auth.ts:197

roles

roles(options?: CallOptions): Promise<Role[]>
Returns a list of roles this user has.
Parameters
- Optionaloptions: CallOptions
Returns Promise<Role[]>
- Defined in src/auth.ts:177

setPassword

setPassword(password: string, options?: CallOptions): Promise<User>
Changes the user's password.
Parameters
- password: string
- Optionaloptions: CallOptions
Returns Promise<User>
- Defined in src/auth.ts:163