Gerenciamento de permissões de usuário

Este guia explica como gerenciar permissões de usuário com a API Frame.io V4. Ele aborda como as permissões funcionam nos níveis de Conta, Espaço de trabalho e Projeto, e quais pontos de acesso usar em cada um.


Níveis de permissão

As permissões no Frame.io são gerenciadas nos níveis de Conta, Espaço de trabalho e Projeto. Cada nível usa seu próprio conjunto de funções:

Account
├── (admin) - full access to all Workspaces, Projects, and Restricted Projects
└── (member)
├── Workspace - (full_access | editor | edit_only | commenter | viewer)
│ │
│ └── Project - (full_access | editor | edit_only | commenter | viewer)
└── Restricted Project - (members require direct invite)

Todo usuário tem uma função de conta. Pela API, você pode definir a função de um usuário como administrador ou membro.

Administradores da conta têm acesso total a todos os Espaços de trabalho e Projetos. Membros da conta podem ser adicionados seletivamente aos Espaços de trabalho e Projetos necessários.

Ao adicionar um Membro da conta a um Espaço de trabalho, o nível de permissão atribuído (full_access, editor, edit_only, commenter ou viewer) se aplica a todos os Projetos existentes e futuros dentro dele. Por exemplo, se você adicionar um membro de conta como visualizador, ele terá permissões de visualizador sempre que acessar qualquer Projeto nesse Espaço de trabalho. Esse mesmo Membro da conta pode ser adicionado a um Projeto específico dentro desse Espaço de trabalho como editor. Como resultado, sempre que acessar esse Projeto, ele terá permissões de editor. As permissões de visualizador continuam sendo aplicadas a todos os outros Projetos nesse Espaço de trabalho. Como as atribuições de Projeto são separadas das atribuições de Espaço de trabalho, se você remover esse Membro da conta do Espaço de trabalho, ele manterá as permissões de editor para esse único Projeto.

Projetos restritos são a exceção. Membros da conta sempre exigem um convite direto. Veja mais detalhes sobre isso na seção Permissões no nível do projeto abaixo.

Permissões de nível de conta

Todo usuário na sua Conta tem uma função:

FunçãoPermissõesConfigurável pela APIPonto de acesso
ProprietárioAcesso total a todos os Espaços de trabalho e Projetos. Um por contaNão
Rotulado comoAcesso total a todos os Espaços de trabalho e ProjetosSimPATCH /accounts/:account_id/users/:user_id
membroPermissões definidas no nível do Espaço de trabalho e/ou ProjetoSimPATCH /accounts/:account_id/users/:user_id
RevisorAcesso somente por links de compartilhamento. Criado quando um usuário é adicionado a um compartilhamento seguroNão

Administradores da conta têm acesso total em todos os lugares. Para limitar o acesso de um Administrador a recursos específicos, primeiro altere sua função de conta para Membro e depois adicione-o aos Espaços de trabalho ou Projetos necessários.

Por exemplo:

1

Liste as funções de usuário da conta para encontrar o ID do usuário e confirmar sua função atual:

$curl https://api.frame.io/v4/accounts/:account_id/users \
> -H "Authorization: Bearer <token>"
2

Atualize a função da conta para Membro:

$curl -X PATCH https://api.frame.io/v4/accounts/:account_id/users/:user_id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "data": {
> "role": "member"
> }
>}'
3

Adicioná-los a um Projeto:

$curl -X PATCH https://api.frame.io/v4/accounts/:account_id/projects/:project_id/users/:user_id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "data": {
> "role": "edit_only"
> }
>}'

Pontos de acesso de permissões da conta

Listar funções de usuário da conta

Lista usuários em determinada conta, incluindo detalhes do usuário (ID, nome, email) e a função dele na conta.


GET``https://api.frame.io/v4/accounts/:account_id/users
Documentação


Permissões no nível do Espaço de trabalho

Ao adicionar um Membro da conta a um Espaço de trabalho, ele terá esse nível de permissão em todos os Projetos dentro dele. Os Espaços de trabalho são somente por convite, portanto Membros da conta veem apenas os Espaços de trabalho aos quais foram adicionados.


FunçãoPermissões
full_accessFazer upload, gerenciar, compartilhar, comentar, visualizar, fazer download, gerenciar configurações e convidar usuários
editorFazer upload, gerenciar, compartilhar, comentar, visualizar, fazer download
edit_onlyFazer upload, gerenciar, comentar e visualizar. Não pode compartilhar nem fazer download
commenterVisualizar e comentar
viewerSomente visualizar

Pontos de acesso de permissões do Espaço de trabalho

Listar usuários

Lista usuários com acesso a determinado espaço de trabalho, incluindo detalhes do usuário (ID, nome, email) e a função dele.


GET``https://api.frame.io/v4/accounts/:account_id/workspaces/:workspace_id/users
Documentação


Permissões no nível do Projeto

Projetos usam os mesmos níveis de permissão que Espaços de trabalho. Adicione um usuário diretamente a um Projeto quando ele precisar de acesso somente a esse Projeto específico ou quando precisar de um nível de permissão diferente da atribuição no Espaço de trabalho. Os usuários não precisam de acesso ao Espaço de trabalho para serem adicionados a um Projeto.


FunçãoPermissões
full_accessFazer upload, gerenciar, compartilhar, comentar, visualizar, fazer download, gerenciar configurações e convidar usuários
editorFazer upload, gerenciar, compartilhar, comentar, visualizar, fazer download
edit_onlyFazer upload, gerenciar, comentar e visualizar. Não pode compartilhar nem fazer download
commenterVisualizar e comentar
viewerSomente visualizar

Exemplo: adicionar um usuário a um Projeto
$curl -X PATCH https://api.frame.io/v4/accounts/:account_id/projects/:project_id/users/:user_id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "data": {
> "role": "full_access"
> }
>}'

Projetos restritos

Projetos restritos exigem um convite direto. O acesso ao Espaço de trabalho não é transferido,

portanto os usuários só podem acessar um Projeto restrito se tiverem sido adicionados diretamente a ele.

Para conceder acesso a um Membro, adicione-o ao Projeto com o nível de permissão apropriado.

Administradores e Proprietários da conta são a exceção e têm acesso a todos os

Projetos restritos.

Pontos de acesso de permissões do Projeto

Listar funções de usuário do Projeto

Lista usuários com acesso a determinado projeto, incluindo detalhes do usuário (ID, nome, email) e a função deles.


GET``https://api.frame.io/v4/accounts/:account_id/projects/:project_id/users
Documentação


Recursos

Recursos adicionais que podem ser úteis: