Method: users.aliases.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Muestra una lista de todos los alias de un usuario.
Solicitud HTTP
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros |
userKey |
string
Identifica al usuario en la solicitud a la API. El valor puede ser la dirección de correo electrónico principal del usuario, la dirección de correo electrónico de alias o el ID de usuario único.
|
Parámetros de consulta
Parámetros |
event |
enum (Event )
Eventos a tener en cuenta
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Representación JSON |
{
"kind": string,
"etag": string,
"aliases": [
{
object (UserAlias )
}
]
} |
Campos |
kind |
string
Indica el tipo de recurso.
|
etag |
string
ETag del recurso.
|
aliases[] |
object (UserAlias )
Es una lista de objetos de alias.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://apps-apis.google.com/a/feeds/alias/
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.alias
https://www.googleapis.com/auth/admin.directory.user.alias.readonly
https://www.googleapis.com/auth/admin.directory.user.readonly
Para obtener más información, consulta la Guía de autorización.
Evento
Tipo de evento de Subscription
Enumeraciones |
ADD |
Evento de creación de alias |
DELETE |
Evento de eliminación de alias |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[],[],null,["# Method: users.aliases.list\n\nLists all aliases for a user.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `userKey` | `string` Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |\n\n### Query parameters\n\n| Parameters ||\n|---------|----------------------------------------------------------------------------------------------------------------|\n| `event` | `enum (`[Event](/workspace/admin/directory/reference/rest/v1/users.aliases/list#Event)`)` Events to watch for. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"aliases\": [ { object (/workspace/admin/directory/reference/rest/v1/users.aliases#UserAlias) } ] } ``` |\n\n| Fields ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `aliases[]` | `object (`[UserAlias](/workspace/admin/directory/reference/rest/v1/users.aliases#UserAlias)`)` A list of alias objects. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/alias/`\n- `\n https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.alias`\n- `\n https://www.googleapis.com/auth/admin.directory.user.alias.readonly`\n- `\n https://www.googleapis.com/auth/admin.directory.user.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nEvent\n-----\n\nType of the Subscription event\n\n| Enums ||\n|----------|---------------------|\n| `ADD` | Alias Created Event |\n| `DELETE` | Alias Deleted Event |"]]