REST Resource: customers.v2.Users

Recurso: User

Representación de 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)
  },
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser": {
    object (CloudIdentityUserExtension)
  }
}
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 ResourceType de usuario.
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 las 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 en los que el usuario tiene membresía directa, 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 de recursos. El proveedor de servicios asigna todos los atributos secundarios de meta (tienen un mutability de readOnly), y todos estos atributos secundarios tienen una característica de 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. Atributos de extensión de usuario empresarial de SCIM
urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser

object (CloudIdentityUserExtension)

Es opcional. Atributos de extensión de usuario de Cloud Identity de SCIM.

Nombre

Representación de SCIM del nombre de un usuario.

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

string

Obligatorio. El apellido del usuario.
givenName

string

Obligatorio. Es el nombre de pila del usuario.

Correo electrónico

Es la representación de 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 de 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 para mostrar.
streetAddress

string

Indica la dirección.
locality

string

Es la ciudad o localidad.
region

string

La región o el estado.
postalCode

string

Es el código postal.
country

string

Indica 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 de SCIM del número de teléfono de un usuario.

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

string

Obligatorio. El 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 el artículo 4.3 de RFC 7643 para obtener más detalles.

Representación JSON 
{
  "employeeNumber": string,
  "costCenter": string,
  "organization": string,
  "department": string,
  "manager": {
    object (Manager)
  }
}
Campos
employeeNumber

string

Es opcional. 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. Es el nombre del departamento al que pertenece el usuario en formato de texto.
manager

object (Manager)

Es opcional. Es el administrador del usuario. Es un atributo complejo que, de manera opcional, permite que los proveedores de servicios representen la jerarquía de la organización haciendo referencia al atributo id de otro usuario.

Administrador

Es la representación de SCIM del administrador de un usuario. Los campos se basan en el artículo 4.3 de la RFC 7643.

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

string

Es opcional. Es el id del recurso de SCIM que representa al administrador del usuario.
$ref

string

Solo salida. Es el URI del recurso de SCIM que representa al administrador del usuario.

GroupReference

Representación de SCIM de la membresía de un usuario a 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 al grupo.
$ref

string

Solo salida. Es el URI del recurso de SCIM que representa al grupo.
type

string

Solo salida. Es el tipo de membresía del grupo. Los valores válidos son direct y indirect.

CloudIdentityUserExtension

Define los atributos de la extensión de usuario de Google Cloud Identity. El URN del esquema para esta extensión es urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser.

Representación JSON 
{
  "websites": [
    {
      object (Website)
    }
  ],
  "additionalExternalIds": [
    {
      object (ExternalId)
    }
  ],
  "additionalIms": [
    {
      object (AdditionalIm)
    }
  ],
  "additionalOrganizations": [
    {
      object (AdditionalOrganization)
    }
  ],
  "addressListVisible": boolean,
  "gender": string,
  "organizationalUnit": {
    object (OrganizationalUnit)
  },
  "primaryOrganization": {
    object (PrimaryOrganization)
  }
}
Campos
websites[]

object (Website)

Es opcional. Son los sitios web asociados con el usuario, excepto los sitios web de tipo profile (que corresponden al atributo de esquema principal de SCIM profileUrl).
additionalExternalIds[]

object (ExternalId)

Es opcional. Es una colección de identificadores externos para el usuario. Esta lista sirve como un conjunto complementario de los que ya están representados por el atributo de esquema principal de SCIM externalId y el atributo de extensión de usuario empresarial de SCIM urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber.
additionalIms[]

object (AdditionalIm)

Es opcional. Direcciones de mensajería instantánea no principales del usuario. Excluye las direcciones de IM principales, que corresponden al atributo de esquema principal de SCIM ims.
additionalOrganizations[]

object (AdditionalOrganization)

Es opcional. Son las organizaciones no principales del usuario.
addressListVisible

boolean

Es opcional. Indica si el usuario debe mostrarse en la lista global de direcciones. Si el cliente no asigna o borra este atributo, se establece de forma predeterminada en true.
gender

string

Es opcional. Se refiere al género del usuario. Los valores admitidos son female, male, other, and unknown. También se admiten valores personalizados. Cualquier otro valor de cadena se trata como un género personalizado.
organizationalUnit

object (OrganizationalUnit)

Es opcional. Es la unidad organizativa del usuario.
primaryOrganization

object (PrimaryOrganization)

Es opcional. Son los atributos adicionales de la organización principal del usuario. Excluye name, department y costCenter (que se representan con urn:ietf:params:scim:schemas:extension:enterprise:2.0:User), así como title (que corresponde al atributo de esquema principal de SCIM title).

