Admin SDK: Directory API

La API de Directory del SDK de Admin permite que los administradores de dominios empresariales vean y administren los usuarios, grupos, dispositivos y recursos relacionados de su organización. Las APIs de Cloud Identity ofrecen formas adicionales de administrar algunos de los mismos recursos.

Para llamar a este servicio, te recomendamos que uses las bibliotecas cliente proporcionadas por Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la siguiente información cuando realices solicitudes a la API.

Un Documento de descubrimiento es una especificación procesable para describir y consumir las API de REST. Se usa para compilar bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar varios documentos de descubrimiento. Este servicio proporciona el documento de descubrimiento siguiente:

Extremo de servicio

Un extremo de servicio es una URL base que especifica la dirección de la red de un servicio de API. Un servicio puede tener varios extremos de servicio. Este servicio tiene el siguiente extremo, y todos los URI que se muestran a continuación son relativos a él:

  • https://admin.googleapis.com

Recurso de REST: asps

Métodos
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
Borra una ASP emitida por un usuario.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
Obtiene información sobre una ASP emitida por un usuario.
list GET /admin/directory/v1/users/{userKey}/asps
Enumera las ASP que emitió un usuario.

Recurso de REST: chromeosdevices

Métodos
action
(deprecated)
POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
En su lugar, usa BatchChangeChromeOsDeviceStatus.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Recupera las propiedades de un dispositivo ChromeOS.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
Recupera una lista paginada de dispositivos ChromeOS de una cuenta.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
Mueve o inserta varios dispositivos ChromeOS en una unidad organizativa.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Actualiza las propiedades actualizables de un dispositivo, como annotatedUser, annotatedLocation, notes, orgUnitPath o annotatedAssetId.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Actualiza las propiedades actualizables de un dispositivo, como annotatedUser, annotatedLocation, notes, orgUnitPath o annotatedAssetId.

Recurso REST: customer.devices.chromeos

Métodos
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
Cambia el estado de un lote de dispositivos ChromeOS.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
Emite un comando para que el dispositivo lo ejecute.

Recurso de REST: customer.devices.chromeos.commands

Métodos
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
Obtiene los datos del comando que emitió un comando específico al dispositivo.

Recurso de REST: customers

Métodos
get GET /admin/directory/v1/customers/{customerKey}
Recupera un cliente.
patch PATCH /admin/directory/v1/customers/{customerKey}
Aplica parches a un cliente.
update PUT /admin/directory/v1/customers/{customerKey}
Actualiza a un cliente.

Recurso de REST: domainAliases

Métodos
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Borra un alias de dominio del cliente.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Recupera un alias de dominio del cliente.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
Inserta un alias de dominio del cliente.
list GET /admin/directory/v1/customer/{customer}/domainaliases
Enumera los alias de dominio del cliente.

Recurso de REST: domains

Métodos
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
Borra un dominio del cliente.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
Recupera un dominio del cliente.
insert POST /admin/directory/v1/customer/{customer}/domains
Inserta un dominio del cliente.
list GET /admin/directory/v1/customer/{customer}/domains
Enumera los dominios del cliente.

Recurso de REST: groups

Métodos
delete DELETE /admin/directory/v1/groups/{groupKey}
Borra un grupo.
get GET /admin/directory/v1/groups/{groupKey}
Recupera las propiedades de un grupo.
insert POST /admin/directory/v1/groups
Crea un grupo.
list GET /admin/directory/v1/groups
Recupera todos los grupos de un dominio o de un usuario a partir de una userKey (paginada).
patch PATCH /admin/directory/v1/groups/{groupKey}
Actualiza las propiedades de un grupo.
update PUT /admin/directory/v1/groups/{groupKey}
Actualiza las propiedades de un grupo.

Recurso de REST: groups.aliases

Métodos
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
Quita un alias.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
Agrega un alias para el grupo.
list GET /admin/directory/v1/groups/{groupKey}/aliases
Enumera todos los alias de un grupo.

Recurso de REST: members

Métodos
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Quita a un miembro de un grupo.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Recupera las propiedades de un miembro del grupo.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
Comprueba si el usuario determinado es miembro del grupo.
insert POST /admin/directory/v1/groups/{groupKey}/members
Agrega un usuario al grupo especificado.
list GET /admin/directory/v1/groups/{groupKey}/members
Recupera una lista paginada de todos los miembros de un grupo.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Actualiza las propiedades de membresía de un usuario del grupo especificado.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Actualiza la membresía de un usuario en el grupo especificado.

Recurso de REST: mobiledevices

Métodos
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
Realiza una acción que afecta a un dispositivo móvil.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Quita un dispositivo móvil.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Recupera las propiedades de un dispositivo móvil.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
Recupera una lista paginada de todos los dispositivos móviles que son propiedad de un usuario de una cuenta.

