User | etcd3

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

Hierarchy

User

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new User(client: AuthClient, name: string): User

- Defined in src/auth.ts:144
Parameters
- client: AuthClient
- name: string
Returns User

Properties

Readonly name

name: string

Methods

addRole

addRole(role: string | Role, options?: grpc.CallOptions): Promise<this>

- Defined in src/auth.ts:180
Adds the user to a role.

Parameters
- role: string | Role
- Optional options: grpc.CallOptions
Returns Promise<this>

create

create(password: string, options?: grpc.CallOptions): Promise<this>

- Defined in src/auth.ts:150
Creates the user, with the provided password.

Parameters
- password: string
- Optional options: grpc.CallOptions
Returns Promise<this>

delete

delete(options?: grpc.CallOptions): Promise<this>

- Defined in src/auth.ts:164
Deletes the user from etcd.

Parameters
- Optional options: grpc.CallOptions
Returns Promise<this>

removeRole

removeRole(role: string | Role, options?: grpc.CallOptions): Promise<this>

- Defined in src/auth.ts:191
Removes the user's access to a role.

Parameters
- role: string | Role
- Optional options: grpc.CallOptions
Returns Promise<this>

roles

roles(options?: grpc.CallOptions): Promise<Role[]>

- Defined in src/auth.ts:171
Returns a list of roles this user has.

Parameters
- Optional options: grpc.CallOptions
Returns Promise<Role[]>

setPassword

setPassword(password: string, options?: grpc.CallOptions): Promise<this>

- Defined in src/auth.ts:157
Changes the user's password.

Parameters
- password: string
- Optional options: grpc.CallOptions
Returns Promise<this>

Generated using TypeDoc