Esta página foi traduzida pela API Cloud Translation.

Admin SDK: Directory API

A API Admin SDK Directory permite que os administradores de domínios empresariais acessem e gerenciem os usuários, grupos, dispositivos e recursos relacionados da organização. As APIs Cloud Identity oferecem outras maneiras de gerenciar alguns dos mesmos recursos.

Serviço: admin.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de detecção:

https://admin.googleapis.com/$discovery/rest?version=directory_v1

Endpoint de serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

https://admin.googleapis.com

Recurso REST: asps

Métodos
`delete`	`DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}` Exclui um ASP emitido por um usuário.
`get`	`GET /admin/directory/v1/users/{userKey}/asps/{codeId}` Recebe informações sobre um ASP emitido por um usuário.
`list`	`GET /admin/directory/v1/users/{userKey}/asps` Lista as ASPs emitidas por um usuário.

Recurso REST: chromeosdevices

Métodos
`action (deprecated)`	`POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action` Use BatchChangeChromeOsDeviceStatus.
`get`	`GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}` Recupera as propriedades de um dispositivo ChromeOS.
`list`	`GET /admin/directory/v1/customer/{customerId}/devices/chromeos` Recupera uma lista paginada de dispositivos ChromeOS em uma conta.
`moveDevicesToOu`	`POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu` Move ou insere vários dispositivos ChromeOS em uma unidade organizacional.
`patch`	`PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}` Atualiza as propriedades atualizáveis de um dispositivo, como `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath` ou `annotatedAssetId`.
`update`	`PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}` Atualiza as propriedades atualizáveis de um dispositivo, como `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath` ou `annotatedAssetId`.

Recurso REST: customer.devices.chromeos

Métodos
`batchChangeStatus`	`POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus` Muda o status de um lote de dispositivos ChromeOS.
`issueCommand`	`POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand` Envia um comando para o dispositivo executar.

Recurso REST: customer.devices.chromeos.commands

Métodos
`get`	`GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}` Recebe dados de comando de um comando específico emitido para o dispositivo.

Recurso REST: customers

Métodos
`get`	`GET /admin/directory/v1/customers/{customerKey}` Recupera um cliente.
`patch`	`PATCH /admin/directory/v1/customers/{customerKey}` Adiciona patches a um cliente.
`update`	`PUT /admin/directory/v1/customers/{customerKey}` Atualiza um cliente.

Recurso REST: domainAliases

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}` Exclui um alias de domínio do cliente.
`get`	`GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}` Recupera um alias de domínio do cliente.
`insert`	`POST /admin/directory/v1/customer/{customer}/domainaliases` Insere um alias de domínio do cliente.
`list`	`GET /admin/directory/v1/customer/{customer}/domainaliases` Lista os aliases de domínio do cliente.

Recurso REST: domains

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}` Exclui um domínio do cliente.
`get`	`GET /admin/directory/v1/customer/{customer}/domains/{domainName}` Recupera um domínio do cliente.
`insert`	`POST /admin/directory/v1/customer/{customer}/domains` Insere um domínio do cliente.
`list`	`GET /admin/directory/v1/customer/{customer}/domains` Lista os domínios do cliente.

Recurso REST: groups

Métodos
`delete`	`DELETE /admin/directory/v1/groups/{groupKey}` Exclui um grupo.
`get`	`GET /admin/directory/v1/groups/{groupKey}` Recupera as propriedades de um grupo.
`insert`	`POST /admin/directory/v1/groups` Cria um grupo.
`list`	`GET /admin/directory/v1/groups` Recupera todos os grupos de um domínio ou de um usuário com uma userKey (paginado).
`patch`	`PATCH /admin/directory/v1/groups/{groupKey}` Atualiza as propriedades de um grupo.
`update`	`PUT /admin/directory/v1/groups/{groupKey}` Atualiza as propriedades de um grupo.

Recurso REST: groups.aliases

