allowlisted_domains

Creates, updates, deletes, gets or lists an allowlisted_domains resource.

Overview

Name	allowlisted_domains
Type	Resource
Id	google.cloudidentity.allowlisted_domains

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Identifier. Resource name of the domain in the allowlist e.g. "allowlistedDomains/0184mhaj1smlusv"
domain	string	Required. Immutable. Name of the domain that is in the allowlist. e.g. "google.com"

list

Name	Datatype	Description
name	string	Output only. Identifier. Resource name of the domain in the allowlist e.g. "allowlistedDomains/0184mhaj1smlusv"
domain	string	Required. Immutable. Name of the domain that is in the allowlist. e.g. "google.com"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	allowlistedDomainsId		Retrieves a specific domain from the allowlist.
list	select		filter, pageSize, pageToken	Lists the domains in the allowlist.
create	insert			Adds a domain to the allowlist.
delete	delete	allowlistedDomainsId		Removes a domain from the allowlist.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
allowlistedDomainsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieves a specific domain from the allowlist.

SELECT
name,
domain
FROM google.cloudidentity.allowlisted_domains
WHERE allowlistedDomainsId = '{{ allowlistedDomainsId }}' -- required
;

list

Lists the domains in the allowlist.

SELECT
name,
domain
FROM google.cloudidentity.allowlisted_domains
WHERE filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Adds a domain to the allowlist.

INSERT INTO google.cloudidentity.allowlisted_domains (
data__domain
)
SELECT 
'{{ domain }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: allowlisted_domains
props:
  - name: domain
    value: "{{ domain }}"
    description: |
      Required. Immutable. Name of the domain that is in the allowlist. e.g. "google.com"

DELETE examples

delete

Removes a domain from the allowlist.

DELETE FROM google.cloudidentity.allowlisted_domains
WHERE allowlistedDomainsId = '{{ allowlistedDomainsId }}' --required
;