REST Resource: customers.v2.Users

Recurso: User

Es la representación SCIM de un usuario.

Representación JSON

{ "schemas": [ string ], "emails": [ { object (Email) } ], "addresses": [ { object (Address) } ], "phoneNumbers": [ { object (Phone) } ], "groups": [ { object (GroupReference) } ], "id": string, "externalId": string, "meta": { object (Meta) }, "userName": string, "name": { object (Name) }, "displayName": string, "active": boolean, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { object (EnterpriseUserExtension) } }

Campos
schemas[]	string Obligatorio. Es una lista de URIs que indican los espacios de nombres de los esquemas de SCIM que definen los atributos presentes en la estructura JSON actual. Solo debe contener valores definidos como schema y schemaExtensions para el User ResourceType.
emails[]	object (Email) Es opcional. Es la lista de las direcciones de correo electrónico del usuario. El tamaño máximo de datos permitido es de 10 KB. El correo electrónico correspondiente a userName se agregará automáticamente a esta lista con su atributo secundario primary establecido en true. Esta entrada de correo electrónico principal es de solo lectura y no se puede modificar a través de este atributo.
addresses[]	object (Address) Es opcional. Es la lista de direcciones físicas del usuario. El tamaño máximo de datos permitido es de 10 KB.
phoneNumbers[]	object (Phone) Es opcional. Es una lista de los números de teléfono del usuario. El tamaño máximo de datos permitido es de 1 KB.
groups[]	object (GroupReference) Solo salida. Es la lista de grupos a los que el usuario pertenece directamente, truncada a un máximo de 1,000 grupos. Este atributo no se devuelve de forma predeterminada y se debe solicitar con el parámetro de consulta attributes. Para leer este atributo, se requiere que el cliente esté en la lista de entidades permitidas. Comunícate con el equipo de asistencia para explicar tu caso de uso y solicitar acceso.
id	string Es el identificador. Es el ID único del usuario. Las características del atributo son caseExact como true, una mutabilidad de readOnly y una característica returned de always.
externalId	string Es opcional. Es un identificador definido por el cliente para el usuario de SCIM. Este campo distingue mayúsculas de minúsculas y es mutable. El cliente es responsable de garantizar la unicidad, ya que el servidor no la aplica.
meta	object (Meta) Solo salida. Es un atributo complejo que contiene metadatos del recurso. Todos los atributos secundarios de meta son asignados por el proveedor de servicios (tienen un mutability de readOnly), y todos estos atributos secundarios tienen una característica returned de default. Este atributo se ignora cuando lo proporcionan los clientes.
userName	string Obligatorio. Es la dirección de correo electrónico principal del usuario. Se usa como identificador único del usuario.
name	object (Name) Obligatorio. El nombre del usuario.
displayName	string Es opcional. El nombre visible del usuario. Límite: 256 caracteres.
active	boolean Es opcional. Es el estado de la cuenta del usuario (false significa que la cuenta está suspendida). Predeterminado: true.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	object (EnterpriseUserExtension) Es opcional. Son atributos de extensión del usuario de SCIM Enterprise.

Nombre

Es la representación SCIM del nombre de un usuario.

Representación JSON
{ "familyName": string, "givenName": string }

Campos
familyName	string Obligatorio. Apellido del usuario
givenName	string Obligatorio. El nombre del usuario.

Correo electrónico

Es la representación SCIM del correo electrónico de un usuario.

Representación JSON
{ "value": string, "type": string, "primary": boolean }

Campos
value	string Obligatorio. La dirección de correo electrónico del usuario.
type	string Es el tipo de cuenta de correo electrónico. Los valores válidos son home, work y other.
primary	boolean Solo salida. Indica si este es el correo electrónico principal del usuario. Este valor se establece en true solo para el correo electrónico que corresponde a userName.

Dirección

Es la representación SCIM de la dirección de un usuario.

Representación JSON
{ "formatted": string, "streetAddress": string, "locality": string, "region": string, "postalCode": string, "country": string, "type": string, "primary": boolean }

Campos
formatted	string Es la dirección completa, con el formato adecuado para mostrarse.
streetAddress	string Es la dirección.
locality	string Ciudad o localidad
region	string Región o estado
postalCode	string Es el código postal.
country	string El país.
type	string Es el tipo de dirección. Los valores válidos son home, work y other.
primary	boolean Indica si esta es la dirección principal del usuario.

Teléfono

Es la representación SCIM del número de teléfono de un usuario.

Representación JSON
{ "value": string, "type": string, "primary": boolean }

Campos
value	string Obligatorio. Número de teléfono.
type	string Es el tipo de número de teléfono. Los valores válidos son home, work, mobile, fax, pager y other.
primary	boolean Indica si este es el número de teléfono principal del usuario.

EnterpriseUserExtension

Define los atributos de la extensión de usuario empresarial de SCIM. El URN del esquema para esta extensión es: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User. Consulta la sección 4.3 del RFC 7643 para obtener más detalles.

Representación JSON
{ "employeeNumber": string, "costCenter": string, "organization": string, "department": string }

Campos
employeeNumber	string Es opcional. Es el identificador, que suele asignar la organización, que se usa para identificar al usuario dentro de la organización.
costCenter	string Es opcional. Es el identificador del centro de costos al que se atribuyen los gastos del usuario.
organization	string Es opcional. Es el nombre de una organización a la que pertenece un usuario.
department	string Es opcional. Nombre del departamento al que pertenece el usuario, en formato de texto.

GroupReference

Es la representación de SCIM de la membresía de un usuario en un grupo.

Representación JSON
{ "value": string, "$ref": string, "type": string }

Campos
value	string Solo salida. Es el id del recurso de SCIM que representa el grupo.
$ref	string Solo salida. Es el URI del recurso de SCIM que representa el grupo.
type	string Solo salida. Es el tipo de membresía del grupo. Los valores válidos son direct y indirect.

Métodos
create	Crea un usuario.
delete	Borra un usuario.
get	Recupera un usuario.
list	Recupera una lista de usuarios.
patch	Actualiza un usuario con la semántica de parche de SCIM.