2026-06-24
▼ ▲ gmailpostmastertools.domains.users.get
Parameter Order : name
Flat Path : v2/domains/{domainsId}/users/{usersId}
Path : v2/{+name}
HTTP Method : GET
Parameters :
name
Pattern : ^domains/[^/]+/users/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The resource name of the user to retrieve. Format: `domains/{domain}/users/{user}`
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Retrieves detailed information about a user that has access to a domain. Returns NOT_FOUND if the user does not exist.
▼ ▲ gmailpostmastertools.domains.users.delete
Parameter Order : name
Flat Path : v2/domains/{domainsId}/users/{usersId}
Path : v2/{+name}
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Deletes a user from a domain. Returns NOT_FOUND if the user does not exist.
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the user to delete. Format: domains/{domain}/users/{user}
Required : Yes
Type : string
Location : path
Pattern : ^domains/[^/]+/users/[^/]+$
▼ ▲ gmailpostmastertools.domains.users.patch
Parameter Order : name
Flat Path : v2/domains/{domainsId}/users/{usersId}
Path : v2/{+name}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address.
Pattern : ^domains/[^/]+/users/[^/]+$
Location : path
Type : string
Required : Yes
updateMask
Description : The list of fields to update.
Type : string
Location : query
Format : google-fieldmask
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Updates a user for a domain. Only Owners and Admins can execute this RPC, only a user's domain permission will be allowed to be updated. Returns NOT_FOUND if the user does not exist. Returns INVALID_ARGUMENT if a permission is not provided or is PERMISSION_UNSPECIFIED, NONE, or OWNER.
▼ ▲ gmailpostmastertools.domains.users.list
Parameter Order : parent
Flat Path : v2/domains/{domainsId}/users
Path : v2/{+parent}/users
HTTP Method : GET
Parameters :
pageSize
Type : integer
Description : Optional. Requested page size. Server may return fewer users than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200.
Location : query
Format : int32
pageToken
Type : string
Description : Optional. The next_page_token value returned from a previous List request, if any.
Location : query
parent
Location : path
Pattern : ^domains/[^/]+$
Required : Yes
Type : string
Description : Required. The parent resource name for which to list users. Format: `domains/{domain}`
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Lists the users that have access to a domain.
▼ ▲ gmailpostmastertools.domains.users.create
Flat Path : v2/domains/{domainsId}/users
Parameter Order : parent
Path : v2/{+parent}/users
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Creates a user, who has access to a domain. Returns INVALID_ARGUMENT if a user is not provided.
HTTP Method : POST
Parameters :
parent
Location : path
Pattern : ^domains/[^/]+$
Required : Yes
Type : string
Description : Required. The parent resource where this user will be created. Format: domains/{domain}
▼ ▲ gmailpostmastertools.domains.delete
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Deletes a domain from the user's account. Returns NOT_FOUND if the domain is not registered by the user.
HTTP Method : DELETE
Parameters :
name
Description : Required. The domain to delete.
Type : string
Required : Yes
Pattern : ^domains/[^/]+$
Location : path
Parameter Order : name
Flat Path : v2/domains/{domainsId}
Path : v2/{+name}
▼ ▲ gmailpostmastertools.domains.verify
Flat Path : v2/domains/{domainsId}:verify
Parameter Order : name
Path : v2/{+name}:verify
HTTP Method : POST
Parameters :
name
Location : path
Pattern : ^domains/[^/]+$
Required : Yes
Type : string
Description : Required. The domain to verify.
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Verifies a user's ownership of a domain at the DNS level. Note that this is distinct from checking if the user has OWNER status within IRDB.
▼ ▲ gmailpostmastertools.domains.getVerificationToken
HTTP Method : GET
Parameters :
verificationMethod
Description : Required. The verification method used. Must be specified, i.e. TXT or CNAME.
Enum Descriptions :
Type : string
Enum :
Location : query
name
Description : Required. The resource name of the verification token to retrieve. Format: `domains/{domain}/verificationToken`
Type : string
Required : Yes
Pattern : ^domains/[^/]+/verificationToken$
Location : path
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Gets a verification token used for verifying a user's ownership over a domain.
Path : v2/{+name}
Flat Path : v2/domains/{domainsId}/verificationToken
Parameter Order : name
▼ ▲ gmailpostmastertools.domains.create
Scopes :
Description : [Developer Preview](https://developers.google.com/workspace/preview): Adds a domain to the user's account. Returns INVALID_ARGUMENT if a domain is not provided. Returns ALREADY_EXISTS if the domain is already registered by the user.
HTTP Method : POST
Flat Path : v2/domains
Path : v2/domains