Se usó la API de Cloud Translation para traducir esta página.

Descripción general de la API de configuración de administrador

La API de configuración de administrador permite que los administradores de los dominios de Google Workspace recuperen y cambien la configuración de sus dominios en forma de feeds de la API de datos de Google.

Esta configuración de dominio incluye muchas de las funciones disponibles en la Consola del administrador de Google Workspace. Algunos ejemplos de usos de esta API incluyen crear un panel de control personalizado o integrar dominios de Google Workspace en un entorno heredado existente.

La API de Admin Settings implementa el protocolo de la API de datos de Google. La API de datos de Google cumple con el modelo de publicación y edición del protocolo de publicación de Atom (Atom Pub/Sub). Las solicitudes HTTP de AtomPub usan el enfoque de diseño de transferencia de conjuntos representativos (RESTful) para los servicios web. Si desea obtener más información, consulte la Guía para el programador de datos de Google.

Público

Este documento está dirigido a los desarrolladores que quieran escribir aplicaciones cliente que puedan modificar y recuperar información sobre los dominios de Google Workspace. Proporciona ejemplos de las interacciones básicas de la API de configuración de administrador con XML y HTTP sin procesar.

En este documento, se asume que comprende las ideas generales que respaldan el protocolo de la API de datos de Google y que usted está familiarizado con la Consola del administrador de Google Workspace. Para obtener más información sobre la Consola del administrador, consulte Cómo usar la Consola del administrador.

Cómo comenzar

Cómo crear una cuenta

La API de Admin Settings está habilitada para las cuentas de Google Workspace. Regístrate con una cuenta de Google Workspace para realizar pruebas. El servicio de configuración de administrador usa Cuentas de Google, por lo que si ya tienes una cuenta en un dominio de Google Workspace, ya está todo listo.

Acerca de los tipos de feed de la API de Admin Settings

La API de Admin Settings te permite gestionar estas categorías de configuración de dominio:

Configuración de inicio de sesión único

El inicio de sesión único (SSO) basado en SAML permite que los usuarios utilicen el mismo acceso y la misma contraseña para los servicios alojados en Google Workspace y para los demás servicios que usted pueda alojar en su organización. Específicamente, cuando se usa el SSO, una aplicación web alojada, como Google Workspace, redirecciona a los usuarios al proveedor de identidad de su organización para autenticarlos cuando acceden. Si deseas obtener información detallada, consulta Información sobre el SSO basado en SAML para Google Workspace.

Configurar el SSO implica ingresar la información necesaria para que el servicio de Google Workspace se comunique con el proveedor de identidad que almacena la información de acceso de los usuarios, además de configurar los vínculos a los que se debe enviar a los usuarios para acceder, salir y cambiar sus contraseñas. La API de Admin Settings te permite actualizar y recuperar estas opciones de manera programática. Google usa tu clave pública generada para verificar esta solicitud de SSO con tu proveedor de identidad y verificar que la respuesta SAML de clave privada no se haya modificado durante la transmisión de la red.

Para obtener un resumen específico y breve de cómo usar la configuración de SSO, obtén tu certificado de clave pública de tu proveedor de identidad, registra la clave pública con Google y establece la configuración de la consulta de SSO basada en SAML. Para mensajes de error, consulta Solución de problemas de SSO:

Genera tus claves: con tu proveedor de identidad, genera un conjunto de claves públicas y privadas utilizando los algoritmos de DSA o RSA. La clave pública está en un certificado con formato X.509. Para obtener más información sobre las claves de firma de inicio de sesión único basadas en SAML, consulta Genera claves y certificados para el servicio de inicio de sesión único de Google Workspace.
Regístrate con Google: utiliza la configuración de inicio de sesión único de la API de Admin Settings para registrar tu certificado de clave pública con Google.
Establece tu configuración de SSO: utiliza la configuración de inicio de sesión único de la API de configuración de administrador para establecer la configuración que se utiliza en la comunicación con los servidores del proveedor de identidad del dominio.

Configuración de puerta de enlace y enrutamiento

Este feed permite que los administradores del dominio controlen el enrutamiento del correo electrónico en sus dominios.

Las operaciones de enrutamiento de correo electrónico permiten que los administradores especifiquen la configuración de enrutamiento de correo electrónico a nivel de dominio. Esto es similar a la función de enrutamiento de correo electrónico de la configuración de Gmail en la Consola del administrador. Para obtener más información, consulte Enrutamiento de correo electrónico y Configuración de la función de enrutamiento dual de correo electrónico.

Ejemplo de una solicitud XML de respuesta a la API de configuración de administrador

En este documento, se proporcionan ejemplos de código de solicitudes y respuestas básicas de la API de Admin Settings mediante XML y HTTP sin procesar. Este ejemplo de lenguaje predeterminado de dominio muestra la sintaxis completa de XML y HTTP para el cuerpo de la entrada de solicitud y respuesta que es común a cada operación:

Para cambiar la configuración de la puerta de enlace de correo electrónico saliente del dominio, envía un PUT HTTP a la URL del feed de la puerta de enlace:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

