Pular para o conteúdo principal
POST
Convidar pessoa

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
email
string
obrigatório
Required string length: 3 - 320
roles
BindingIn · object[]
obrigatório
Required array length: 1 - 32 elements
password
string | null

Opcional. Sem ela, a pessoa recebe um convite: um link de uso único para escolher a senha, e depois o autenticador no primeiro login. Uma pessoa cujo domínio de e-mail é do SSO do tenant não recebe convite e entra pelo provedor de identidade.

Required string length: 12 - 1024
with_totp
boolean
padrão:true

Só com password: cria o segredo do autenticador agora e o devolve em totp_uri. Sem senha, a pessoa configura o autenticador no primeiro login.

Resposta

A pessoa, com o convite (mostrado uma vez só) quando criada sem senha.

active
boolean
obrigatório
created_at
string<date-time>
obrigatório
email
string
obrigatório
password_set
boolean
obrigatório

Falso enquanto uma pessoa convidada não escolheu a senha, e para quem o SSO criou.

roles
BindingOut · object[]
obrigatório
sso
boolean
obrigatório

O domínio do e-mail pertence à conexão de SSO do tenant.

user_id
string<uuid>
obrigatório
deactivated_at
string<date-time> | null
invitation
InvitationOut · object | null

Aparece uma vez só: na criação, para uma pessoa criada sem senha.

invitation_expires_at
string<date-time> | null

Até quando o link de convite aberto da pessoa vale; nulo quando não há convite aberto.

last_login_at
string<date-time> | null
last_sso_login_at
string<date-time> | null
recovery_codes_left
integer
padrão:0
second_factor_confirmed_at
string<date-time> | null

Quando o autenticador em uso foi confirmado; nulo enquanto não há um.

totp_uri
string | null

Aparece uma vez só, na criação, para cadastrar o segundo fator.