REST Resource: customers.v2.Users

Recurso: User

Representação SCIM de um usuário.

Representação 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

Obrigatório. Uma lista de URIs que indicam os namespaces dos esquemas SCIM que definem os atributos presentes na estrutura JSON atual. Precisa conter apenas valores definidos como schema e schemaExtensions para o ResourceType do usuário.
emails[]

object (Email)

Opcional. A lista de endereços de e-mail do usuário. O tamanho máximo permitido para os dados é de 10 KB. O e-mail correspondente a userName será adicionado automaticamente a essa lista com o subatributo primary definido como true. Essa entrada de e-mail principal é somente leitura e não pode ser modificada por esse atributo.
addresses[]

object (Address)

Opcional. A lista de endereços físicos do usuário. O tamanho máximo permitido para os dados é de 10 KB.
phoneNumbers[]

object (Phone)

Opcional. Uma lista dos números de telefone do usuário. O tamanho máximo permitido de dados é 1 KB.
groups[]

object (GroupReference)

Apenas saída. A lista de grupos em que o usuário tem associação direta, truncada para no máximo 1.000 grupos.

Esse atributo não é retornado por padrão e precisa ser solicitado usando o parâmetro de consulta attributes. A leitura desse atributo requer que o cliente esteja na lista de permissões. Entre em contato com o suporte para explicar seu caso de uso e solicitar acesso.
id

string

Identificador. O ID exclusivo do usuário. As características do atributo são caseExact como true, uma mutabilidade de readOnly e uma característica returned de always.
externalId

string

Opcional. Um identificador definido pelo cliente para o usuário do SCIM. Esse campo diferencia maiúsculas de minúsculas e pode ser modificado. O cliente é responsável por garantir a exclusividade, já que o servidor não a impõe.
meta

object (Meta)

Apenas saída. Um atributo complexo que contém metadados de recursos. Todos os subatributos de meta são atribuídos pelo provedor de serviços (têm um mutability de readOnly), e todos esses subatributos têm uma característica returned de default. Esse atributo é ignorado quando fornecido pelos clientes.
userName

string

Obrigatório. O endereço de e-mail principal do usuário. Usado como o identificador exclusivo do usuário.
name

object (Name)

Obrigatório. O nome do usuário.
displayName

string

Opcional. O nome de exibição do usuário. Limite: 256 caracteres.
active

boolean

Opcional. O status da conta do usuário (false significa que a conta está suspensa). Padrão: true.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object (EnterpriseUserExtension)

Opcional. Atributos de extensão do usuário corporativo do SCIM.
urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser

object (CloudIdentityUserExtension)

Opcional. Atributos de extensão do usuário do Cloud Identity do SCIM.

Nome

Representação SCIM do nome de um usuário.

Representação JSON 
{
  "familyName": string,
  "givenName": string
}
Campos
familyName

string

Obrigatório. O sobrenome do usuário.
givenName

string

Obrigatório. O nome do usuário.

E-mail

Representação SCIM do e-mail de um usuário.

Representação JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Campos
value

string

Obrigatório. O endereço de e-mail do usuário.
type

string

O tipo da conta de e-mail. Os valores válidos são home, work e other.
primary

boolean

Apenas saída. Indica se este é o e-mail principal do usuário. Esse valor é definido como true apenas para o e-mail que corresponde a userName.

Endereço

Representação SCIM do endereço de um usuário.

Representação JSON 
{
  "formatted": string,
  "streetAddress": string,
  "locality": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "type": string,
  "primary": boolean
}
Campos
formatted

string

Endereço completo, formatado para exibição.
streetAddress

string

É o endereço.
locality

string

É a cidade ou região administrativa.
region

string

A região ou o estado.
postalCode

string

O código postal ou CEP.
country

string

O país.
type

string

O tipo do endereço. Os valores válidos são home, work e other.
primary

boolean

Indica se este é o endereço principal do usuário.

Telefone

Representação SCIM do número de telefone de um usuário.

Representação JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Campos
value

string

Obrigatório. O número de telefone.
type

string

O tipo do número de telefone. Os valores válidos são home, work, mobile, fax, pager e other.
primary

