Pular para o conteúdo principal
GET
Recuperar um usuário

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

userId
string
obrigatório

O identificador exclusivo do usuário a ser recuperado.

Parâmetros de consulta

idProperty
enum<string>

Especifica a propriedade usada para identificar o usuário. Os valores válidos são "USER_ID" e "EMAIL".

Opções disponíveis:
EMAIL,
USER_ID

Resposta

successful operation

email
string
obrigatório

O endereço de e-mail do usuário. Este é um campo obrigatório e deve ser único.

id
string
obrigatório

O identificador exclusivo do usuário, representado como uma string.

roleIds
string[]
obrigatório

Uma matriz de strings que representa os IDs das funções atribuídas ao usuário. Este é um campo obrigatório.

superAdmin
boolean
obrigatório

Um booleano que indica se o usuário tem privilégios de superadministrador. Este é um campo obrigatório.

firstName
string

O primeiro nome do usuário, representado como uma string.

lastName
string

O sobrenome do usuário, representado como uma string.

primaryTeamId
string

O ID da equipe principal ao qual o usuário pertence, representado como uma string.

roleId
string

Uma string que representa um único ID de função atribuído ao usuário.

seatNames
string[]

Uma matriz de strings que representa os nomes das licenças atribuídas ao usuário.

secondaryTeamIds
string[]

Uma matriz de strings que representa os IDs das equipes secundárias às quais o usuário está associado.

sendWelcomeEmail
boolean

Um booleano que indica se um e-mail de boas-vindas deve ser enviado ao usuário.

Última modificação em 6 de outubro de 2026