Skip to main content
PATCH
Altera as configurações do club

Authorizations

Authorization
string
header
required

Token OPACO de sessão de quem administra, emitido por /v1/auth/admin/sign-in e verificado contra a nossa tabela — o mesmo desenho do studentSession, para a outra identidade.

É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o studentSession; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe.

O dashboard o guarda em cookie httpOnly, que o BFF troca pelo Authorization a cada chamada.

Path Parameters

clubId
string<uuid>
required

Id público da organização — o mesmo que GET /v1/me devolve em organization_id.

Na URL o recurso se chama club; no contrato e no domínio, organization. A divergência é deliberada: clubs é a palavra do produto, e a URL é o que as pessoas leem.

É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer.

O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso.

Body

application/json
agent_access
enum<string>

Quem do time pode conectar agentes externos (MCP) a este club. disabled: ninguém. admins (padrão): só quem administra. everyone: todo o time, cada um com o próprio papel.

Vale a cada chamada do agente, não só ao conectar: fechar corta na hora as conexões e chaves de quem deixou de poder, e reabrir as devolve.

Available options:
disabled,
admins,
everyone
create_students_without_access
boolean
student_password_mode
enum<string>

Como nasce a senha de quem ganha conta pela compra, pelo convite ou pela importação (quem se cadastra escolhe a própria):

  • none — sem senha. O e-mail de acesso leva o link de "defina a sua senha", e o código por e-mail também entra.
  • fixed — a mesma senha para todo aluno novo.
  • document — o documento do aluno, só os dígitos. Quem chega sem documento nasce como no none.

Com senha inicial, o e-mail de acesso diz como entrar em vez de levar o link, e a conta nasce confirmada. Vale para contas NOVAS: mudar o modo não mexe em quem já existe.

Available options:
none,
fixed,
document
student_password
string
write-only

A senha fixa. Só vale com o modo fixed (o atual ou o que vem junto); ausente, mantém a guardada.

Required string length: 8 - 1024
moderate_comments
boolean
watermark_pdf
boolean
notify_access_granted
boolean
notify_access_expiring
boolean
notify_comment_activity
boolean
notify_mentorship_reminders
boolean
notify_live_reminders
boolean
notify_certificate_issued
boolean
expiring_notice_days
integer
Required range: 1 <= x <= 60

Response

As configurações

data
object
required