Partager via


User class

Utilisé pour lire, remplacer et supprimer des utilisateurs.

En outre, vous pouvez accéder aux autorisations d’un utilisateur donné via user.permission et user.permissions.

Consultez Utilisateurs pour créer, upsert, interroger ou lire tout.

Propriétés

database
id
permissions

Opérations de création, d’upserting, d’interrogation ou de lecture de toutes les opérations.

Consultez client.permission(id) pour lire, remplacer ou supprimer une autorisation spécifique par ID.

url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

Méthodes

delete(RequestOptions)

Supprimez l’utilisateur donné.

permission(string)

Opérations de lecture, de remplacement ou de suppression d’une autorisation spécifique par ID.

Consultez client.permissions pour la création, l’upserting, l’interrogation ou la lecture de toutes les opérations.

read(RequestOptions)

Lisez la définition UserDefinition pour l’utilisateur donné.

replace(UserDefinition, RequestOptions)

Remplacez la définition de l’utilisateur donnée par la définition UserDefinition spécifiée.

Détails de la propriété

database

database: Database

Valeur de propriété

id

id: string

Valeur de propriété

string

permissions

Opérations de création, d’upserting, d’interrogation ou de lecture de toutes les opérations.

Consultez client.permission(id) pour lire, remplacer ou supprimer une autorisation spécifique par ID.

permissions: Permissions

Valeur de propriété

url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

string url

Valeur de propriété

string

Détails de la méthode

delete(RequestOptions)

Supprimez l’utilisateur donné.

function delete(options?: RequestOptions): Promise<UserResponse>

Paramètres

options
RequestOptions

Retours

Promise<UserResponse>

permission(string)

Opérations de lecture, de remplacement ou de suppression d’une autorisation spécifique par ID.

Consultez client.permissions pour la création, l’upserting, l’interrogation ou la lecture de toutes les opérations.

function permission(id: string): Permission

Paramètres

id

string

Retours

read(RequestOptions)

Lisez la définition UserDefinition pour l’utilisateur donné.

function read(options?: RequestOptions): Promise<UserResponse>

Paramètres

options
RequestOptions

Retours

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Remplacez la définition de l’utilisateur donnée par la définition UserDefinition spécifiée.

function replace(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

Paramètres

body
UserDefinition

UserDefinition spécifié pour remplacer la définition.

options
RequestOptions

Retours

Promise<UserResponse>