User class
ユーザーの読み取り、置換、削除に使用します。
さらに、 と user.permissionsを使用して、特定のユーザーのアクセス許可にuser.permissionアクセスできます。
「 ユーザー 」を参照して、すべてを作成、アップサート、クエリ、または読み取りを行います。
プロパティ
| database | |
| id | |
| permissions | すべての操作を作成、アップサート、クエリ、または読み取るための操作。 ID による特定のアクセス許可の読み取り、置換、または削除を参照してください |
| url | リソースへの参照 URL を返します。 [アクセス許可] のリンクに使用されます。 |
メソッド
| delete(Request |
指定されたユーザーを削除 します。 |
| permission(string) | ID による特定のアクセス許可の読み取り、置換、または削除を行う操作。 すべての操作の作成、アップサート、クエリ、または読み取りに関するページを参照してください |
| read(Request |
指定された ユーザーの UserDefinition を読み取 る。 |
| replace(User |
指定した User の定義を、指定した UserDefinition に置き換えます。 |
プロパティの詳細
database
id
id: stringプロパティ値
string
permissions
すべての操作を作成、アップサート、クエリ、または読み取るための操作。
ID による特定のアクセス許可の読み取り、置換、または削除を参照してください client.permission(id) 。
permissions: Permissionsプロパティ値
url
リソースへの参照 URL を返します。 [アクセス許可] のリンクに使用されます。
string urlプロパティ値
string
メソッドの詳細
delete(RequestOptions)
指定されたユーザーを削除 します。
function delete(options?: RequestOptions): Promise<UserResponse>パラメーター
- options
- RequestOptions
戻り値
Promise<UserResponse>
permission(string)
ID による特定のアクセス許可の読み取り、置換、または削除を行う操作。
すべての操作の作成、アップサート、クエリ、または読み取りに関するページを参照してください client.permissions 。
function permission(id: string): Permissionパラメーター
- id
-
string
戻り値
read(RequestOptions)
指定された ユーザーの UserDefinition を読み取 る。
function read(options?: RequestOptions): Promise<UserResponse>パラメーター
- options
- RequestOptions
戻り値
Promise<UserResponse>
replace(UserDefinition, RequestOptions)
指定した User の定義を、指定した UserDefinition に置き換えます。
function replace(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>パラメーター
- body
- UserDefinition
定義を置き換える 指定された UserDefinition 。
- options
- RequestOptions
戻り値
Promise<UserResponse>