Method: projects.locations.completeExternalIdentities

Esse método fornece sugestões para usuários e grupos gerenciados em um provedor de identidade externo, com base no prefixo fornecido.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}:completeExternalIdentities

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso de local principal, como projects/*/locations/global.

Parâmetros de consulta

Parâmetros
prefixQuery

string

Obrigatório. O prefixo a ser pesquisado. Para os usuários, esse prefixo é comparado com o primaryEmail. Para grupos, esse prefixo é comparado ao displayName. A correspondência não diferencia maiúsculas de minúsculas.
maxSuggestions

integer

Opcional. O número máximo de resultados de usuários e grupos a serem retornados. O serviço pode retornar um valor inferior a este.

Se não for especificado, no máximo seis resultados serão retornados. O limite é distribuído da forma mais uniforme possível entre usuários e grupos. Por exemplo, se maxSuggestions for 7, o serviço poderá retornar 4 usuários e 3 grupos. Se houver menos sugestões de um tipo do que metade do limite, o outro tipo poderá retornar mais sugestões até o limite maxSuggestions.
entityTypeFilter

enum (EntityTypeFilter)

Opcional. O tipo de entidades a serem buscadas. Se não for definido, todos os tipos de entidade serão retornados.
useScimIdentities

boolean

Opcional. Indica se as identidades do SCIM serão usadas para conclusão de identidades externas. Se for "false", vamos chamar a API Microsoft Graph para buscar as identidades externas.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para CompletionService.CompleteExternalIdentities.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
Campos
externalIdentities[]

object (ExternalIdentity)

A lista de identidades externas que correspondem à consulta.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.locations.completeExternalIdentities

Para mais informações, consulte a documentação do IAM.

EntityTypeFilter

O tipo de entidades a serem buscadas.

Tipos enumerados
ENTITY_TYPE_FILTER_UNSPECIFIED Filtro de tipo de entidade não especificado.
USERS Buscar apenas usuários.
GROUPS Buscar apenas grupos.

ExternalIdentity

Identidade externa que representa um usuário ou grupo. Esse usuário ou grupo é de um provedor de identidade (IdP) externo.

Representação JSON 
{
  "externalId": string,
  "displayName": string,

  // Union field EntityType can be only one of the following:
  "userMetadata": {
    object (UserMetadata)
  },
  "groupMetadata": {
    object (GroupMetadata)
  }
  // End of list of possible types for union field EntityType.
}
Campos
externalId

string

O ID exclusivo de terceiros(externalId) da entidade (usuário ou grupo).
displayName

string

O nome de exibição do usuário ou grupo.
Campo de união EntityType. O tipo da identidade externa. Usado para indicar o tipo de entidade (usuário ou grupo) e os metadados correspondentes. EntityType pode ser apenas de um dos tipos a seguir:
userMetadata

object (UserMetadata)

metadados correspondentes ao usuário externo.
groupMetadata

object (GroupMetadata)

metadados correspondentes ao usuário externo.

UserMetadata

metadados correspondentes ao usuário externo.

Representação JSON 
{
  "givenName": string,
  "familyName": string,
  "primaryEmail": string
}
Campos
givenName

string

O nome do usuário.
familyName

string

O sobrenome do usuário.
primaryEmail

string

O endereço de e-mail principal do usuário.

GroupMetadata

Esse tipo não tem campos.

metadados correspondentes ao grupo externo.