Configurar e usar a API do Canva Admin

Você pode usar a API Admin do Canva para automatizar o gerenciamento da organização a partir dos seus próprios sistemas. Gerencie usuários, equipes, grupos e associações, além de recuperar eventos do registro de auditoria, sem precisar realizar essas tarefas manualmente no Canva.

• Disponível nos planos Canva Enterprise, Canva Districts e Canva Universidades.
• Acessível por administradores da organização.
• Disponível para organizações com uma ou várias equipes.

Antes de configurar a API Admin, confira se sua organização atende a estes requisitos:

• Nível da organização: a API Admin é específica da organização. Ela está disponível para organizações com uma ou várias equipes nos planos Canva Enterprise, Canva Districts e Canva Campus.
• Conta de administrador da organização: somente administradores da organização podem criar e gerenciar clientes da API Admin nas configurações do Canva.
• Equipe de engenharia interna ou terceirizada: sua organização precisa ter recursos de engenharia para desenvolver e manter a integração. O Canva não oferece suporte à implementação.
  • Se sua equipe não puder desenvolver uma integração com uma API, o provisionamento SCIM é mais adequado para automatizar o gerenciamento de usuários na sua organização.
• Familiaridade com a estrutura do Canva: antes de desenvolver a integração, entenda claramente como sua organização, suas equipes e seus grupos estão configurados no Canva.
• Autenticação multifator (MFA) ou conta gerenciada por início único de sessão (SSO): o administrador da organização que configurar a API Admin precisa ter a MFA ativada ou usar uma conta gerenciada por SSO. A conta precisa ser gerenciada ou pertencer à organização em nome da qual essa pessoa está agindo.

A API Admin oferece endpoints para:

• Usuários, equipes e grupos: criar, consultar, atualizar e excluir.
• Associações: adicionar ou remover pessoas de equipes e grupos e definir as funções delas.
• Registros de auditoria: recuperar eventos do registro de auditoria de forma programada.
• Convites para equipes: convidar pessoas para uma equipe (inclusive pessoas de fora da sua organização), visualizar convites pendentes, recuperar o link de um convite existente usando o endereço de e-mail exato e cancelar convites.

Um administrador da organização cria um cliente da API Admin e o usa para fazer chamadas à API.

Siga a documentação da API Admin do Canva para trocar suas credenciais de cliente por um token de acesso e começar a fazer solicitações à API.

Para saber mais sobre como autenticar solicitações à API e usar tokens bearer do OAuth 2.0, compartilhe a documentação de autenticação da API Admin do Canva com sua equipe de engenharia.

As ações realizadas pela API Admin são registradas em nome do cliente da API Admin, e não do administrador que o utilizou.

Nos registros de auditoria, o campo Ator exibe o nome e o ID do cliente da API Admin. Isso ajuda a identificar qual integração realizou uma ação.

Você também pode identificar o administrador da organização que criou, atualizou ou excluiu um cliente específico da API.

Para mais informações, consulte Sobre os registros de auditoria do Canva.

Os administradores da organização podem usar a API Admin para convidar pessoas para uma equipe, inclusive colaboradores externos à organização.

O que você precisa saber

• Cada convite criado é para uma equipe e um endereço de e-mail.
• Cada convite pode ser usado uma vez e expira após 30 dias.
• Dependendo da sua configuração, o Canva pode não enviar o convite por e-mail automaticamente. Se necessário, compartilhe o link do convite diretamente com a pessoa convidada.
• Mantenha os links de convite privados. Cada link só funciona para o endereço de e-mail para o qual foi criado.
• As configurações atuais de convites e domínios da sua equipe também se aplicam às pessoas que você convidar.
• Se já houver um convite pendente para a pessoa, criar um novo convite retornará o mesmo registro, redefinirá o prazo de validade para 30 dias a partir da solicitação e atualizará a função do convite para a função solicitada.

Para ver os detalhes dos endpoints, consulte a documentação da API Admin do Canva.

Tanto a API Admin quanto o SCIM podem ajudar no provisionamento de usuários.

A API Admin permite gerenciar outros aspectos da organização no Canva além do provisionamento de usuários, incluindo equipes, grupos, associações e registros de auditoria.

O SCIM oferece suporte ao provisionamento e desprovisionamento padrão. Se você precisa apenas do provisionamento padrão de usuários ou se sua equipe não pode desenvolver uma integração personalizada com a API, o SCIM é mais adequado às suas necessidades.

Minha organização precisa de uma pessoa desenvolvedora para usar a API Admin?

Sim. Para usar a API Admin, sua organização precisa ter recursos de engenharia internos ou terceirizados para desenvolver e manter a integração. O Canva não oferece suporte à implementação. Se sua equipe não puder desenvolver uma integração com uma API, o provisionamento SCIM é mais adequado para automatizar o gerenciamento de usuários na sua organização.

Todo mundo na minha organização precisa usar MFA ou início único de sessão (SSO) para usar a API Admin?

Não. Somente o administrador da organização que configurar a API Admin precisa ter a MFA ativada ou usar uma conta gerenciada por início único de sessão (SSO). A conta precisa ser gerenciada ou pertencer à organização em nome da qual essa pessoa está agindo. As demais pessoas da organização não precisam usar MFA ou SSO especificamente para que a API Admin funcione.

Minha organização pode convidar colaboradores externos usando a API Admin?

Sim. Os administradores da organização podem usar a API Admin para convidar pessoas para equipes, inclusive colaboradores externos. As configurações atuais de convites e domínios da sua equipe também se aplicam às pessoas que você convidar.

É possível recuperar o link de um convite existente sem criar um novo convite?

Sim. Você pode recuperar o link de um convite existente usando o endereço de e-mail exato da pessoa convidada, sem gerar um novo convite.