REST Resource: projects.tenants

Recurso: usuario

Un recurso de usuario representa un usuario en el servicio. Un usuario es un grupo o entidad que comparte el acceso común con privilegios específicos para recursos como los perfiles. El cliente puede crear varios usuarios para proporcionar aislamiento de datos para diferentes grupos.

Representación JSON
{
  "name": string,
  "externalId": string,
  "usageType": enum (DataUsageType),
  "keywordSearchableProfileCustomAttributes": [
    string
  ]
}
Campos
name

string

Obligatorio durante la actualización del usuario.

El nombre del recurso de un usuario. El servicio lo genera cuando se crea un usuario.

El formato es “projects/{projectId}/tenants/{tenantId}”, por ejemplo, “proyectos/foo/usuarios/bar”.

externalId

string

Obligatorio. Es el identificador de usuario del cliente, que se usa para identificar de forma única al usuario.

La cantidad máxima de caracteres permitida es 255.

usageType

enum (DataUsageType)

Indica si los datos que pertenecen a este usuario se pueden usar para proporcionar mejoras del producto para otros usuarios.

El comportamiento predeterminado es DataUsageType.ISOLATED si no lo estableces.

keywordSearchableProfileCustomAttributes[]

string

Es una lista de claves de Profile.custom_attributes filtrables, cuyos stringValues correspondientes se usan en las búsquedas de palabras clave. Los perfiles con stringValues debajo de estas claves de campo especificadas se muestran si alguno de los valores coincide con la palabra clave de la búsqueda. Los valores de campos personalizados con paréntesis, corchetes y símbolos especiales no se pueden buscar tal como están y deben estar entre comillas.

DataUsageType

Enumeración que representa cómo se usan los datos del usuario que son propiedad del usuario.

Enums
DATA_USAGE_TYPE_UNSPECIFIED Valor predeterminado
AGGREGATED Los datos que posee este usuario se utilizan para mejorar la calidad de búsqueda/recomendación entre usuarios.
ISOLATED Los datos que posee esta instancia se utilizan solo para mejorar la calidad de las recomendaciones o la búsqueda de esta instancia.

Métodos

complete

Completa el prefijo especificado con palabras clave sugeridas.

create

Crea una entidad de usuario nueva.

delete

Borra el usuario especificado.

get

Recupera el usuario especificado.

list

Enumera todas las instancias asociadas con el proyecto.

patch

Actualiza el usuario especificado.