Recurso de REST: orgunits

Métodos
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Quita una unidad organizativa.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Recupera una unidad organizativa.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
Agrega una unidad organizativa.
list GET /admin/directory/v1/customer/{customerId}/orgunits
Recupera una lista de todas las unidades organizativas de una cuenta.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Actualiza una unidad organizativa.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Actualiza una unidad organizativa.

Recurso de REST: privilegios

Métodos
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
Recupera una lista paginada de todos los privilegios de un cliente.

Recurso de REST: resources.buildings

Métodos
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Borra un edificio.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Recupera un edificio.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
Inserta un edificio.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
Recupera una lista de edificios de una cuenta.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Aplica parches a un edificio.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Actualiza un edificio.

Recurso de REST: resources.calendars

Métodos
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Borra un recurso de calendario.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Recupera un recurso de calendario.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
Inserta un recurso de calendario.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
Recupera una lista de recursos de calendario de una cuenta.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Aplica parches a un recurso de calendario.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Actualiza un recurso de calendario.

Recurso de REST: resources.features

Métodos
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Borra un componente.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Recupera un atributo.
insert POST /admin/directory/v1/customer/{customer}/resources/features
Inserta un componente.
list GET /admin/directory/v1/customer/{customer}/resources/features
Recupera una lista de funciones de una cuenta.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Aplica parches a una función.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
Cambia el nombre de un componente.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Actualiza una función.

Recurso de REST: roleAssignments

Métodos
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Borra una asignación de rol.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Recupera una asignación de rol.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
Crea una asignación de rol.
list GET /admin/directory/v1/customer/{customer}/roleassignments
Recupera una lista paginada de todas las rolesAssignments.

Recurso de REST: roles

Métodos
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
Borra un rol.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
Recupera un rol.
insert POST /admin/directory/v1/customer/{customer}/roles
Crea un rol.
list GET /admin/directory/v1/customer/{customer}/roles
Recupera una lista paginada de todos los roles de un dominio.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
Aplica parches a una función.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
Actualiza un rol.

Recurso de REST: schemas

Métodos
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Borra un esquema.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Recupera un esquema.
insert POST /admin/directory/v1/customer/{customerId}/schemas
Crea un esquema.
list GET /admin/directory/v1/customer/{customerId}/schemas
Recupera todos los esquemas de un cliente.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Aplica parches a un esquema.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Actualiza un esquema.

Recurso de REST: tokens

Métodos
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
Borra todos los tokens de acceso emitidos por un usuario para una aplicación.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
Obtiene información sobre un token de acceso emitido por un usuario.
list GET /admin/directory/v1/users/{userKey}/tokens
Muestra el conjunto de tokens especificados por el usuario que emitió a aplicaciones de terceros.

Recurso de REST: twoStepVerification

Métodos
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
Desactiva la verificación en 2 pasos para el usuario.

Recurso de REST: users

Métodos
delete DELETE /admin/directory/v1/users/{userKey}
Borra un usuario.
get GET /admin/directory/v1/users/{userKey}
Recupera un usuario.
insert POST /admin/directory/v1/users
Crea un usuario.
list GET /admin/directory/v1/users
Recupera una lista paginada de usuarios borrados o de todos los usuarios de un dominio.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
Convierte a un usuario en un administrador avanzado.
patch PATCH /admin/directory/v1/users/{userKey}
Actualiza un usuario mediante la semántica de parches.
signOut POST /admin/directory/v1/users/{userKey}/signOut
Hace que un usuario salga de todas las sesiones web y de dispositivos, y restablece sus cookies de acceso.
undelete POST /admin/directory/v1/users/{userKey}/undelete
Recupera un usuario borrado.
update PUT /admin/directory/v1/users/{userKey}
Actualiza un usuario.
watch POST /admin/directory/v1/users/watch
Observa los cambios en la lista de usuarios.

Recurso de REST: users.aliases

Métodos
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
Quita un alias.
insert POST /admin/directory/v1/users/{userKey}/aliases
Agrega un alias.
list GET /admin/directory/v1/users/{userKey}/aliases
Enumera todos los alias de un usuario.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
Observa los cambios en la lista de usuarios.

Recurso de REST: users.photos

Métodos
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
Quita la foto del usuario.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
Recupera la foto del usuario.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
Agrega una foto para el usuario.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
Agrega una foto para el usuario.

Recurso de REST: verificationCodes

Métodos
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
Genera nuevos códigos de verificación de respaldo para el usuario.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
Invalida los códigos de verificación actuales del usuario.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
Muestra el conjunto actual de códigos de verificación de respaldo válidos para el usuario especificado.