Method: users.undelete
Undeletes a deleted user.
HTTP request
POST https://admin.googleapis.com/admin/directory/v1/users/{userKey}/undelete
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
userKey |
string
The immutable id of the user
|
Request body
The request body contains an instance of UserUndelete
.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admin.directory.user
For more information, see the Authorization guide.
UserUndelete
JSON representation |
{
"orgUnitPath": string
} |
Fields |
orgUnitPath |
string
OrgUnit of User
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["This request undeletes a previously deleted user using their immutable ID."],["The request body requires specifying the user's organizational unit path."],["Authorization requires the `https://www.googleapis.com/auth/admin.directory.user` scope."],["A successful response is a standard HTTP response specific to the method used."]]],["This document details the process for undeleting a user via a `POST` request to `https://admin.googleapis.com/admin/directory/v1/users/{userKey}/undelete`. The `userKey` (immutable user ID) is a required path parameter. The request body utilizes `UserUndelete`, containing `orgUnitPath` which specifies the user's organizational unit. Successful requests receive a generic HTTP response. The required authorization scope is `https://www.googleapis.com/auth/admin.directory.user`.\n"]]