Account
The account a tenant signs in to. It owns the projects, and every website hangs off one of them.
List accounts
The top of the ownership tree: an account owns projects, a project owns websites, and a user reaches a website only through a membership in its account. The list is already scoped to the caller's own memberships, so there is nothing to filter by hand — and for the same reason its total_size counts what the caller can see, not what the platform holds.
query Parameters
page_sizeRows per page. Over the maximum is clamped, not rejected.
page_tokenOpaque token from a previous next_page_token. A token minted under a different order_by/filter is rejected.
skipRows to skip before the page (AIP-158). skip + page_size is capped at 10000; beyond that is OUT_OF_RANGE.
order_byComma-separated field [asc|desc], at most 3 keys. Default: create_time desc. Sortable: create_time, display_name.
filterAIP-160 subset (§8). Filterable: create_time, display_name, is_active. A field outside the list is INVALID_ARGUMENT.
List accounts › Responses
One page of accounts.
This page of accounts, in the requested order.
next_page_tokenOpaque. Absent or empty means this was the last page.
total_sizeRows in the whole filtered collection, not in this page.
Create account
The top of the ownership tree: an account owns projects, a project owns websites, and a user reaches a website only through a membership in its account. The list is already scoped to the caller's own memberships, so there is nothing to filter by hand — and for the same reason its total_size counts what the caller can see, not what the platform holds.
Create account › Request Body
display_nameThe account's label, as the admin shows it in the account switcher.
is_activeWhether the account is in use. An inactive one is invisible on this surface: the list skips it and a read answers NOT_FOUND.
Create account › Responses
The created resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
display_nameThe account's label, as the admin shows it in the account switcher.
is_activeWhether the account is in use. An inactive one is invisible on this surface: the list skips it and a read answers NOT_FOUND.
ownerThe member who owns the account, as users/{user}: whoever created it, or the first member of an account made for them. An account has exactly one owner; neither Create nor Update sets it, and only the owner moves it, with :transfer_ownership. The owner may do everything in the account whatever their role says, is the only member who may delete it or hand it over, and can be neither removed from it nor leave it.
Get account
The top of the ownership tree: an account owns projects, a project owns websites, and a user reaches a website only through a membership in its account. The list is already scoped to the caller's own memberships, so there is nothing to filter by hand — and for the same reason its total_size counts what the caller can see, not what the platform holds.
path Parameters
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
Headers
If-None-MatchA matching etag answers 304 with no body (§16).
Get account › Responses
The resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
display_nameThe account's label, as the admin shows it in the account switcher.
is_activeWhether the account is in use. An inactive one is invisible on this surface: the list skips it and a read answers NOT_FOUND.
ownerThe member who owns the account, as users/{user}: whoever created it, or the first member of an account made for them. An account has exactly one owner; neither Create nor Update sets it, and only the owner moves it, with :transfer_ownership. The owner may do everything in the account whatever their role says, is the only member who may delete it or hand it over, and can be neither removed from it nor leave it.
Delete account
Deletes the account; its projects and its memberships go with it. Only the account's owner may: any other member — an administrator included — is refused PERMISSION_DENIED.
path Parameters
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
Headers
If-MatchThe etag the client last read. A mismatch is ABORTED (409) with the current resource in the error details (§14).
Delete account › Responses
Deleted. No body (§7).
Update account
The top of the ownership tree: an account owns projects, a project owns websites, and a user reaches a website only through a membership in its account. The list is already scoped to the caller's own memberships, so there is nothing to filter by hand — and for the same reason its total_size counts what the caller can see, not what the platform holds.
path Parameters
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
query Parameters
update_maskComma-separated field paths to merge. A field named here and sent as null is cleared; without the mask a null is dropped (§7, §11).
Headers
If-MatchThe etag the client last read. A mismatch is ABORTED (409) with the current resource in the error details (§14).
Update account › Request Body
display_nameThe account's label, as the admin shows it in the account switcher.
is_activeWhether the account is in use. An inactive one is invisible on this surface: the list skips it and a read answers NOT_FOUND.
Update account › Responses
The updated resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
display_nameThe account's label, as the admin shows it in the account switcher.
is_activeWhether the account is in use. An inactive one is invisible on this surface: the list skips it and a read answers NOT_FOUND.
ownerThe member who owns the account, as users/{user}: whoever created it, or the first member of an account made for them. An account has exactly one owner; neither Create nor Update sets it, and only the owner moves it, with :transfer_ownership. The owner may do everything in the account whatever their role says, is the only member who may delete it or hand it over, and can be neither removed from it nor leave it.
Transfer ownership (accounts)
Hands the account to another of its members: send {"user": "users/{user}"}. Only the owner may — anyone else is refused PERMISSION_DENIED. The new owner must already be a member, otherwise the request is INVALID_ARGUMENT on user. The previous owner stays in the account as a roles/admin member, and the new owner's membership reads roles/admin, dormant while they own it. The response is the account, with its new owner.
path Parameters
idId of the accounts resource this URL addresses.
Transfer ownership (accounts) › Request Body optional
Transfer ownership (accounts) › Responses
The affected resource, or the method’s own response object (§10).