User class
ユーザーの読み取り、置換、および削除に使用されます。
さらに、user.permission と user.permissionsを使用して、特定のユーザーのアクセス許可にアクセスできます。
作成、アップサート、クエリ、またはすべてを読み取る ユーザー を参照してください。
プロパティ
| database | |
| id | |
| permissions | すべての操作を作成、アップサート、クエリ、読み取るための操作。 ID による特定のアクセス許可の読み取り、置換、または削除については、 |
| url | リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。 |
メソッド
| delete(Request |
指定した ユーザーを削除します。 |
| permission(string) | ID による特定のアクセス許可の読み取り、置換、または削除を行う操作。 すべての操作の作成、アップサート、クエリ、読み取りについては、 |
| read(Request |
指定された Userの 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)
指定された Userの 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
- options
- RequestOptions
戻り値
Promise<UserResponse>