Workspace Member Update

5 min

Resumo

Atualiza a associação de um usuário no grupo especificado.

Parâmetros

Parâmetro	Tipo	Comentários
group - required	string	Identifica o grupo na solicitação de API. O valor pode ser o endereço de e-mail do grupo, o alias do grupo ou o ID exclusivo do grupo.
member - required	string	Identifica o membro do grupo na solicitação de API. Um membro do grupo pode ser um usuário ou outro grupo. O valor pode ser o endereço de e-mail principal do membro (grupo ou usuário), alias ou ID exclusivo.
body	string	O corpo da solicitação contém uma instância de Member.

Suboptions do parâmetro body

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
kind	string		O tipo do recurso de API. Para recursos de Membros, o valor é admin#directory#member.
email	string		O endereço de e-mail do membro. Um membro pode ser um usuário ou outro grupo. Esta propriedade é necessária ao adicionar um membro a um grupo. O emaildeve ser exclusivo e não pode ser um alias de outro grupo. Se o endereço de e-mail for alterado, a API refletirá automaticamente as alterações do endereço de e-mail.
role	string		O papel do membro em um grupo. A API retorna um erro para ciclos em associações a grupos. Por exemplo, se group1 for membro de group2, group2 não pode ser membro de group1. Para obter mais informações sobre a função de um membro, consulte Atribuir funções de grupo a membros . Os valores aceitáveis são: MANAGER: esta função só está disponível se o Google Groups for Business estiver ativado usando o Admin Console. Consulte ATIVAR ou DESATIVAR o Groups for Business . Uma função MANAGER pode fazer tudo feito por uma OWNERfunção, exceto tornar um membro OWNER ETag do recurso.ou excluir o grupo. Um grupo pode ter vários membros MANAGER. MEMBER: esta função pode se inscrever em um grupo, visualizar arquivos de discussão e visualizar a lista de membros do grupo. Para obter mais informações sobre funções de membros, consulte Atribuir funções de grupo a membros . OWNER: esta função pode enviar mensagens para o grupo, adicionar ou remover membros, alterar funções de membros, alterar as configurações do grupo e excluir o grupo. Um OWNER deve ser um membro do grupo. Um grupo pode ter mais de um OWNER.
etag	string		ETag do recurso.
type	string	Escolhas: CUSTOMER EXTERNAL GROUP USER	O tipo de membro do grupo. Os valores aceitáveis são: CUSTOMER: o membro representa todos os usuários em um domínio. Um endereço de e-mail não é retornado e o ID retornado é o ID do cliente. EXTERNAL: o membro é um usuário ou grupo de fora do domínio. (Não usado atualmente) GROUP: O membro é outro grupo. USER: O membro é um usuário.
status	string		Status do membro (Imutável)
delivery_settings	string	Escolhas: ALL_MAIL DAILY DIGEST DISABLED NONE	Define as preferências de entrega de correio do membro. Isso é suportado apenas por create/update/get. Os valores aceitáveis são: ALL_MAIL: Todas as mensagens, entregues assim que chegam. DAILY: Não mais de uma mensagem por dia. DIGEST: até 25 mensagens agrupadas em uma única mensagem. DISABLED: Remova a assinatura. NONE: Sem mensagens.
id	string		O ID exclusivo do membro do grupo. Member_id pode ser usado como solicitação em memberKey.

Este módulo utiliza fragmentos da documentação do módulo Workspace.

Exemplos

# Exemplo: Adiciona um usuário ao grupo especificado.
- workspace_update_insert:
    service_account_email: [email protected]
    user_key: [email protected]
    group_key: group_key
    private_key: |-
        -----BEGIN PRIVATE KEY-----
        -----END PRIVATE KEY-----
    domain: your.domain.com
    group: '[email protected]'
    body:
      email: '[email protected]'

Valores retornados

Chave	Tipo	Retornado quando	Descrição
kind	string	sucesso	O tipo do recurso de API. Para recursos de Membros, o valor é admin#directory#member.
email	string	sucesso	O endereço de e-mail do membro. Um membro pode ser um usuário ou outro grupo. Esta propriedade é necessária ao adicionar um membro a um grupo. O emaildeve ser exclusivo e não pode ser um alias de outro grupo. Se o endereço de e-mail for alterado, a API refletirá automaticamente as alterações do endereço de e-mail.
role	string	sucesso	O papel do membro em um grupo. A API retorna um erro para ciclos em associações a grupos. Por exemplo, se group1 for membro de group2, group2 não pode ser membro de group1. Para obter mais informações sobre a função de um membro, consulte Atribuir funções de grupo a membros . Os valores aceitáveis são: MANAGER: esta função só está disponível se o Google Groups for Business estiver ativado usando o Admin Console. Consulte ATIVAR ou DESATIVAR o Groups for Business . Uma função MANAGER pode fazer tudo feito por uma OWNERfunção, exceto tornar um membro OWNER ETag do recurso.ou excluir o grupo. Um grupo pode ter vários membros MANAGER. MEMBER: esta função pode se inscrever em um grupo, visualizar arquivos de discussão e visualizar a lista de membros do grupo. Para obter mais informações sobre funções de membros, consulte Atribuir funções de grupo a membros . OWNER: esta função pode enviar mensagens para o grupo, adicionar ou remover membros, alterar funções de membros, alterar as configurações do grupo e excluir o grupo. Um OWNER deve ser um membro do grupo. Um grupo pode ter mais de um OWNER.
etag	string	sucesso	ETag do recurso.
type	string	sucesso	O tipo de membro do grupo. Os valores aceitáveis são: CUSTOMER: o membro representa todos os usuários em um domínio. Um endereço de e-mail não é retornado e o ID retornado é o ID do cliente. EXTERNAL: o membro é um usuário ou grupo de fora do domínio. (Não usado atualmente) GROUP: O membro é outro grupo. USER: O membro é um usuário.
status	string	sucesso	Status do membro (Imutável)
id	string	sucesso	O ID exclusivo do membro do grupo. Member_id pode ser usado como solicitação em memberKey.