La solicitud PUT del lenguaje predeterminado de dominio AtomPub entry es:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

Excepto por las propiedades y los valores específicos de la operación, los elementos atom:property representan un solo par clave-valor que contiene información sobre una propiedad que deseas recuperar o actualizar. Estas son comunes a todos los cuerpos de solicitud de la API de configuración de administrador.

El elemento entry de respuesta de idioma predeterminado del dominio muestra las propiedades smartHost y smtpMode junto con la sintaxis XML común para todos los cuerpos de respuesta de la API de Admin Settings:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

Cómo administrar la configuración de inicio de sesión único

La función de inicio de sesión único (SSO) de Google Workspace les permite a los usuarios acceder a varios servicios y solo tienen que ingresar una vez la información de acceso y la contraseña. El proveedor de identidad del dominio almacena esta contraseña, no Google Workspace. Para obtener más información, consulte la página de SSO del Centro de ayuda. En las siguientes secciones, se muestra el formato XML que se usa para la configuración de inicio de sesión único.

Recuperando la configuración de inicio de sesión único

Para recuperar la configuración de inicio de sesión único, envía un GET HTTP a la URL del feed general de SSO y, luego, incluye un encabezado Authorization como se describe en Autenticación para el servicio de configuración de administrador. Para mensajes de error, consulte Solución de problemas de SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

Esta operación no tiene parámetros en el cuerpo de la solicitud.

Una respuesta correcta muestra un código de estado HTTP 200 OK, junto con un feed AtomPub con la configuración de SSO del dominio.

El XML de respuesta GET muestra las propiedades samlSignonUri, samlLogoutUri, changePasswordUri, enableSSO, ssoWhitelist y useDomainSpecificIssuer:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

Las propiedades incluyen lo siguiente:

samlSignonUri: La URL del proveedor de identidad a la que Google Workspace envía la solicitud SAML para la autenticación de usuarios.
samlLogoutUri: La dirección a la que se enviará a los usuarios cuando salgan de la aplicación web.
CambiarContraseña: La dirección a la que se enviará a los usuarios cuando quieran cambiar su contraseña de SSO para la aplicación web
habilitar SSO: Habilita el SSO basado en SAML para este dominio. Si anteriormente configuraste la configuración de SSO y, luego, configuraste enableSSO como enableSSO=false, se conservarán las opciones de configuración que ingresaste.
sosoWhitelist: Una ssoWhitelist es una dirección IP de máscara de red en formato de enrutamiento entre dominios sin clases (CIDR). La ssoWhitelist determina qué usuarios acceden con el SSO y cuáles con la página de autenticación de la cuenta de Google Workspace. Si no se especifican máscaras, todos los usuarios accederán usando el SSO. Para obtener más información, consulta Cómo funcionan las máscaras de red.
useDomainSpecificIssuer.: Se puede usar una entidad emisora específica del dominio en la solicitud de SAML para el proveedor de identidad. Aunque no es necesario para la mayoría de las implementaciones de SSO, esta función es útil en las grandes empresas que utilizan un único proveedor de identidad para autenticar una organización completa con varios subdominios. La asignación de ese subdominio se determina con la entidad emisora del dominio específico. Para obtener más información, consulta ¿Cómo funciona el elemento de emisión en la solicitud de SAML?

Si tu solicitud falla por algún motivo, se muestra un código de estado diferente. Para obtener más información sobre los códigos de estado de la API de datos de Google, consulte Códigos de estado de HTTP.

Actualizando la configuración de inicio de sesión único

Para actualizar la configuración de SSO de un dominio, primero recupera la configuración de SSO mediante la operación de Recuperación de inicio de sesión único, modifícala y, luego, envía una solicitud PUT a la URL del feed de SSO. Asegúrate de que el valor de <id> esté en la entrada actualizada que coincida exactamente con el <id> de la entrada existente. Incluye un encabezado Authorization como se describe en Cómo autenticar en el servicio de API de Admin Settings. Y para mensajes de error, consulte Solución de problemas de SSO.

Cuando actualice la configuración de inicio de sesión único, envíe una solicitud PUT HTTP a la URL del feed general de SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

El cuerpo XML de la solicitud PUT es el siguiente:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

Una respuesta correcta muestra un código de estado HTTP 200 OK, junto con un feed de AtomPub con la configuración de SSO.

El archivo XML de respuesta PUT es el siguiente:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

Recupera la clave de firma de inicio de sesión único

Para recuperar la clave de firma de inicio de sesión único, envía un GET HTTP a la URL del feed de la clave de firma de SSO y, además, incluye un encabezado Authorization como se describe en Autenticación para el servicio de configuración de administrador. Para mensajes de error, consulte Solución de problemas de SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

Esta operación no tiene parámetros en el cuerpo de la solicitud.

Una respuesta correcta muestra un código de estado HTTP 200 OK, junto con un feed AtomPub con la clave de firma.

El XML de respuesta de GET muestra la propiedad signingKey:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

Actualiza la clave de acceso de inicio de sesión único

