REST Resource: customers.v2.Groups

Recurso: grupo

Representação SCIM de um grupo.

Representação JSON
{
  "schemas": [
    string
  ],
  "members": [
    {
      object (Member)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "displayName": string,
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup": {
    object (CloudIdentityGroupExtension)
  }
}
Campos
schemas[]

string

Obrigatório. Uma lista de URIs que indicam os namespaces dos esquemas SCIM que definem os atributos presentes na estrutura JSON atual. Só pode conter valores definidos como schema e schemaExtensions para o Group ResourceType.

members[]

object (Member)

Opcional. A lista de participantes desse grupo. Esse atributo não é retornado no momento. As associações de grupos podem ser modificadas por solicitações PATCH.

id

string

Identificador. O ID exclusivo do grupo. As características do atributo são caseExact como true, uma mutabilidade de readOnly e uma característica returned de always.

externalId

string

Opcional. Um identificador do recurso conforme definido pelo cliente de provisionamento.

meta

object (Meta)

Apenas saída. Metadados do recurso. Todos os subatributos têm uma mutabilidade de readOnly e uma característica returned de default.

displayName

string

Obrigatório. O nome de exibição do grupo.

urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup

object (CloudIdentityGroupExtension)

Obrigatório. Atributos de grupo específicos do Cloud Identity.

Participante

Representação SCIM de um participante do grupo.

Representação JSON
{
  "value": string,
  "$ref": string
}
Campos
value

string

Imutável. Identificador do participante desse grupo.

$ref

string

Imutável. O URI do participante.

CloudIdentityGroupExtension

Define os atributos da extensão do grupo do Google Cloud Identity. O URN do esquema para essa extensão é: urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup.

Representação JSON
{
  "email": string,
  "description": string
}
Campos
email

string

Obrigatório. O endereço de e-mail do grupo. Se sua conta tiver vários domínios, selecione o domínio apropriado para o endereço de e-mail. O email precisa ser exclusivo. Os endereços de e-mail de grupos estão sujeitos às mesmas regras de uso de caracteres que os nomes de usuário. Para mais detalhes, consulte a documentação da Central de Ajuda.

description

string

Opcional. Uma descrição estendida para ajudar os usuários a determinar a finalidade de um Group.

Limite: 4.096 caracteres.

Métodos

create

Cria um grupo.

delete

Exclui um grupo.

get

Recupera um grupo.

list

Recupera uma lista de grupos.

patch

Atualiza um grupo usando a semântica de patch do SCIM.