Compartilhar recurso do workspace

POST

/v1/workspace/resources/:resource_id/share

Concede uma função (uma entre ‘admin’, ‘editor’, ‘commenter’ ou ‘viewer’) em um recurso do espaço de trabalho a um usuário, grupo ou chave de API do espaço de trabalho (conta de serviço). Isso substitui qualquer função existente que o destinatário tenha no recurso. Para selecionar um usuário ou uma conta de serviço, informe apenas o e-mail do usuário; o usuário deve estar no seu espaço de trabalho. Para selecionar um grupo, informe apenas o ID do grupo. Para selecionar uma chave de API do espaço de trabalho (conta de serviço), informe o ID da chave de API; o recurso será compartilhado com a conta de serviço associada a essa chave. Você precisa ter acesso de administrador ao recurso para compartilhá-lo.

Concede uma função (uma entre 'admin', 'editor', 'commenter' ou 'viewer') em um recurso do espaço de trabalho a um usuário, grupo ou chave de API do espaço de trabalho (conta de serviço). Isso substitui qualquer função existente que o destinatário tenha no recurso. Para selecionar um usuário ou uma conta de serviço, informe apenas o e-mail do usuário; o usuário deve estar no seu espaço de trabalho. Para selecionar um grupo, informe apenas o ID do grupo. Para selecionar uma chave de API do espaço de trabalho (conta de serviço), informe o ID da chave de API; o recurso será compartilhado com a conta de serviço associada a essa chave. Você precisa ter acesso de administrador ao recurso para compartilhá-lo.

Parâmetros de caminho

resource_idstringObrigatório

O ID do recurso de destino.

Solicitação

This endpoint expects an object.

roleenumObrigatório

Função a conceder ao destino: uma de ‘admin’, ‘editor’, ‘commenter’ ou ‘viewer’.

Valores permitidos:

resource_typeenumObrigatório

Tipo de recurso do recurso de destino.

user_emailstring or nullOpcional

O e-mail do usuário ou da conta de serviço.

group_idstring or nullOpcional

O ID do grupo de destino. Use ‘default’ para definir a função básica do recurso — todo membro do espaço de trabalho recebe essa função, a menos que tenha uma função superior por meio de uma concessão direta de usuário, associação a grupo ou chave de API do espaço de trabalho (conta de serviço).

workspace_api_key_idstring or nullOpcional

O ID da chave de API do espaço de trabalho de destino (conta de serviço). Não é a própria string da chave de API que você envia no cabeçalho para autenticação — é o ID da chave, que administradores do espaço de trabalho podem encontrar em Desenvolvedores → Contas de serviço.

Resposta

Resposta bem-sucedida

Erros

422

Unprocessable Entity Error

Parâmetros de caminho

Cabeçalhos

Solicitação

Resposta

Erros