Para actualizar la clave de firma de SSO de un dominio, primero recupera la clave de firma mediante la operación Recuperar la clave de firma de inicio de sesión único, modifícala y, luego, envía una solicitud PUT a la URL del feed de la clave de firma de SSO. Asegúrate de que el valor de <id> esté en la entrada actualizada que coincida exactamente con el <id> de la entrada existente. Para obtener más información sobre las claves de firma de inicio de sesión único basadas en SAML, consulta Genera claves y certificados para el servicio de inicio de sesión único de Google Workspace.

Cuando actualices la clave de firma de inicio de sesión único, envía un PUT HTTP a la URL del feed de la clave de firma de SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

El archivo XML de solicitud PUT es el siguiente:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

Administrar el enrutamiento y la puerta de enlace de correo electrónico

La sección de la puerta de enlace de correo electrónico saliente muestra cómo la API de Admin Settings admite el enrutamiento de correo saliente de los usuarios de su dominio. La sección de enrutamiento de correo electrónico muestra cómo enrutar mensajes a otro servidor de correo.

Recupera la configuración de la puerta de enlace de correo electrónico saliente

Para recuperar la configuración de la puerta de enlace de correo electrónico saliente, envía un GET HTTP a la URL del feed de la puerta de enlace y, luego, incluye un encabezado Authorization como se describe en Autenticación para el servicio de configuración del administrador:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

Esta operación no tiene parámetros en el cuerpo de la solicitud.

Una respuesta correcta muestra un código de estado HTTP 200 OK, junto con un feed de AtomPub con la información de estado de la puerta de enlace de correo electrónico.

La respuesta GET muestra las propiedades smartHost y smtpMode. Para obtener más información sobre estas propiedades, consulta Actualiza la configuración de la puerta de enlace de correo electrónico saliente.

Un ejemplo de una respuesta posible es el siguiente:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

Actualizando la configuración de la puerta de enlace de correo electrónico saliente

Para actualizar la configuración de la puerta de enlace de correo electrónico saliente de un dominio, envía una solicitud PUT HTTP a la URL del feed de la puerta de enlace:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

El archivo XML de solicitud PUT es el siguiente:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

Las propiedades de la solicitud son las siguientes:

host inteligente: La dirección IP o el nombre de host de tu servidor SMTP. Google Workspace enruta el correo electrónico saliente a este servidor.
modo smtp: El valor predeterminado es SMTP. Otro valor, SMTP_TLS, protege la conexión con TLS al entregar el mensaje.

Una respuesta correcta muestra un código de estado HTTP 200 OK, junto con el feed de AtomPub con el estado de configuración de la puerta de enlace de correo electrónico.

Administrar la configuración de enrutamiento de correo electrónico

Primero, crea una solicitud XML:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

Las propiedades de la solicitud son las siguientes:

Destino de la ruta

Este destino es el nombre de host o la dirección IP del servidor de correo SMTP-En al que se enruta el correo electrónico. El nombre de host o la dirección IP deben resolverse para Google. Para obtener más detalles sobre cómo resolver los nombres de host de correo electrónico, consulte Pilote Google Workspace con enrutamiento de correo electrónico.

Redición de ruta

Si es verdadero, el campo to: del sobre SMTP del mensaje se cambia al nombre de host de destino (nombre de host usuario@destino) y el mensaje se entrega a esta dirección de usuario en el servidor de correo electrónico de destino. Si es false, el correo electrónico se entrega en la dirección de correo electrónico del mensaje original to: (usuario@nombre de host original) en el servidor de correo electrónico de destino. Esto es similar a la configuración "Cambiar sobre de SMTP" de la Consola del administrador. Para obtener más información, consulte Configuración de dominio para el enrutamiento de correo electrónico.

rutahabilitada

Si el valor es true, la función de enrutamiento de correo electrónico está habilitada. Si es false, la funcionalidad está inhabilitada.

Notificaciones de rebote

Si el valor es true, Google Workspace está habilitado para enviar notificaciones de rebote al remitente cuando falle una entrega.

Administración de la cuenta

Esta configuración determina cómo el enrutamiento de correo electrónico afecta a los diferentes tipos de usuarios del dominio:

allAccounts: envía todos los correos electrónicos a este destino.
provisionedAccounts: Envía correos electrónicos a este destino si el usuario existe en Google Workspace.
unknownAccounts: Envía correos electrónicos a este destino si el usuario no existe en Google Workspace. Esto es similar a la configuración "Correo electrónico de entrega para" de la Consola del administrador. Para obtener más información sobre los requisitos previos y la forma de usar el enrutamiento de correo electrónico, consulte Configuración de dominio para enrutamiento de correo electrónico. ~ Para publicar esta solicitud, envía un POST HTTP a la URL del feed de enrutamiento de correo electrónico y, luego, incluye un encabezado Authorization como se describe en Cómo autenticar en el servicio de configuración de administrador:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

Una respuesta correcta muestra un código de estado HTTP 200 OK, junto con un feed AtomPub con la información de archivo.

Endpoints se dará de baja el 31 de octubre de 2018

Los siguientes extremos dejaron de estar disponibles como parte de este anuncio. Venció el 31 de octubre de 2018 y ya no están disponibles.

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryEmail
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/edition
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx