Method: verificationCodes.list
Stay organized with collections
Save and categorize content based on your preferences.
Returns the current set of valid backup verification codes for the specified user.
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/verificationCodes
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
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.
|
Request body
The request body must be empty.
Response body
JSON response template for list verification codes operation in Directory API.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"kind": string,
"etag": string,
"items": [
{
object (VerificationCode)
}
]
} |
| Fields |
kind |
string
The type of the resource. This is always admin#directory#verificationCodesList.
|
etag |
string
ETag of the resource.
|
items[] |
object (VerificationCode)
A list of verification code resources.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admin.directory.user.security
For more information, see the Authorization guide.
VerificationCode
The Directory API allows you to view, generate, and invalidate backup verification codes for a user.
| JSON representation |
{
"userId": string,
"verificationCode": string,
"kind": string,
"etag": string
} |
| Fields |
userId |
string
The obfuscated unique ID of the user.
|
verificationCode |
string
A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.
|
kind |
string
The type of the resource. This is always admin#directory#verificationCode.
|
etag |
string
ETag of the resource.
|
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 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Method: verificationCodes.list\n\nReturns the current set of valid backup verification codes for the specified user.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/verificationCodes`\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### Request body\n\nThe request body must be empty.\n\n### Response body\n\nJSON response template for list verification codes operation in Directory API.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"items\": [ { object (/workspace/admin/directory/reference/rest/v1/verificationCodes/list#VerificationCode) } ] } ``` |\n\n| Fields ||\n|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the resource. This is always `admin#directory#verificationCodesList`. |\n| `etag` | `string` ETag of the resource. |\n| `items[]` | `object (`[VerificationCode](/workspace/admin/directory/reference/rest/v1/verificationCodes/list#VerificationCode)`)` A list of verification code resources. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/admin.directory.user.security`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nVerificationCode\n----------------\n\nThe Directory API allows you to view, generate, and invalidate backup verification codes for a user.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------|\n| ``` { \"userId\": string, \"verificationCode\": string, \"kind\": string, \"etag\": string } ``` |\n\n| Fields ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The obfuscated unique ID of the user. |\n| `verificationCode` | `string` A current verification code for the user. Invalidated or used verification codes are not returned as part of the result. |\n| `kind` | `string` The type of the resource. This is always `admin#directory#verificationCode`. |\n| `etag` | `string` ETag of the resource. |"]]
