spaces/{space-id}

Resumo do método

PUT /spaces/{space-id}

Descrição

Use esse método para incluir, editar ou excluir as permissões de usuário ou de grupos de usuários para um espaço

Informações de recurso

Requisitos	Descrição
Formato de resposta	JSON
Requer autenticação	True
Suporta credenciais do cliente OAuth 2	Sim usando um ID de Serviço do Usuário que contém Categoria de Autoria de Artefato
Taxa limitada	O IBM Blueworks Live aplica um limite de taxa que determina com que frequência essa API pode ser chamada em um período específico. A taxa permitida é de 200 solicitações por hora. O limite de taxa é aplicado à conta inteira. Mesmo se métodos de autenticação diferentes forem usados, a taxa única de toda a conta será aplicada em todos os usuários. Quando o limite de taxa para a API é excedido para a conta, a próxima solicitação é rejeitada com o código de status 429 e o cabeçalho de resposta Retry-After, que indica o número de segundos quando a próxima solicitação pode ser feita.

Parâmetros

Nome	Local	Descrição	Necessário	Tipo
space-id	Caminho	O identificador do espaço.	True	Sequência
operation	Consultar	O tipo de operação. As operações incluem: Add, Update, Delete..	True	Sequência
Content-type	Cabeçalho	O valor deve ser application/json	Necessário quando há conteúdo no corpo da solicitação	Sequência
X-On-Behalf-Of	Cabeçalho	O contexto do usuário. O valor deve ser um nome do usuário na conta. O usuário deve ter permissão para executar a ação na conta e no espaço especificado, se houver.	Necessário se as credenciais do OAuth do ID de serviço forem usadas Não é necessário ao usar a credencial OAuth do ID do Serviço do Usuário	Sequência

Corpo JSON da solicitação

O corpo da solicitação é um objeto JSON que contém as propriedades a seguir:

Resposta

Observação: os exemplos a seguir para as operações Add, Update e Delete são aplicáveis a todos os espaços. Se um subespaço herdar permissões de um espaço pai, você deverá primeiro desativar a herança de permissões de espaço antes de chamar qualquer uma das operações.

Exemplo 1 de entrada - Add

• Adicione um usuário a um espaço:

  Primeiro, obtenha o ID do usuário com a UserList API e, em seguida, use o seguinte comando.

  curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=add --header 'authorization:
  Bearer access_token' --header 'content-type: application/json'
  --data '{"users": [{"participantId": "5f500e1280001", "permissions": {"blueprintProcesses": false, "automateProcesses":
  true, "composeDecisions": false, "authorPolicies": true, "manageAndEdit": false}}]}'

• Adicione um grupo de usuários padrão (todos os editores, todos os colaboradores, toda a comunidade, todos os visualizadores, todos os administradores) a um espaço:

  curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=add --header 'authorization:
  Bearer access_token' --header 'content-type: application/json'
  --data '{"users": [{"participantType": "all-contributors", "permissions": {"automateProcesses": true, "manageAndEdit":
  false}}]}'

• Adicione um grupo de usuários personalizado a um espaço:

  Primeiro, obtenha o ID do usuário com a ManageGroup API e, em seguida, use o seguinte comando.

  curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=add --header 'authorization:
  Bearer access_token' --header 'content-type: application/json'
  --data '{"users" : [{"participantId": "5f500e1280001", "permissions": {"blueprintProcesses": true,
  "automateProcesses": true, "composeDecisions": false, "authorPolicies": true, "manageAndEdit": false}}]}'

Exemplo 2 entrada - Update

• Atualize as permissões de usuário:
  • Usuário:

    curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=update --header
    'authorization: Bearer access_token' --header 'content-type:
    application/json' --data '{"users" : [{"participantId": "5f500e1280001", "permissions": {"blueprintProcesses": true,
    "automateProcesses": true, "composeDecisions": false, "authorPolicies": true, "manageAndEdit": false}}]}'

  • Grupo de usuários padrão:

    curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=update --header
    'authorization: Bearer access_token' --header 'content-type:
    application/json' --data '{"users" : ["participantType": "all-editors", "permissions": {"blueprintProcesses": true,
    "automateProcesses": true, "composeDecisions": false, "authorPolicies": true, "manageAndEdit": false}}]}'

  • Grupo de usuários personalizado:

    curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=update --header
    'authorization: Bearer access_token' --header 'content-type:
    application/json' --data '{"users" : [{"participantId": "5f500e1280001", "permissions": {"blueprintProcesses": true,
    "automateProcesses": true, "composeDecisions": false, "authorPolicies": true, "manageAndEdit": false}}]}'

• Desative a opção "Herdar permissões de espaço de um pai" para um subespaço:

  curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=update --header
  'authorization: Bearer access_token' --header 'content-type:
  application/json' --data '{"inheritParentSpace": false}'

  Observação: use esse comando primeiro se quiser chamar uma operação Add, Update ou Delete em um subespaço que herda permissões de um espaço pai.

Exemplo 3 entrada - Delete

• Excluir um usuário de um espaço:

  curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=delete --header
  'authorization: Bearer access_token' --header 'content-type: 
  application/json' --data '{"users": [{"participantId": "5f500e1280001"}]}'

• Exclua um grupo de usuários padrão (todos os editores, todos os colaboradores, toda a comunidade, todos os visualizadores, todos os administradores) de um espaço:

  curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=delete --header 
  'authorization: Bearer access_token' --header 'content-type: 
  application/json' --data '{"users": [{"participantType": "all-contributors"}]}'

• Exclua um grupo de usuários personalizado de um espaço:

  curl -i --request PUT --url https://your_server_url/bwl/spaces/{space-id}?operation=delete --header 
  'authorization: Bearer access_token' --header 'content-type: 
  application/json' --data '{"users" : [{"participantId": "5f500e1280001"}]}'

Exemplo de saída

Se a solicitação for bem-sucedida, uma mensagem “200 OK” "Updated Space permissions" será retornada..

Cabeçalhos de resposta

Nome do Cabeçalho	Descrição
Retry-After	Quando a próxima solicitação pode ser feita, em um número de segundos

Mensagens de resposta

Código de HTTP	Razão
200	A solicitação foi concluída com sucesso.
400	Há um erro ao processar a solicitação Os parâmetros necessários estavam ausentes ou continham valores inválidos.
401	A autenticação deste usuário não foi aprovada. Essa resposta poderá aparecer pelos seguintes motivos: Um nome de usuário ou senha inválido fornecido. Este usuário pertence a várias contas e uma conta não foi especificada na solicitação.
403	Este usuário não tem permissão para modificar as permissões de um espaço nesta conta
404	O ID do espaço não existe.
429	A solicitação excedeu o limite de taxa da API para essa conta.

Para obter mais informações, consulte a especificação OpenAPI.