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) } }

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. Só pode conter valores definidos como schema e schemaExtensions para o User ResourceType.
emails[]	object (Email) Opcional. A lista de endereços de e-mail do usuário. O tamanho máximo permitido dos dados é 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 dos dados é 10 KB.
phoneNumbers[]	object (Phone) Opcional. Uma lista dos números de telefone do usuário. O tamanho máximo permitido dos dados é 1 KB.
groups[]	object (GroupReference) Apenas saída. A lista de grupos em que o usuário é membro direto, truncada para um máximo de 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 a inclusão do cliente em uma lista de permissão. Entre em contato com o suporte para explicar seu caso de uso e pedir 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 meta são atribuídos pelo provedor de serviços (têm um mutability de readOnly), e todos eles 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 empresarial 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 localidade.
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 empresarial 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 }

Campos
employeeNumber	string Opcional. Identificador, geralmente atribuído pela organização, usado para identificar o usuário dentro dela.
costCenter	string Opcional. Identificador do centro de custo a que as despesas do usuário são atribuídas.
organization	string Opcional. O nome de uma organização a que um usuário pertence.
department	string Opcional. O nome do departamento a que um usuário pertence no formato de texto.

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 SCIM que representa o grupo.
$ref	string Apenas saída. O URI do recurso 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.

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.