OrganizationalUnit

Representación de SCIM de la unidad organizativa de un usuario.

Representación JSON 
{
  "path": string
}
Campos
path

string

Es opcional. Es la ruta de acceso completa de la unidad organizativa a la que pertenece el usuario (por ejemplo, /corp/engineering) o / para la unidad organizativa de nivel superior. La unidad organizativa ya debe existir. Si el cliente no asigna o borra este atributo, se establece de forma predeterminada en /.

Sitio web

Representación de SCIM del sitio web de un usuario. Excluye los sitios web de tipo profile, que corresponden al atributo de esquema principal de SCIM profileUrl.

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

string

Obligatorio. Es la URL del sitio web.
type

string

Es opcional. Es el tipo de sitio web. Los valores admitidos son home, work y other. Cualquier valor de entrada que no sea home ni work se trata como other.

ExternalId

Representación de SCIM del identificador externo adicional de un usuario. Excluye los identificadores externos que ya están representados por el atributo de esquema principal de SCIM externalId y el atributo de extensión de usuario empresarial de SCIM urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber.

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

string

Obligatorio. Es el valor del ID externo.
type

string

Es opcional. Es el tipo de ID externo. Los valores admitidos son account, customer, loginId y network. También se admiten valores personalizados; cualquier otro valor de cadena se trata como un tipo personalizado. Los valores organization y cloudidentityscim.googleapis.com están reservados y no se pueden usar.

AdditionalIm

Es la representación de SCIM de la dirección de mensajería instantánea (IM) no principal de un usuario. Excluye las direcciones de IM principales, que corresponden al atributo de esquema principal de SCIM ims.

Representación JSON 
{
  "value": string,
  "usage": string,
  "type": string
}
Campos
value

string

Obligatorio. Es la dirección de mensajería instantánea.
usage

string

Es opcional. El uso de la IM. Los valores admitidos son home, work y other. También se admiten valores personalizados; cualquier otro valor de cadena se trata como un uso personalizado.
type

string

Es opcional. Es el tipo de servicio de IM. Los valores admitidos incluyen aim, gtalk, icq, jabber, msn, netmeeting, qq, skype y yahoo. También se admiten valores personalizados; cualquier otro valor de cadena se trata como un tipo personalizado.

PrimaryOrganization

Es la representación de SCIM de la organización principal de un usuario. Los campos de este atributo complejo se aplican a la misma organización principal que la extensión de usuario empresarial de SCIM (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User). Se excluyen name, department y costCenter (que se representan con los atributos organization, department y costCenter en urn:ietf:params:scim:schemas:extension:enterprise:2.0:User), así como title (que corresponde al atributo de esquema principal de SCIM title).

Representación JSON 
{
  "type": string,
  "domain": string,
  "fullTimeEquivalent": integer,
  "location": string,
  "symbol": string
}
Campos
type

string

Es opcional. Es el tipo de organización. Los valores válidos son school y work.
domain

string

Es opcional. Es el nombre de dominio asociado con la organización. Por ejemplo, example.com.
fullTimeEquivalent

integer

Es opcional. El porcentaje de milésimas equivalente a tiempo completo dentro de la organización (100000 = 100%).
location

string

Es opcional. Es la ubicación física de la organización.
symbol

string

Es opcional. Es el símbolo de la organización.

AdditionalOrganization

Representación de SCIM de la organización no principal de un usuario. Excluye la organización principal del usuario, que se representa en el atributo primaryOrganization, la extensión de usuario empresarial de SCIM (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User) y el atributo de esquema principal de SCIM title.

Representación JSON 
{
  "type": string,
  "costCenter": string,
  "department": string,
  "domain": string,
  "fullTimeEquivalent": integer,
  "location": string,
  "name": string,
  "symbol": string,
  "title": string
}
Campos
type

string

Es opcional. Es el tipo de organización. Los valores válidos son school y work.
costCenter

string

Es opcional. Es el centro de costos de la organización.
department

string

Es opcional. Es el departamento de la organización.
domain

string

Es opcional. Es el nombre de dominio asociado con la organización. Por ejemplo, example.com.
fullTimeEquivalent

integer

Es opcional. El porcentaje de milésimas equivalente a tiempo completo dentro de la organización (100000 = 100%).
location

string

Es opcional. Es la ubicación física de la organización.
name

string

Es opcional. Es el nombre de la organización.
symbol

string

Es opcional. Es el símbolo de la organización.
title

string

Es opcional. El cargo del usuario dentro de la organización.

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.