Métodos
`delete`	`DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}` Remove um alias.
`insert`	`POST /admin/directory/v1/groups/{groupKey}/aliases` Adiciona um alias para o grupo.
`list`	`GET /admin/directory/v1/groups/{groupKey}/aliases` Lista todos os aliases de um grupo.

Recurso REST: membros

Métodos
`delete`	`DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}` Remove um participante de um grupo.
`get`	`GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}` Recupera as propriedades de um membro do grupo.
`hasMember`	`GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}` Verifica se o usuário especificado é membro do grupo.
`insert`	`POST /admin/directory/v1/groups/{groupKey}/members` Adiciona um usuário ao grupo especificado.
`list`	`GET /admin/directory/v1/groups/{groupKey}/members` Recupera uma lista paginada de todos os membros de um grupo.
`patch`	`PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}` Atualiza as propriedades de associação de um usuário no grupo especificado.
`update`	`PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}` Atualiza a associação de um usuário ao grupo especificado.

Recurso REST: mobiledevices

Métodos
`action`	`POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action` Realiza uma ação que afeta um dispositivo móvel.
`delete`	`DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}` Remove um dispositivo móvel.
`get`	`GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}` Recupera as propriedades de um dispositivo móvel.
`list`	`GET /admin/directory/v1/customer/{customerId}/devices/mobile` Recupera uma lista paginada de todos os dispositivos móveis de um usuário de uma conta.

Recurso REST: orgunits

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}` Remove uma unidade organizacional.
`get`	`GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}` Recupera uma unidade organizacional.
`insert`	`POST /admin/directory/v1/customer/{customerId}/orgunits` Adiciona uma unidade organizacional.
`list`	`GET /admin/directory/v1/customer/{customerId}/orgunits` Recupera uma lista de todas as unidades organizacionais de uma conta.
`patch`	`PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}` Atualiza uma unidade organizacional.
`update`	`PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}` Atualiza uma unidade organizacional.

Recurso REST: privilégios

Métodos
`list`	`GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges` Recupera uma lista paginada de todos os privilégios de um cliente.

Recurso REST: resources.buildings

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}` Exclui um edifício.
`get`	`GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}` Recupera um edifício.
`insert`	`POST /admin/directory/v1/customer/{customer}/resources/buildings` Insere um edifício.
`list`	`GET /admin/directory/v1/customer/{customer}/resources/buildings` Recupera uma lista de edifícios de uma conta.
`patch`	`PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}` Adiciona patches a um edifício.
`update`	`PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}` Atualiza um edifício.

Recurso REST: resources.calendars

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}` Exclui um recurso de agenda.
`get`	`GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}` Recupera um recurso da agenda.
`insert`	`POST /admin/directory/v1/customer/{customer}/resources/calendars` Insere um recurso da agenda.
`list`	`GET /admin/directory/v1/customer/{customer}/resources/calendars` Recupera uma lista de recursos de agenda de uma conta.
`patch`	`PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}` Corrige um recurso da agenda.
`update`	`PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}` Atualiza um recurso de agenda.

Recurso REST: resources.features

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}` Exclui um elemento.
`get`	`GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}` Recupera um recurso.
`insert`	`POST /admin/directory/v1/customer/{customer}/resources/features` Insere um recurso.
`list`	`GET /admin/directory/v1/customer/{customer}/resources/features` Recupera uma lista de recursos de uma conta.
`patch`	`PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}` Adiciona patches a um recurso.
`rename`	`POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename` Renomeia um recurso.
`update`	`PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}` Atualiza um recurso.

Recurso REST: roleAssignments

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}` Exclui uma atribuição de função.
`get`	`GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}` Recupera uma atribuição de função.
`insert`	`POST /admin/directory/v1/customer/{customer}/roleassignments` Cria uma atribuição de função.
`list`	`GET /admin/directory/v1/customer/{customer}/roleassignments` Recupera uma lista paginada de todas as atribuiçãos de função.

Recurso REST: roles

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}` Exclui uma função.
`get`	`GET /admin/directory/v1/customer/{customer}/roles/{roleId}` Recupera um papel.
`insert`	`POST /admin/directory/v1/customer/{customer}/roles` Cria uma função.
`list`	`GET /admin/directory/v1/customer/{customer}/roles` Recupera uma lista paginada de todos os papéis em um domínio.
`patch`	`PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}` Adiciona patches a uma função.
`update`	`PUT /admin/directory/v1/customer/{customer}/roles/{roleId}` Atualiza uma função.