boolean

Indica se este é o número de telefone principal do usuário.

EnterpriseUserExtension

Define os atributos da extensão de usuário corporativo do SCIM. O URN do esquema para essa extensão é: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User. Consulte a Seção 4.3 da RFC 7643 para mais detalhes.

Representação JSON 
{
  "employeeNumber": string,
  "costCenter": string,
  "organization": string,
  "department": string,
  "manager": {
    object (Manager)
  }
}
Campos
employeeNumber

string

Opcional. Identificador, normalmente atribuído pela organização, usado para identificar o usuário dentro da organização.
costCenter

string

Opcional. Identificador do centro de custo ao qual as despesas do usuário são atribuídas.
organization

string

Opcional. O nome de uma organização à qual um usuário pertence.
department

string

Opcional. O nome de um departamento ao qual o usuário pertence no formato de texto.
manager

object (Manager)

Opcional. O gerente do usuário. Um atributo complexo que permite aos provedores de serviços representar a hierarquia organizacional referenciando o atributo id de outro usuário.

Gerente

Representação SCIM do gerente de um usuário. Os campos são baseados na Seção 4.3 do RFC 7643.

Representação JSON 
{
  "value": string,
  "$ref": string
}
Campos
value

string

Opcional. O id do recurso SCIM que representa o gerente do usuário.
$ref

string

Apenas saída. O URI do recurso SCIM que representa o gerente do usuário.

GroupReference

Representação SCIM da associação de um usuário a um grupo.

Representação JSON 
{
  "value": string,
  "$ref": string,
  "type": string
}
Campos
value

string

Apenas saída. O id do recurso do SCIM que representa o grupo.
$ref

string

Apenas saída. O URI do recurso do SCIM que representa o grupo.
type

string

Apenas saída. O tipo de associação ao grupo. Os valores válidos são: direct e indirect.

CloudIdentityUserExtension

Define os atributos da extensão de usuário do Google Cloud Identity. O URN do esquema para essa extensão é: urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser.

Representação 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)

Opcional. Os sites associados ao usuário, exceto os do tipo profile (que correspondem ao atributo de esquema principal do SCIM profileUrl).
additionalExternalIds[]

object (ExternalId)

Opcional. Uma coleção de identificadores externos do usuário. Essa lista serve como um conjunto complementar aos já representados pelo atributo de esquema principal do SCIM externalId e pelo atributo de extensão do usuário corporativo do SCIM urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber.
additionalIms[]

object (AdditionalIm)

Opcional. Endereços de mensagens instantâneas não principais do usuário. Exclui os endereços de MI principais, que correspondem ao atributo de esquema principal do SCIM ims.
additionalOrganizations[]

object (AdditionalOrganization)

Opcional. Organizações não principais do usuário.
addressListVisible

boolean

Opcional. Indica se o usuário deve aparecer na lista de endereços global. Se não for atribuído ou for limpo pelo cliente, esse atributo vai usar true como padrão.
gender

string

Opcional. O gênero do usuário. Os valores aceitos são female, male, other e unknown. Valores personalizados também são aceitos. Qualquer outro valor de string é tratado como um gênero personalizado.
organizationalUnit

object (OrganizationalUnit)

Opcional. A unidade organizacional do usuário.
primaryOrganization

object (PrimaryOrganization)

Opcional. Atributos adicionais da organização principal do usuário. Exclui name, department e costCenter (representados por urn:ietf:params:scim:schemas:extension:enterprise:2.0:User), além de title (que corresponde ao atributo de esquema principal do SCIM title).

OrganizationalUnit

Representação SCIM da unidade organizacional de um usuário.

Representação JSON 
{
  "path": string
}
Campos
path

string

Opcional. O caminho completo da unidade organizacional a que o usuário pertence (por exemplo, /corp/engineering) ou / para a unidade organizacional de nível superior. A unidade organizacional já precisa existir. Se não for atribuído ou for limpo pelo cliente, esse atributo vai usar / como padrão.

Site

Representação SCIM do site de um usuário. Exclui sites do tipo profile, que correspondem ao atributo de esquema principal do SCIM profileUrl.

