Options
All
  • Public
  • Public/Protected
  • All
Menu

The Role provides an entry point for managing etcd roles. Etcd has an ACL-esque system: users have one or more roles, and roles have one or more permissions that grant them access (read, write, or both) on key ranges.

Hierarchy

  • Role

Index

Constructors

constructor

Properties

Readonly name

name: string

Methods

addUser

  • addUser(user: string | User, options?: grpc.CallOptions): Promise<this>
  • Grants a user access to the role.

    Parameters

    • user: string | User
    • Optional options: grpc.CallOptions

    Returns Promise<this>

create

  • create(options?: grpc.CallOptions): Promise<this>
  • Creates the role in etcd.

    Parameters

    • Optional options: grpc.CallOptions

    Returns Promise<this>

delete

  • delete(options?: grpc.CallOptions): Promise<this>
  • Deletes the role from etcd.

    Parameters

    • Optional options: grpc.CallOptions

    Returns Promise<this>

grant

permissions

removeUser

  • removeUser(user: string | User, options?: grpc.CallOptions): Promise<this>
  • Removes a user's access to the role.

    Parameters

    • user: string | User
    • Optional options: grpc.CallOptions

    Returns Promise<this>

revoke

Legend

  • Constructor
  • Method
  • Inherited method

Generated using TypeDoc