Recurso REST: schemas

Métodos
`delete`	`DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}` Exclui um esquema.
`get`	`GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}` Recupera um esquema.
`insert`	`POST /admin/directory/v1/customer/{customerId}/schemas` Cria um esquema.
`list`	`GET /admin/directory/v1/customer/{customerId}/schemas` Recupera todos os esquemas de um cliente.
`patch`	`PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}` Adiciona patches a um esquema.
`update`	`PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}` Atualiza um esquema.

Recurso REST: tokens

Métodos
`delete`	`DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}` Exclui todos os tokens de acesso emitidos por um usuário para um aplicativo.
`get`	`GET /admin/directory/v1/users/{userKey}/tokens/{clientId}` Recebe informações sobre um token de acesso emitido por um usuário.
`list`	`GET /admin/directory/v1/users/{userKey}/tokens` Retorna o conjunto de tokens que o usuário especificado emitiu para apps de terceiros.

Recurso REST: twoStepVerification

Métodos
`turnOff`	`POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff` Desativa a verificação em duas etapas para o usuário.

Recurso REST: users

Métodos
`delete`	`DELETE /admin/directory/v1/users/{userKey}` Exclui um usuário.
`get`	`GET /admin/directory/v1/users/{userKey}` Recupera um usuário.
`insert`	`POST /admin/directory/v1/users` Cria um usuário.
`list`	`GET /admin/directory/v1/users` Recupera uma lista paginada de usuários excluídos ou de todos os usuários em um domínio.
`makeAdmin`	`POST /admin/directory/v1/users/{userKey}/makeAdmin` Torna um usuário superadministrador.
`patch`	`PATCH /admin/directory/v1/users/{userKey}` Atualiza um usuário usando a semântica de patch.
`signOut`	`POST /admin/directory/v1/users/{userKey}/signOut` Desconecta o usuário de todas as sessões da Web e do dispositivo e redefine os cookies de login.
`undelete`	`POST /admin/directory/v1/users/{userKey}/undelete` Desfaz a exclusão de um usuário.
`update`	`PUT /admin/directory/v1/users/{userKey}` Atualiza um usuário.
`watch`	`POST /admin/directory/v1/users/watch` Monitora as mudanças na lista de usuários.

Recurso REST: users.aliases

Métodos
`delete`	`DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}` Remove um alias.
`insert`	`POST /admin/directory/v1/users/{userKey}/aliases` Adiciona um alias.
`list`	`GET /admin/directory/v1/users/{userKey}/aliases` Lista todos os aliases de um usuário.
`watch`	`POST /admin/directory/v1/users/{userKey}/aliases/watch` Monitora as mudanças na lista de usuários.

Recurso REST: users.photos

Métodos
`delete`	`DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail` Remove a foto do usuário.
`get`	`GET /admin/directory/v1/users/{userKey}/photos/thumbnail` Recupera a foto do usuário.
`patch`	`PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail` Adiciona uma foto para o usuário.
`update`	`PUT /admin/directory/v1/users/{userKey}/photos/thumbnail` Adiciona uma foto para o usuário.

Recurso REST: verificationCodes

Métodos
`generate`	`POST /admin/directory/v1/users/{userKey}/verificationCodes/generate` Gera novos códigos de verificação extra para o usuário.
`invalidate`	`POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate` Invalida os códigos de verificação extra atuais do usuário.
`list`	`GET /admin/directory/v1/users/{userKey}/verificationCodes` Retorna o conjunto atual de códigos de verificação alternativos válidos para o usuário especificado.