Package version:

Class User

Used to read, replace, and delete Users.

Additionally, you can access the permissions for a given user via user.permission and user.permissions.

See

Users to create, upsert, query, or read all.

Index

Properties

database id permissions

Accessors

Methods

delete permission read replace

Properties

`Readonly`database

database: Database

The parent Database.

`Readonly`id

id: string

`Readonly`permissions

permissions: Permissions

Operations for creating, upserting, querying, or reading all operations.

See client.permission(id) to read, replace, or delete a specific Permission by id.

Accessors

url

get url(): string
Returns a reference URL to the resource. Used for linking in Permissions.

Returns string
- Defined in sdk/cosmosdb/cosmos/src/client/User/User.ts:36

Methods

delete

delete(options?): Promise<UserResponse>
Delete the given User.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<UserResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/User/User.ts:119

permission

permission(id): Permission
Operations to read, replace, or delete a specific Permission by id.

See client.permissions for creating, upserting, querying, or reading all operations.
Parameters
- id: string
Returns Permission
- Defined in sdk/cosmosdb/cosmos/src/client/User/User.ts:56

read

read(options?): Promise<UserResponse>
Read the UserDefinition for the given User.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<UserResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/User/User.ts:63

replace

replace(body, options?): Promise<UserResponse>
Replace the given User's definition with the specified UserDefinition.
Parameters
- body: UserDefinition
  The specified UserDefinition to replace the definition.
- Optionaloptions: RequestOptions
Returns Promise<UserResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/User/User.ts:88