Representação JSON 
{
  "value": string,
  "type": string
}
Campos
value

string

Obrigatório. O URL do site.
type

string

Opcional. O tipo do site. Os valores compatíveis são home, work e other. Qualquer valor de entrada diferente de home ou work é tratado como other.

ExternalId

Representação SCIM de um identificador externo adicional de um usuário. Exclui identificadores externos já representados pelo atributo de esquema principal do SCIM externalId e pelo atributo de extensão do usuário corporativo do SCIM urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber.

Representação JSON 
{
  "value": string,
  "type": string
}
Campos
value

string

Obrigatório. O valor do ID externo.
type

string

Opcional. O tipo de ID externo. Os valores compatíveis incluem account, customer, loginId e network. Valores personalizados também são aceitos. Qualquer outro valor de string é tratado como um tipo personalizado. Os valores organization e cloudidentityscim.googleapis.com são reservados e não podem ser usados.

AdditionalIm

Representação SCIM do endereço de mensagem instantânea (IM) não principal de um usuário. Exclui os endereços de MI principais, que correspondem ao atributo de esquema principal do SCIM ims.

Representação JSON 
{
  "value": string,
  "usage": string,
  "type": string
}
Campos
value

string

Obrigatório. O endereço de MI.
usage

string

Opcional. O uso do IM. Os valores compatíveis incluem home, work e other. Valores personalizados também são aceitos. Qualquer outro valor de string é tratado como um uso personalizado.
type

string

Opcional. O tipo do serviço de mensagens instantâneas. Os valores compatíveis incluem aim, gtalk, icq, jabber, msn, netmeeting, qq, skype e yahoo. Valores personalizados também são aceitos. Qualquer outro valor de string é tratado como um tipo personalizado.

PrimaryOrganization

Representação SCIM da organização principal de um usuário. Os campos desse atributo complexo se aplicam à mesma organização principal que a extensão de usuário corporativo do SCIM (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User). Ele exclui name, department e costCenter (que são representados pelos atributos organization, department e costCenter em urn:ietf:params:scim:schemas:extension:enterprise:2.0:User), bem como title (que corresponde ao atributo de esquema principal do SCIM title).

Representação JSON 
{
  "type": string,
  "domain": string,
  "fullTimeEquivalent": integer,
  "location": string,
  "symbol": string
}
Campos
type

string

Opcional. O tipo da organização. Os valores válidos são: school e work.
domain

string

Opcional. O nome de domínio associado à organização. Por exemplo, example.com
fullTimeEquivalent

integer

Opcional. A porcentagem de milissegundos equivalente em tempo integral na organização (100000 = 100%).
location

string

Opcional. A localização física da organização.
symbol

string

Opcional. O símbolo da organização.

AdditionalOrganization

Representação SCIM da organização não principal de um usuário. Exclui a organização principal do usuário, que é representada pelo atributo primaryOrganization, pela extensão de usuário corporativo do SCIM (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User) e pelo atributo de esquema principal do SCIM title.

Representação JSON 
{
  "type": string,
  "costCenter": string,
  "department": string,
  "domain": string,
  "fullTimeEquivalent": integer,
  "location": string,
  "name": string,
  "symbol": string,
  "title": string
}
Campos
type

string

Opcional. O tipo da organização. Os valores válidos são: school e work.
costCenter

string

Opcional. O centro de custo da organização.
department

string

Opcional. O departamento da organização.
domain

string

Opcional. O nome de domínio associado à organização. Por exemplo, example.com
fullTimeEquivalent

integer

Opcional. A porcentagem de milissegundos equivalente em tempo integral na organização (100000 = 100%).
location

string

Opcional. A localização física da organização.
name

string

Opcional. É o nome da organização.
symbol

string

Opcional. O símbolo da organização.
title

string

Opcional. O cargo do usuário na organização.

Métodos

create

 Cria um usuário.

delete

 Exclui um usuário.

get

 Recupera um usuário.

list

 Recupera uma lista de usuários.

patch

 Atualiza um usuário usando a semântica de patch do SCIM.